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 sources cache to Nuxt app #5288

Merged
merged 3 commits into from
Dec 19, 2024
Merged

Add sources cache to Nuxt app #5288

merged 3 commits into from
Dec 19, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Dec 18, 2024

Fixes

Fixes #5287 by @obulat

Description

This PR uses the server route with defineCachedFunction to cache the /stats response for an hour. This is following SWR (stale-while-revalidate) principle, so if a request to update the stats fails, the cached (even outdated) version is still returned.

This PR also simplifies the provider store to combine the fetch state for images and audio into a single object since we don't really need the distinction between the media types.

The requests don't add the auth token to the API request, but it should be okay because the request is only sent once an hour.

Testing Instructions

Run the app locally, and open the localhost:8443/sources page. You should see the log about /stats requests (for audio and images) in the terminal (not the browser console). Now, reload the page several times. There should be no other requests logged, since the data is cached in the nitro server.

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: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Dec 18, 2024
Copy link

github-actions bot commented Dec 18, 2024

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 392      ✗ 0   
     data_received..................: 91 MB   380 kB/s
     data_sent......................: 51 kB   214 B/s
     http_req_blocked...............: avg=41.46µs  min=2.14µs   med=4.62µs   max=2.23ms p(90)=149.28µs p(95)=182.22µs
     http_req_connecting............: avg=28.27µs  min=0s       med=0s       max=2.19ms p(90)=99.03µs  p(95)=129.03µs
     http_req_duration..............: avg=158.8ms  min=19.38ms  med=114.31ms max=1.07s  p(90)=335.67ms p(95)=415.63ms
       { expected_response:true }...: avg=158.8ms  min=19.38ms  med=114.31ms max=1.07s  p(90)=335.67ms p(95)=415.63ms
   ✓ http_req_failed................: 0.00%   ✓ 0        ✗ 392 
     http_req_receiving.............: avg=175.49µs min=53.6µs   med=146.23µs max=2.58ms p(90)=272.42µs p(95)=338.59µs
     http_req_sending...............: avg=25.1µs   min=8.52µs   med=23.38µs  max=84.1µs p(90)=39.55µs  p(95)=45.99µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s     p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=158.6ms  min=19.24ms  med=114.1ms  max=1.07s  p(90)=335.35ms p(95)=415.34ms
     http_reqs......................: 392     1.631053/s
     iteration_duration.............: avg=836.93ms min=262.74ms med=925.35ms max=1.75s  p(90)=1.16s    p(95)=1.45s   
     iterations.....................: 75      0.312064/s
     vus............................: 0       min=0      max=6 
     vus_max........................: 60      min=60     max=60

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 December 18, 2024 11:09
@obulat obulat requested a review from a team as a code owner December 18, 2024 11:09
@obulat obulat requested review from krysal and dhruvkb December 18, 2024 11:09
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! I was able to verify that this works as expected locally. The cache seems to persist across frontend server sessions as it did not make the API call after I terminated the server with +C and started it again.

@obulat obulat merged commit 7b473e2 into main Dec 19, 2024
55 checks passed
@obulat obulat deleted the add/sources-cache branch December 19, 2024 03:16
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: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Cache sources stats in Nuxt
3 participants