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

Make Storybook visual regression tests more strict #4919

Merged
merged 1 commit into from
Sep 20, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Sep 12, 2024

Fixes

Related to #4305 by @zackkrida

Description

Originally, this PR completely removed maxDiffPixelRatio from Storybook Playwright config. However, that resulted in more than 200 changed snapshots. To make it easier, I decided to split that change into several ones. The first step here is to lower the maxDiffPixelRatio from 0.01 to 0.003.

I also added a wrapper to VSearchTypes story to make the snapshot better.

Testing Instructions

The snapshot changes should be correct, and the CI 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 (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where 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.

@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Sep 12, 2024
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🧰 goal: internal improvement Improvement that benefits maintainers, not users 💻 aspect: code Concerns the software code in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Sep 12, 2024
@obulat obulat self-assigned this Sep 12, 2024
@obulat obulat marked this pull request as ready for review September 12, 2024 14:19
@obulat obulat requested a review from a team as a code owner September 12, 2024 14:19
@obulat obulat mentioned this pull request Sep 12, 2024
8 tasks
@zackkrida
Copy link
Member

@obulat a lot of this looks good, but there are also very many snapshots with updates where I'm not sure what the actual change is. My concern with that is if it could be indicative of flake. Fortunately, they did all pass locally 😄

I'll review this in-depth by tomorrow at the latest!

@@ -18,7 +18,7 @@ export const Default: Story = {
setup() {
return () =>
h("div", { id: "teleports" }, [
h("div", { class: "fixed inset-0 w-full h-full" }, [
h("div", { class: "fixed inset-0 w-full h-full bg-default" }, [
Copy link
Contributor Author

Choose a reason for hiding this comment

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

By default, there is no background, and the header background comes from the page background. Adding the background here to make the header look correct in both light and dark snapshots.

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 difference is due to the updated background color (bg-surface?)

@obulat obulat force-pushed the fix/storybook-snapshots branch 6 times, most recently from 91b9295 to c60ba27 Compare September 13, 2024 13:10
@obulat obulat changed the title Remove maxDiffPixelRatio from Storybook tests Make Storybook visual regression tests more strict Sep 13, 2024
@obulat obulat force-pushed the fix/storybook-snapshots branch 3 times, most recently from 9e1019e to 89ff2fb Compare September 17, 2024 18:49
@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 ready for review 4 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.

@obulat obulat marked this pull request as draft September 19, 2024 10:35
@obulat obulat marked this pull request as ready for review September 19, 2024 19:58
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 screenshots look great, @obulat!

To clarify the plan here, is maxDiffPixelRatio: 0.003, the final value, or are you incrementally reducing it to 0 so that the review process is easier?

@obulat
Copy link
Contributor Author

obulat commented Sep 20, 2024

To clarify the plan here, is maxDiffPixelRatio: 0.003, the final value, or are you incrementally reducing it to 0 so that the review process is easier?

The latter. I hope there's no flakiness, otherwise we might want to introduce maxDiffPixelRatio on a test-by-test basis.

@obulat obulat merged commit 0ad26ae into main Sep 20, 2024
55 checks passed
@obulat obulat deleted the fix/storybook-snapshots branch September 20, 2024 04:59
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.

3 participants