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 Nuxt and create shared folder #5187

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Nov 26, 2024

Description

This PR updates Nuxt to the latest version, 3.14.15.

This version introduces the shared directory for code that is used both by the server and by the client-side app. This is important because Nuxt does not allow the server code to import from the Nuxt app portions of the app (e.g., useNuxtApp).

This will be important for adding server-side cache for media provider stats, and for proxying API requests through the Nuxt server, and will be added in a follow-up PR.

Please, don't be intimidated by the number of changed lines: most of them are either in the lock file, or in the imports.
I updated the ESLint rule for ordering the imports to make it more strict, so now we won't have too much variability. You can check the new rules in packages/js/eslint-plugin/src/configs/import.ts, and add suggestions on the order.

I moved all utils, constants and types that do not import anything from the nuxt app side to shared folder. Nuxt does not

That is what the most of the changes in this PR relate to.

Testing Instructions

The app should run as usual without any warnings. 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 (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.

@openverse-bot openverse-bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 26, 2024
Copy link

github-actions bot commented Nov 26, 2024

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 6400      ✗ 0   
     data_received..................: 1.5 GB  8.2 MB/s
     data_sent......................: 838 kB  4.6 kB/s
     http_req_blocked...............: avg=13.48µs  min=1.91µs   med=3.95µs   max=7.85ms  p(90)=5.27µs   p(95)=5.71µs  
     http_req_connecting............: avg=9.21µs   min=0s       med=0s       max=7.77ms  p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=632.58ms min=40.01ms  med=543.75ms max=3.31s   p(90)=1.13s    p(95)=1.23s   
       { expected_response:true }...: avg=632.58ms min=40.01ms  med=543.75ms max=3.31s   p(90)=1.13s    p(95)=1.23s   
   ✓ http_req_failed................: 0.00%   ✓ 0         ✗ 6400
     http_req_receiving.............: avg=145.77µs min=43.34µs  med=116.5µs  max=44.21ms p(90)=180.65µs p(95)=214.73µs
     http_req_sending...............: avg=20.26µs  min=7.19µs   med=19.49µs  max=1.05ms  p(90)=24.85µs  p(95)=26.83µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s      p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=632.42ms min=39.87ms  med=543.4ms  max=3.31s   p(90)=1.13s    p(95)=1.23s   
     http_reqs......................: 6400    35.172592/s
     iteration_duration.............: avg=3.38s    min=379.78ms med=2.99s    max=9.97s   p(90)=6.52s    p(95)=6.92s   
     iterations.....................: 1200    6.594861/s
     vus............................: 1       min=1       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

Copy link

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

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 added 🟨 priority: medium Not blocking but should be addressed soon 🧰 goal: internal improvement Improvement that benefits maintainers, not users and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Nov 26, 2024
@openverse-bot openverse-bot added the 🏷 status: label work required Needs proper labelling before it can be worked on label Nov 26, 2024
@obulat obulat added 💻 aspect: code Concerns the software code in the repository and removed 🏷 status: label work required Needs proper labelling before it can be worked on labels Nov 26, 2024
@obulat obulat force-pushed the update/nuxt-and-create-shared-folder branch from 670c55b to 49ef3fd Compare November 26, 2024 16:28
@obulat obulat marked this pull request as ready for review November 26, 2024 17:08
@obulat obulat requested a review from a team as a code owner November 26, 2024 17:08
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: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Status: 👀 Needs Review
Development

Successfully merging this pull request may close these issues.

2 participants