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.
This commit is contained in:
agent committed 2026-11-11 13:31:48 -05:00
1 parent ff9a700c86
commit ceed27ad9e
10 files changed
+214 -4

No files matched your search

+12 -1
View File
@@ -1,5 +1,5 @@
import "reflect-metadata";
import { validateAppConfig } from "../src/config/app.config";
import { LogMode, validateAppConfig } from "../src/config/app.config";
import { durationSeconds } from "../src/common/interval";
describe("Authentication configuration", () => {
@@ -12,6 +12,17 @@ describe("Authentication configuration", () => {
expect(config.AUTH_REVOKED_TOKEN_CLEANUP_CRON).toBe("0 3 * * *");
});
it("defaults to console logging and accepts debug logging", () => {
expect(validateAppConfig({}).LOG_MODE).toBe(LogMode.Console);
expect(validateAppConfig({ LOG_MODE: "debug" }).LOG_MODE).toBe(
LogMode.Debug,
);
});
it("rejects unsupported logging modes", () => {
expect(() => validateAppConfig({ LOG_MODE: "silent" })).toThrow();
});
it("parses explicit true and false values without JavaScript truthiness", () => {
expect(validateAppConfig({ AUTH_ENABLED: "false" }).AUTH_ENABLED).toBe(
false,
+2
View File
@@ -0,0 +1,2 @@
// Application logs should stay quiet during tests unless DEBUG enables them.
process.env.LOG_MODE = 'debug';
+84
View File
@@ -0,0 +1,84 @@
// 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");
});
});