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 Storybook tests by waiting for URL instead of a port #1137

Merged
merged 2 commits into from Apr 6, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Apr 5, 2023

Fixes

Fixes #1135 by @obulat

Description

Playwright accepts either port or url configuration for the webserver, and checks if one of them is ready before running tests. It seems that the port is "ready" before Storybook is fully built, which makes the first couple of tests fail.

This PR replaces the port with the first test's URL to make sure that the Storybook is fully built and ready to run tests.

Note: the fix has been merge as part of #946, but this PR still should be merged as it uses a better url than the one in main now.

Testing Instructions

The CI should pass. These changes were added to #1132 to make it pass the CI tests.

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.

@obulat obulat added 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend labels Apr 5, 2023
@obulat obulat requested a review from a team as a code owner April 5, 2023 06:07
@obulat obulat requested review from zackkrida and dhruvkb April 5, 2023 06:07
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Apr 5, 2023
@obulat obulat changed the title Wait for the specific URL to be ready Fix Storybook tests by waiting for URL instead of a port Apr 5, 2023
@github-actions
Copy link

github-actions bot commented Apr 5, 2023

Size Change: -2.62 kB (0%)

Total Size: 843 kB

Filename Size Change
./frontend/.nuxt/dist/client/235.js 0 B -273 B (removed) 🏆
./frontend/.nuxt/dist/client/235.modern.js 0 B -278 B (removed) 🏆
./frontend/.nuxt/dist/client/236.js 0 B -1.85 kB (removed) 🏆
./frontend/.nuxt/dist/client/app.js 125 kB -992 B (-1%)
./frontend/.nuxt/dist/client/app.modern.js 117 kB -1.07 kB (-1%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.55 kB -19 B (-1%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.78 kB -23 B (-1%)
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.9 kB -27 B (-1%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.89 kB -27 B (-1%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 888 B -18 B (-2%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 889 B -18 B (-2%)
./frontend/.nuxt/dist/client/components/v-image-details.js 2.15 kB -13 B (-1%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB -15 B (-1%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 1.62 kB -13 B (-1%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 1.61 kB -12 B (-1%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B -18 B (-4%)
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 421 B -18 B (-4%)
./frontend/.nuxt/dist/client/components/v-search-grid.js 5.72 kB -28 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 5.64 kB -31 B (-1%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.9 kB -44 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.9 kB -45 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 5.62 kB -24 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 4.85 kB -21 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 6 kB -26 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 5.16 kB -15 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.68 kB -45 B (-2%)
./frontend/.nuxt/dist/client/runtime.modern.js 2.68 kB -44 B (-2%)
./frontend/.nuxt/dist/client/227.js 272 B +272 B (new file) 🆕
./frontend/.nuxt/dist/client/227.modern.js 277 B +277 B (new file) 🆕
./frontend/.nuxt/dist/client/228.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/commons/app.js 90.3 kB 0 B
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 752 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 757 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 515 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 518 B 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.63 kB 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.48 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.26 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.21 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 542 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 548 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 689 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.js 1.12 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 526 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 530 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 787 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 790 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.59 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 1.23 kB -8 B (-1%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.25 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.js 1 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 1 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 9.96 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 9.94 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 754 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 758 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.52 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.52 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 5.18 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 5.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.76 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.72 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.72 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.59 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.59 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.js 2.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 2.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 526 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 528 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 801 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 699 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 837 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-modal.modern.js 996 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 757 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 755 B 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.27 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.27 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.js 3.24 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 3.12 kB 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 978 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.js 825 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 830 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 600 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 605 B 0 B
./frontend/.nuxt/dist/client/components/v-search-type-radio.js 804 B 0 B
./frontend/.nuxt/dist/client/components/v-search-type-radio.modern.js 779 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.16 kB 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/external-sources.js 1.56 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.57 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.35 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.js 1.27 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.26 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.27 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 7.21 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.6 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.51 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 2.84 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 2.73 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 447 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 244 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.57 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.57 kB -2 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 64.1 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.3 kB 0 B

compressed-size-action

@obulat obulat mentioned this pull request Apr 5, 2023
7 tasks
@github-actions
Copy link

github-actions bot commented Apr 5, 2023

Full-stack documentation: https://docs.openverse.org/_preview/1137

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.

Wow, that was an strange problem and an interesting fix!

frontend/test/storybook/playwright.config.ts Outdated Show resolved Hide resolved
obulat and others added 2 commits April 5, 2023 17:24
* Update TW line-heights

* Update snapshots

* Update storybook snapshots

* Use the named styles

* Update frontend/src/styles/tailwind.css

Co-authored-by: Zack Krida <zackkrida@pm.me>

* Fix storybook tests running before server is ready

---------

Co-authored-by: Zack Krida <zackkrida@pm.me>
Co-authored-by: Dhruv Bhanushali <hi@dhruvkb.dev>
Openverse PRs automation moved this from Needs review to Reviewer approved Apr 6, 2023
@zackkrida zackkrida merged commit 46a19a5 into main Apr 6, 2023
34 checks passed
Openverse PRs automation moved this from Reviewer approved to Merged! Apr 6, 2023
@zackkrida zackkrida deleted the fix/storybook_tests branch April 6, 2023 13:57
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
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

Sometimes Storybook tests start running before the server is ready
3 participants