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 bodyserializer/accept header to openverse api client to correctly authenticate with the API #5330

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

Conversation

madewithkode
Copy link
Collaborator

Add bodyserializer/accept header to openverse api client to correctly authenticate with the API

Fixes

Fixes #5314 by @obulat

Description

The @openverse/api-client package sends the requests for token to the Openverse Django API with the correct parameters but does not serialize the body to the required x-www-form-urlencoded format. This causes the requests to be sent with an empty body. The new changes adds a bodySerializer1 that creates new URLSearchParams from the body object, and stringifies it, thus allowing requests to be sent with correct body objects.

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.

@madewithkode madewithkode requested a review from a team as a code owner January 12, 2025 10:18
@madewithkode madewithkode self-assigned this Jan 12, 2025
@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels Jan 12, 2025
Copy link

github-actions bot commented Jan 12, 2025

Latest k6 run output1

     ✓ status was 200

     checks.........................: 100.00% ✓ 398      ✗ 0   
     data_received..................: 96 MB   397 kB/s
     data_sent......................: 52 kB   216 B/s
     http_req_blocked...............: avg=77.46µs  min=2.28µs   med=4.62µs   max=1.43ms   p(90)=155.24µs p(95)=666.74µs
     http_req_connecting............: avg=40.88µs  min=0s       med=0s       max=1ms      p(90)=92.94µs  p(95)=153.61µs
     http_req_duration..............: avg=160.78ms min=19.03ms  med=100.06ms max=1.03s    p(90)=389.23ms p(95)=519.19ms
       { expected_response:true }...: avg=160.78ms min=19.03ms  med=100.06ms max=1.03s    p(90)=389.23ms p(95)=519.19ms
   ✓ http_req_failed................: 0.00%   ✓ 0        ✗ 398 
     http_req_receiving.............: avg=166.23µs min=49.56µs  med=139.72µs max=725.86µs p(90)=277.51µs p(95)=330.41µs
     http_req_sending...............: avg=37.38µs  min=9.61µs   med=22.81µs  max=3.43ms   p(90)=38.88µs  p(95)=65.05µs 
     http_req_tls_handshaking.......: avg=0s       min=0s       med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=160.58ms min=18.91ms  med=99.73ms  max=1.03s    p(90)=389.05ms p(95)=518.95ms
     http_reqs......................: 398     1.653474/s
     iteration_duration.............: avg=849.05ms min=278.32ms med=853.92ms max=1.71s    p(90)=1.17s    p(95)=1.52s   
     iterations.....................: 76      0.315739/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

return new URLSearchParams(body).toString()
},
headers: {
Accept: "x-www-form-encoded",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Accept: "x-www-form-encoded",
"Content-Type": "x-www-form-encoded",

Sorry, I've mixed up the headers in the issue. The correct one will be content type, to encode the body of the request (and not the response)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skipped this myself, thanks for spotting. Updated now.

@madewithkode madewithkode force-pushed the 5314_add_bodyserializer_and_accept_header_to_openverse_api_client_to_correctly_authenticate_with_the_api branch from ec7db68 to c108fab Compare January 14, 2025 15:43
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: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Status: 🔁 Changes Requested
Development

Successfully merging this pull request may close these issues.

Add bodySerializer and Accept header to @openverse/api-client to correctly authenticate with the API
3 participants