Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Update Playwright tests utilities to work both when the new_header flag is enabled and when it's disabled #1914

Merged
merged 1 commit into from
Oct 19, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 16, 2022

Fixes

Related to #1843 by @dhruvkb

Description

This PR prepares the background for the tests with new_header enabled:

  • Updates the utils methods to add the mode parameter. By default, it is set to new, and all the functions work with the new_header. The previous functions are used when mode parameter is set to old.
  • Renames all the tests that use the affected utils methods to add -old suffix to them. The new tests without the suffix will be added in a follow-up PR.
  • Adds the new breakpoint-related methods. Previously, desktop widths started at md breakpoint, and now they start at lg.
  • Improves the accessible label for the VContentSettingsButton to add a number of filters applied.

Testing Instructions

The tests in CI should pass.

Checklist

  • My pull request has a descriptive title (not a vague title like Update 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.

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.

@github-actions
Copy link

github-actions bot commented Oct 16, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1914
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1914/tailwind

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 openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Oct 16, 2022
@github-actions
Copy link

github-actions bot commented Oct 16, 2022

Size Change: -3.3 kB (0%)

Total Size: 820 kB

Filename Size Change
./.nuxt/dist/client/230.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/230.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/231.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 134 kB -1.56 kB (-1%)
./.nuxt/dist/client/app.modern.js 125 kB -1.58 kB (-1%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.5 kB +19 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.48 kB +23 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.23 kB -55 B (-1%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -10 B (-1%)
./.nuxt/dist/client/pages/search/index.js 2.96 kB +12 B (0%)
./.nuxt/dist/client/runtime.js 2.63 kB -65 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.64 kB -63 B (-2%)
./.nuxt/dist/client/216.js 273 B +273 B (new file) 🆕
./.nuxt/dist/client/216.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/217.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.1 kB -7 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 745 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 749 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 514 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 2.75 kB +2 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.73 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.01 kB -1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 357 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 360 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.82 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.11 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.06 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 537 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 542 B 0 B
./.nuxt/dist/client/components/v-bone.js 685 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 690 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.11 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 778 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.43 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.24 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.98 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 749 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-external-search-form.js 3.11 kB 0 B
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.09 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.57 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.6 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-details.js 1.44 kB 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 2.53 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 522 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 524 B 0 B
./.nuxt/dist/client/components/v-load-more.js 788 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-media-license.js 799 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 808 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.63 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 430 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.77 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.74 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.1 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 2.97 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 966 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.45 kB 0 B
./.nuxt/dist/client/components/v-search-grid.modern.js 5.41 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 658 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 651 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 793 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.modern.js 771 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B -1 B (0%)
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 997 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 888 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 893 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 15.8 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.06 kB -2 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.07 kB +1 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 4.89 kB -7 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.73 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.45 kB +6 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.45 kB -2 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.24 kB +2 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 7.22 kB 0 B
./.nuxt/dist/client/pages/index.js 5.05 kB 0 B
./.nuxt/dist/client/pages/index.modern.js 4.91 kB -2 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.54 kB -2 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB +2 B (0%)
./.nuxt/dist/client/pages/search.js 2.75 kB +1 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.6 kB +2 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.19 kB -3 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.2 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.79 kB +4 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB 0 B
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB -2 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 241 B -2 B (-1%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 265 B -1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B -1 B (0%)
./.nuxt/dist/client/pages/search/video.js 239 B -1 B (0%)
./.nuxt/dist/client/pages/search/video.modern.js 244 B +1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.44 kB -2 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/vendors/app.js 57.2 kB +3 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 56.5 kB 0 B

compressed-size-action

@obulat obulat force-pushed the update_pw_helpers branch from 0719234 to bd8da8b Compare October 18, 2022 10:56
@obulat obulat marked this pull request as ready for review October 18, 2022 11:04
@obulat obulat requested a review from a team as a code owner October 18, 2022 11:04
@obulat obulat requested review from zackkrida and dhruvkb October 18, 2022 11:04
@obulat obulat changed the title Update Playwright tests to work with the new_header Update Playwright tests utilities to work both when the new_header flag is enabled and when it's disabled Oct 18, 2022
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🌟 goal: addition Addition of new feature labels Oct 18, 2022
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

The VContentSettingsButton aria improvements look great as well. LGTM.

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.

I'm not always a huge fan of "old" and "new" as indicators for things like this. Whatever is "new" today eventually becomes old. I guess at that point we'd come back and refactor all of these to remove the "old" tests... but to someone reading this who isn't clued into the header work, these mode names are cryptic. Are there clearer names than new and old for the mode? Maybe even "new_header" or "old_header"?

Also, one nit, if we could extract the 'old' | 'new' type out it would help with the eventual "delete the old mode" refactor... if you removed the shared type then TypeScript would tell you precisely everywhere that needed to be changed to accommodate the refactor 🙂

@obulat
Copy link
Contributor Author

obulat commented Oct 19, 2022

Maybe even "new_header" or "old_header"?

Also, one nit, if we could extract the 'old' | 'new' type out it would help with the eventual "delete the old mode" refactor... if you removed the shared type then TypeScript would tell you precisely everywhere that needed to be changed to accommodate the refactor 🙂

Great suggestions, thank you, @sarayourfriend! I've added the new type, and made new_header and old_header constants so that the value can be changed in a single place.

Rename the tests that use utils functions adding `-old`
Update test/playwright/utils/navigation.ts
Create a `HeaderMode` type, and set values to 'new_header'/'old_header'
@obulat obulat force-pushed the update_pw_helpers branch from 16c3db0 to b73ace1 Compare October 19, 2022 04:55
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! The -old filenames would be nice to be -with-old-header instead, but just a nit pick and don't want to hold up the PR any more. Sorry I didn't think of it before.

Nice work getting this stuff consolidated 🚀

@obulat obulat merged commit f28c532 into main Oct 19, 2022
@obulat obulat deleted the update_pw_helpers branch October 19, 2022 05:11
github-actions bot pushed a commit that referenced this pull request Oct 19, 2022
obulat added a commit that referenced this pull request Oct 26, 2022
…flag is enabled and when it's disabled (#1914)

Add e2e test utils for new_header

Rename the tests that use utils functions adding `-old`
Update test/playwright/utils/navigation.ts
Create a `HeaderMode` type, and set values to 'new_header'/'old_header'
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants