@openapi-typescript-infra/service 5.6.0 → 5.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "5.6.0",
+  "version": "5.7.0",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "exports": {
     ".": {

package/src/telemetry/requestLogger.ts

@@ -10,6 +10,7 @@ import { ConfigurationSchema } from '../config/schema.js';
 import { getNodeEnv } from '../env.js';
 
 const LOG_PREFS = Symbol('Logging information');
+const LOGGED_SEMAPHORE = Symbol('Logged semaphore');
 
 interface LogPrefs {
   start: [number, number];
@@ -57,9 +58,13 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
   app: ServiceExpress<SLocals>,
   error: Error | undefined,
   req: Request,
-  res: Response,
+  res: Response & { [LOGGED_SEMAPHORE]?: boolean },
   histogram: Histogram,
 ) {
+  if (res[LOGGED_SEMAPHORE]) {
+    return;
+  }
+
   const prefs = (res.locals as WithLogPrefs)[LOG_PREFS];
   if (prefs.logged) {
     // This happens when error handler runs, but onEnd hasn't fired yet. We only log the first one.
@@ -71,9 +76,22 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
 
   const dur = hrdur[0] + hrdur[1] / 1000000000;
   const [url, preInfo] = getBasicInfo(req);
+
+  let responseType: string = 'finished';
+
+  // ts warning is known and incorrect—`aborted` is a subset of `destroyed`
+  if (req.aborted) {
+    responseType = 'aborted';
+  } else if (req.destroyed) {
+    responseType = 'destroyed';
+  } else if (error) {
+    responseType = 'errored';
+  }
+
   const endLog: Record<string, string | string[] | number | undefined> = {
     ...preInfo,
     t: 'req',
+    r: responseType,
     s: (error as ErrorWithStatus)?.status || res.statusCode || 0,
     dur,
   };
@@ -124,6 +142,8 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
   } else {
     logger.info(endLog, msg);
   }
+
+  res[LOGGED_SEMAPHORE] = true;
 }
 
 export function loggerMiddleware<
@@ -180,8 +200,10 @@ export function loggerMiddleware<
       logger.info(preLog, msg);
     }
 
-    const logWriter = () => finishLog(app, undefined, req, res, histogram);
+    const logWriter = (err?: Error) => finishLog(app, err, req, res, histogram);
     res.on('finish', logWriter);
+    res.on('close', logWriter);
+    res.on('error', logWriter);
     next();
   };
 }