@elisra-devops/docgen-skins 0.28.0 → 0.29.0

package/bin/test/logger.test.js

@@ -0,0 +1,272 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston = __importStar(require("winston"));
+const winston_transport_1 = __importDefault(require("winston-transport"));
+const logger_1 = require("../services/logger");
+const logSink_1 = require("../services/logSink");
+const runContext_1 = require("../services/runContext");
+const applyRedact = (info) => (0, logger_1.redact)().transform(Object.assign({}, info));
+describe('logger redact format', () => {
+    test('scrubs a top-level token/password/secret regardless of key casing', () => {
+        const out = applyRedact({ level: 'info', message: 'x', token: 'abc', Password: 'p', SECRET: 's' });
+        expect(out.token).toBe('[REDACTED]');
+        expect(out.Password).toBe('[REDACTED]');
+        expect(out.SECRET).toBe('[REDACTED]');
+    });
+    test('scrubs nested config.auth.password and config.headers.Authorization — the AxiosError.toJSON() leak', () => {
+        const axiosLikeError = {
+            message: 'Request failed',
+            config: {
+                auth: { username: '', password: 'super-secret-pat' },
+                headers: { Authorization: 'Bearer abc.def.ghi' },
+            },
+        };
+        const out = applyRedact({ level: 'error', message: 'upstream failed', err: axiosLikeError });
+        expect(out.err.config.auth.password).toBe('[REDACTED]');
+        expect(out.err.config.headers.Authorization).toBe('[REDACTED]');
+        expect(out.err.message).toBe('Request failed');
+    });
+    test('leaves non-sensitive fields untouched', () => {
+        const out = applyRedact({ level: 'info', message: 'ok', project: 'Cube-ADCS', docType: 'SVD' });
+        expect(out.project).toBe('Cube-ADCS');
+        expect(out.docType).toBe('SVD');
+    });
+    test('never throws on a circular object', () => {
+        const circular = { name: 'x' };
+        circular.self = circular;
+        expect(() => applyRedact({ level: 'info', message: 'x', circular })).not.toThrow();
+    });
+    test('never throws and passes info through on null/undefined meta', () => {
+        expect(() => applyRedact({ level: 'info', message: 'x', meta: null })).not.toThrow();
+        expect(() => applyRedact({ level: 'info', message: 'x', meta: undefined })).not.toThrow();
+    });
+});
+// A capturing transport + the exact JSON format chain logger.ts uses (errors -> timestamp ->
+// redact -> splat -> json), so these tests exercise the real pipeline, not just redact() alone.
+class CaptureTransport extends winston_transport_1.default {
+    constructor() {
+        super(...arguments);
+        this.lines = [];
+    }
+    log(info, callback) {
+        var _a;
+        this.lines.push(JSON.parse((_a = info[Symbol.for('message')]) !== null && _a !== void 0 ? _a : JSON.stringify(info)));
+        callback();
+    }
+}
+function makeTestLogger() {
+    const capture = new CaptureTransport();
+    const logger = winston.createLogger({
+        level: 'silly',
+        format: winston.format.combine(winston.format.errors({ stack: true }), winston.format.timestamp(), (0, logger_1.redact)(), winston.format.splat(), winston.format.json()),
+        transports: [capture],
+    });
+    return { logger, capture };
+}
+describe('logger pipeline — errors({stack:true})', () => {
+    test('logger.error(err) (single-arg Error) still produces a non-empty message and a stack', () => {
+        // This is the regression errors({stack:true}) exists to prevent: without it, winston's
+        // single-arg path makes `info` *be* the Error, and message/stack are non-enumerable, so
+        // json() would emit {"level":"error","timestamp":"…"} — content-free.
+        const { logger, capture } = makeTestLogger();
+        logger.error(new Error('boom'));
+        expect(capture.lines).toHaveLength(1);
+        expect(capture.lines[0].message).toBe('boom');
+        expect(typeof capture.lines[0].stack).toBe('string');
+        expect(capture.lines[0].stack.length).toBeGreaterThan(0);
+    });
+});
+describe('logger pipeline — hostile inputs never throw', () => {
+    test.each([
+        ['null', null],
+        ['undefined', undefined],
+        ['NaN', NaN],
+        ['a circular object', (() => { const c = { a: 1 }; c.self = c; return c; })()],
+        ['an object with a throwing getter', { get boom() { throw new Error('nope'); } }],
+        ['a BigInt', BigInt(9007199254740993)],
+        ['a Symbol', Symbol('x')],
+        ['an Error with no message', new Error()],
+        ['a 10MB string', 'x'.repeat(10 * 1024 * 1024)],
+    ])('logger.error(%s) does not throw', (_label, value) => {
+        const { logger } = makeTestLogger();
+        expect(() => logger.error(value)).not.toThrow();
+    });
+});
+describe('DiagnosticsTransport (Phase 6a)', () => {
+    function makeDiagnosticsLogger() {
+        const capture = new CaptureTransport();
+        const logger = winston.createLogger({
+            level: 'silly',
+            format: winston.format.combine(winston.format.errors({ stack: true }), winston.format.timestamp(), (0, logger_1.redact)(), winston.format.splat(), winston.format.json()),
+            transports: [capture, new logger_1.DiagnosticsTransport()],
+        });
+        return { logger, capture };
+    }
+    test('pushes warn/error records to whatever sink is installed', () => {
+        var _a, _b;
+        const events = [];
+        const sink = { push: (e) => events.push(e) };
+        (0, logSink_1.installLogSink)(sink);
+        const { logger } = makeDiagnosticsLogger();
+        logger.warn('a stable warning');
+        logger.error('a stable error', Object.assign(new Error('boom'), { code: 'ECONN' }));
+        expect(events).toHaveLength(2);
+        expect(events[0].level).toBe('warn');
+        expect((_a = events[1].err) === null || _a === void 0 ? void 0 : _a.code).toBe('ECONN');
+        expect((_b = events[1].err) === null || _b === void 0 ? void 0 : _b.stack).toEqual(expect.any(String));
+    });
+    test('does not push info/debug records', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        logger.info('not interesting to the dashboard');
+        expect(events).toHaveLength(0);
+    });
+    test('a throwing sink cannot break the log call', () => {
+        (0, logSink_1.installLogSink)({
+            push: () => {
+                throw new Error('sink is down');
+            },
+        });
+        const { logger } = makeDiagnosticsLogger();
+        expect(() => logger.error('still must not throw')).not.toThrow();
+    });
+    test.each([
+        ['null', null],
+        ['undefined', undefined],
+        ['NaN', NaN],
+        ['a circular object', (() => { const c = { a: 1 }; c.self = c; return c; })()],
+        ['an object with a throwing getter', { get boom() { throw new Error('nope'); } }],
+        ['a BigInt', BigInt(9007199254740993)],
+        ['a Symbol', Symbol('x')],
+        ['an Error with no message', new Error()],
+        ['a 10MB string', 'x'.repeat(10 * 1024 * 1024)],
+    ])('logger.error(%s) with a sink installed does not throw', (_label, value) => {
+        (0, logSink_1.installLogSink)({ push: () => undefined });
+        const { logger } = makeDiagnosticsLogger();
+        expect(() => logger.error(value)).not.toThrow();
+    });
+});
+describe('textFormat safety (regression)', () => {
+    // The hostile-input matrix above exercises makeTestLogger()'s json() pipeline — it never
+    // touched the real singleton logger's text-format branch (LOG_FORMAT's default), which is
+    // where a Symbol message crashed: a template literal's implicit ToString throws on a Symbol,
+    // and this formatter sits with no try/catch around it.
+    test('logger.error(Symbol) does not throw through the real default-exported logger', () => {
+        // eslint-disable-next-line @typescript-eslint/no-var-requires
+        const logger = require('../services/logger').default;
+        expect(() => logger.error(Symbol('x'))).not.toThrow();
+    });
+});
+describe('DiagnosticsTransport capture policy (Phase 6b)', () => {
+    function makeDiagnosticsLogger() {
+        const capture = new CaptureTransport();
+        const logger = winston.createLogger({
+            level: 'silly',
+            format: winston.format.combine(winston.format.errors({ stack: true }), winston.format.timestamp(), (0, logger_1.redact)(), winston.format.splat(), winston.format.json()),
+            transports: [capture, new logger_1.DiagnosticsTransport()],
+        });
+        return { logger, capture };
+    }
+    test('normal mode (no captureMode) does not persist debug/info', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'run-1' }, () => {
+            logger.debug('a debug line');
+            logger.info('an info line');
+        });
+        expect(events).toHaveLength(0);
+    });
+    test('verbose mode persists debug and info', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'run-2', captureMode: 'verbose' }, () => {
+            logger.debug('a debug line');
+            logger.info('an info line');
+        });
+        expect(events).toHaveLength(2);
+        expect(events[0].retainPending).toBeUndefined();
+    });
+    test('warn/error persist regardless of capture mode', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'run-3' }, () => {
+            logger.warn('a warning');
+            logger.error('an error');
+        });
+        expect(events).toHaveLength(2);
+    });
+    test('retain-on-failure persists debug/info tagged retainPending: true', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'run-4', captureMode: 'retain-on-failure' }, () => {
+            logger.debug('a debug line');
+        });
+        expect(events).toHaveLength(1);
+        expect(events[0].retainPending).toBe(true);
+    });
+    test('retain-on-failure does not tag warn/error as retainPending', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'run-5', captureMode: 'retain-on-failure' }, () => {
+            logger.error('an error');
+        });
+        expect(events).toHaveLength(1);
+        expect(events[0].retainPending).toBeUndefined();
+    });
+    test('a concurrent normal-mode run is unaffected by a sibling verbose run', () => {
+        const events = [];
+        (0, logSink_1.installLogSink)({ push: (e) => events.push(e) });
+        const { logger } = makeDiagnosticsLogger();
+        runContext_1.runContextStore.run({ runId: 'verbose-run', captureMode: 'verbose' }, () => {
+            logger.debug('verbose debug');
+        });
+        runContext_1.runContextStore.run({ runId: 'normal-run' }, () => {
+            logger.debug('normal debug');
+        });
+        expect(events).toHaveLength(1);
+        expect(events[0].message).toBe('verbose debug');
+    });
+});
+//# sourceMappingURL=logger.test.js.map

package/bin/test/logger.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.test.js","sourceRoot":"","sources":["../../src/test/logger.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,0EAA0C;AAC1C,+CAAkE;AAClE,iDAA+E;AAC/E,uDAAyD;AAEzD,MAAM,WAAW,GAAG,CAAC,IAA6B,EAAE,EAAE,CAAE,IAAA,eAAM,GAAU,CAAC,SAAS,mBAAM,IAAI,EAAG,CAAC;AAEhG,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,IAAI,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC7E,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QACnG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACxC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,oGAAoG,EAAE,GAAG,EAAE;QAC9G,MAAM,cAAc,GAAG;YACrB,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE;gBACN,IAAI,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,kBAAkB,EAAE;gBACpD,OAAO,EAAE,EAAE,aAAa,EAAE,oBAAoB,EAAE;aACjD;SACF,CAAC;QACF,MAAM,GAAG,GAAQ,WAAW,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,cAAc,EAAE,CAAC,CAAC;QAClG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACxD,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;QACjD,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAChG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC7C,MAAM,QAAQ,GAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QACpC,QAAQ,CAAC,IAAI,GAAG,QAAQ,CAAC;QACzB,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACvE,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrF,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC5F,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,6FAA6F;AAC7F,gGAAgG;AAChG,MAAM,gBAAiB,SAAQ,2BAAS;IAAxC;;QACE,UAAK,GAA8B,EAAE,CAAC;IAKxC,CAAC;IAJC,GAAG,CAAC,IAA6B,EAAE,QAAoB;;QACrD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAC,IAAY,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1F,QAAQ,EAAE,CAAC;IACb,CAAC;CACF;AACD,SAAS,cAAc;IACrB,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;QAClC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EACtC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,IAAA,eAAM,GAAE,EACR,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EACtB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CACtB;QACD,UAAU,EAAE,CAAC,OAAO,CAAC;KACtB,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAC7B,CAAC;AAED,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,IAAI,CAAC,qFAAqF,EAAE,GAAG,EAAE;QAC/F,uFAAuF;QACvF,wFAAwF;QACxF,sEAAsE;QACtE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAC7C,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrD,MAAM,CAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAgB,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;IAC5D,IAAI,CAAC,IAAI,CAAC;QACR,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,WAAW,EAAE,SAAS,CAAC;QACxB,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,CAAC,kCAAkC,EAAE,EAAE,IAAI,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,CAAC,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtC,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC,0BAA0B,EAAE,IAAI,KAAK,EAAE,CAAC;QACzC,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;KAChD,CAAC,CAAC,iCAAiC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACtD,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,CAAC;QACpC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAY,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,SAAS,qBAAqB;QAC5B,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;YAClC,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EACtC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,IAAA,eAAM,GAAE,EACR,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EACtB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CACtB;YACD,UAAU,EAAE,CAAC,OAAO,EAAE,IAAI,6BAAoB,EAAE,CAAC;SAClD,CAAC,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;;QACnE,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,MAAM,IAAI,GAAY,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,IAAA,wBAAc,EAAC,IAAI,CAAC,CAAC;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAChC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACpF,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,CAAC,MAAA,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,0CAAE,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAA,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,0CAAE,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,kCAAkC,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACrD,IAAA,wBAAc,EAAC;YACb,IAAI,EAAE,GAAG,EAAE;gBACT,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;YAClC,CAAC;SACF,CAAC,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,CAAC;QACR,CAAC,MAAM,EAAE,IAAI,CAAC;QACd,CAAC,WAAW,EAAE,SAAS,CAAC;QACxB,CAAC,KAAK,EAAE,GAAG,CAAC;QACZ,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAQ,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,CAAC,kCAAkC,EAAE,EAAE,IAAI,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,CAAC,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACtC,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC,0BAA0B,EAAE,IAAI,KAAK,EAAE,CAAC;QACzC,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;KAChD,CAAC,CAAC,uDAAuD,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC5E,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAY,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,yFAAyF;IACzF,0FAA0F;IAC1F,6FAA6F;IAC7F,uDAAuD;IACvD,IAAI,CAAC,8EAA8E,EAAE,GAAG,EAAE;QACxF,8DAA8D;QAC9D,MAAM,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC;QACrD,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gDAAgD,EAAE,GAAG,EAAE;IAC9D,SAAS,qBAAqB;QAC5B,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;YAClC,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EACtC,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,EAC1B,IAAA,eAAM,GAAE,EACR,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EACtB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CACtB;YACD,UAAU,EAAE,CAAC,OAAO,EAAE,IAAI,6BAAoB,EAAE,CAAC;SAClD,CAAC,CAAC;QACH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC,0DAA0D,EAAE,GAAG,EAAE;QACpE,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE;YAC3C,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAChD,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE;YACnE,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACzD,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE;YAC3C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC5E,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,EAAE,GAAG,EAAE;YAC7E,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACtE,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,EAAE,GAAG,EAAE;YAC7E,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC/E,MAAM,MAAM,GAAsB,EAAE,CAAC;QACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,EAAE,MAAM,EAAE,GAAG,qBAAqB,EAAE,CAAC;QAC3C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE;YACzE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE;YAChD,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/bin/test/runContext.test.d.ts

@@ -0,0 +1 @@
+export {};

package/bin/test/runContext.test.js

@@ -0,0 +1,96 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const winston = __importStar(require("winston"));
+const winston_transport_1 = __importDefault(require("winston-transport"));
+const logger_1 = require("../services/logger");
+const runContext_1 = require("../services/runContext");
+class CaptureTransport extends winston_transport_1.default {
+    constructor() {
+        super(...arguments);
+        this.lines = [];
+    }
+    log(info, callback) {
+        var _a;
+        this.lines.push(JSON.parse((_a = info[Symbol.for('message')]) !== null && _a !== void 0 ? _a : JSON.stringify(info)));
+        callback();
+    }
+}
+function makeTestLogger() {
+    const capture = new CaptureTransport();
+    const logger = winston.createLogger({
+        level: 'silly',
+        format: winston.format.combine((0, logger_1.withRunContext)(), winston.format.json()),
+        transports: [capture],
+    });
+    return { logger, capture };
+}
+describe('withRunContext', () => {
+    test('is a no-op when the store was never populated', () => {
+        const { logger, capture } = makeTestLogger();
+        logger.info('outside any run');
+        expect(capture.lines[0].runId).toBeUndefined();
+    });
+    test('stamps runId onto every log emitted inside store.run(...)', () => {
+        const { logger, capture } = makeTestLogger();
+        runContext_1.runContextStore.run({ runId: 'run-123' }, () => {
+            logger.info('inside the run');
+        });
+        logger.info('outside again');
+        expect(capture.lines[0].runId).toBe('run-123');
+        expect(capture.lines[1].runId).toBeUndefined();
+    });
+    test('async work started inside the run keeps the runId across the await boundary', () => __awaiter(void 0, void 0, void 0, function* () {
+        const { logger, capture } = makeTestLogger();
+        yield runContext_1.runContextStore.run({ runId: 'run-async' }, () => __awaiter(void 0, void 0, void 0, function* () {
+            yield new Promise((resolve) => setTimeout(resolve, 0));
+            logger.info('after await');
+        }));
+        expect(capture.lines[0].runId).toBe('run-async');
+    }));
+});
+//# sourceMappingURL=runContext.test.js.map

package/bin/test/runContext.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runContext.test.js","sourceRoot":"","sources":["../../src/test/runContext.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iDAAmC;AACnC,0EAA0C;AAC1C,+CAAoD;AACpD,uDAAyD;AAEzD,MAAM,gBAAiB,SAAQ,2BAAS;IAAxC;;QACE,UAAK,GAA8B,EAAE,CAAC;IAKxC,CAAC;IAJC,GAAG,CAAC,IAA6B,EAAE,QAAoB;;QACrD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAC,IAAY,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1F,QAAQ,EAAE,CAAC;IACb,CAAC;CACF;AACD,SAAS,cAAc;IACrB,MAAM,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;QAClC,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAA,uBAAc,GAAE,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QACvE,UAAU,EAAE,CAAC,OAAO,CAAC;KACtB,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAC7B,CAAC;AAED,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,IAAI,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACzD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAC7C,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACrE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAC7C,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE;YAC7C,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7B,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,GAAS,EAAE;QAC7F,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QAC7C,MAAM,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,GAAS,EAAE;YAC3D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;YACvD,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7B,CAAC,CAAA,CAAC,CAAC;QACH,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC,CAAA,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/eslint.config.mjs

@@ -0,0 +1,40 @@
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+
+// Phase 4 regression guard: bans the two log-record-corrupting patterns the observability plan
+// found and fixed by hand across all four backend repos. Deliberately does NOT extend
+// js.configs.recommended/tseslint's recommended rule sets — this repo has never had a linter,
+// and pulling in a general rule set now would surface a large, unrelated pre-existing backlog
+// (unused vars, etc.) as new lint failures. Scope is exactly the one regression this guards
+// against. Keep this file identical in shape across docgen-api-gate / docgen-content-control /
+// docgen-data-provider-package / docgen-dg-skins-package — see each repo's CLAUDE.md "keep
+// these files in sync" note.
+export default tseslint.config(
+  {
+    ignores: ['bin/**', 'coverage/**', '**/test/**', '**/tests/**'],
+  },
+  {
+    files: ['src/**/*.ts'],
+    extends: [tseslint.configs.base],
+    languageOptions: {
+      globals: globals.node,
+    },
+    rules: {
+      'no-restricted-syntax': [
+        'error',
+        {
+          selector:
+            "CallExpression[callee.object.name='logger'] > :matches(TemplateLiteral, BinaryExpression[operator='+']).arguments:first-child MemberExpression[property.name='stack']",
+          message:
+            'Do not embed .stack in the log message string — errors({stack:true}) attaches it automatically when the Error is passed as an argument. Pass the Error itself as a positional/meta argument instead.',
+        },
+        {
+          selector:
+            "CallExpression[callee.object.name='logger'] CallExpression[callee.object.name='JSON'][callee.property.name='stringify'] > Identifier.arguments:first-child[name=/^(e|err|error|ex)$/]",
+          message:
+            "Don't JSON.stringify an Error — message/stack are non-enumerable and it serializes to {}. Pass the Error object directly as a log argument.",
+        },
+      ],
+    },
+  }
+);

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@elisra-devops/docgen-skins",
-  "version": "0.28.0",
+  "version": "0.29.0",
   "description": "Can be outputed in various types:",
   "main": "./bin/index.js",
   "types": "./bin/index.d.ts",
   "scripts": {
     "start": "node ./bin/server.js",
     "build": "tsc",
-    "test": "jest --coverage --runInBand --forceExit"
+    "test": "jest --coverage --runInBand --forceExit",
+    "lint": "eslint ."
   },
   "repository": {
     "type": "git",
@@ -22,12 +23,16 @@
     "winston": "^3.2.1"
   },
   "devDependencies": {
+    "@eslint/js": "^9.39.5",
     "@types/babel__traverse": "^7.20.2",
     "@types/jest": "^29.5.12",
+    "eslint": "^9.39.5",
+    "globals": "^15.15.0",
     "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
     "ts-jest": "^29.2.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "typescript-eslint": "^8.71.0"
   },
   "jest": {
     "testEnvironment": "node",

package/src/index.ts

@@ -665,11 +665,14 @@ export default class Skins {
                     testSkin.push(populatedTableSkin);
                   }
                 } catch (error) {
-                  logger.warn(
-                    `For suite id : ${testSuite.suiteSkinData.fields[0].value} , the testCaseStepsSkinData is not defined for ${testcase.testCaseHeaderSkinData.fields[0].value} `
-                  );
-                  logger.warn(`data ${JSON.stringify(testcase.testCaseStepsSkinData)}`);
-                  logger.error(`Error occurred when building test steps ${error.message}}`);
+                  // One event, one record — this used to be three separate calls (two
+                  // warnings plus an error) for a single failure.
+                  logger.error('Error occurred when building test steps', {
+                    message: error.message,
+                    suiteId: testSuite.suiteSkinData.fields[0].value,
+                    testCaseHeader: testcase.testCaseHeaderSkinData.fields[0].value,
+                    testCaseStepsSkinData: testcase.testCaseStepsSkinData,
+                  });
                   aggregatedErrors.push(error.message);
                 }
 

package/src/models/json/table/JSONTableCell.ts

@@ -93,9 +93,10 @@ export default class JSONTableCell {
         runs = [...runs, ...jsonRun.getRun()];
       }
     } catch (e) {
-      logger.error(`Error generating JSON cell: ${e.message}`);
-      logger.error(`Error data: ${JSON.stringify(data)}`);
-      logger.error(`Type Of Data: ${typeof data.value}`);
+      // One event, one record — three separate calls used to interleave with other
+      // requests' output under concurrency and would have become three unrelated
+      // entries in the dashboard's error grouping instead of one.
+      logger.error('Error generating JSON cell', { message: e.message, data, typeOfDataValue: typeof data.value });
       let jsonRun = new JSONRun('Docgen Error: Invalid data value', styles);
       runs = [...runs, ...jsonRun.getRun()];
     }

package/src/services/logSink.ts

@@ -0,0 +1,44 @@
+"use strict";
+
+// The one queryable-error-store event shape, emitted by DiagnosticsTransport (logger.ts).
+// This package never installs a sink itself — it only reads whatever the host process
+// (docgen-content-control's index.ts) installed. err is intentionally narrow —
+// {message, code, stack} — per the settled Phase 6 schema decision: no generic
+// extra-fields bucket.
+export interface DiagnosticEvent {
+  ts: string;
+  level: string;
+  service: string;
+  version: string;
+  runId?: string;
+  docType?: string;
+  step?: string;
+  contentControlType?: string;
+  contentControlTitle?: string;
+  project?: string;
+  userId?: string;
+  message: string;
+  err?: { message: string; code?: string; stack?: string };
+  // Phase 6b — set on a debug/info event captured under retain-on-failure. Deleted by
+  // api-gate at the run's one success point; left alone (and thus permanent, subject to the
+  // normal TTL) if the run fails.
+  retainPending?: boolean;
+}
+
+export interface LogSink {
+  push(event: DiagnosticEvent): void;
+}
+
+// Symbol.for so this package's copy converges on the same installed sink as
+// docgen-content-control's (the host process this package runs inside) and
+// docgen-data-provider-package's, the same reasoning as runContext.ts's AsyncLocalStorage. A
+// never-populated sink is a harmless no-op — this package only reads it, never installs one.
+const KEY = Symbol.for("elisradevops.docgen.logSink");
+
+export function getLogSink(): LogSink | undefined {
+  return (globalThis as Record<symbol, unknown>)[KEY] as LogSink | undefined;
+}
+
+export function installLogSink(sink: LogSink): void {
+  (globalThis as Record<symbol, unknown>)[KEY] = sink;
+}