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

Update Storybook and pin Nuxt Storybook module version #5025

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 9, 2024

Fixes

Fixes #4963 by @sarayourfriend

Description

Now that the Nuxt Storybook module has released a stable release that works with Openverse, we can pin its version, and update the module's dependencies to match it.

This PR also sets the default port for Storybook in dev mode to match that of the production mode.

When re-running the Storybook in dev mode, you could get SyntaxError: Unexpected token 'export' before, so I added cleanup step that removes the .nuxt folder and fixes this issue.

Testing Instructions

The Storybook tests in the CI should pass.
Run ov just frontend/run dev. This should run the Storybook in dev mode at http://localhost:54000.

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.

@obulat obulat requested a review from a team as a code owner October 9, 2024 06:31
@openverse-bot openverse-bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Oct 9, 2024
@obulat obulat removed the request for review from zackkrida October 9, 2024 10:37
Copy link

github-actions bot commented Oct 9, 2024

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 8000      ✗ 0   
     data_received..................: 1.9 GB  8.1 MB/s
     data_sent......................: 1.0 MB  4.6 kB/s
     http_req_blocked...............: avg=15.35µs  min=1.86µs  med=3.83µs   max=12.12ms p(90)=5.38µs  p(95)=5.8µs   
     http_req_connecting............: avg=9.38µs   min=0s      med=0s       max=6.96ms  p(90)=0s      p(95)=0s      
     http_req_duration..............: avg=597.29ms min=34.28ms med=530.76ms max=2.55s   p(90)=1.11s   p(95)=1.25s   
       { expected_response:true }...: avg=597.29ms min=34.28ms med=530.76ms max=2.55s   p(90)=1.11s   p(95)=1.25s   
   ✓ http_req_failed................: 0.00%   ✓ 0         ✗ 8000
     http_req_receiving.............: avg=144.22µs min=39.99µs med=116.86µs max=17.48ms p(90)=185µs   p(95)=222.47µs
     http_req_sending...............: avg=23.51µs  min=6.79µs  med=19.42µs  max=7.59ms  p(90)=25.33µs p(95)=27.2µs  
     http_req_tls_handshaking.......: avg=0s       min=0s      med=0s       max=0s      p(90)=0s      p(95)=0s      
     http_req_waiting...............: avg=597.12ms min=34.16ms med=530.62ms max=2.55s   p(90)=1.11s   p(95)=1.25s   
     http_reqs......................: 8000    34.763787/s
     iteration_duration.............: avg=3.99s    min=1.23s   med=3.46s    max=12.46s  p(90)=8.69s   p(95)=9.31s   
     iterations.....................: 1200    5.214568/s
     vus............................: 3       min=3       max=30
     vus_max........................: 30      min=30      max=30

Footnotes

  1. This comment will automatically update with new output each time k6 runs for this PR

@obulat obulat marked this pull request as draft October 9, 2024 18:09
@obulat obulat force-pushed the update/storybook branch 2 times, most recently from 81254a6 to d5dffda Compare October 11, 2024 17:04
Copy link

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

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.

@obulat obulat force-pushed the update/storybook branch 2 times, most recently from f8610ec to 20344f3 Compare October 18, 2024 06:54
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: high Stalls work on the project or its dependents 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Status: 🚧 Draft
Development

Successfully merging this pull request may close these issues.

Peer dependency issues with storybook
2 participants