fix(client-fetch): ensures plain/text body is sent with request #2564

franworks · 2025-08-30T17:32:34Z

resolves: #2553

When the options.serializedBody property was introduced, it replaced the body sent in the Request object causing any options.body not requiring a bodySerializer (ie plain/text) to be omitted from the request.

This PR fixes this behavior, ensuring that when an options.body is defined it is sent with the Request 'as-is', or 'serialized' if an options.bodySerializer is defined.

resolves: hey-api#2553

bolt-new-by-stackblitz · 2025-08-30T17:32:36Z

Run & review this pull request in StackBlitz Codeflow.

changeset-bot · 2025-08-30T17:32:37Z

⚠️ No Changeset found

Latest commit: 4064f51

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.

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

vercel · 2025-08-30T17:32:37Z

Someone is attempting to deploy a commit to the Hey API Team on Vercel.

A member of the Team first needs to authorize it.

franworks · 2025-08-31T01:57:14Z

@mrlubos assistance is requested to address next steps in resolving pipeline errors.

mrlubos · 2025-08-31T02:16:22Z

packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/client.ts

@@ -78,9 +78,12 @@ export const createClient = (config: Config = {}): Client => {
    const requestInit: ReqInit = {
      redirect: 'follow',
      ...opts,
-      body: opts.serializedBody,


Isn't all that you want something like this?

body: opts.serializedBody !== undefined ? opts.serializedBody : opts.body,

i thought about going the opts.serializedBody ?? opts.body route but decided to put it in a separate block for readability and clarity.

Body is already a property on the options object, no need to define or reassign if its not necessary. It was confusing for me to see body redefined in the client-next plugin like body: options.body. I had to ask myself if something was different - it wasn't.

Happy to change it if you prefer the one liner.

mrlubos

Please update the logic in all clients using serializedBody and then update snapshots with pnpm --filter @test/openapi-ts test:update

refs: hey-api#2553

pkg-pr-new · 2025-08-31T04:05:12Z

Open in StackBlitz

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/codegen-core@2564

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/nuxt@2564

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/openapi-ts@2564

npm i https://pkg.pr.new/hey-api/openapi-ts/@hey-api/vite-plugin@2564

commit: b4d06c6

codecov · 2025-08-31T04:05:16Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 23.98%. Comparing base (fe2803a) to head (b4d06c6).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2564      +/-   ##
==========================================
+ Coverage   23.69%   23.98%   +0.28%     
==========================================
  Files         362      362              
  Lines       36340    36345       +5     
  Branches     1562     1603      +41     
==========================================
+ Hits         8612     8716     +104     
+ Misses      27715    27616      -99     
  Partials       13       13

Flag	Coverage Δ
unittests	`23.98% <100.00%> (+0.28%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

franworks · 2025-08-31T21:16:31Z

@mrlubos the next client was the only client impacted by the serializeBody change - that has issue has now been resolved as part of this PR.

Tests have been added, snapshots updated.

mrlubos · 2025-08-31T21:21:15Z

@mrlubos the next client was the only client impacted by the serializeBody change - that has issue has now been resolved as part of this PR.

Tests have been added, snapshots updated.

Isn't this line going to have the same issue?

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/client.ts

Line 98 in 34fa59f

opts.serializedBody || null,

franworks · 2025-08-31T21:33:27Z

@mrlubos I reviewed the changes tracked in the issue that triggered the bug which were the client-fetch and client-next clients.

I did not go through and review all of the clients. However, I can do that, starting with your reference to the angular client.

mrlubos · 2025-08-31T21:40:55Z

@mrlubos I reviewed the changes tracked in the issue that triggered the bug which were the client-fetch and client-next clients.

I did not go through and review all of the clients. However, I can do that, starting with your reference to the angular client.

Yes please. Aside from making sure this bug isn't present in any of the clients, I think there are 2 issues with this change.

if (opts.serializedBody) { requires the serialized body to be truthy, which would not be true for empty strings, 0, etc. I think it should be checking for the presence of serialized body instead fix(client-fetch): ensures plain/text body is sent with request #2564 (comment)
if (opts.body === undefined || opts.body === '') { relies on the raw body for removing the Content-Type header. This is incorrect, it should work based on the final body we'll be sending. Currently it makes it possible to have a body that serializes to empty string and we'd fail to remove the Content-Type header.

franworks · 2025-08-31T22:04:44Z

@mrlubos the angular client would not have this issue because serializedBody is initialized with options.body

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/client-angular/bundle/client.ts

Line 70 in 34fa59f

serializedBody: options.body as any,

franworks · 2025-08-31T22:43:06Z

@mrlubos - looking at the angular client, would be acceptable to initialize the serializedBody with the options.body?

mrlubos · 2025-08-31T22:58:28Z

That's either a mistake we want to fix or a valid approach we should use across all clients. I don't know what's the better approach, and I don't feel particularly strongly about either option. The only thing I feel strongly about is having it be consistent so one can easily reason through these features

franworks · 2025-08-31T23:16:20Z

Agreed. I'm writing tests for the different scenarios. Will post back when I have it sorted out.

…ent with request refs: hey-api#2553

franworks · 2025-09-01T14:53:01Z

@mrlubos I pushed just the fetch client changes. If these changes make sense, I will update the other clients.
I do not think serializedBody should be initialized with opts.body - it would be unexpected if no bodySerializer is defined.

franworks · 2025-09-01T15:15:55Z

@mrlubos A body defined as 0 or false with defined bodySerializer will not make it into the expected block

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/client.ts

Line 61 in 34fa59f

if (opts.body && opts.bodySerializer) {

Should this check be updated as part of this PR?

mrlubos · 2025-09-02T05:56:03Z

@mrlubos A body defined as 0 or false with defined bodySerializer will not make it into the expected block

openapi-ts/packages/openapi-ts/src/plugins/@hey-api/client-fetch/bundle/client.ts

Line 61 in 34fa59f

if (opts.body && opts.bodySerializer) {

Should this check be updated as part of this PR?

Yes please

mrlubos · 2025-09-02T05:56:27Z

I do not think serializedBody should be initialized with opts.body - it would be unexpected if no bodySerializer is defined.

I agree

fix(client-fetch): ensures plain/text body is sent with request

662300b

resolves: hey-api#2553

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. bug 🔥 Something isn't working client Client package related labels Aug 30, 2025

mrlubos reviewed Aug 31, 2025

View reviewed changes

Fransis Young added 2 commits August 30, 2025 23:30

fix(client-next): ensures plain/text body is sent with request

9320253

refs: hey-api#2553

test(client): updates snapshots

b4d06c6

refs: hey-api#2553

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Aug 31, 2025

fix(client-fetch): ensures valid serialized or unserialized body is s…

4064f51

…ent with request refs: hey-api#2553

franworks marked this pull request as draft September 1, 2025 14:54

Uh oh!

fix(client-fetch): ensures plain/text body is sent with request #2564

Are you sure you want to change the base?

fix(client-fetch): ensures plain/text body is sent with request #2564

Conversation

franworks commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bolt-new-by-stackblitz bot commented Aug 30, 2025

Uh oh!

changeset-bot bot commented Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Aug 30, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

mrlubos Aug 31, 2025

Choose a reason for hiding this comment

Uh oh!

franworks Aug 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Aug 31, 2025

Uh oh!

codecov bot commented Aug 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

mrlubos commented Aug 31, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

mrlubos commented Aug 31, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

mrlubos commented Aug 31, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

franworks commented Sep 1, 2025

Uh oh!

franworks commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mrlubos commented Sep 2, 2025

Uh oh!

mrlubos commented Sep 2, 2025

Uh oh!

Uh oh!

franworks commented Aug 30, 2025 •

edited

Loading

changeset-bot bot commented Aug 30, 2025 •

edited

Loading

franworks Aug 31, 2025 •

edited

Loading

codecov bot commented Aug 31, 2025 •

edited

Loading

franworks commented Sep 1, 2025 •

edited

Loading