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

Refactor Playwright tests #3614

Merged
merged 1 commit into from Jan 4, 2024
Merged

Refactor Playwright tests #3614

merged 1 commit into from Jan 4, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jan 2, 2024

Fixes

Extracted from #3605

Description

The test setup often includes closing banners and filters and turning on some feature flags. Several functions were used for that, and they were interfering with each other.

This PR uses cookies for this setup. The setCookies function is updated to correctly set and/or update the cookie values, stringifying and decoding them where necessary.
Now, instead of using the Close buttons in the UI, or the preference page to change the feature flag status, most of the tests set cookies before opening the first page.

This PR also moves around some of the breakpoints.describe and test.describe to prevent duplication.

In the attribution test, the function for collecting analytics events is used instead of an ad-hoc solution.

These changes are necessary to update Playwright from version 1.30 to version 1.40, and also for migrating to Nuxt 3.

Testing Instructions

CI should pass, and the changes 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.

Signed-off-by: Olga Bulat <obulat@gmail.com>
@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 🧱 stack: frontend Related to the Nuxt frontend labels Jan 2, 2024
@obulat obulat requested a review from a team as a code owner January 2, 2024 08:04
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.

Changes look great! Glad this can be put into a single function!

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.

This PR uses cookies for this setup. The setCookies function is updated to correctly set and/or update the cookie values, stringifying and decoding them where necessary.
Now, instead of using the Close buttons in the UI, or the preference page to change the feature flag status, most of the tests set cookies before opening the first page.

Far out! That is a nicer approach for the individual test setup.

The only thing that strikes me is that the previous approach implicitly tested the process that sets the cookies. Now we don't do that, because we set the cookies directly. Should we also introduce new tests for the preferences and banner functionality... or are there already tests for that? If we need new ones, I think they should be in a follow-up issue, not in this PR.

@obulat obulat merged commit 88e5103 into main Jan 4, 2024
72 checks passed
@obulat obulat deleted the refactor/playwright-tests branch January 4, 2024 02:31
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.

None yet

3 participants