@nest-boot/logger 7.0.4 → 7.1.0

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"}