fix(middleware): propagate return plain object error message instead of masking (#30)

src/middleware/http-exceptions.ts

@@ -70,3 +70,9 @@ export class ResponseValidationError extends WinterSpecMiddlewareError {
     super(formatZodError(error), 500)
   }
 }
+
+export class ResponseObjectNotAllowedError extends WinterSpecMiddlewareError {
+  constructor() {
+    super("Use ctx.json({...}) instead of returning an object directly.", 500)
+  }
+}

src/middleware/with-response-object-check.ts

@@ -1,4 +1,4 @@
-import { ResponseValidationError } from "./http-exceptions.js"
+import { ResponseObjectNotAllowedError } from "./http-exceptions.js"
 import { Middleware } from "./types.js"
 import { RouteSpec } from "src/types/route-spec.js"
 
@@ -9,9 +9,7 @@ export const withResponseObjectCheck: Middleware<
   const rawResponse = await next(req, ctx)
 
   if (typeof rawResponse === "object" && !(rawResponse instanceof Response)) {
-    throw new Error(
-      "Use ctx.json({...}) instead of returning an object directly."
-    )
+    throw new ResponseObjectNotAllowedError()
   }
 
   return rawResponse

tests/middleware/with-response-object-check.test.ts

@@ -0,0 +1,39 @@
+import test from "ava"
+import { z } from "zod"
+import { getTestRoute } from "../fixtures/get-test-route.js"
+import { createWithDefaultExceptionHandling } from "../../src/middleware/with-default-exception-handling.js"
+
+test("returning a plain object with jsonResponse validation under default exception handling", async (t) => {
+  const { axios } = await getTestRoute(t, {
+    globalSpec: {
+      authMiddleware: {},
+      beforeAuthMiddleware: [createWithDefaultExceptionHandling()],
+    },
+    routeSpec: {
+      auth: "none",
+      methods: ["GET"],
+      jsonResponse: z.object({
+        ok: z.boolean(),
+        message: z.string(),
+      }),
+    },
+    routeFn: (_, ctx) => {
+      // Accidental plain object return
+      return { ok: true, message: "hello" } as any
+    },
+    routePath: "/test-plain-object",
+  })
+
+  const response = await axios.get("/test-plain-object", {
+    validateStatus: () => true,
+  })
+
+  console.log("Response status:", response.status)
+  console.log("Response data:", response.data)
+
+  t.is(response.status, 500)
+  t.is(
+    response.data.message,
+    "Use ctx.json({...}) instead of returning an object directly."
+  )
+})