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

Fix flaky Playwright tests #3759

Merged
merged 3 commits into from
Feb 7, 2024
Merged

Fix flaky Playwright tests #3759

merged 3 commits into from
Feb 7, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Feb 6, 2024

Fixes

Fixes #3713 by @sarayourfriend
Fixes #3714 by @sarayourfriend

Description

This PR attempts to fix the flaky Storybook Playwright tests by adding waits or testing that a font request was sent after the menu button is clicked, to make sure the fonts are loaded before taking the snapshots.

I merged the sensitive results test fix into this PR since both PRs were failing the CI due to the other test failure (sensitive result fix was failing due to Storybook failure, and the Storybook fix was failing due to sensitive results failure).

Instead of going to the homepage, and making a new search to check that sensitive results were loaded, I added a check for sent API request with the sensitive parameter.

Testing Instructions

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

Signed-off-by: Olga Bulat <obulat@gmail.com>
Signed-off-by: Olga Bulat <obulat@gmail.com>
Signed-off-by: Olga Bulat <obulat@gmail.com>
@obulat obulat changed the title Add waits to fix test flakiness due to font loading Fix flaky Playwright tests Feb 6, 2024
@obulat obulat mentioned this pull request Feb 6, 2024
8 tasks
@obulat obulat marked this pull request as ready for review February 6, 2024 18:43
@obulat obulat requested a review from a team as a code owner February 6, 2024 18:43
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! I wonder if it's worth excluding fonts from the playwright test, or at least, excluding them from maybe all but one specific one? It feels like whack-a-mole if we're adding sleep to tests as they appear flaky, when I suppose any test could technically have suddenly-new flakiness due to font loading?

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

LGTM!

@obulat
Copy link
Contributor Author

obulat commented Feb 7, 2024

LGTM! I wonder if it's worth excluding fonts from the playwright test, or at least, excluding them from maybe all but one specific one? It feels like whack-a-mole if we're adding sleep to tests as they appear flaky, when I suppose any test could technically have suddenly-new flakiness due to font loading?

I think I understood why the font loading issue happens for the internal header in storybook. The first rendered element does not contain any text, only the mobile header with logo and a button. That's why we would only load the font after opening the modal, which does have some text.

1000314355.jpg

I'll review the tests for similar situations.
And I still am not sure what happened to the filter button.

@obulat obulat merged commit f6bd3a5 into main Feb 7, 2024
46 checks passed
@obulat obulat deleted the fix/storybook-flaky-tests branch February 7, 2024 03:06
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: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
4 participants