@elisra-devops/docgen-data-provider 1.143.0 → 1.144.0

package/bin/tests/utils/runContextPropagation.test.d.ts

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

package/bin/tests/utils/runContextPropagation.test.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Guards the run context (runId / docType / project) that every log record is stamped from.
+// Prod showed data-provider records with a run id but no project / doc type; these tests pin
+// down what must hold in this package for a record to be attributed to the right run.
+const fs = require("fs");
+const path = require("path");
+const winston = require("winston");
+const logger_1 = require("../../utils/logger");
+const logSink_1 = require("../../utils/logSink");
+const runContext_1 = require("../../utils/runContext");
+const pLimit = require('p-limit');
+const pause = (ms) => new Promise((r) => setTimeout(r, ms));
+function makeLogger() {
+    const events = [];
+    (0, logSink_1.installLogSink)({ push: (e) => events.push(e), flush: async () => undefined });
+    const logger = winston.createLogger({
+        level: 'debug',
+        format: winston.format.combine((0, logger_1.withRunContext)(), winston.format.json()),
+        transports: [new logger_1.DiagnosticsTransport()],
+    });
+    return { logger, events };
+}
+describe('run context reaches log events from the places the data provider logs from', () => {
+    test('from tasks queued behind a per-instance p-limit, and from a retry timer', async () => {
+        const { logger, events } = makeLogger();
+        const limit = pLimit(2); // per request, like the providers' `private limit = pLimit(10)` fields
+        await runContext_1.runContextStore.run({ runId: 'run-1', docType: 'STD', project: 'MEWP' }, async () => {
+            await Promise.all([1, 2, 3, 4, 5, 6].map((i) => limit(async () => {
+                await pause(3);
+                logger.error(`queued task ${i}`);
+            })));
+            await new Promise((resolve) => setTimeout(() => {
+                logger.warn('Request failed. Retrying');
+                resolve();
+            }, 5));
+        });
+        expect(events).toHaveLength(7);
+        events.forEach((e) => expect(e).toMatchObject({ runId: 'run-1', docType: 'STD', project: 'MEWP' }));
+    });
+    test('concurrent runs, each with its own limiter, never see each other\'s context', async () => {
+        const { logger, events } = makeLogger();
+        await Promise.all(['A', 'B', 'C', 'D'].map((id) => runContext_1.runContextStore.run({ runId: `run-${id}`, docType: id === 'A' ? 'STD' : 'SVD', project: `P-${id}` }, async () => {
+            const limit = pLimit(2);
+            await Promise.all([1, 2, 3, 4].map((i) => limit(async () => { await pause(i); logger.error(`${id}:${i}`); })));
+        })));
+        expect(events).toHaveLength(16);
+        events.forEach((e) => {
+            const id = e.message.split(':')[0];
+            expect(e).toMatchObject({ runId: `run-${id}`, project: `P-${id}` });
+        });
+    });
+});
+// A p-limit queue shared by two concurrent runs resumes a queued task from whichever task last
+// finished — i.e. in the OTHER run's async context — so its log lines are attributed to the wrong
+// run (measured: half the tasks of two interleaved runs). Per-instance limiters are safe because
+// a provider instance serves one request. If you need a limiter, make it a per-request/instance
+// field; do not hoist it to module or class-static scope.
+describe('no process-wide p-limit queue', () => {
+    const walk = (dir) => fs.readdirSync(dir, { withFileTypes: true }).flatMap((d) => {
+        const p = path.join(dir, d.name);
+        if (d.isDirectory())
+            return d.name === 'tests' ? [] : walk(p);
+        return p.endsWith('.ts') ? [p] : [];
+    });
+    test('no pLimit(...) at module scope or in a static member', () => {
+        const offenders = [];
+        for (const file of walk(path.resolve(__dirname, '../..'))) {
+            fs.readFileSync(file, 'utf8')
+                .split('\n')
+                .forEach((line, i) => {
+                const moduleScope = /^(export\s+)?(const|let|var)\s+\w+\s*=\s*pLimit\(/.test(line);
+                const staticMember = /\bstatic\b[^=]*=\s*pLimit\(/.test(line);
+                if (moduleScope || staticMember)
+                    offenders.push(`${path.relative(process.cwd(), file)}:${i + 1}: ${line.trim()}`);
+            });
+        }
+        expect(offenders).toEqual([]);
+    });
+});
+//# sourceMappingURL=runContextPropagation.test.js.map

package/bin/tests/utils/runContextPropagation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runContextPropagation.test.js","sourceRoot":"","sources":["../../../src/tests/utils/runContextPropagation.test.ts"],"names":[],"mappings":";;AAAA,4FAA4F;AAC5F,6FAA6F;AAC7F,sFAAsF;AACtF,yBAAyB;AACzB,6BAA6B;AAC7B,mCAAmC;AACnC,+CAA0E;AAC1E,iDAA+E;AAC/E,uDAAyD;AAEzD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;AAClC,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;AAEpE,SAAS,UAAU;IACjB,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,IAAA,wBAAc,EAAC,EAAE,IAAI,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,EAAa,CAAC,CAAC;IAC1G,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,IAAI,6BAAoB,EAAE,CAAC;KACzC,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAC5B,CAAC;AAED,QAAQ,CAAC,4EAA4E,EAAE,GAAG,EAAE;IAC1F,IAAI,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;QACzF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,uEAAuE;QAChG,MAAM,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,KAAK,IAAI,EAAE;YACxF,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAC3B,KAAK,CAAC,KAAK,IAAI,EAAE;gBACf,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;YACnC,CAAC,CAAC,CACH,CACF,CAAC;YACF,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAClC,UAAU,CAAC,GAAG,EAAE;gBACd,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;gBACxC,OAAO,EAAE,CAAC;YACZ,CAAC,EAAE,CAAC,CAAC,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACtG,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC7F,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,CAAC;QACxC,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAC9B,4BAAe,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,IAAI,EAAE;YAC9G,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACxB,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjH,CAAC,CAAC,CACH,CACF,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAChC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACnB,MAAM,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,+FAA+F;AAC/F,kGAAkG;AAClG,iGAAiG;AACjG,gGAAgG;AAChG,0DAA0D;AAC1D,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,MAAM,IAAI,GAAG,CAAC,GAAW,EAAY,EAAE,CACrC,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACzD,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,CAAC,WAAW,EAAE;YAAE,OAAO,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9D,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC,CAAC,CAAC,CAAC;IAEL,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAChE,MAAM,SAAS,GAAa,EAAE,CAAC;QAC/B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;YAC1D,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC;iBAC1B,KAAK,CAAC,IAAI,CAAC;iBACX,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;gBACnB,MAAM,WAAW,GAAG,mDAAmD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnF,MAAM,YAAY,GAAG,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC9D,IAAI,WAAW,IAAI,YAAY;oBAAE,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACpH,CAAC,CAAC,CAAC;QACP,CAAC;QACD,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elisra-devops/docgen-data-provider",
-  "version": "1.143.0",
+  "version": "1.144.0",
   "description": "A document generator data provider, aimed to retrive data from azure devops",
   "repository": {
     "type": "git",

package/src/tests/utils/runContextPropagation.test.ts

@@ -0,0 +1,93 @@
+// Guards the run context (runId / docType / project) that every log record is stamped from.
+// Prod showed data-provider records with a run id but no project / doc type; these tests pin
+// down what must hold in this package for a record to be attributed to the right run.
+import * as fs from 'fs';
+import * as path from 'path';
+import * as winston from 'winston';
+import { DiagnosticsTransport, withRunContext } from '../../utils/logger';
+import { installLogSink, LogSink, DiagnosticEvent } from '../../utils/logSink';
+import { runContextStore } from '../../utils/runContext';
+
+const pLimit = require('p-limit');
+const pause = (ms: number) => new Promise((r) => setTimeout(r, ms));
+
+function makeLogger() {
+  const events: DiagnosticEvent[] = [];
+  installLogSink({ push: (e: DiagnosticEvent) => events.push(e), flush: async () => undefined } as LogSink);
+  const logger = winston.createLogger({
+    level: 'debug',
+    format: winston.format.combine(withRunContext(), winston.format.json()),
+    transports: [new DiagnosticsTransport()],
+  });
+  return { logger, events };
+}
+
+describe('run context reaches log events from the places the data provider logs from', () => {
+  test('from tasks queued behind a per-instance p-limit, and from a retry timer', async () => {
+    const { logger, events } = makeLogger();
+    const limit = pLimit(2); // per request, like the providers' `private limit = pLimit(10)` fields
+    await runContextStore.run({ runId: 'run-1', docType: 'STD', project: 'MEWP' }, async () => {
+      await Promise.all(
+        [1, 2, 3, 4, 5, 6].map((i) =>
+          limit(async () => {
+            await pause(3);
+            logger.error(`queued task ${i}`);
+          })
+        )
+      );
+      await new Promise<void>((resolve) =>
+        setTimeout(() => {
+          logger.warn('Request failed. Retrying');
+          resolve();
+        }, 5)
+      );
+    });
+    expect(events).toHaveLength(7);
+    events.forEach((e) => expect(e).toMatchObject({ runId: 'run-1', docType: 'STD', project: 'MEWP' }));
+  });
+
+  test('concurrent runs, each with its own limiter, never see each other\'s context', async () => {
+    const { logger, events } = makeLogger();
+    await Promise.all(
+      ['A', 'B', 'C', 'D'].map((id) =>
+        runContextStore.run({ runId: `run-${id}`, docType: id === 'A' ? 'STD' : 'SVD', project: `P-${id}` }, async () => {
+          const limit = pLimit(2);
+          await Promise.all([1, 2, 3, 4].map((i) => limit(async () => { await pause(i); logger.error(`${id}:${i}`); })));
+        })
+      )
+    );
+    expect(events).toHaveLength(16);
+    events.forEach((e) => {
+      const id = e.message.split(':')[0];
+      expect(e).toMatchObject({ runId: `run-${id}`, project: `P-${id}` });
+    });
+  });
+});
+
+// A p-limit queue shared by two concurrent runs resumes a queued task from whichever task last
+// finished — i.e. in the OTHER run's async context — so its log lines are attributed to the wrong
+// run (measured: half the tasks of two interleaved runs). Per-instance limiters are safe because
+// a provider instance serves one request. If you need a limiter, make it a per-request/instance
+// field; do not hoist it to module or class-static scope.
+describe('no process-wide p-limit queue', () => {
+  const walk = (dir: string): string[] =>
+    fs.readdirSync(dir, { withFileTypes: true }).flatMap((d) => {
+      const p = path.join(dir, d.name);
+      if (d.isDirectory()) return d.name === 'tests' ? [] : walk(p);
+      return p.endsWith('.ts') ? [p] : [];
+    });
+
+  test('no pLimit(...) at module scope or in a static member', () => {
+    const offenders: string[] = [];
+    for (const file of walk(path.resolve(__dirname, '../..'))) {
+      fs.readFileSync(file, 'utf8')
+        .split('\n')
+        .forEach((line, i) => {
+          const moduleScope = /^(export\s+)?(const|let|var)\s+\w+\s*=\s*pLimit\(/.test(line);
+          const staticMember = /\bstatic\b[^=]*=\s*pLimit\(/.test(line);
+          if (moduleScope || staticMember) offenders.push(`${path.relative(process.cwd(), file)}:${i + 1}: ${line.trim()}`);
+        });
+    }
+    expect(offenders).toEqual([]);
+  });
+});