Files
liqa/server/test/trace-logger.spec.ts
T
agent ceed27ad9e feat(logging): add opt-in debug logging mode
- Add validated LOG_MODE configuration and route trace-aware diagnostics through debug.
- Select debug mode in shared test setup while preserving DEBUG namespace control.
- Add logger/config regression coverage and document runtime configuration.
2026-11-11 13:31:48 -05:00

85 lines
2.7 KiB
TypeScript

// eslint-disable-next-line @typescript-eslint/no-require-imports
import createDebug = require("debug");
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", () => {
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;
new TraceLogger("Runtime").log("visible by default");
expect(stdout).toHaveBeenCalled();
expect(stderr).not.toHaveBeenCalled();
});
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(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" }, () => {
new TraceLogger("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");
new TraceLogger("Unit").debug("test diagnostic");
expect(stdout).not.toHaveBeenCalled();
expect(stderr.mock.calls.flat().join("")).toContain("test diagnostic");
});
});