Ability to configure and disable accessLogger (#2521)

#2512
#2365

Author: RobinTail

CHANGELOG.md

@@ -4,9 +4,22 @@
 
 ### v22.13.0
 
+- Ability to configure and disable access logging:
+  - New config option: `accessLogger` — the function for producing access logs;
+  - The default value is the function writing messages similar to `GET: /v1/path` having `debug` severity;
+  - The option can be assigned with `null` to disable writing of access logs;
+  - Thanks to the contributions of [@gmorgen1](https://github.com/gmorgen1) and [@crgeary](https://github.com/crgeary);
 - [@danmichaelo](https://github.com/danmichaelo) fixed a broken link in the Security policy;
 - Added JSDoc for several types involved into creating Middlewares and producing Endpoints.
 
+```ts
+import { createConfig } from "express-zod-api";
+
+const config = createConfig({
+  accessLogger: (request, logger) => logger.info(request.path), // or null to disable
+});
+```
+
 ### v22.12.0
 
 - Featuring HTML forms support (URL Encoded request body):
@@ -1400,7 +1413,7 @@ new Integration({
     - This makes all requests eligible for the assigned parsers and reverts changes made in [v18.5.2](#v1852);
     - Specifying `rawParser` in config is no longer needed to enable the feature.
 - Non-breaking significant changes:
-  - Request logging reflects the actual path instead of the configured route, and it's placed in front of parsing:
+  - Access logging reflects the actual path instead of the configured route, and it's placed in front of parsing:
     - The severity of those messaged reduced from `info` to `debug`;
   - The debug messages from uploader are enabled by default when the logger level is set to `debug`;
 - How to migrate confidently:

README.md

@@ -88,6 +88,8 @@ Therefore, many basic tasks can be accomplished faster and easier, in particular
 
 These people contributed to the improvement of the framework by reporting bugs, making changes and suggesting ideas:
 
+[<img src="https://github.com/gmorgen1.png" alt="@gmorgen1" width="50px" />](https://github.com/gmorgen1)
+[<img src="https://github.com/crgeary.png" alt="@crgeary" width="50px" />](https://github.com/crgeary)
 [<img src="https://github.com/danmichaelo.png" alt="@danmichaelo" width="50px" />](https://github.com/danmichaelo)
 [<img src="https://github.com/james10424.png" alt="@james10424" width="50px" />](https://github.com/james10424)
 [<img src="https://github.com/APTy.png" alt="@APTy" width="50px" />](https://github.com/APTy)

express-zod-api/src/config-type.ts

@@ -30,6 +30,8 @@ type ChildLoggerProvider = (params: {
   parent: ActualLogger;
 }) => ActualLogger | Promise<ActualLogger>;
 
+type LogAccess = (request: Request, logger: ActualLogger) => void;
+
 export interface CommonConfig {
   /**
    * @desc Enables cross-origin resource sharing.
@@ -62,6 +64,12 @@ export interface CommonConfig {
    * @example ({ parent }) => parent.child({ requestId: uuid() })
    * */
   childLoggerProvider?: ChildLoggerProvider;
+  /**
+   * @desc The function for producing access logs
+   * @default ({ method, path }, logger) => logger.debug(`${method}: ${path}`)
+   * @example null — disables the feature
+   * */
+  accessLogger?: null | LogAccess;
   /**
    * @desc You can disable the startup logo.
    * @default true

express-zod-api/src/server-helpers.ts

@@ -121,22 +121,30 @@ export const moveRaw: RequestHandler = (req, {}, next) => {
   next();
 };
 
-/** @since v19 prints the actual path of the request, not a configured route, severity decreased to debug level */
+/** @since v22.13 the access logging can be customized and disabled */
 export const createLoggingMiddleware =
   ({
     logger: parent,
-    config,
+    config: {
+      childLoggerProvider,
+      accessLogger = ({ method, path }, logger) =>
+        logger.debug(`${method}: ${path}`),
+    },
   }: {
     logger: ActualLogger;
     config: CommonConfig;
   }): RequestHandler =>
   async (request, response, next) => {
-    const logger =
-      (await config.childLoggerProvider?.({ request, parent })) || parent;
-    logger.debug(`${request.method}: ${request.path}`);
-    if (request.res)
-      (request as EquippedRequest).res!.locals[metaSymbol] = { logger };
-    next();
+    try {
+      const logger =
+        (await childLoggerProvider?.({ request, parent })) || parent;
+      accessLogger?.(request, logger);
+      if (request.res)
+        (request as EquippedRequest).res!.locals[metaSymbol] = { logger };
+      next();
+    } catch (error) {
+      next(error); // @todo remove in v23 that is express 5 only
+    }
   };
 
 export const makeGetLogger =

express-zod-api/tests/__snapshots__/server-helpers.spec.ts.snap

@@ -0,0 +1,21 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`Server helpers > createLoggingMiddleware > should handle errors in accessLogger 1`] = `
+[
+  [
+    AssertionError({
+      "message": "Something went wrong",
+    }),
+  ],
+]
+`;
+
+exports[`Server helpers > createLoggingMiddleware > should handle errors in childLoggerProvider 1`] = `
+[
+  [
+    AssertionError({
+      "message": "Something went wrong",
+    }),
+  ],
+]
+`;

express-zod-api/tests/server-helpers.spec.ts

@@ -1,3 +1,4 @@
+import { fail } from "node:assert/strict";
 import { fileUploadMock } from "./express-mock";
 import { metaSymbol } from "../src/metadata";
 import {
@@ -243,26 +244,61 @@ describe("Server helpers", () => {
   });
 
   describe("createLoggingMiddleware", () => {
-    const logger = makeLoggerMock();
-    const child = makeLoggerMock({ isChild: true });
-    test.each([undefined, () => child, async () => child])(
-      "should make RequestHandler writing logger to res.locals %#",
-      async (childLoggerProvider) => {
-        const config = { childLoggerProvider } as CommonConfig;
+    describe("should make RequestHandler writing logger to res.locals", () => {
+      const logger = makeLoggerMock();
+      const child = makeLoggerMock({ isChild: true });
+      test.each([undefined, () => child, async () => child])(
+        "case %#",
+        async (childLoggerProvider) => {
+          const config = { childLoggerProvider } as CommonConfig;
+          const handler = createLoggingMiddleware({ logger, config });
+          expect(typeof handler).toBe("function");
+          const nextMock = vi.fn();
+          const response = makeResponseMock();
+          const request = makeRequestMock({ path: "/test" });
+          request.res = response;
+          await handler(request, response, nextMock);
+          expect(nextMock).toHaveBeenCalled();
+          expect(
+            (childLoggerProvider ? child : logger)._getLogs().debug.pop(),
+          ).toEqual(["GET: /test"]);
+          expect(request.res).toHaveProperty("locals", {
+            [metaSymbol]: { logger: childLoggerProvider ? child : logger },
+          });
+        },
+      );
+    });
+
+    test.each<[CommonConfig["accessLogger"], string[][]]>([
+      [undefined, [["GET: /test"]]],
+      [null, []],
+      [({}, instance) => instance.debug("TEST"), [["TEST"]]],
+    ])(
+      "access logger can be customized and disabled %#",
+      async (accessLogger, expected) => {
+        const config = { accessLogger } as CommonConfig;
+        const logger = makeLoggerMock();
         const handler = createLoggingMiddleware({ logger, config });
-        expect(typeof handler).toBe("function");
-        const nextMock = vi.fn();
+        const request = makeRequestMock({ path: "/test" });
         const response = makeResponseMock();
+        await handler(request, response, vi.fn());
+        expect(logger._getLogs().debug).toEqual(expected);
+      },
+    );
+
+    test.each(["childLoggerProvider", "accessLogger"] as const)(
+      "should handle errors in %s",
+      async (prop) => {
+        const config = {
+          [prop]: () => fail("Something went wrong"),
+        } as unknown as CommonConfig;
+        const logger = makeLoggerMock();
+        const handler = createLoggingMiddleware({ logger, config });
         const request = makeRequestMock({ path: "/test" });
-        request.res = response;
+        const response = makeResponseMock();
+        const nextMock = vi.fn();
         await handler(request, response, nextMock);
-        expect(nextMock).toHaveBeenCalled();
-        expect(
-          (childLoggerProvider ? child : logger)._getLogs().debug.pop(),
-        ).toEqual(["GET: /test"]);
-        expect(request.res).toHaveProperty("locals", {
-          [metaSymbol]: { logger: childLoggerProvider ? child : logger },
-        });
+        expect(nextMock.mock.calls).toMatchSnapshot();
       },
     );
   });