Files
liqa/server/test/trace-logger.spec.ts
T
agent 7235abdcef
CI / changes (pull_request) Successful in 6s
CI / server (pull_request) Failing after 34m29s
CI / client (pull_request) Successful in 3m0s
CI / image (pull_request) Skipped
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.
2026-11-11 14:30:37 -05:00

108 lines
3.8 KiB
TypeScript

// 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("application logger selection and output", () => {
const originalLogMode = process.env.LOG_MODE;
const originalNodeEnv = process.env.NODE_ENV;
const originalDebug = createDebug.disable();
let stdout: jest.SpyInstance;
let stderr: jest.SpyInstance;
beforeEach(() => {
stdout = jest.spyOn(process.stdout, "write").mockImplementation(() => true);
stderr = jest.spyOn(process.stderr, "write").mockImplementation(() => true);
createDebug.disable();
});
afterEach(() => {
stdout.mockRestore();
stderr.mockRestore();
createDebug.disable();
if (originalDebug) createDebug.enable(originalDebug);
if (originalLogMode === undefined) delete process.env.LOG_MODE;
else process.env.LOG_MODE = originalLogMode;
if (originalNodeEnv === undefined) delete process.env.NODE_ENV;
else process.env.NODE_ENV = originalNodeEnv;
});
it("keeps console output as the default", () => {
delete process.env.LOG_MODE;
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");
expect(createAppLogger("Runtime")).toBeInstanceOf(DebugLogger);
createAppLogger("Runtime").warn("quiet without matching namespace");
expect(stdout).not.toHaveBeenCalled();
expect(stderr).not.toHaveBeenCalled();
});
it("routes matching debug output with level, context, trace id and error detail", () => {
process.env.LOG_MODE = LogMode.Debug;
process.env.NODE_ENV = "production";
createDebug.enable("liqa:runtime");
traceStorage.run({ traceId: "trace-123" }, () => {
createAppLogger("Runtime").error(
"request failed",
"synthetic stack\n at test()",
"Runtime",
);
});
const output = stderr.mock.calls.flat().join("");
expect(stdout).not.toHaveBeenCalled();
expect(output).toContain("[ERROR] [Runtime:trace-123] request failed");
expect(output).toContain("synthetic stack");
});
it("preserves DEBUG=test for test-process logging", () => {
process.env.LOG_MODE = LogMode.Debug;
process.env.NODE_ENV = "test";
createDebug.enable("test");
createAppLogger("Unit").debug("test diagnostic");
expect(stdout).not.toHaveBeenCalled();
expect(stderr.mock.calls.flat().join("")).toContain("test diagnostic");
});
});