@openapi-typescript-infra/service 4.13.1 → 4.15.0

package/build/types.d.ts

@@ -49,7 +49,7 @@ export interface Service<SLocals extends AnyServiceLocals = ServiceLocals<Config
     healthy?: (app: ServiceExpress<SLocals>) => boolean | Promise<boolean>;
     onRequest?(req: RequestWithApp<SLocals>, res: Response<unknown, RLocals>): void | Promise<void>;
     authorize?(req: RequestWithApp<SLocals>, res: Response<unknown, RLocals>): boolean | Promise<boolean>;
-    getLogFields?(req: RequestWithApp<SLocals>, values: Record<string, string | string[] | number | undefined>): void;
+    getLogFields?(req: RequestWithApp<SLocals>, values: Record<string, string | string[] | number | undefined>): string | undefined;
     attachRepl?(app: ServiceExpress<SLocals>, repl: REPLServer): void;
 }
 export type ServiceFactory<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>, RLocals extends RequestLocals = RequestLocals> = () => Service<SLocals, RLocals>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-typescript-infra/service",
-  "version": "4.13.1",
+  "version": "4.15.0",
   "description": "An opinionated framework for building configuration driven services - web, api, or  ob. Uses OpenAPI, pino logging, express, confit, Typescript and vitest.",
   "main": "build/index.js",
   "scripts": {
@@ -122,7 +122,7 @@
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.3.3",
-    "vitest": "^1.2.1"
+    "vitest": "^1.2.2"
   },
   "resolutions": {
     "qs": "^6.11.0"

package/src/telemetry/requestLogger.ts

@@ -31,11 +31,10 @@ interface ErrorWithStatus extends Error {
   status?: number;
 }
 
-function getBasicInfo(req: Request) {
+function getBasicInfo(req: Request): [string, Record<string, string | number>] {
   const url = req.originalUrl || req.url;
 
   const preInfo: Record<string, string> = {
-    url,
     ip: requestip.getClientIp(req) || '',
     m: req.method,
   };
@@ -45,7 +44,7 @@ function getBasicInfo(req: Request) {
     preInfo.sid = sessionReq.session.id;
   }
 
-  return preInfo;
+  return [url, preInfo];
 }
 
 function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<ConfigurationSchema>>(
@@ -65,8 +64,10 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
   const hrdur = process.hrtime(prefs.start);
 
   const dur = hrdur[0] + hrdur[1] / 1000000000;
+  const [url, preInfo] = getBasicInfo(req);
   const endLog: Record<string, string | string[] | number | undefined> = {
-    ...getBasicInfo(req),
+    ...preInfo,
+    t: 'req',
     s: (error as ErrorWithStatus)?.status || res.statusCode || 0,
     dur,
   };
@@ -107,8 +108,8 @@ function finishLog<SLocals extends AnyServiceLocals = ServiceLocals<Configuratio
     }
   }
 
-  service.getLogFields?.(req as RequestWithApp<SLocals>, endLog);
-  logger.info(endLog, 'req');
+  const msg = service.getLogFields?.(req as RequestWithApp<SLocals>, endLog) || url;
+  logger.info(endLog, msg);
 }
 
 export function loggerMiddleware<
@@ -153,14 +154,16 @@ export function loggerMiddleware<
     }
 
     if (config?.preLog) {
+      const [url, preInfo] = getBasicInfo(req);
       const preLog: Record<string, string | string[] | number | undefined> = {
-        ...getBasicInfo(req),
+        ...preInfo,
+        t: 'pre',
         ref: req.headers.referer || undefined,
         sid: (req as WithIdentifiedSession).session?.id,
         c: req.headers.correlationid || undefined,
       };
-      service.getLogFields?.(req as RequestWithApp<SLocals>, preLog);
-      logger.info(preLog, 'pre');
+      const msg = service.getLogFields?.(req as RequestWithApp<SLocals>, preLog) || url;
+      logger.info(preLog, msg);
     }
 
     const logWriter = () => finishLog(app, undefined, req, res, histogram);

package/src/types.ts

@@ -95,11 +95,13 @@ export interface Service<
   ): boolean | Promise<boolean>;
 
   // Add or redact any fields for logging. Note this will be called twice per request,
-  // once at the start and once at the end. Modify the values directly.
+  // once at the start and once at the end. Modify the values directly. Return a
+  // string to control the "msg" field of the logs, or return undefined to leave it
+  // as the default, which is the request URL.
   getLogFields?(
     req: RequestWithApp<SLocals>,
     values: Record<string, string | string[] | number | undefined>,
-  ): void;
+  ): string | undefined;
 
   // The repl is a useful tool for diagnosing issues in non-dev environments.
   // The attachRepl method provides a way to add custom functionality
@@ -195,11 +197,8 @@ export interface ServiceTypes<
   ServiceLocals: SLocals;
 }
 
-export type UnwrapServiceConfig<SLocals extends ServiceLocals> = SLocals extends ServiceLocals<
-  infer C
->
-  ? C
-  : never;
+export type UnwrapServiceConfig<SLocals extends ServiceLocals> =
+  SLocals extends ServiceLocals<infer C> ? C : never;
 
 // TODO this allows us to clean up the generics by having a loose parameter
 // but using the UnwrapServiceConfig to get the specific type back