feat: support router level middleware for express

Author: mnahkies

e2e/src/generated/server/express/routes/escape-hatches.ts

@@ -1,6 +1,7 @@
 import type {Server} from "node:http"
 import {
   afterAll,
+  afterEach,
   beforeAll,
   beforeEach,
   describe,
@@ -24,7 +25,6 @@ describe.each(
 }) => {
   let server: Server | undefined
   let client: ApiClient
-  const logSpy = jest.spyOn(console, "log").mockImplementation(() => {})
 
   beforeAll(async () => {
     const args = await startServer()
@@ -43,11 +43,6 @@ describe.each(
 
   afterAll(async () => {
     server?.close()
-    logSpy.mockRestore()
-  })
-
-  beforeEach(() => {
-    logSpy.mockClear()
   })
 
   describe("CORS", () => {
@@ -539,20 +534,28 @@ describe.each(
   })
 
   describe("route matching", () => {
+    let logSpy: jest.SpiedFunction<typeof console.log>
+
+    beforeEach(() => {
+      logSpy = jest.spyOn(console, "log").mockImplementation(() => {})
+    })
+
+    afterEach(() => {
+      logSpy.mockRestore()
+    })
+
     it("should match fixed field route over parameterized route", async () => {
       const res = await client.routeMatchingGetByFixedField()
 
       expect(res.status).toBe(200)
       await expect(res.json()).resolves.toEqual({matched: "fixed-field"})
 
-      if (name === "koa") {
-        expect(logSpy).toHaveBeenCalledWith(
-          "Request started: GET /route-matching/fixed-field",
-        )
-        expect(logSpy).toHaveBeenCalledWith(
-          "Request completed: [200] GET /route-matching/fixed-field [object Object]",
-        )
-      }
+      expect(logSpy).toHaveBeenCalledWith(
+        "Request started: GET /route-matching/fixed-field",
+      )
+      expect(logSpy).toHaveBeenCalledWith(
+        "Request completed: [200] GET /route-matching/fixed-field",
+      )
     })
 
     it("should match parameterized route", async () => {
@@ -561,14 +564,12 @@ describe.each(
       expect(res.status).toBe(200)
       await expect(res.json()).resolves.toEqual({matched: "id", id: "123"})
 
-      if (name === "koa") {
-        expect(logSpy).toHaveBeenCalledWith(
-          "Request started: GET /route-matching/123",
-        )
-        expect(logSpy).toHaveBeenCalledWith(
-          "Request completed: [200] GET /route-matching/123 [object Object]",
-        )
-      }
+      expect(logSpy).toHaveBeenCalledWith(
+        "Request started: GET /route-matching/123",
+      )
+      expect(logSpy).toHaveBeenCalledWith(
+        "Request completed: [200] GET /route-matching/123",
+      )
     })
   })
 })

e2e/src/generated/server/express/routes/media-types.ts

@@ -1,9 +1,24 @@
+import type {RequestHandler} from "express"
 import {
   createRouter,
   type RouteMatchingGetByFixedField,
   type RouteMatchingGetById,
 } from "../../generated/server/express/routes/route-matching.ts"
 
+export const routerMatchingLoggingMiddleware: RequestHandler = (
+  req,
+  res,
+  next,
+) => {
+  console.log(`Request started: ${req.method} ${req.path}`)
+  res.on("finish", () => {
+    console.log(
+      `Request completed: [${res.statusCode}] ${req.method} ${req.path}`,
+    )
+  })
+  next()
+}
+
 const routeMatchingGetByFixedField: RouteMatchingGetByFixedField = async (
   _params,
   respond,
@@ -19,8 +34,11 @@ const routeMatchingGetById: RouteMatchingGetById = async (
 }
 
 export function createRouteMatchingRouter() {
-  return createRouter({
-    routeMatchingGetByFixedField,
-    routeMatchingGetById,
-  })
+  return createRouter(
+    {
+      routeMatchingGetByFixedField,
+      routeMatchingGetById,
+    },
+    {middleware: [routerMatchingLoggingMiddleware]},
+  )
 }

e2e/src/generated/server/express/routes/query-parameters.ts

@@ -11,9 +11,7 @@ export const routerMatchingLoggingMiddleware: RouterMiddleware = async (
 ) => {
   console.log(`Request started: ${ctx.method} ${ctx.path}`)
   await next()
-  console.log(
-    `Request completed: [${ctx.status}] ${ctx.method} ${ctx.path} ${ctx.body}`,
-  )
+  console.log(`Request completed: [${ctx.status}] ${ctx.method} ${ctx.path}`)
 }
 
 const routeMatchingGetByFixedField: RouteMatchingGetByFixedField = async (

e2e/src/generated/server/express/routes/request-headers.ts

@@ -38,7 +38,7 @@ export class ExpressRouterBuilder extends AbstractRouterBuilder {
     this.imports
       .from("express")
       .add("Router")
-      .addType("Request", "Response", "NextFunction")
+      .addType("Request", "Response", "NextFunction", "RequestHandler")
 
     this.imports.from("express").all("express")
 
@@ -209,9 +209,13 @@ ${this.operationTypes.flatMap((it) => it.statements).join("\n\n")}
 
 ${this.implementationExport(implementationExportName)}
 
-export function ${createRouterExportName}(implementation: ${implementationExportName}): Router {
+export function ${createRouterExportName}(implementation: ${implementationExportName}, options: {middleware?: RequestHandler[]} = {}): Router {
   const router = Router()
 
+  if (options.middleware?.length) {
+    router.use(...options.middleware)
+  }
+
   ${statements.join("\n\n")}
 
   return router