Skip to content

fix: include method and path in plain object return error #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
immanuwell wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: include method and path in plain object return error #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/middleware/with-response-object-check.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ export const withResponseObjectCheck: Middleware<
const rawResponse = await next(req, ctx)

if (typeof rawResponse === "object" && !(rawResponse instanceof Response)) {
const method = req.method?.toUpperCase() ?? "UNKNOWN"
const path = new URL(req.url).pathname
throw new Error(
"Use ctx.json({...}) instead of returning an object directly."
`Route ${method} ${path} returned a plain object. Use ctx.json({...}) instead of returning an object directly.`
)
}

Expand Down
1 change: 1 addition & 0 deletions tests/errors/do-not-allow-raw-json.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ test("should throw an error when responding with raw JSON", async (t) => {
const { data } = await axios.get("/", {
validateStatus: () => true,
})
t.true(data.error.includes("Route GET /"))
t.true(
data.error.includes(
"Use ctx.json({...}) instead of returning an object directly"
Expand Down
Loading