@tsed/platform-log-request 8.11.1 → 8.12.0-rc.1

package/lib/esm/domain/PlatformLogRequestSettings.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=PlatformLogRequestSettings.js.map

package/lib/esm/index.js

@@ -5,4 +5,3 @@ export * from "./domain/PlatformLogRequestSettings.js";
 export * from "./services/PlatformLogRequestFactory.js";
 export * from "./utils/defaultAlterLog.js";
 export * from "./utils/defaultLogResponse.js";
-//# sourceMappingURL=index.js.map

package/lib/esm/services/PlatformLogRequestFactory.js

@@ -26,4 +26,3 @@ export const PlatformLogRequestFactory = injectable(Symbol.for("PLATFORM:LOGGER:
     }
 })
     .token();
-//# sourceMappingURL=PlatformLogRequestFactory.js.map

package/lib/esm/utils/defaultAlterLog.js

@@ -16,4 +16,3 @@ export function defaultAlterLog(level, obj, ctx) {
         params: ctx.request.params
     };
 }
-//# sourceMappingURL=defaultAlterLog.js.map

package/lib/esm/utils/defaultLogResponse.js

@@ -26,4 +26,3 @@ export function defaultLogResponse($ctx) {
         });
     }
 }
-//# sourceMappingURL=defaultLogResponse.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/platform-log-request",
   "description": "Log request module for Ts.ED Framework (Express, Koa, Serverless)",
   "type": "module",
-  "version": "8.11.1",
+  "version": "8.12.0-rc.1",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -26,11 +26,11 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.11.1",
-    "@tsed/di": "8.11.1",
-    "@tsed/platform-middlewares": "8.11.1",
-    "@tsed/platform-params": "8.11.1",
-    "@tsed/typescript": "8.11.1",
+    "@tsed/barrels": "8.12.0-rc.1",
+    "@tsed/di": "8.12.0-rc.1",
+    "@tsed/platform-middlewares": "8.12.0-rc.1",
+    "@tsed/platform-params": "8.12.0-rc.1",
+    "@tsed/typescript": "8.12.0-rc.1",
     "eslint": "9.12.0",
     "typescript": "5.4.5",
     "vitest": "3.1.4"
@@ -57,5 +57,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/platform/platform-log-request",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "rc"
+  }
 }

package/lib/esm/domain/PlatformLogRequestSettings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformLogRequestSettings.js","sourceRoot":"","sources":["../../../src/domain/PlatformLogRequestSettings.ts"],"names":[],"mappings":""}

package/lib/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC"}

package/lib/esm/services/PlatformLogRequestFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PlatformLogRequestFactory.js","sourceRoot":"","sources":["../../../src/services/PlatformLogRequestFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,QAAQ,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAEhE,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAC;AAElE,SAAS,OAAO;IACd,MAAM,EACJ,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,eAAe,EAC1B,aAAa,GAAG,kBAAkB,EACnC,GAAG,QAAQ,CAA2B,QAAQ,EAAE,EAAE,CAAC,CAAC;IAErD,OAAO,UAAU;QACf,CAAC,CAAC;YACE,QAAQ;YACR,aAAa;SACd;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC;AAID,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;KACvF,OAAO,CAAC,OAAO,CAAC;KAChB,KAAK,CAAC;IACL,UAAU,CAAC,QAAoC,EAAE,IAAiB;QAChE,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAQ,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;YAC/E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACzB,CAAC;IACH,CAAC;IACD,WAAW,CAAC,QAAoC,EAAE,IAAiB;QACjE,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAChC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;CACF,CAAC;KACD,KAAK,EAAE,CAAC"}

package/lib/esm/utils/defaultAlterLog.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultAlterLog.js","sourceRoot":"","sources":["../../../src/utils/defaultAlterLog.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,GAA4B,EAAE,GAAc;IACzF,MAAM,UAAU,GAAG;QACjB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM;QAC1B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG;QACpB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG;QAC3C,GAAG,GAAG;KACP,CAAC;IAEF,IAAI,KAAK,KAAK,MAAM,EAAE,CAAC;QACrB,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO;QACL,GAAG,UAAU;QACb,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO;QAC5B,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI;QACtB,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK;QACxB,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,MAAM;KAC3B,CAAC;AACJ,CAAC"}

package/lib/esm/utils/defaultLogResponse.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"defaultLogResponse.js","sourceRoot":"","sources":["../../../src/utils/defaultLogResponse.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,YAAY,CAAC;AAGvC,MAAM,UAAU,kBAAkB,CAAC,IAAiB;IAClD,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAwB,CAAC;QAE5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YAChB,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;YAChC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC7C,KAAK,EAAE,IAAI;YACX,GAAG,WAAW,CAAC;gBACb,UAAU,EAAE,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,IAAI;gBACtC,aAAa,EAAE,KAAK,EAAE,OAAO;gBAC7B,YAAY,EAAE,KAAK,EAAE,MAAM;gBAC3B,WAAW,EAAE,KAAK,EAAE,KAAK;gBACzB,UAAU,EAAE,KAAK,EAAE,IAAI;gBACvB,aAAa,EAAE,KAAK,EAAE,OAAO;aAC9B,CAAC;SACH,CAAC,CAAC;IACL,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YACf,KAAK,EAAE,aAAa;YACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU;YAChC,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC7C,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/src/domain/PlatformLogRequestSettings.ts

@@ -1,28 +0,0 @@
-import type {DIContext} from "@tsed/di";
-
-export type AlterLogCallback = (
-  level: "debug" | "info" | "warn" | "error" | "all",
-  obj: Record<string, unknown>,
-  ctx: DIContext
-) => Record<string, unknown>;
-
-export interface PlatformLogRequestSettings {
-  /**
-   * Log all incoming request. By default, is true and print the configured `logger.requestFields`.
-   */
-  logRequest?: boolean;
-  /**
-   * A function to alter the log object before it's logged.
-   */
-  alterLog?: AlterLogCallback;
-  /**
-   * A function to log the server response.
-   */
-  onLogResponse?: ($ctx: DIContext) => void;
-}
-
-declare global {
-  namespace TsED {
-    interface LoggerConfiguration extends Partial<PlatformLogRequestSettings> {}
-  }
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./domain/PlatformLogRequestSettings.js";
-export * from "./services/PlatformLogRequestFactory.js";
-export * from "./utils/defaultAlterLog.js";
-export * from "./utils/defaultLogResponse.js";

package/src/services/PlatformLogRequestFactory.spec.ts

@@ -1,139 +0,0 @@
-import "../domain/PlatformLogRequestSettings.js";
-
-import {DITest} from "@tsed/di";
-
-import {PlatformLogRequestFactory} from "./PlatformLogRequestFactory.js";
-
-describe("PlatformLogRequestFactory", () => {
-  describe("when logger is enabled", () => {
-    beforeEach(() =>
-      DITest.create({
-        logger: {}
-      })
-    );
-    afterEach(() => DITest.reset());
-
-    it("should create logger factory", async () => {
-      const factory = await DITest.invoke<PlatformLogRequestFactory>(PlatformLogRequestFactory);
-
-      expect(factory).toEqual({
-        alterLog: expect.any(Function),
-        onLogResponse: expect.any(Function)
-      });
-
-      const ctx: any = {
-        request: {
-          method: "GET"
-        },
-        logger: {
-          alterLog: vi.fn(),
-          info: vi.fn()
-        }
-      };
-
-      vi.spyOn(factory!, "alterLog").mockReturnValue({});
-      vi.spyOn(factory!, "onLogResponse").mockReturnValue(undefined);
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onRequest(factory!, ctx);
-
-      expect(ctx.logger.alterLog).toHaveBeenCalledWith(expect.any(Function));
-
-      ctx.logger.alterLog.mock.calls[0][0]({test: "test"}, "info");
-
-      expect(ctx.logStarted).toBe(true);
-      expect(factory!.alterLog).toHaveBeenCalledWith(
-        "info",
-        {
-          test: "test"
-        },
-        ctx
-      );
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onResponse(factory!, ctx);
-
-      expect(factory!.onLogResponse).toHaveBeenCalledWith(ctx);
-    });
-  });
-  describe("when logger is enabled with options", () => {
-    beforeEach(() =>
-      DITest.create({
-        logger: {
-          logRequest: true,
-          alterLog: vi.fn().mockReturnValue({}),
-          onLogResponse: vi.fn()
-        }
-      })
-    );
-    afterEach(() => DITest.reset());
-
-    it("should create logger factory", async () => {
-      const factory = await DITest.invoke<PlatformLogRequestFactory>(PlatformLogRequestFactory);
-
-      expect(factory).toEqual({
-        alterLog: expect.any(Function),
-        onLogResponse: expect.any(Function)
-      });
-
-      const ctx: any = {
-        request: {
-          method: "GET"
-        },
-        logger: {
-          alterLog: vi.fn(),
-          info: vi.fn()
-        }
-      };
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onRequest(factory!, ctx);
-
-      expect(ctx.logger.alterLog).toHaveBeenCalledWith(expect.any(Function));
-
-      ctx.logger.alterLog.mock.calls[0][0]({test: "test"}, "info");
-
-      expect(ctx.logStarted).toBe(true);
-      expect(factory!.alterLog).toHaveBeenCalledWith(
-        "info",
-        {
-          test: "test"
-        },
-        ctx
-      );
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onResponse(factory!, ctx);
-
-      expect(factory!.onLogResponse).toHaveBeenCalledWith(ctx);
-    });
-  });
-  describe("when logger is disabled", () => {
-    beforeEach(() =>
-      DITest.create({
-        logger: {
-          logRequest: false
-        }
-      })
-    );
-    afterEach(() => DITest.reset());
-
-    it("should create logger factory", async () => {
-      const factory = await DITest.invoke<PlatformLogRequestFactory>(PlatformLogRequestFactory);
-
-      expect(factory).toEqual(null);
-
-      const ctx: any = {
-        request: {
-          method: "GET"
-        },
-        logger: {
-          alterLog: vi.fn(),
-          info: vi.fn()
-        }
-      };
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onRequest(factory!, ctx);
-
-      expect(ctx.logger.alterLog).not.toHaveBeenCalled();
-
-      DITest.injector.getProvider(PlatformLogRequestFactory)?.hooks?.$onResponse(factory!, ctx);
-    });
-  });
-});

package/src/services/PlatformLogRequestFactory.ts

@@ -1,38 +0,0 @@
-import {type BaseContext, constant, injectable} from "@tsed/di";
-
-import {defaultAlterLog} from "../utils/defaultAlterLog.js";
-import {defaultLogResponse} from "../utils/defaultLogResponse.js";
-
-function factory() {
-  const {
-    logRequest = true,
-    alterLog = defaultAlterLog,
-    onLogResponse = defaultLogResponse
-  } = constant<TsED.LoggerConfiguration>("logger", {});
-
-  return logRequest
-    ? {
-        alterLog,
-        onLogResponse
-      }
-    : null;
-}
-
-export type PlatformLogRequestFactory = ReturnType<typeof factory>;
-
-export const PlatformLogRequestFactory = injectable(Symbol.for("PLATFORM:LOGGER:REQUEST"))
-  .factory(factory)
-  .hooks({
-    $onRequest(instance: ReturnType<typeof factory>, $ctx: BaseContext) {
-      if (instance) {
-        $ctx.logger.alterLog((obj: any, level) => instance.alterLog(level, obj, $ctx));
-        $ctx.logStarted = true;
-      }
-    },
-    $onResponse(instance: ReturnType<typeof factory>, $ctx: BaseContext) {
-      if (instance && $ctx.logStarted) {
-        instance.onLogResponse($ctx);
-      }
-    }
-  })
-  .token();

package/src/utils/defaultAlterLog.spec.ts

@@ -1,66 +0,0 @@
-import {defaultAlterLog} from "./defaultAlterLog.js";
-
-describe("defaultAlterLog", () => {
-  it("should return the expected log object", () => {
-    expect(
-      defaultAlterLog("info", {test: "test"}, {
-        request: {
-          method: "GET",
-          url: "url",
-          headers: {
-            "x-forwarded-for": "value"
-          },
-          route: "route"
-        }
-      } as never)
-    ).toEqual({
-      method: "GET",
-      route: "route",
-      test: "test",
-      url: "url"
-    });
-  });
-  it("should return the expected log object (without route)", () => {
-    expect(
-      defaultAlterLog("info", {test: "test"}, {
-        request: {
-          method: "GET",
-          url: "url",
-          headers: {
-            "x-forwarded-for": "value"
-          }
-        }
-      } as never)
-    ).toEqual({
-      method: "GET",
-      route: "url",
-      test: "test",
-      url: "url"
-    });
-  });
-  it("should return the expected log object with extras info", () => {
-    expect(
-      defaultAlterLog("error", {test: "test"}, {
-        request: {
-          method: "GET",
-          url: "url",
-          headers: {
-            "x-forwarded-for": "value"
-          },
-          route: "route"
-        }
-      } as never)
-    ).toEqual({
-      method: "GET",
-      route: "route",
-      test: "test",
-      url: "url",
-      body: undefined,
-      headers: {
-        "x-forwarded-for": "value"
-      },
-      params: undefined,
-      query: undefined
-    });
-  });
-});

package/src/utils/defaultAlterLog.ts

@@ -1,22 +0,0 @@
-import type {DIContext} from "@tsed/di";
-
-export function defaultAlterLog(level: string, obj: Record<string, unknown>, ctx: DIContext) {
-  const minimalLog = {
-    method: ctx.request.method,
-    url: ctx.request.url,
-    route: ctx.request.route || ctx.request.url,
-    ...obj
-  };
-
-  if (level === "info") {
-    return minimalLog;
-  }
-
-  return {
-    ...minimalLog,
-    headers: ctx.request.headers,
-    body: ctx.request.body,
-    query: ctx.request.query,
-    params: ctx.request.params
-  };
-}

package/src/utils/defaultLogResponse.spec.ts

@@ -1,98 +0,0 @@
-import {defaultLogResponse} from "./defaultLogResponse.js";
-
-describe("defaultLogEnd", () => {
-  it("should log the request end", () => {
-    // GIVEN
-    const $ctx = {
-      response: {
-        statusCode: 200
-      },
-      logger: {
-        info: vi.fn()
-      }
-    };
-
-    // WHEN
-    defaultLogResponse($ctx as any);
-
-    // THEN
-    expect($ctx.logger.info).toHaveBeenCalledWith({
-      event: "request.end",
-      status: 200,
-      status_code: "200",
-      state: "OK"
-    });
-  });
-  it("should log the request end with error", () => {
-    // GIVEN
-    const $ctx = {
-      response: {
-        statusCode: 500
-      },
-      error: {
-        name: "name",
-        message: "message",
-        errors: "errors",
-        stack: "stack",
-        body: "body",
-        headers: "headers"
-      },
-      logger: {
-        error: vi.fn()
-      }
-    };
-
-    // WHEN
-    defaultLogResponse($ctx as any);
-
-    // THEN
-    expect($ctx.logger.error).toHaveBeenCalledWith({
-      event: "request.end",
-      status: 500,
-      status_code: "500",
-      state: "KO",
-      error_name: "name",
-      error_message: "message",
-      error_errors: "errors",
-      error_stack: "stack",
-      error_body: "body",
-      error_headers: "headers"
-    });
-  });
-  it("should log the request end with error code", () => {
-    // GIVEN
-    const $ctx = {
-      response: {
-        statusCode: 500
-      },
-      error: {
-        code: "code",
-        message: "message",
-        errors: "errors",
-        stack: "stack",
-        body: "body",
-        headers: "headers"
-      },
-      logger: {
-        error: vi.fn()
-      }
-    };
-
-    // WHEN
-    defaultLogResponse($ctx as any);
-
-    // THEN
-    expect($ctx.logger.error).toHaveBeenCalledWith({
-      event: "request.end",
-      status: 500,
-      status_code: "500",
-      state: "KO",
-      error_name: "code",
-      error_message: "message",
-      error_errors: "errors",
-      error_stack: "stack",
-      error_body: "body",
-      error_headers: "headers"
-    });
-  });
-});

package/src/utils/defaultLogResponse.ts

@@ -1,30 +0,0 @@
-import {cleanObject} from "@tsed/core";
-import type {BaseContext} from "@tsed/di";
-
-export function defaultLogResponse($ctx: BaseContext) {
-  if ($ctx.response.statusCode >= 400) {
-    const error = $ctx.error as any | undefined;
-
-    $ctx.logger.error({
-      event: "request.end",
-      status: $ctx.response.statusCode,
-      status_code: String($ctx.response.statusCode),
-      state: "KO",
-      ...cleanObject({
-        error_name: error?.name || error?.code,
-        error_message: error?.message,
-        error_errors: error?.errors,
-        error_stack: error?.stack,
-        error_body: error?.body,
-        error_headers: error?.headers
-      })
-    });
-  } else {
-    $ctx.logger.info({
-      event: "request.end",
-      status: $ctx.response.statusCode,
-      status_code: String($ctx.response.statusCode),
-      state: "OK"
-    });
-  }
-}

package/vitest.config.mts

@@ -1,21 +0,0 @@
-// @ts-ignore
-import {presets} from "@tsed/vitest/presets";
-import {defineConfig} from "vitest/config";
-
-export default defineConfig(
-  {
-    ...presets,
-    test: {
-      ...presets.test,
-      coverage: {
-        ...presets.test.coverage,
-        thresholds: {
-          statements: 0,
-          branches: 0,
-          functions: 0,
-          lines: 0
-        }
-      }
-    }
-  }
-);