feat: improve escape hatches

Author: mnahkies

packages/openapi-code-generator/src/typescript/server/typescript-express/typescript-express-router-builder.ts

@@ -45,15 +45,16 @@ export class ExpressRouterBuilder extends AbstractRouterBuilder {
     this.imports
       .from("@nahkies/typescript-express-runtime/server")
       .add(
+        "ExpressRuntimeResponder",
+        "ExpressRuntimeResponse",
+        "Params",
+        "SkipResponse",
         "StatusCode",
         "StatusCode1xx",
         "StatusCode2xx",
         "StatusCode3xx",
         "StatusCode4xx",
         "StatusCode5xx",
-        "Params",
-        "ExpressRuntimeResponse",
-        "ExpressRuntimeResponder",
       )
 
     this.imports
@@ -114,7 +115,8 @@ export class ExpressRouterBuilder extends AbstractRouterBuilder {
                     respond: ${symbols.responderName},
                     req: Request,
                     res: Response,
-                  ) => Promise<ExpressRuntimeResponse<unknown>>`,
+                    next: NextFunction
+                  ) => Promise<ExpressRuntimeResponse<unknown> | typeof SkipResponse>`,
           kind: "type",
         }),
       ],
@@ -135,9 +137,14 @@ router.${builder.method.toLowerCase()}(\`${route(builder.route)}\`, async (req:
 
    const responder = ${responder.implementation}
 
-   const response = await implementation.${symbols.implPropName}(input, responder, req, res)
+   const response = await implementation.${symbols.implPropName}(input, responder, req, res, next)
     .catch(err => { throw ExpressRuntimeError.HandlerError(err) })
 
+   // escape hatch to allow responses to be sent by the implementation handler
+   if(response === SkipResponse) {
+    return
+   }
+
    const { status, body } = response instanceof ExpressRuntimeResponse ? response.unpack() : response
 
     res.status(status)

packages/openapi-code-generator/src/typescript/server/typescript-koa/typescript-koa-router-builder.ts

@@ -42,6 +42,7 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {
         "Params",
         "Response",
         "ServerConfig",
+        "SkipResponse",
         "StatusCode",
         "StatusCode2xx",
         "StatusCode3xx",
@@ -54,6 +55,7 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {
       .from("@nahkies/typescript-koa-runtime/errors")
       .add("KoaRuntimeError", "RequestInputType")
 
+    this.imports.from("koa").add("Next")
     this.imports.addModule("KoaRouter", "@koa/router")
     this.imports.from("@koa/router").add("RouterContext")
 
@@ -110,13 +112,15 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {
           value: `(
                     params: ${params.type},
                     respond: ${symbols.responderName},
-                    ctx: RouterContext
+                    ctx: RouterContext,
+                    next: Next
                   ) => Promise<KoaRuntimeResponse<unknown> | ${[
                     ...responseSchemas.specific.map(
                       (it) => `Response<${it.statusType}, ${it.type}>`,
                     ),
                     responseSchemas.defaultResponse &&
                       `Response<StatusCode, ${responseSchemas.defaultResponse.type}>`,
+                    "typeof SkipResponse",
                   ]
                     .filter(isDefined)
                     .join(" | ")}>`,
@@ -138,9 +142,14 @@ router.${builder.method.toLowerCase()}('${symbols.implPropName}','${route(builde
 
    const responder = ${responder.implementation}
 
-   const response = await implementation.${symbols.implPropName}(input, responder, ctx)
+   const response = await implementation.${symbols.implPropName}(input, responder, ctx, next)
     .catch(err => { throw KoaRuntimeError.HandlerError(err) })
 
+   // escape hatch to allow responses to be sent by the implementation handler
+   if(response === SkipResponse) {
+    return
+   }
+
    const { status, body } = response instanceof KoaRuntimeResponse ? response.unpack() : response
 
    ctx.body = ${symbols.responseBodyValidator}(status, body)

packages/typescript-express-runtime/src/server.ts

@@ -42,6 +42,8 @@ export type Response<Status extends StatusCode, Type> = {
   body: Type
 }
 
+export const SkipResponse = Symbol("skip response processing")
+
 export class ExpressRuntimeResponse<Type> {
   private _body?: Type
 

packages/typescript-koa-runtime/src/server.ts

@@ -38,6 +38,8 @@ export type Response<Status extends StatusCode, Type> = {
   body: Type
 }
 
+export const SkipResponse = Symbol("skip response processing")
+
 export class KoaRuntimeResponse<Type> {
   private _body?: Type