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.

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

Add Playwright visual regression tests for error pages #2611

Merged
merged 2 commits into from
Jul 14, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jul 11, 2023

Fixes

Fixes #2610 by @obulat

Description

To simulate the errors on the server, we use mock tapes that have the specific errors we need.
To simulate the errors on the client, we use Playwright's page.route function.

This PR adds the snapshot tests for the following scenarios:

  • Fetching search results/single media results
  • CSR / SSR
  • 404, 429, 500

The snapshots show the problems we currently have in the error pages: the pages we show are not always consistent with the actual problem that the app encountered.

Testing Instructions

The CI should pass and the code should make sense.

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 self-assigned this Jul 11, 2023
@obulat obulat requested a review from a team as a code owner July 11, 2023 08:55
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Jul 11, 2023
@openverse-bot openverse-bot 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 labels Jul 11, 2023
@github-actions
Copy link

github-actions bot commented Jul 11, 2023

Size Change: 0 B

Total Size: 829 kB

ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/232.js 272 B
./frontend/.nuxt/dist/client/232.modern.js 276 B
./frontend/.nuxt/dist/client/233.js 1.85 kB
./frontend/.nuxt/dist/client/app.js 122 kB
./frontend/.nuxt/dist/client/app.modern.js 113 kB
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 80.7 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.18 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.62 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 728 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 732 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 6.42 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.26 kB
./frontend/.nuxt/dist/client/components/v-audio-cell.js 570 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 575 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.79 kB
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 958 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 962 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.28 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.23 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 633 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.25 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.25 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-page.js 531 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 535 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 491 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 496 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.99 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.28 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 792 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.41 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.38 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 376 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 2 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.98 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 894 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 895 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.54 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.54 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.28 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.26 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.8 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.77 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.81 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.81 kB
./frontend/.nuxt/dist/client/components/v-image-details.js 1.44 kB
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.29 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.16 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 640 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B
./frontend/.nuxt/dist/client/components/v-load-more.js 1.17 kB
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-media-license.js 931 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 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 852 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 858 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.47 kB
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.47 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 976 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.65 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.65 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.81 kB
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.17 kB
./frontend/.nuxt/dist/client/components/v-search-results-title.js 617 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 620 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 298 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.2 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.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.42 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.74 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.54 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.24 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 7.04 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.97 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.74 kB
./frontend/.nuxt/dist/client/pages/index.js 6.36 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 6.32 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.31 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.25 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB
./frontend/.nuxt/dist/client/pages/search.js 2.25 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 2.05 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 4.1 kB
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.98 kB
./frontend/.nuxt/dist/client/pages/search/image.js 544 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 549 B
./frontend/.nuxt/dist/client/pages/search/index.js 441 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 446 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 242 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 244 B
./frontend/.nuxt/dist/client/pages/sources.js 1.53 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB
./frontend/.nuxt/dist/client/runtime.js 2.69 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.69 kB
./frontend/.nuxt/dist/client/vendors/app.js 65.3 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.8 kB

compressed-size-action

Copy link
Collaborator

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

LGMT. Just to clarify "the snapshots show problems with inconsistency" that you mentioned, is the CSR single result error page being blank part of that? I wish there was a way to record that a snapshot was recording a bug rather than recording the intended behaviour/presentation.

Regardless, LGTM, glad we have these. It really helps to have these for bugs too because it enforces the idea of writing the test to reproduce the bug before fixing the bug 🙂

@obulat
Copy link
Contributor Author

obulat commented Jul 12, 2023

LGMT. Just to clarify "the snapshots show problems with inconsistency" that you mentioned, is the CSR single result error page being blank part of that? I wish there was a way to record that a snapshot was recording a bug rather than recording the intended behaviour/presentation.

Yes, I meant exactly that, @sarayourfriend. The error pages on CSR should also show the yellow error page (and they do, in #2585 :) )

@openverse-bot
Copy link
Collaborator

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

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

Excluding weekend1 days, this PR was ready for review 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 operation 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.

Fetching search results/single media results
CSR / SSR
404, 429, 500
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.

Really clever to use the error code as the search term 😻

@obulat obulat merged commit 129980f into main Jul 14, 2023
41 checks passed
@obulat obulat deleted the add/error_pages_vr_tests branch July 14, 2023 14:42
@obulat obulat mentioned this pull request Jul 17, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add Playwright VR tests for error pages
4 participants