Skip to content

fix(fastify): send object error bodies with a json content type - #18253

Merged
kamilmysliwiec merged 2 commits into
nestjs:masterfrom
maxymlyskov:fix/send-object-error-bodies-with-json-type
Oct 24, 2026
Merged

kamilmysliwiec merged 2 commits into
nestjs:masterfrom
maxymlyskov:fix/send-object-error-bodies-with-json-type

Conversation

@maxymlyskov

Copy link
Copy Markdown
Contributor

Context: sibling to 7dc6e34, which sends object error bodies as JSON from ExpressAdapter.reply(). This does the same for FastifyAdapter.reply()

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

A route sets Content-Type: text/csv, then throws new NotFoundException({ code, message }). reply() only switches to application/json when body.statusCode >= 400 (fastify-adapter.ts#L767-L779), and a custom body has no statusCode, so the csv type stays. Fastify won't serialize a plain object under a non-JSON type without a reply serializer, so it throws FST_ERR_REP_INVALID_PAYLOAD_TYPE and the client gets a 500 in place of the 404.

Real HTTP on master, fastify 5.12.7. The built-in body has a statusCode and gets through, express answers the custom one fine:

PROBE master fastify /export.csv  status=500 content-type=application/json; charset=utf-8 body={"statusCode":500,"message":"Attempted to send payload of invalid type 'object'. Expected a string or Buffer."
PROBE master fastify /builtin.csv status=404 content-type=application/json; charset=utf-8 body={"message":"no such report","error":"Not Found","statusCode":404}
PROBE master express /export.csv  status=404 content-type=application/json; charset=utf-8 body={"code":"REPORT_NOT_FOUND","message":"no such report"}

Issue Number: N/A

Raw test output with fastify-adapter.ts from master:

 FAIL  packages/platform-fastify/test/adapters/fastify-adapter.spec.ts > FastifyAdapter > reply > should force a JSON content type for error bodies without a "statusCode"
AssertionError: expected "vi.fn()" to be called with arguments: [ 'Content-Type', 'application/json' ]
 FAIL  packages/platform-fastify/test/adapters/fastify-adapter.spec.ts > FastifyAdapter > reply > should answer a custom error body with its status on a route with a non-JSON content type
AssertionError: expected 500 to be 404 // Object.is equality
 Test Files  1 failed (1)
      Tests  2 failed | 5 passed | 127 skipped (134)

What is the new behavior?

reply() also forces application/json for an object body that isn't a stream (.pipe) or an ArrayBuffer view (Buffer, TypedArray) when the statusCode argument is 400 or more, the rule 7dc6e34 added to Express. It lives in an isErrorBody() helper next to isJsonContentType so reply() doesn't get more branches.

PROBE branch fastify /export.csv  status=404 content-type=application/json; charset=utf-8 body={"code":"REPORT_NOT_FOUND","message":"no such report"}
PROBE branch fastify /file.csv    status=200 content-type=text/csv body=id,name\n1,a\n

Text, Buffer and stream error bodies keep the route's type. Bodies with a statusCode, JSON and +json routes, and successful object bodies behave as before.

Does this PR introduce a breaking change?

  • Yes
  • No

Behaviour change, as in 7dc6e34: on a non-JSON route such an error reply is now labelled application/json and logs the existing "Content-Type doesn't match Reply body" warning. With a custom reply serializer, master sent it under the route's type.

Other information

Same condition as Express after 7dc6e34, and it extends the statusCode switch from #10474 (for #8469) to custom error bodies.

#18208 was a successful object reply on a non-JSON route, kept as plain Fastify does it, and this doesn't change it (/ok.csv still answers 500 on the branch). It only touches error replies, where the 500 hides the exception Nest is sending.

The 2 tests above fail on master and pass here; the related specs pass (166 tests), and prettier and oxlint are clean.

maxymlyskov and others added 2 commits October 24, 2026 04:23
FastifyAdapter.reply() replaced a non-JSON Content-Type set on the route
(e.g. with @Header() or in middleware) only when the body had a
statusCode of 400 or more. A custom HttpException body, as in
new NotFoundException({ code, message }), need not have one. Fastify
only serializes an object when the Content-Type is JSON or not set, so
it threw FST_ERR_REP_INVALID_PAYLOAD_TYPE and answered 500: the
exception's status and body were lost.

An object body sent with an error status code now gets the JSON
Content-Type too, as on Express since 7dc6e34. Streams and binary
bodies, which Fastify sends as they are, keep the route's type, and so
do text bodies. Behaviour change: on a route with a non-JSON
Content-Type, such a response is labelled application/json and logs the
same warning as error bodies with a statusCode already did.
@kamilmysliwiec
kamilmysliwiec merged commit 4103075 into nestjs:master Oct 24, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants