Merge pull request #108 from stainless-api/sam/fix-hono-plugin

fix(hono): return 204 for void handler results instead of crashing

Author: dgellow

packages/hono/package.json

@@ -34,7 +34,7 @@
     "typescript": "^5.3.2"
   },
   "dependencies": {
-    "hono": "^4.0.0",
+    "hono": "^4.12.1",
     "qs": "^6.11.2",
     "stainless": "workspace:*"
   }

packages/hono/src/__tests__/honoPlugin.test.ts

@@ -4,6 +4,50 @@ import { stlApi } from "../honoPlugin";
 
 const stl = new Stl({ plugins: {} });
 
+describe("void-returning handlers", () => {
+  const api = stl.api({
+    basePath: "/api",
+    resources: {
+      webhooks: stl.resource({
+        summary: "webhooks",
+        actions: {
+          fireAndForget: stl.endpoint({
+            endpoint: "POST /api/webhooks/events",
+            handler: async () => {
+              // Handler that does work but returns nothing
+            },
+          }),
+          earlyReturn: stl.endpoint({
+            endpoint: "POST /api/webhooks/noop",
+            handler: async () => {
+              return;
+            },
+          }),
+        },
+      }),
+    },
+  });
+
+  const app = new Hono();
+  app.use("*", stlApi(api));
+
+  test("handler returning void responds with 204", async () => {
+    const response = await app.request("/api/webhooks/events", {
+      method: "POST",
+    });
+    expect(response.status).toBe(204);
+    expect(await response.text()).toBe("");
+  });
+
+  test("handler with explicit bare return responds with 204", async () => {
+    const response = await app.request("/api/webhooks/noop", {
+      method: "POST",
+    });
+    expect(response.status).toBe(204);
+    expect(await response.text()).toBe("");
+  });
+});
+
 describe("basic routing", () => {
   const api = stl.api({
     basePath: "/api",

packages/hono/src/honoPlugin.ts

@@ -1,6 +1,6 @@
 import { Context } from "hono";
 import { createMiddleware } from "hono/factory";
-import { StatusCode } from "hono/utils/http-status";
+import { ContentfulStatusCode } from "hono/utils/http-status";
 import qs from "qs";
 import {
   allEndpoints,
@@ -91,14 +91,18 @@ function makeHandler(endpoints: AnyEndpoint[], options?: StlAppOptions) {
         return result;
       }
 
+      if (result === undefined) {
+        return c.body(null, 204);
+      }
+
       return c.json(result);
     } catch (error) {
       if (options?.handleErrors === false) {
         throw error;
       }
 
       if (isStlError(error)) {
-        return c.json(error.response, error.statusCode as StatusCode);
+        return c.json(error.response, error.statusCode as ContentfulStatusCode);
       }
 
       console.error(

packages/next/package.json

@@ -31,7 +31,7 @@
     "next": "^14.2.8"
   },
   "dependencies": {
-    "hono": "^4.0.0",
+    "hono": "^4.12.0",
     "lodash": "^4.17.21",
     "qs": "^6.11.2",
     "stainless": "workspace:*"