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

Initialize the stores only on the server #5046

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 18, 2024

Fixes

Fixes #5037 by @obulat

Description

This PR makes the init-stores plugin run only on the server.

We don't need to run it both on the server and on the client because the cookie values don't change from the server to client rendering. We also do not need to re-fetch the providers since they were fetched on the server.

This PR also adds numbers to the plugin names to ensure that the order of execution is correct on the server: 01.api-token - 02.init-stores - other plugins. The token is necessary for fetching the providers, and the stores need to be initialized before anything else

The other plugins do not depend on each other, so there I removed numbers from their names.

Testing Instructions

Run the app and check the browser devtools Network tab for requests. There should be no stats requests since they are sent on the server (and thus, don't show up in the browser devtools).

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: 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 18, 2024
Copy link

github-actions bot commented Oct 18, 2024

Latest k6 run output1

$     ✓ status was 200

     checks.........................: 100.00% ✓ 8000      ✗ 0   
     data_received..................: 1.8 GB  8.8 MB/s
     data_sent......................: 1.0 MB  5.0 kB/s
     http_req_blocked...............: avg=22.17µs  min=1.94µs  med=3.43µs   max=10.66ms p(90)=4.86µs   p(95)=5.25µs  
     http_req_connecting............: avg=17.09µs  min=0s      med=0s       max=10.6ms  p(90)=0s       p(95)=0s      
     http_req_duration..............: avg=545.72ms min=41.13ms med=485.31ms max=2.28s   p(90)=1.02s    p(95)=1.12s   
       { expected_response:true }...: avg=545.72ms min=41.13ms med=485.31ms max=2.28s   p(90)=1.02s    p(95)=1.12s   
   ✓ http_req_failed................: 0.00%   ✓ 0         ✗ 8000
     http_req_receiving.............: avg=138.76µs min=41.41µs med=105.87µs max=27.69ms p(90)=169.76µs p(95)=202.17µs
     http_req_sending...............: avg=23.11µs  min=6.97µs  med=18.44µs  max=24.48ms p(90)=24.03µs  p(95)=26.28µs 
     http_req_tls_handshaking.......: avg=0s       min=0s      med=0s       max=0s      p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=545.55ms min=41.02ms med=485.19ms max=2.28s   p(90)=1.02s    p(95)=1.12s   
     http_reqs......................: 8000    37.963424/s
     iteration_duration.............: avg=3.64s    min=1.14s   med=3.07s    max=10.3s   p(90)=7.91s    p(95)=8.41s   
     iterations.....................: 1200    5.694514/s
     vus............................: 6       min=6       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 ready for review October 18, 2024 12:32
@obulat obulat requested a review from a team as a code owner October 18, 2024 12:32
@obulat obulat requested review from krysal and dhruvkb October 18, 2024 12:32
Copy link
Collaborator

@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.

I was able to confirm that requests to the /stats endpoints aren't being made when I visit the homepage locally 🥳

This PR makes the init-stores plugin run only on the server.

Just curious, was this done simply by changing .ts to .server.ts in the plugin name? Will doing this have any affect on any of the other data in the store? Things like dark mode or sensitivity preferences?

@obulat
Copy link
Contributor Author

obulat commented Oct 18, 2024

Just curious, was this done simply by changing .ts to .server.ts in the plugin name? Will doing this have any affect on any of the other data in the store? Things like dark mode or sensitivity preferences?

Yes, simply by adding the .server. The plugins without a suffix run both on the server and on the client. If you want them to run either on the server or on the client, you can add the suffix.
For dark mode or sensitivity, we get the cookies on the server - and initialize the stores based on them. I don't think there is a scenario where the cookies from the server request would be different from the cookies during the hydration (from the broser/client).

@obulat obulat merged commit 807ba2f into main Oct 18, 2024
53 checks passed
@obulat obulat deleted the only-init-stores-on-server branch October 18, 2024 19:04
@AetherUnbound
Copy link
Collaborator

Thanks for that explanation!

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: frontend Related to the Nuxt frontend
Projects
Status: 🤝 Merged
Development

Successfully merging this pull request may close these issues.

Duplicate /stats requests
3 participants