@nest-boot/logger 7.0.5 → 7.1.0

package/dist/logger.interceptor.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/logger.interceptor.spec.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const testing_1 = require("@nestjs/testing");
+const rxjs_1 = require("rxjs");
+const logger_1 = require("./logger");
+const logger_interceptor_1 = require("./logger.interceptor");
+describe("LoggingInterceptor", () => {
+    it("should assign route bindings for HTTP requests", async () => {
+        function handler() {
+            return undefined;
+        }
+        class TestController {
+        }
+        const assign = jest.fn();
+        const handle = jest.fn(() => (0, rxjs_1.of)("ok"));
+        const interceptor = await createInterceptor(assign);
+        const next = {
+            handle,
+        };
+        const context = {
+            getClass: jest.fn(() => TestController),
+            getHandler: jest.fn(() => handler),
+            getType: jest.fn(() => "http"),
+            switchToHttp: jest.fn(() => ({
+                getRequest: () => ({
+                    route: {
+                        path: "/test",
+                    },
+                }),
+            })),
+        };
+        interceptor.intercept(context, next).subscribe();
+        expect(assign).toHaveBeenCalledWith({
+            route: {
+                controller: "TestController",
+                handler: "handler",
+                path: "/test",
+            },
+        });
+        expect(handle).toHaveBeenCalledTimes(1);
+    });
+    it("should skip route bindings for non-HTTP requests", async () => {
+        const assign = jest.fn();
+        const handle = jest.fn(() => (0, rxjs_1.of)("ok"));
+        const interceptor = await createInterceptor(assign);
+        const next = {
+            handle,
+        };
+        const context = {
+            getType: jest.fn(() => "rpc"),
+        };
+        interceptor.intercept(context, next);
+        expect(assign).not.toHaveBeenCalled();
+        expect(handle).toHaveBeenCalledTimes(1);
+    });
+});
+async function createInterceptor(assign) {
+    const moduleRef = await testing_1.Test.createTestingModule({
+        providers: [
+            logger_interceptor_1.LoggingInterceptor,
+            {
+                provide: logger_1.Logger,
+                useValue: {
+                    assign,
+                },
+            },
+        ],
+    }).compile();
+    return moduleRef.get(logger_interceptor_1.LoggingInterceptor);
+}
+//# sourceMappingURL=logger.interceptor.spec.js.map

package/dist/logger.interceptor.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.interceptor.spec.js","sourceRoot":"","sources":["../src/logger.interceptor.spec.ts"],"names":[],"mappings":";;AAAA,6CAAuC;AACvC,+BAA0B;AAE1B,qCAAkC;AAClC,6DAA0D;AAE1D,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,SAAS,OAAO;YACd,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,cAAc;SAAG;QACvB,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAA,SAAE,EAAC,IAAI,CAAC,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG;YACX,MAAM;SACP,CAAC;QACF,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC;YACvC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC;YAClC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;YAC9B,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC3B,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC;oBACjB,KAAK,EAAE;wBACL,IAAI,EAAE,OAAO;qBACd;iBACF,CAAC;aACH,CAAC,CAAC;SACJ,CAAC;QAEF,WAAW,CAAC,SAAS,CAAC,OAAgB,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,CAAC;QAE1D,MAAM,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC;YAClC,KAAK,EAAE;gBACL,UAAU,EAAE,gBAAgB;gBAC5B,OAAO,EAAE,SAAS;gBAClB,IAAI,EAAE,OAAO;aACd;SACF,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAA,SAAE,EAAC,IAAI,CAAC,CAAC,CAAC;QACvC,MAAM,WAAW,GAAG,MAAM,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG;YACX,MAAM;SACP,CAAC;QACF,MAAM,OAAO,GAAG;YACd,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;SAC9B,CAAC;QAEF,WAAW,CAAC,SAAS,CAAC,OAAgB,EAAE,IAAI,CAAC,CAAC;QAE9C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,iBAAiB,CAAC,MAAiB;IAChD,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;QAC/C,SAAS,EAAE;YACT,uCAAkB;YAClB;gBACE,OAAO,EAAE,eAAM;gBACf,QAAQ,EAAE;oBACR,MAAM;iBACP;aACF;SACF;KACF,CAAC,CAAC,OAAO,EAAE,CAAC;IAEb,OAAO,SAAS,CAAC,GAAG,CAAC,uCAAkB,CAAC,CAAC;AAC3C,CAAC"}

package/dist/logger.module.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/logger.module.spec.js

@@ -0,0 +1,199 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_context_1 = require("@nest-boot/request-context");
+const testing_1 = require("@nestjs/testing");
+const mockChildLogger = {
+    ctx: "child",
+};
+const mockPinoLogger = {
+    child: jest.fn(() => mockChildLogger),
+};
+const mockPino = jest.fn(() => mockPinoLogger);
+const mockLoggerMiddleware = jest.fn((req) => {
+    req.log = {
+        child: jest.fn(() => mockChildLogger),
+    };
+});
+const mockPinoHttp = jest.fn(() => mockLoggerMiddleware);
+jest.mock("pino", () => ({
+    __esModule: true,
+    default: mockPino,
+}));
+jest.mock("pino-http", () => ({
+    __esModule: true,
+    default: mockPinoHttp,
+}));
+const logger_module_1 = require("./logger.module");
+const logger_module_definition_1 = require("./logger.module-definition");
+describe("LoggerModule", () => {
+    afterEach(() => {
+        jest.restoreAllMocks();
+        jest.clearAllMocks();
+    });
+    it("should register synchronous and asynchronous options", () => {
+        const options = {
+            autoLogging: false,
+        };
+        const dynamicModule = logger_module_1.LoggerModule.register(options);
+        const useFactory = () => options;
+        const asyncModule = logger_module_1.LoggerModule.registerAsync({
+            useFactory,
+        });
+        expect(dynamicModule.module).toBe(logger_module_1.LoggerModule);
+        expect(dynamicModule.providers).toEqual(expect.arrayContaining([
+            {
+                provide: logger_module_definition_1.MODULE_OPTIONS_TOKEN,
+                useValue: options,
+            },
+        ]));
+        expect(asyncModule.providers).toEqual(expect.arrayContaining([
+            {
+                inject: [],
+                provide: logger_module_definition_1.MODULE_OPTIONS_TOKEN,
+                useFactory,
+            },
+        ]));
+    });
+    it("should apply defaults while preserving supplied options", async () => {
+        const module = await createLoggerModule({
+            autoLogging: {
+                ignore: () => false,
+            },
+            customProps: () => ({
+                custom: true,
+            }),
+            genReqId: () => "custom-id",
+        });
+        const options = module.options;
+        expect(options.redact).toEqual([
+            "req.headers.authorization",
+            "req.headers.cookie",
+        ]);
+        expect(options.genReqId()).toBe("custom-id");
+        expect(options.customReceivedMessage()).toBe("request received");
+        expect(options.customProps()).toEqual({
+            custom: true,
+        });
+    });
+    it("should configure default request id, props, and auto logging behavior", async () => {
+        const module = await createLoggerModule();
+        const options = module.options;
+        jest.spyOn(request_context_1.RequestContext, "isActive").mockReturnValue(true);
+        jest.spyOn(request_context_1.RequestContext, "get").mockReturnValue({
+            tenantId: "tenant-1",
+        });
+        jest.spyOn(request_context_1.RequestContext, "id", "get").mockReturnValue("ctx-id");
+        process.env.NODE_ENV = "test";
+        expect(options.autoLogging.ignore({
+            headers: {
+                "x-logging": "false",
+            },
+        })).toBe(true);
+        expect(options.autoLogging.ignore({
+            headers: {},
+        })).toBe(false);
+        expect(options.genReqId()).toBe("ctx-id");
+        expect(options.customProps()).toEqual({
+            tenantId: "tenant-1",
+        });
+    });
+    it("should cover fallback defaults for boolean auto logging and inactive context", async () => {
+        const module = await createLoggerModule({
+            autoLogging: false,
+        });
+        const options = module.options;
+        jest.spyOn(request_context_1.RequestContext, "isActive").mockReturnValueOnce(false);
+        jest
+            .spyOn(request_context_1.RequestContext, "id", "get")
+            .mockReturnValue(undefined);
+        expect(options.autoLogging).toBe(false);
+        expect(options.customProps()).toEqual({});
+        expect(options.genReqId()).toEqual(expect.any(String));
+    });
+    it("should return empty custom props when bindings are not set", async () => {
+        const module = await createLoggerModule();
+        const options = module.options;
+        jest.spyOn(request_context_1.RequestContext, "isActive").mockReturnValue(true);
+        jest.spyOn(request_context_1.RequestContext, "get").mockReturnValue(undefined);
+        expect(options.customProps()).toEqual({});
+    });
+    it("should emit decorator metadata when options exist at runtime", () => {
+        jest.isolateModules(() => {
+            jest.doMock("./logger-module-options.interface", () => {
+                var _a;
+                return ({
+                    LoggerModuleOptions: (_a = class LoggerModuleOptions {
+                        },
+                        _a.marker = true,
+                        _a),
+                });
+            });
+            expect(jest.requireActual("./logger.module")
+                .LoggerModule).toBeDefined();
+            jest.dontMock("./logger-module-options.interface");
+        });
+    });
+    it("should register pino logger middleware for requests", async () => {
+        const module = await createLoggerModule();
+        const registerMiddleware = jest
+            .spyOn(request_context_1.RequestContext, "registerMiddleware")
+            .mockImplementation();
+        module.onModuleInit();
+        const middleware = registerMiddleware.mock.calls[0][1];
+        const req = {};
+        const res = {};
+        const ctx = {
+            get: jest.fn((token) => {
+                if (token === request_context_1.REQUEST)
+                    return req;
+                if (token === request_context_1.RESPONSE)
+                    return res;
+                return undefined;
+            }),
+            id: "ctx-id",
+            set: jest.fn(),
+            type: "http",
+        };
+        const next = jest.fn().mockResolvedValue("next-result");
+        await expect(middleware(ctx, next)).resolves.toBe("next-result");
+        expect(mockLoggerMiddleware).toHaveBeenCalledWith(req, res);
+        expect(ctx.set).toHaveBeenCalledWith(logger_module_definition_1.PINO_LOGGER, mockChildLogger);
+    });
+    it("should register fallback pino logger middleware without request objects", async () => {
+        const module = await createLoggerModule();
+        const registerMiddleware = jest
+            .spyOn(request_context_1.RequestContext, "registerMiddleware")
+            .mockImplementation();
+        module.onModuleInit();
+        const middleware = registerMiddleware.mock.calls[0][1];
+        const ctx = {
+            get: jest.fn(() => undefined),
+            id: "ctx-id",
+            set: jest.fn(),
+            type: "job",
+        };
+        const next = jest.fn().mockResolvedValue("next-result");
+        await expect(middleware(ctx, next)).resolves.toBe("next-result");
+        expect(mockPinoLogger.child).toHaveBeenCalledWith({
+            ctx: {
+                id: "ctx-id",
+                type: "job",
+            },
+        });
+        expect(ctx.set).toHaveBeenCalledWith(logger_module_definition_1.PINO_LOGGER, mockChildLogger);
+    });
+});
+async function createLoggerModule(options) {
+    const providers = [logger_module_1.LoggerModule];
+    if (typeof options !== "undefined") {
+        providers?.push({
+            provide: logger_module_definition_1.MODULE_OPTIONS_TOKEN,
+            useValue: options,
+        });
+    }
+    const moduleRef = await testing_1.Test.createTestingModule({
+        providers,
+    }).compile();
+    return moduleRef.get(logger_module_1.LoggerModule);
+}
+//# sourceMappingURL=logger.module.spec.js.map

package/dist/logger.module.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.module.spec.js","sourceRoot":"","sources":["../src/logger.module.spec.ts"],"names":[],"mappings":";;AAAA,gEAA+E;AAC/E,6CAAuC;AAEvC,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,OAAO;CACb,CAAC;AACF,MAAM,cAAc,GAAG;IACrB,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC;CACtC,CAAC;AACF,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,CAAC;AAC/C,MAAM,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,EAAE;IAC3C,GAAG,CAAC,GAAG,GAAG;QACR,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC;KACtC,CAAC;AACJ,CAAC,CAAC,CAAC;AACH,MAAM,YAAY,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC;AAEzD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACvB,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,QAAQ;CAClB,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;IAC5B,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,YAAY;CACtB,CAAC,CAAC,CAAC;AAEJ,mDAA+C;AAC/C,yEAA+E;AAG/E,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG;YACd,WAAW,EAAE,KAAK;SACnB,CAAC;QACF,MAAM,aAAa,GAAG,4BAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACrD,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;QACjC,MAAM,WAAW,GAAG,4BAAY,CAAC,aAAa,CAAC;YAC7C,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,4BAAY,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,OAAO,EAAE,+CAAoB;gBAC7B,QAAQ,EAAE,OAAO;aAClB;SACF,CAAC,CACH,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,OAAO,CACnC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,MAAM,EAAE,EAAE;gBACV,OAAO,EAAE,+CAAoB;gBAC7B,UAAU;aACX;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC;YACtC,WAAW,EAAE;gBACX,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK;aACpB;YACD,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC;gBAClB,MAAM,EAAE,IAAI;aACb,CAAC;YACF,QAAQ,EAAE,GAAG,EAAE,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,OAAO,GAAI,MAAsC,CAAC,OAAO,CAAC;QAEhE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YAC7B,2BAA2B;YAC3B,oBAAoB;SACrB,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,MAAM,CAAC,OAAO,CAAC,qBAAqB,EAAE,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACjE,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;YACpC,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAI,MAAsC,CAAC,OAAO,CAAC;QAChE,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,UAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC;YAChD,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAElE,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC;QAE9B,MAAM,CACJ,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE;gBACP,WAAW,EAAE,OAAO;aACrB;SACF,CAAC,CACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,MAAM,CACJ,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;YACzB,OAAO,EAAE,EAAE;SACZ,CAAC,CACH,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACd,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC;YACpC,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8EAA8E,EAAE,KAAK,IAAI,EAAE;QAC5F,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC;YACtC,WAAW,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,MAAM,OAAO,GAAI,MAAsC,CAAC,OAAO,CAAC;QAChE,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,UAAU,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAClE,IAAI;aACD,KAAK,CAAC,gCAAc,EAAE,IAAI,EAAE,KAAK,CAAC;aAClC,eAAe,CAAC,SAA8B,CAAC,CAAC;QAEnD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC1C,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC1C,MAAM,OAAO,GAAI,MAAsC,CAAC,OAAO,CAAC;QAChE,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,UAAU,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAE7D,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE;YACvB,IAAI,CAAC,MAAM,CAAC,mCAAmC,EAAE,GAAG,EAAE;;gBAAC,OAAA,CAAC;oBACtD,mBAAmB,QAAE,MAAM,mBAAmB;yBAE7C;wBADiB,SAAM,GAAG,IAAK;2BAC/B;iBACF,CAAC,CAAA;aAAA,CAAC,CAAC;YAEJ,MAAM,CACJ,IAAI,CAAC,aAAa,CAAmC,iBAAiB,CAAC;iBACpE,YAAY,CAChB,CAAC,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,QAAQ,CAAC,mCAAmC,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC1C,MAAM,kBAAkB,GAAG,IAAI;aAC5B,KAAK,CAAC,gCAAc,EAAE,oBAAoB,CAAC;aAC3C,kBAAkB,EAAE,CAAC;QAExB,MAAM,CAAC,YAAY,EAAE,CAAC;QAEtB,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,EAAE,CAAC;QACf,MAAM,GAAG,GAAG;YACV,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrB,IAAI,KAAK,KAAK,yBAAO;oBAAE,OAAO,GAAG,CAAC;gBAClC,IAAI,KAAK,KAAK,0BAAQ;oBAAE,OAAO,GAAG,CAAC;gBACnC,OAAO,SAAS,CAAC;YACnB,CAAC,CAAC;YACF,EAAE,EAAE,QAAQ;YACZ,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,IAAI,EAAE,MAAM;SACb,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAExD,MAAM,MAAM,CAAC,UAAU,CAAC,GAAY,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE1E,MAAM,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,sCAAW,EAAE,eAAe,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,MAAM,GAAG,MAAM,kBAAkB,EAAE,CAAC;QAC1C,MAAM,kBAAkB,GAAG,IAAI;aAC5B,KAAK,CAAC,gCAAc,EAAE,oBAAoB,CAAC;aAC3C,kBAAkB,EAAE,CAAC;QAExB,MAAM,CAAC,YAAY,EAAE,CAAC;QAEtB,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG;YACV,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;YAC7B,EAAE,EAAE,QAAQ;YACZ,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE;YACd,IAAI,EAAE,KAAK;SACZ,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAExD,MAAM,MAAM,CAAC,UAAU,CAAC,GAAY,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAE1E,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAAC;YAChD,GAAG,EAAE;gBACH,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,KAAK;aACZ;SACF,CAAC,CAAC;QACH,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,sCAAW,EAAE,eAAe,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,kBAAkB,CAAC,OAA6B;IAC7D,MAAM,SAAS,GACb,CAAC,4BAAY,CAAC,CAAC;IAEjB,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACnC,SAAS,EAAE,IAAI,CAAC;YACd,OAAO,EAAE,+CAAoB;YAC7B,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;QAC/C,SAAS;KACV,CAAC,CAAC,OAAO,EAAE,CAAC;IAEb,OAAO,SAAS,CAAC,GAAG,CAAC,4BAAY,CAAC,CAAC;AACrC,CAAC"}

package/dist/logger.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/logger.spec.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_context_1 = require("@nest-boot/request-context");
+const core_1 = require("@nestjs/core");
+const testing_1 = require("@nestjs/testing");
+const mockPinoLogger = {
+    child: jest.fn(),
+    debug: jest.fn(),
+    error: jest.fn(),
+    info: jest.fn(),
+    trace: jest.fn(),
+    warn: jest.fn(),
+};
+const mockPino = jest.fn(() => mockPinoLogger);
+jest.mock("pino", () => ({
+    __esModule: true,
+    default: mockPino,
+}));
+const logger_1 = require("./logger");
+const logger_module_definition_1 = require("./logger.module-definition");
+class ParentService {
+}
+describe("Logger", () => {
+    afterEach(() => {
+        jest.restoreAllMocks();
+        jest.clearAllMocks();
+    });
+    it("should default context to the parent class name and allow overriding it", async () => {
+        const logger = await createLogger();
+        expect(logger.getContext()).toBe("ParentService");
+        logger.setContext("CustomContext");
+        expect(logger.getContext()).toBe("CustomContext");
+    });
+    it("should merge bindings into request context", async () => {
+        jest.spyOn(request_context_1.RequestContext, "get").mockReturnValue({
+            requestId: "request-1",
+        });
+        const set = jest.spyOn(request_context_1.RequestContext, "set").mockImplementation();
+        const logger = await createLogger();
+        logger.assign({
+            tenantId: "tenant-1",
+        });
+        expect(set).toHaveBeenCalledWith(logger_module_definition_1.BINDINGS, {
+            requestId: "request-1",
+            tenantId: "tenant-1",
+        });
+    });
+    it("should assign bindings when request context has no existing bindings", async () => {
+        jest.spyOn(request_context_1.RequestContext, "get").mockReturnValue(undefined);
+        const set = jest.spyOn(request_context_1.RequestContext, "set").mockImplementation();
+        const logger = await createLogger();
+        logger.assign({
+            tenantId: "tenant-1",
+        });
+        expect(set).toHaveBeenCalledWith(logger_module_definition_1.BINDINGS, {
+            tenantId: "tenant-1",
+        });
+    });
+    it("should log with the global pino logger when request context is inactive", async () => {
+        jest.spyOn(request_context_1.RequestContext, "get").mockImplementation(() => {
+            throw new Error("Request context is not active");
+        });
+        const logger = await createLogger();
+        logger.verbose("trace message");
+        logger.debug("debug message");
+        logger.log("info message", { requestId: "request-1" }, "Override");
+        logger.warn("warn message");
+        logger.error("error message");
+        expect(mockPino).toHaveBeenCalledTimes(1);
+        expect(mockPinoLogger.trace).toHaveBeenCalledWith({
+            context: "ParentService",
+        }, "trace message");
+        expect(mockPinoLogger.debug).toHaveBeenCalledWith({
+            context: "ParentService",
+        }, "debug message");
+        expect(mockPinoLogger.info).toHaveBeenCalledWith({
+            context: "Override",
+            requestId: "request-1",
+        }, "info message");
+        expect(mockPinoLogger.warn).toHaveBeenCalledWith({
+            context: "ParentService",
+        }, "warn message");
+        expect(mockPinoLogger.error).toHaveBeenCalledWith({
+            context: "ParentService",
+        }, "error message");
+    });
+    it("should log with request-scoped pino logger and bindings", async () => {
+        const requestLogger = {
+            warn: jest.fn(),
+        };
+        jest.spyOn(request_context_1.RequestContext, "get").mockImplementation((token) => {
+            if (token === logger_module_definition_1.PINO_LOGGER)
+                return requestLogger;
+            if (token === logger_module_definition_1.BINDINGS) {
+                return {
+                    requestId: "request-1",
+                };
+            }
+            return undefined;
+        });
+        const logger = await createLogger();
+        logger.warn("warn message");
+        expect(requestLogger.warn).toHaveBeenCalledWith({
+            context: "ParentService",
+            requestId: "request-1",
+        }, "warn message");
+    });
+    it("should log with empty bindings when request context has no bindings", async () => {
+        const requestLogger = {
+            debug: jest.fn(),
+        };
+        jest.spyOn(request_context_1.RequestContext, "get").mockImplementation((token) => {
+            if (token === logger_module_definition_1.PINO_LOGGER)
+                return requestLogger;
+            return undefined;
+        });
+        const logger = await createLogger();
+        logger.debug("debug message");
+        expect(requestLogger.debug).toHaveBeenCalledWith({
+            context: "ParentService",
+        }, "debug message");
+    });
+});
+async function createLogger() {
+    const moduleRef = await testing_1.Test.createTestingModule({
+        providers: [
+            logger_1.Logger,
+            {
+                provide: core_1.INQUIRER,
+                useValue: new ParentService(),
+            },
+        ],
+    }).compile();
+    return await moduleRef.resolve(logger_1.Logger);
+}
+//# sourceMappingURL=logger.spec.js.map

package/dist/logger.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.spec.js","sourceRoot":"","sources":["../src/logger.spec.ts"],"names":[],"mappings":";;AAAA,gEAA4D;AAC5D,uCAAwC;AACxC,6CAAuC;AAEvC,MAAM,cAAc,GAAG;IACrB,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;IAChB,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;IAChB,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;IAChB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;IACf,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;IAChB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;CAChB,CAAC;AACF,MAAM,QAAQ,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,CAAC;AAE/C,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IACvB,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,QAAQ;CAClB,CAAC,CAAC,CAAC;AAEJ,qCAAkC;AAClC,yEAAmE;AAEnE,MAAM,aAAa;CAAG;AAEtB,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAElD,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QAEnC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC;YAChD,SAAS,EAAE,WAAW;SACvB,CAAC,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACnE,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,MAAM,CAAC;YACZ,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;QAEH,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,mCAAQ,EAAE;YACzC,SAAS,EAAE,WAAW;YACtB,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC;QACnE,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,MAAM,CAAC;YACZ,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;QAEH,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,mCAAQ,EAAE;YACzC,QAAQ,EAAE,UAAU;SACrB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACvF,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;YACxD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAChC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAC9B,MAAM,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE,UAAU,CAAC,CAAC;QACnE,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,MAAM,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAC/C;YACE,OAAO,EAAE,eAAe;SACzB,EACD,eAAe,CAChB,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAC/C;YACE,OAAO,EAAE,eAAe;SACzB,EACD,eAAe,CAChB,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAC9C;YACE,OAAO,EAAE,UAAU;YACnB,SAAS,EAAE,WAAW;SACvB,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAC9C;YACE,OAAO,EAAE,eAAe;SACzB,EACD,cAAc,CACf,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAC/C;YACE,OAAO,EAAE,eAAe;SACzB,EACD,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,aAAa,GAAG;YACpB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;SAChB,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7D,IAAI,KAAK,KAAK,sCAAW;gBAAE,OAAO,aAAa,CAAC;YAChD,IAAI,KAAK,KAAK,mCAAQ,EAAE,CAAC;gBACvB,OAAO;oBACL,SAAS,EAAE,WAAW;iBACvB,CAAC;YACJ,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE5B,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAC7C;YACE,OAAO,EAAE,eAAe;YACxB,SAAS,EAAE,WAAW;SACvB,EACD,cAAc,CACf,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,aAAa,GAAG;YACpB,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;SACjB,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC,CAAC,kBAAkB,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7D,IAAI,KAAK,KAAK,sCAAW;gBAAE,OAAO,aAAa,CAAC;YAChD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,YAAY,EAAE,CAAC;QAEpC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,oBAAoB,CAC9C;YACE,OAAO,EAAE,eAAe;SACzB,EACD,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,KAAK,UAAU,YAAY;IACzB,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;QAC/C,SAAS,EAAE;YACT,eAAM;YACN;gBACE,OAAO,EAAE,eAAQ;gBACjB,QAAQ,EAAE,IAAI,aAAa,EAAE;aAC9B;SACF;KACF,CAAC,CAAC,OAAO,EAAE,CAAC;IAEb,OAAO,MAAM,SAAS,CAAC,OAAO,CAAC,eAAM,CAAC,CAAC;AACzC,CAAC"}