Encode the request body if `Content-Type` header is `x-www-form-urlencoded` #2096

obulat · 2025-01-11T06:20:39Z

Changes

Fixes #2069
This PR updates the defaultBodySerializer to correctly serialize the body if Content-Type header is set to x-www-form-urlencoded. This is useful for OAuth2 token requests.

How to Review

I'm not sure about the headers: what type are they, and are they normalized?
I added handling for both a plain JS object (headers['Accept-Content']) and a Headers object (headers.get['Accept-Content']), as well as both capitalized and lower-case versions.

Checklist

Unit tests updated
docs/ updated (if necessary)
pnpm run update:examples run (only applicable for openapi-typescript)

netlify · 2025-01-11T06:20:42Z

👷 Deploy request for openapi-ts pending review.

Visit the deploys page to approve it

Name	Link
🔨 Latest commit	`3fd7e57`

changeset-bot · 2025-01-11T06:20:43Z

⚠️ No Changeset found

Latest commit: 3fd7e57

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

drwpow · 2025-01-25T19:35:42Z

packages/openapi-fetch/src/index.js

@@ -72,7 +72,7 @@ export default function createClient(clientOptions) {
            });
    }

-    const serializedBody = body === undefined ? undefined : bodySerializer(body);
+    const serializedBody = body === undefined ? undefined : bodySerializer(body, headers);


So these are the headers unique to this request (probably could be named better). Below on line 92, we merge all the headers together. We should probably move that up, adn pass that in here to bodySerializer. That way it takes into account headers that users have set in their createClient() call, and it handles the normalization for you so it’s always a Header type (and you aren’t dealing with what the user passed in)

drwpow · 2025-01-25T19:36:33Z

This approach looks good to me, and good test! But before we merge, we’ll want to:

Use the merged/normalized headers like the comment mentioned
Add a patch changeset (see comment)

drwpow · 2025-03-18T16:48:40Z

@obulat Still willing to accept this PR with the changes mentioned!

drwpow

This PR is close enough! I’ll make the changes post-merge to make sure we’re not grabbing incorrect/stale headers, and add a changeset retroactively.

* Update schema-object.ts * chore(deps): update dependency msw to v2.7.6 (openapi-ts#2287) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @types/node to v22.15.10 (openapi-ts#2293) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @shikijs/vitepress-twoslash to v3.4.0 (openapi-ts#2298) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency @arethetypeswrong/cli to ^0.18.0 (openapi-ts#2272) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency execa to v9.5.3 (openapi-ts#2303) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(metadata): fix thunk type detection (openapi-ts#2125) * Don't remove `null` type if a default is present. (openapi-ts#2145) * Don't remove `null` type if a default is present. * Don't remove `null` type from enums if default is present. * Don't remove `null` type if default is present (legacy) * [ci] release (openapi-ts#2307) * [ci] release * Add 2145 manually --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <[email protected]> * chore(deps): update dependency @types/react to v18.3.21 (openapi-ts#2218) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * fix(openapi-fetch): fix overriding baseUrl per request without overriding default baseUrl (openapi-ts#2157) * Support $ref into `paths` (openapi-ts#2185) * React query handle 204 or zero content length (openapi-ts#2235) * fix(openapi-react-query): Handle 204 or zero Content-Length header by returning data as null * fix(openapi-react-query): updated and added 204 & zero Content-Length queryFn tests * chore(openapi-react-query): Fixed linting in test * chore(deps): update dependency @arethetypeswrong/cli to v0.18.1 (openapi-ts#2306) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency msw to v2.8.2 (openapi-ts#2304) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Update Speakeasy URL (openapi-ts#2302) * chore(deps): update dependency @tanstack/react-query to v5.75.7 (openapi-ts#2301) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * chore(deps): update dependency lint-staged to v15.5.2 (openapi-ts#2297) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * feat(swr-openapi): add custom error types to query builder (openapi-ts#2147) * chore(deps): update vitest monorepo to v3 (openapi-ts#2284) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Encode the request body if Content-Type set (openapi-ts#2096) * Improve header handling (openapi-ts#2308) * [ci] release (openapi-ts#2309) * [ci] release * Release additional packages --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <[email protected]> * chore: update openapi-fetch test fixture (openapi-ts#2313) * Build packages with unbuild to improve CJS support (openapi-ts#2310) * [ci] release (openapi-ts#2314) * [ci] release * Fix major bump --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <[email protected]> * Update code of conduct source (openapi-ts#2316) Signed-off-by: Emmanuel Ferdman <[email protected]> --------- Signed-off-by: Emmanuel Ferdman <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Martin Paucot <[email protected]> Co-authored-by: Theron Luhn <[email protected]> Co-authored-by: openapi-ts-bot <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Drew Powers <[email protected]> Co-authored-by: Luis Merino <[email protected]> Co-authored-by: Duncan Beevers <[email protected]> Co-authored-by: Wheelebin <[email protected]> Co-authored-by: Nolan Di Mare Sullivan <[email protected]> Co-authored-by: しゅーまい <[email protected]> Co-authored-by: Olga Bulat <[email protected]> Co-authored-by: Emmanuel Ferdman <[email protected]>

obulat · 2025-06-06T11:53:05Z

@drwpow, sorry I couldn't finish up the work here, and thank you so much for merging!

drwpow · 2025-06-06T12:53:00Z

Oh no worries at all; the maintainers and I all had individual things come up that made reviews earlier in the year slower than we’d like too. Thanks again for the work! 🙏

Encode the request body if Content-Type set

3fd7e57

obulat requested a review from a team as a code owner January 11, 2025 06:20

obulat requested a review from drwpow January 11, 2025 06:20

drwpow reviewed Jan 25, 2025

View reviewed changes

duncanbeevers added the openapi-fetch Relevant to the openapi-fetch library label Feb 15, 2025

drwpow approved these changes May 10, 2025

View reviewed changes

drwpow merged commit 0058128 into openapi-ts:main May 10, 2025
8 checks passed

This was referenced May 10, 2025

Improve header handling #2308

Merged

[ci] release #2309

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Encode the request body if `Content-Type` header is `x-www-form-urlencoded` #2096

Encode the request body if `Content-Type` header is `x-www-form-urlencoded` #2096

Uh oh!

obulat commented Jan 11, 2025 •

edited

Loading

Uh oh!

netlify bot commented Jan 11, 2025

Uh oh!

changeset-bot bot commented Jan 11, 2025

Uh oh!

drwpow Jan 25, 2025

Uh oh!

drwpow commented Jan 25, 2025

Uh oh!

drwpow commented Mar 18, 2025

Uh oh!

drwpow left a comment

Uh oh!

Uh oh!

obulat commented Jun 6, 2025

Uh oh!

drwpow commented Jun 6, 2025

Uh oh!

Uh oh!

Uh oh!

Encode the request body if Content-Type header is x-www-form-urlencoded #2096

Encode the request body if Content-Type header is x-www-form-urlencoded #2096

Uh oh!

Conversation

obulat commented Jan 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

How to Review

Checklist

Uh oh!

netlify bot commented Jan 11, 2025

👷 Deploy request for openapi-ts pending review.

Uh oh!

changeset-bot bot commented Jan 11, 2025

⚠️ No Changeset found

Uh oh!

drwpow Jan 25, 2025

Choose a reason for hiding this comment

Uh oh!

drwpow commented Jan 25, 2025

Uh oh!

drwpow commented Mar 18, 2025

Uh oh!

drwpow left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

obulat commented Jun 6, 2025

Uh oh!

drwpow commented Jun 6, 2025

Uh oh!

Uh oh!

Encode the request body if `Content-Type` header is `x-www-form-urlencoded` #2096

Encode the request body if `Content-Type` header is `x-www-form-urlencoded` #2096

obulat commented Jan 11, 2025 •

edited

Loading