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

[madewithkode]

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.

[github-actions]

Latest k6 run output¹

     ✓ status was 200

     checks.........................: 100.00% ✓ 396      ✗ 0   
     data_received..................: 91 MB   377 kB/s
     data_sent......................: 52 kB   215 B/s
     http_req_blocked...............: avg=32.24µs  min=2.37µs  med=4.57µs   max=341.16µs p(90)=139.8µs  p(95)=158.35µs
     http_req_connecting............: avg=19.76µs  min=0s      med=0s       max=241.71µs p(90)=94.59µs  p(95)=113.65µs
     http_req_duration..............: avg=153.4ms  min=16.81ms med=104.98ms max=1.03s    p(90)=342.62ms p(95)=466.41ms
       { expected_response:true }...: avg=153.4ms  min=16.81ms med=104.98ms max=1.03s    p(90)=342.62ms p(95)=466.41ms
   ✓ http_req_failed................: 0.00%   ✓ 0        ✗ 396 
     http_req_receiving.............: avg=151.98µs min=44.3µs  med=128.16µs max=508.36µs p(90)=239.65µs p(95)=315.86µs
     http_req_sending...............: avg=31.73µs  min=8.12µs  med=22.24µs  max=2.65ms   p(90)=37.27µs  p(95)=43.01µs 
     http_req_tls_handshaking.......: avg=0s       min=0s      med=0s       max=0s       p(90)=0s       p(95)=0s      
     http_req_waiting...............: avg=153.22ms min=16.68ms med=104.67ms max=1.03s    p(90)=342.35ms p(95)=465.97ms
     http_reqs......................: 396     1.647308/s
     iteration_duration.............: avg=839.08ms min=351.9ms med=931.34ms max=1.67s    p(90)=1.14s    p(95)=1.47s   
     iterations.....................: 73      0.30367/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]

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)

[madewithkode]

Skipped this myself, thanks for spotting. Updated now.

[obulat]

Thank you for your contribution, @madewithkode !

I realized that I also had the header value wrong in the original issue 🤦‍♀️ Fixed that, and also updated the tests to be sure that the body is correctly encoded.