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

🦋 Changeset detected

Latest commit: f653716

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another 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.

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

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: f653716

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

Codecov Report

❌ Patch coverage is 96.15385% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 24.05%. Comparing base (62cff55) to head (f653716).
⚠️ Report is 16 commits behind head on main.

Files with missing lines	Patch %	Lines
...c/plugins/@hey-api/client-angular/bundle/client.ts	94.11%	1 Missing ⚠️
.../src/plugins/@hey-api/client-next/bundle/client.ts	94.73%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2564      +/-   ##
==========================================
+ Coverage   23.59%   24.05%   +0.46%     
==========================================
  Files         363      363              
  Lines       36545    36585      +40     
  Branches     1562     1628      +66     
==========================================
+ Hits         8622     8802     +180     
+ Misses      27910    27770     -140     
  Partials       13       13

Flag	Coverage Δ
unittests	`24.05% <96.15%> (+0.46%)`	⬆️

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

…nt with request refs: hey-api#2553

franworks · 2025-09-02T18:07:40Z

Changing how the angular client works would be a breaking change, and I don't think that should be done as part of this PR.
I have the changes, I can put them on a branch and PR them separately.

refs: hey-api#2553

mrlubos · 2025-09-02T22:49:57Z

Changing how the angular client works would be a breaking change, and I don't think that should be done as part of this PR. I have the changes, I can put them on a branch and PR them separately.

Sounds good! What would be the breaking change?

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

franworks · 2025-09-03T00:08:23Z

Changing how the angular client works would be a breaking change, and I don't think that should be done as part of this PR. I have the changes, I can put them on a branch and PR them separately.

Sounds good! What would be the breaking change?

serializedBody will go from being initialized with options.body to being undefined, so in the case of unserialized data - it would break that functionality for anyone leveraging that value in the interceptor.

…ition

…n undefined by default

mrlubos · 2025-09-04T02:16:21Z

Changing how the angular client works would be a breaking change, and I don't think that should be done as part of this PR. I have the changes, I can put them on a branch and PR them separately.

Sounds good! What would be the breaking change?

serializedBody will go from being initialized with options.body to being undefined, so in the case of unserialized data - it would break that functionality for anyone leveraging that value in the interceptor.

I think that's fine, what do you think? Isn't that how it works for the Fetch client too?

franworks · 2025-09-04T04:17:08Z

Changing how the angular client works would be a breaking change, and I don't think that should be done as part of this PR. I have the changes, I can put them on a branch and PR them separately.

Sounds good! What would be the breaking change?

serializedBody will go from being initialized with options.body to being undefined, so in the case of unserialized data - it would break that functionality for anyone leveraging that value in the interceptor.

I think that's fine, what do you think? Isn't that how it works for the Fetch client too?

The fetch client does work like that. I felt that a breaking change warranted it is own issue with a description of what changed and why.

However, if this is not a concern, I will push the change.

…s sent with request BREAKING CHANGE: options.serializedBody is undefined by default, and will only be assigned a value when options.bodySerializer is defined refs: hey-api#2553

mrlubos · 2025-09-04T04:44:53Z

Yeah I'm not overly concerned with it as both the Angular client and serialized body are relatively new changes. We can document it in release notes, the pull request looks ready now I think. I'll review it one last time and merge later, thank you for the big contribution!

franworks · 2025-09-04T04:57:09Z

Yeah I'm not overly concerned with it as both the Angular client and serialized body are relatively new changes. We can document it in release notes, the pull request looks ready now I think. I'll review it one last time and merge later, thank you for the big contribution!

Thank you!

mrlubos

This looks good! I think we need to improve the Axios client as well, but happy to merge it

franworks · 2025-09-04T21:31:15Z

Ok, I can help with that. I'll create an issue and start looking into it later on this evening.

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

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

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

fix(client-next): ensures valid serialized or unserialized body is se…

7c3e725

…nt with request refs: hey-api#2553

test(client): updates snapshots

b1a3658

refs: hey-api#2553

Merge branch 'main' into fix/hey-api#2553-handle-plain-text-request-body

27c0521

mrlubos reviewed Sep 2, 2025

View reviewed changes

packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/client.ts Outdated Show resolved Hide resolved

mrlubos reviewed Sep 2, 2025

View reviewed changes

packages/openapi-ts/src/plugins/@hey-api/client-next/bundle/client.ts Show resolved Hide resolved

Fransis Young added 4 commits September 2, 2025 20:48

chore(client-fetch,client-nuxt): removes redundant delete header cond…

244304d

…ition

chore(client): updates snapshots

65c8763

chore(client-fetch,client-nuxt): updates getValidRequestBody to retur…

bdd7725

…n undefined by default

test(client): updates snapshots

10e5488

franworks marked this pull request as ready for review September 3, 2025 16:50

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Sep 3, 2025

fix(client-angular)!: ensures valid serialized or unserialized body i…

b2b6998

…s sent with request BREAKING CHANGE: options.serializedBody is undefined by default, and will only be assigned a value when options.bodySerializer is defined refs: hey-api#2553

This was referenced Sep 4, 2025

fix(client-fetch): serialize body with falsey but valid json values #2590

Closed

client-fetch does not body-serialize valid json values that are falsey #2589

Closed

mrlubos added 2 commits September 4, 2025 23:05

Create brave-seahorses-dream.md

074a459

Merge branch 'main' into fix/hey-api#2553-handle-plain-text-request-body

f653716

mrlubos approved these changes Sep 4, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 4, 2025

mrlubos merged commit 01b8086 into hey-api:main Sep 5, 2025
12 of 13 checks passed

hey-api bot mentioned this pull request Sep 4, 2025

ci: release #2591

Merged

franworks mentioned this pull request Sep 5, 2025

Client Improvement: Move getValidRequestBody method from client to core-client utils #2604

Closed

Uh oh!

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

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

Uh oh!

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!

🦋 Changeset detected

Uh oh!

vercel bot commented Aug 30, 2025

Uh oh!

franworks commented Aug 31, 2025

Uh oh!

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

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!

franworks commented Sep 2, 2025

Uh oh!

mrlubos commented Sep 2, 2025

Uh oh!

Uh oh!

Uh oh!

franworks commented Sep 3, 2025

Uh oh!

mrlubos commented Sep 4, 2025

Uh oh!

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

Uh oh!

Uh oh!

mrlubos commented Sep 4, 2025

Uh oh!

franworks commented Sep 4, 2025

Uh oh!

mrlubos left a comment

Choose a reason for hiding this comment

Uh oh!

franworks commented Sep 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

franworks commented Aug 30, 2025 •

edited

Loading

changeset-bot bot commented Aug 30, 2025 •

edited

Loading

pkg-pr-new bot commented Aug 31, 2025 •

edited

Loading

codecov bot commented Aug 31, 2025 •

edited

Loading

franworks commented Sep 1, 2025 •

edited

Loading

franworks commented Sep 4, 2025 •

edited

Loading