refactor(logging): separate console and debug logger classes
- Preserve TraceLogger console formatting and add DebugLogger with DEBUG namespace output. - Select the logger through LOG_MODE and route application call sites through the factory. - Cover factory selection, console formatting, debug output and auth-log redaction.
This commit is contained in:
1 parent
ceed27ad9e
commit
7235abdcef
16 files changed
+146
-142
No files matched your search
@@ -1,6 +1,6 @@
|
||||
import { CallHandler, ExecutionContext } from "@nestjs/common";
|
||||
import { of } from "rxjs";
|
||||
import { TraceLogger } from "../src/common/trace-logger";
|
||||
import { DebugLogger } from "../src/common/debug-logger";
|
||||
import {
|
||||
LoggingInterceptor,
|
||||
redactAuthRequestBody,
|
||||
@@ -31,7 +31,7 @@ describe("redactAuthRequestBody", () => {
|
||||
it("never logs a password received on the accepted trailing-slash login path", () => {
|
||||
const loggedMessages: unknown[][] = [];
|
||||
const debug = jest
|
||||
.spyOn(TraceLogger.prototype, "debug")
|
||||
.spyOn(DebugLogger.prototype, "debug")
|
||||
.mockImplementation((...args: unknown[]) => {
|
||||
loggedMessages.push(args);
|
||||
});
|
||||
|
||||
@@ -1,10 +1,12 @@
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
import createDebug = require("debug");
|
||||
import { createAppLogger } from "../src/common/app-logger";
|
||||
import { DebugLogger } from "../src/common/debug-logger";
|
||||
import { TraceLogger } from "../src/common/trace-logger";
|
||||
import { traceStorage } from "../src/common/trace-context";
|
||||
import { LogMode } from "../src/config/app.config";
|
||||
|
||||
describe("TraceLogger output mode", () => {
|
||||
describe("application logger selection and output", () => {
|
||||
const originalLogMode = process.env.LOG_MODE;
|
||||
const originalNodeEnv = process.env.NODE_ENV;
|
||||
const originalDebug = createDebug.disable();
|
||||
@@ -13,12 +15,8 @@ describe("TraceLogger output mode", () => {
|
||||
let stderr: jest.SpyInstance;
|
||||
|
||||
beforeEach(() => {
|
||||
stdout = jest
|
||||
.spyOn(process.stdout, "write")
|
||||
.mockImplementation(() => true);
|
||||
stderr = jest
|
||||
.spyOn(process.stderr, "write")
|
||||
.mockImplementation(() => true);
|
||||
stdout = jest.spyOn(process.stdout, "write").mockImplementation(() => true);
|
||||
stderr = jest.spyOn(process.stderr, "write").mockImplementation(() => true);
|
||||
createDebug.disable();
|
||||
});
|
||||
|
||||
@@ -35,18 +33,43 @@ describe("TraceLogger output mode", () => {
|
||||
|
||||
it("keeps console output as the default", () => {
|
||||
delete process.env.LOG_MODE;
|
||||
new TraceLogger("Runtime").log("visible by default");
|
||||
expect(createAppLogger("Runtime")).toBeInstanceOf(TraceLogger);
|
||||
expect(
|
||||
createAppLogger("Runtime").log("visible by default"),
|
||||
).toBeUndefined();
|
||||
|
||||
expect(stdout).toHaveBeenCalled();
|
||||
expect(stderr).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("keeps TraceLogger on console regardless of LOG_MODE", () => {
|
||||
process.env.LOG_MODE = LogMode.Debug;
|
||||
new TraceLogger("Runtime").log("trace logger stays on console");
|
||||
|
||||
expect(stdout).toHaveBeenCalled();
|
||||
expect(stderr).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("preserves timestamp, level and trace context in console output", () => {
|
||||
const before = Date.now();
|
||||
traceStorage.run({ traceId: "trace-console" }, () => {
|
||||
new TraceLogger("Runtime", { colors: false }).log("legacy format");
|
||||
});
|
||||
const output = stdout.mock.calls.flat().join("");
|
||||
const timestamp = output.match(/\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d{3}Z/);
|
||||
|
||||
expect(timestamp).not.toBeNull();
|
||||
expect(Date.parse(timestamp![0])).toBeGreaterThanOrEqual(before);
|
||||
expect(output).toContain(" LOG [Runtime:trace-console] legacy format");
|
||||
});
|
||||
|
||||
it("writes debug-mode output only when its namespace is enabled", () => {
|
||||
process.env.LOG_MODE = LogMode.Debug;
|
||||
process.env.NODE_ENV = "production";
|
||||
createDebug.enable("liqa:other");
|
||||
|
||||
new TraceLogger("Runtime").warn("quiet without matching namespace");
|
||||
expect(createAppLogger("Runtime")).toBeInstanceOf(DebugLogger);
|
||||
createAppLogger("Runtime").warn("quiet without matching namespace");
|
||||
|
||||
expect(stdout).not.toHaveBeenCalled();
|
||||
expect(stderr).not.toHaveBeenCalled();
|
||||
@@ -58,7 +81,7 @@ describe("TraceLogger output mode", () => {
|
||||
createDebug.enable("liqa:runtime");
|
||||
|
||||
traceStorage.run({ traceId: "trace-123" }, () => {
|
||||
new TraceLogger("Runtime").error(
|
||||
createAppLogger("Runtime").error(
|
||||
"request failed",
|
||||
"synthetic stack\n at test()",
|
||||
"Runtime",
|
||||
@@ -76,7 +99,7 @@ describe("TraceLogger output mode", () => {
|
||||
process.env.NODE_ENV = "test";
|
||||
createDebug.enable("test");
|
||||
|
||||
new TraceLogger("Unit").debug("test diagnostic");
|
||||
createAppLogger("Unit").debug("test diagnostic");
|
||||
|
||||
expect(stdout).not.toHaveBeenCalled();
|
||||
expect(stderr.mock.calls.flat().join("")).toContain("test diagnostic");
|
||||
|
||||
Reference in new issue
Block a user