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 timeouts to visual regression, e2e tests, and storybook generation #796

Merged
merged 2 commits into from
Mar 3, 2023

Conversation

zackkrida
Copy link
Member

Fixes

Fixes #795 by @dhruvkb

Description

Adds a 15 minute timeout to playwright tests, e2e tests, and storybook doc generation. This should be a sensible default timeout that leaves space for successful runs to complete.

Testing Instructions

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.

@zackkrida zackkrida requested a review from a team as a code owner February 28, 2023 16:13
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels Feb 28, 2023
@github-actions
Copy link

github-actions bot commented Feb 28, 2023

Full-stack documentation: Ready

https://WordPress.github.io/openverse/_preview/796

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.

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.

LGTM. @zackkrida could you add .github/workflows/ci_cd.yml to the filters (https://github.com/WordPress/openverse/blob/de8a078374da546479bf534784104dfb671a222f/.github/filters.yml) for all 3 packages so that the complete CI is triggered and we can verify that 15m is enough for the tests to run completely?

@zackkrida zackkrida requested review from obulat and removed request for sarayourfriend February 28, 2023 18:48
@@ -513,6 +514,7 @@ jobs:
name: Nuxt Playwright VR tests
if: needs.get-changes.outputs.frontend == 'true'
runs-on: ubuntu-latest
timeout-minutes: 15
Copy link
Member

Choose a reason for hiding this comment

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

This test takes ~12 min so 15 min might be cutting it close. Maybe a higher limit like 20 min might be more appropriate.

Copy link
Member Author

Choose a reason for hiding this comment

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

12 is the max I've seen, with as low as 7. Could we keep this as-is and increase in future PRs which increase the duration?

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Great!
I re-checked some of the CI runs, and I guess 15 minutes should be enough.
Screenshot 2023-03-03 at 6 51 29 AM
Screenshot 2023-03-03 at 6 52 05 AM

@zackkrida zackkrida merged commit c60c02e into main Mar 3, 2023
@zackkrida zackkrida deleted the add-test-timeouts branch March 3, 2023 15:13
dhruvkb pushed a commit that referenced this pull request Apr 14, 2023
* _-prefix methods that should not be overridden

* Initial template

* Add initial docs

* Update template, add test template file

* Add script to generate template files

* Update docs to reference script

* Moving more documentation into the code

* Reformat docs

- Breaks out into several files
- Removes documentation that is redundant (copied from code)
- Prefers documentation within the template
- Explicitly documents advanced options as FAQ
- Some small updates to the templating

* Small tweaks

* Remove unused 'license_url' from nappy and comment out unused test imports

* Remove unused 'license_url' from nappy and comment out unused test imports

* write small helper fn for filesizes

* Add UA string header

* move thumbnail_url to metadata for now

* rename thumbnail_url metadata field to thumbnail

* add dag start date

* no header in next params & add thumbnail_url

* add tests and test resources

* remove questionable tag from test image

* update docs

* add popularity metrics to metadata

* Add url to source docs

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* remove template comment from next query params

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* remove template comment on optional fields

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* remove template comment on get batch

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* remove template comment from main

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* remove template comment from get_record_data

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* pass batch_limit to the API

Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>

* tests for batch limit API parameter

* point to popularity metrics

* template test directory fix

* make license info a class variable

* Remove outdated/duplicated template creation files

* Update DAG documentation

* fortify and test convert filesize

Co-authored-by: Staci Cooper <staci.cooper@automattic.com>
Co-authored-by: rwidom <rebeccawidom@gmail.com>
Co-authored-by: rwidom <rwidom@users.noreply.github.com>
Co-authored-by: Madison Swain-Bowden <bowdenm@spu.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set a timeout for Playwright jobs
4 participants