Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Playwright navigation utilities #1869

Merged
merged 4 commits into from May 1, 2023
Merged

Improve Playwright navigation utilities #1869

merged 4 commits into from May 1, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 21, 2023 •
edited

Fixes

Fixes #1848 by @obulat

Description

This PR refactors Playwright navigation utilities:

  • replaces waitForNavigation with waitForURL to prevent race conditions (as mentioned in Replace deprecated waitForNavigation method in Playwright tests #1848 description)
  • adds 3 functions that set UI properties using cookies: setBreakpointCookie, dismissBannersUsingCookies and closeFiltersUsingCookies
  • combines the functions to open/close filters and search types popovers and modals.

The CI failed on the first run. The failures however should be fixed by #1871 and #1808.

Testing Instructions

The Playwright tests should pass.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from a team as a code owner April 21, 2023 13:44
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Apr 21, 2023
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: frontend Related to the Nuxt frontend labels Apr 21, 2023
@github-actions
Copy link

github-actions bot commented Apr 21, 2023 •
edited

Size Change: 0 B

Total Size: 857 kB

ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/235.js 273 B
./frontend/.nuxt/dist/client/235.modern.js 277 B
./frontend/.nuxt/dist/client/236.js 1.85 kB
./frontend/.nuxt/dist/client/app.js 126 kB
./frontend/.nuxt/dist/client/app.modern.js 117 kB
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 751 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 757 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.58 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.45 kB
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 396 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 3 kB
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 2.33 kB
./frontend/.nuxt/dist/client/components/v-audio-details/components/v-content-report-form/components/v-content-report-popover/comp/e356c88c.js 3.86 kB
./frontend/.nuxt/dist/client/components/v-audio-details/components/v-content-report-popover/components/v-image-details/pages/audi/7832d35f.modern.js 4.24 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.6 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.54 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 514 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 520 B
./frontend/.nuxt/dist/client/components/v-bone.js 688 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.28 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 974 B
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 973 B
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 528 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 715 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 716 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 776 B
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 4.04 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 1.72 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 756 B
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 1.72 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 1.69 kB
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 10 kB
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 10 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B
./frontend/.nuxt/dist/client/components/v-error-image.js 1.7 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.79 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.78 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 785 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 785 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 2.13 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 2.11 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.js 5.27 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 5.25 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.76 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.73 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.59 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.58 kB
./frontend/.nuxt/dist/client/components/v-image-details.js 2.62 kB
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.96 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 2.67 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 2.55 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 1.24 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 1.21 kB
./frontend/.nuxt/dist/client/components/v-load-more.js 809 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 709 B
./frontend/.nuxt/dist/client/components/v-media-license.js 829 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 837 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.31 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.29 kB
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B
./frontend/.nuxt/dist/client/components/v-no-results.js 723 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 722 B
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.27 kB
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.27 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 3.25 kB
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 3.12 kB
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 979 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 828 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 5.6 kB
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 5.53 kB
./frontend/.nuxt/dist/client/components/v-search-results-title.js 599 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 604 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.2 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.2 kB
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 5.59 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 4.93 kB
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 6.59 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 5.81 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 1.85 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.71 kB
./frontend/.nuxt/dist/client/pages/index.js 7.33 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 7.27 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.01 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.02 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB
./frontend/.nuxt/dist/client/pages/search.js 2.19 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 3.61 kB
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.51 kB
./frontend/.nuxt/dist/client/pages/search/image.js 2.84 kB
./frontend/.nuxt/dist/client/pages/search/image.modern.js 2.74 kB
./frontend/.nuxt/dist/client/pages/search/index.js 443 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.51 kB
./frontend/.nuxt/dist/client/runtime.js 2.75 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.75 kB
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.8 kB

compressed-size-action

@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/1869

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@openverse-bot
Copy link
Collaborator

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@zackkrida
@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was updated 2 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday. ↩

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range. ↩

@obulat obulat force-pushed the fix/pw_wait_for_url branch 2 times, most recently from e01523d to 63e916b Compare April 26, 2023 18:21
sarayourfriend
sarayourfriend approved these changes Apr 27, 2023
View reviewed changes
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Lots of big changes but the improvement in the tests is obvious 🚀

frontend/test/playwright/utils/navigation.ts
}
}

export const filters = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I like this object-grouped model. In the future maybe the cookies could be handled similarly.

@obulat obulat self-assigned this Apr 30, 2023
@obulat obulat added 🟥 priority: critical Must be addressed ASAP and removed 🟧 priority: high Stalls work on the project or its dependents labels May 1, 2023
dhruvkb
dhruvkb approved these changes May 1, 2023
View reviewed changes
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had already gone through this one. Was waiting for #1871 and #1808.

Openverse PRs automation moved this from Needs review to Reviewer approved May 1, 2023
@obulat obulat merged commit 1f2eef5 into main May 1, 2023
44 checks passed
Openverse PRs automation moved this from Reviewer approved to Merged! May 1, 2023
@obulat obulat deleted the fix/pw_wait_for_url branch May 1, 2023 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhruvkb dhruvkb dhruvkb approved these changes

@sarayourfriend sarayourfriend sarayourfriend approved these changes

@zackkrida zackkrida Awaiting requested review from zackkrida zackkrida is a code owner automatically assigned from WordPress/openverse-frontend

@krysal krysal Awaiting requested review from krysal

Assignees

@obulat obulat

Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟥 priority: critical Must be addressed ASAP 🧱 stack: frontend Related to the Nuxt frontend
Projects
Openverse PRs
Archived in project
Openverse PRs
  
Merged!
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Replace deprecated waitForNavigation method in Playwright tests
4 participants
@obulat @openverse-bot @dhruvkb @sarayourfriend