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

Add the new e2e tests that work with new_header flag on #1918

Merged
merged 6 commits into from
Oct 28, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 18, 2022

Fixes

Related to #1843 by @dhruvkb

Description

This PR is based on the work from #1914. It adds the new e2e tests that test the functionality when the new_header flag is on.

Testing Instructions

The 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.

@obulat obulat requested a review from a team as a code owner October 18, 2022 11:13
@obulat obulat requested review from zackkrida and dhruvkb October 18, 2022 11:13
@github-actions
Copy link

github-actions bot commented Oct 18, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1918
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1918/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 18, 2022
@github-actions
Copy link

github-actions bot commented Oct 18, 2022

Size Change: -3.12 kB (0%)

Total Size: 812 kB

Filename Size Change
./.nuxt/dist/client/226.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/226.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/227.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 130 kB -1.26 kB (-1%)
./.nuxt/dist/client/app.modern.js 121 kB -1.46 kB (-1%)
./.nuxt/dist/client/commons/app.js 88.1 kB -38 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB -32 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.41 kB -20 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB -17 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.99 kB +11 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 4 kB +10 B (0%)
./.nuxt/dist/client/components/v-external-search-form.js 3.08 kB -26 B (-1%)
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB -22 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.js 2.54 kB -23 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB -23 B (-1%)
./.nuxt/dist/client/components/v-no-results.js 2.75 kB -25 B (-1%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB -22 B (-1%)
./.nuxt/dist/client/components/v-search-grid.js 5.42 kB -25 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.39 kB -21 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB -27 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.7 kB -26 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.23 kB -53 B (-1%)
./.nuxt/dist/client/pages/search.js 2.72 kB -28 B (-1%)
./.nuxt/dist/client/pages/search.modern.js 2.57 kB -21 B (-1%)
./.nuxt/dist/client/pages/search/audio.js 1.23 kB +42 B (+4%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.23 kB +36 B (+3%)
./.nuxt/dist/client/runtime.js 2.64 kB -41 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.64 kB -42 B (-2%)
./.nuxt/dist/client/vendors/app.js 57.2 kB +16 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 56.5 kB -21 B (0%)
./.nuxt/dist/client/217.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/217.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/218.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 744 B -1 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 751 B +1 B (0%)
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.76 kB +1 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.02 kB -3 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 356 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 359 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB +1 B (0%)
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -2 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-audio-track.js 5.12 kB +3 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.07 kB +5 B (0%)
./.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 541 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 +1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-page.js 467 B +1 B (0%)
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 776 B -2 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 B +1 B (0%)
./.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 -1 B (0%)
./.nuxt/dist/client/components/v-copy-license.js 999 B -2 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.5 kB -2 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 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 748 B +4 B (+1%)
./.nuxt/dist/client/components/v-dmca-notice.modern.js 752 B -1 B (0%)
./.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 +3 B (0%)
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B -1 B (0%)
./.nuxt/dist/client/components/v-full-layout.js 1.49 kB -1 B (0%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.49 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB +1 B (0%)
./.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 +1 B (0%)
./.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 +1 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 521 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 525 B 0 B
./.nuxt/dist/client/components/v-load-more.js 790 B +1 B (0%)
./.nuxt/dist/client/components/v-load-more.modern.js 682 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 800 B +1 B (0%)
./.nuxt/dist/client/components/v-media-license.modern.js 807 B -1 B (0%)
./.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 +1 B (0%)
./.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-radio.js 1.51 kB -1 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB -3 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.1 kB +2 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB +2 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.js 967 B +2 B (0%)
./.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 +3 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB +5 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 813 B -1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 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 +1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 795 B +2 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 769 B +2 B (0%)
./.nuxt/dist/client/components/v-server-timeout.js 298 B -2 B (-1%)
./.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 895 B -1 B (0%)
./.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 +1 B (0%)
./.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-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 302 B 0 B
./.nuxt/dist/client/pages/about.js 1.06 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.07 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.89 kB 0 B
./.nuxt/dist/client/pages/audio/_id.modern.js 4.73 kB +3 B (0%)
./.nuxt/dist/client/pages/external-sources.js 1.45 kB +1 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 0 B
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 7.24 kB +6 B (0%)
./.nuxt/dist/client/pages/index.js 5 kB -3 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.86 kB +1 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -1 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.54 kB +1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.79 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +2 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.97 kB +2 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB 0 B
./.nuxt/dist/client/pages/search/model-3d.js 242 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 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B 0 B
./.nuxt/dist/client/pages/search/video.js 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./.nuxt/dist/client/pages/sources.js 1.44 kB -1 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB +1 B (0%)

compressed-size-action

@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 and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Oct 18, 2022
@obulat obulat force-pushed the update_pw_helpers branch from 16c3db0 to b73ace1 Compare October 19, 2022 04:55
@obulat obulat force-pushed the add/new_header_e2e_tests branch from 6773c69 to 4aaa86a Compare October 19, 2022 05:05
Base automatically changed from update_pw_helpers to main October 19, 2022 05:11
@obulat obulat force-pushed the add/new_header_e2e_tests branch from 4aaa86a to 5c24cc4 Compare October 19, 2022 05:43
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.

Looks good to me, fairly comprehensive set of interaction paths.

@openverse-bot
Copy link
Contributor

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

@zackkrida
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 requested a review from sarayourfriend October 26, 2022 01:36
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.

Sorry for the delay. The tests look good but why is there duplication of the breakpoints utilities. I noted it in two places but it seems to be consistent. Do the breakpoint utilities need to be updated to accommodate something different about the new header?

Comment on lines 48 to 60
for (const breakpoint of testScreens) {
test.describe(`filters on ${breakpoint}`, () => {
const width = SCREEN_SIZES.get(breakpoint as TestScreen) as number

test.use({ viewport: { width, height: 700 } })

test.beforeEach(async ({ context, page }) => {
await mockProviderApis(context)
await enableNewHeader(page)
})
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the reason not to use the describeBreakpoints utility here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The main reason was I didn't understand how describeBreakpoints utility works 🤦‍♀️ I thought it was only for the snapshots, because that's how it's used in the VR tests, and after this comment I realized that I don't have to use the expectSnapshot that it provides :) I'm going to re-factor the tests to use it.
I think for the functionality tests, we can simply test one mobile and one desktop breakpoint. This will make sure that the functionality is tested, but will not increase the testing time too much (as if we tested all breakpoints).

Copy link
Contributor

@sarayourfriend sarayourfriend Oct 27, 2022

Choose a reason for hiding this comment

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

Right on! If you use describeEachBreakpoint(testScreens) you'd get the behaviour you're looking for (only sm and xl tested). Or we could add a new alias for those called something like describeEndToEndTestScreens or something (names! 🥴). Agreed that for non-snapshot tests we can skip all the intermediary sizes and save some time 🏎️

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've added a new alias describeMobileAndDesktop, and added documentation comments stating that it's to be used with e2e tests. It's easier for me to understand than endToEndTests that it has 2 variants from this name, even if that can be ambivalent since the describeEvery also basically tests mobile and desktop breakpoints.

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice! Despite the ambiguity I think it's a great name 😁

Comment on lines 13 to 18
const mockUaString =
'Mozilla/5.0 (Android 7.0; Mobile; rv:54.0) Gecko/54.0 Firefox/54.0'
const mobileFixture = {
viewport: { width: 640, height: 700 },
userAgent: mockUaString,
}
Copy link
Contributor

Choose a reason for hiding this comment

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

This duplicates part of the breakpoints utilities which already configure the user agent string and viewport. What is the reason to duplicate that here? Could we import the UA string from breakpoints at least to deduplicate there if the rest is not possible?

@obulat obulat force-pushed the add/new_header_e2e_tests branch from 5c24cc4 to 040f75e Compare October 27, 2022 10:34
@obulat obulat force-pushed the add/new_header_e2e_tests branch from 287cf59 to ef7a818 Compare October 27, 2022 18:07
: props.isFilterVisible
? 'l'
: 'm'
const audioTrackSize = ref(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we'll need to revisit the audioTrackSize selection with @panchovm after the new_header is added. Currently, I feel like the l/m change on the md screen makes it look worse instead of better. And the code is fairly complicated.

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.

These tests are amazing. Kudos, Olga!

@@ -156,9 +153,9 @@ export default defineComponent({
}
focusIn(document.getElementById('__layout'), Focus.First)
},
fetchMedia(...args: unknown[]) {
fetchMedia({ shouldPersistMedia } = { shouldPersistMedia: false }) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Is shouldPersistMedia always false here or should the type be boolean?

Suggested change
fetchMedia({ shouldPersistMedia } = { shouldPersistMedia: false }) {
fetchMedia({ shouldPersistMedia } = { shouldPersistMedia: boolean }) {

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh dear, I totally misread this code! I thought it was the type but it was the default value 🤦 Sorry for the bad suggestion 😞

obulat and others added 2 commits October 28, 2022 06:45
Co-authored-by: sarayourfriend <24264157+sarayourfriend@users.noreply.github.com>
@github-actions
Copy link

Playwright Failure Test Results

It looks like some of the Playwright tests failed. You can download the Playwright trace
output for both Storybook and Nuxt Playwright tests that have failed at the bottom of this
page, under the "Artifacts" section:

https://github.com/WordPress/openverse-frontend/actions/runs/3342725568

Read more about how to use this artifact here: https://github.com/WordPress/openverse-frontend/blob/main/test/playwright/README.md#debugging

@obulat obulat merged commit b7c60a7 into main Oct 28, 2022
@obulat obulat deleted the add/new_header_e2e_tests branch October 28, 2022 04:57
github-actions bot pushed a commit that referenced this pull request Oct 28, 2022
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