fix: allow route handlers to return plain objects as JSON responses#159
Open
sucloudflare wants to merge 1 commit into
Open
fix: allow route handlers to return plain objects as JSON responses#159sucloudflare wants to merge 1 commit into
sucloudflare wants to merge 1 commit into
Conversation
Closes tscircuit#30 When a route returns a plain object (e.g. `return { ok: true }`) instead of `return new WinterSpecJsonResponse({ ok: true })`, the runtime now automatically wraps it in a WinterSpecJsonResponse and serializes it, including validation against the routeSpec.jsonResponse schema when present. Tests: 3 new e2e tests in tests/endpoints/plain-object-return.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #30
Problem
When a route handler returns a plain object (e.g.
return { ok: true }) instead ofreturn new WinterSpecJsonResponse({ ok: true }), the runtime fell through to an unhandled path and either threw or failed silently.Fix
In
serializeToResponse, added a guard that detects when the return value is a plain object (not aResponse, not aWinterSpecResponse) and automatically wraps it inWinterSpecJsonResponse, including validation againstrouteSpec.jsonResponsewhen present.Tests added
3 new e2e tests in
tests/endpoints/plain-object-return.test.ts:{ ok: true }→ 200 with JSON body ✅jsonResponseschema ✅