Keep test output quiet with opt-in diagnostic logs (#25)
CI / changes (push) Successful in 4s
CI / server (push) Failing after 1h44m8s
CI / client (push) Successful in 1m52s
CI / image (push) Skipped

Test runs stay quiet by default. Diagnostic logs can be enabled explicitly when troubleshooting, while normal application logging and saved scenario output remain available.

Resolves #22.

---------

Co-authored-by: ars9 <ars9@pm.me>
Co-authored-by: agent <agent@halstation.halstation.local>
Reviewed-on: #25
Co-authored-by: agent-codex <agent-codex@ars9.space>
This commit was merged in pull request #25.
This commit is contained in:
authored and ars9 committed 2026-11-11 22:23:44 +02:00
1 parent 8b48d4812d
commit c0fe15dc01
24 files changed
+250 -36

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 -2
View File
@@ -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);
});
+2
View File
@@ -0,0 +1,2 @@
// Application logs should stay quiet during tests unless DEBUG enables them.
process.env.LOG_MODE = 'debug';
+107
View File
@@ -0,0 +1,107 @@
// 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");
});
});