@digitraffic/common 2026.5.27-1 → 2026.6.29-1

package/dist/__test__/utils/lead-time-logging.test.d.ts

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

package/dist/__test__/utils/lead-time-logging.test.js

@@ -0,0 +1,152 @@
+import { afterEach, describe, expect, test, vi } from "vitest";
+import { logger } from "../../aws/runtime/dt-logger-default.js";
+import { logLeadTime, logLeadTimes } from "../../utils/lead-time-logging.js";
+describe("lead-time-logging", () => {
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    test("logLeadTime logs expected payload", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        const errorSpy = vi
+            .spyOn(logger, "error")
+            .mockImplementation(() => undefined);
+        logLeadTime("lead-time", "test-target", 123);
+        expect(infoSpy).toHaveBeenCalledTimes(1);
+        expect(infoSpy).toHaveBeenCalledWith({
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "lead-time",
+            customTarget: "test-target",
+            tookMs: 123,
+        });
+        expect(errorSpy).toHaveBeenCalledTimes(0);
+    });
+    test("logLeadTime merges extra fields", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        logLeadTime("mqtt-time", "mqtt", 88, {
+            customSource: "mqtt",
+            customRetriesCount: 2,
+        });
+        expect(infoSpy).toHaveBeenCalledTimes(1);
+        expect(infoSpy).toHaveBeenCalledWith({
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "mqtt-time",
+            customTarget: "mqtt",
+            tookMs: 88,
+            customSource: "mqtt",
+            customRetriesCount: 2,
+        });
+    });
+    test("logLeadTime logs error if logger.info throws", () => {
+        const infoError = new Error("boom");
+        vi.spyOn(logger, "info").mockImplementation(() => {
+            throw infoError;
+        });
+        const errorSpy = vi
+            .spyOn(logger, "error")
+            .mockImplementation(() => undefined);
+        logLeadTime("process-time", "target", 10);
+        expect(errorSpy).toHaveBeenCalledTimes(1);
+        expect(errorSpy).toHaveBeenCalledWith({
+            method: "LeadTimeLogging.logLeadTime",
+            message: "Error logging lead time",
+            error: infoError,
+        });
+    });
+    test("logLeadTimes logs only lead-time when only leadTimeMs is safe", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        logLeadTimes({ target: "x", leadTimeMs: 10 });
+        expect(infoSpy).toHaveBeenCalledTimes(1);
+        expect(infoSpy).toHaveBeenNthCalledWith(1, {
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "lead-time",
+            customTarget: "x",
+            tookMs: 10,
+        });
+    });
+    test("logLeadTimes logs only process-time when only processTimeMs is safe", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        logLeadTimes({ target: "x", processTimeMs: 20 });
+        expect(infoSpy).toHaveBeenCalledTimes(1);
+        expect(infoSpy).toHaveBeenNthCalledWith(1, {
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "process-time",
+            customTarget: "x",
+            tookMs: 20,
+        });
+    });
+    test("logLeadTimes logs both in order with extra fields", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        const input = {
+            target: "device",
+            leadTimeMs: 11,
+            processTimeMs: 22,
+            extraFields: { customSource: "mqtt", customPartition: 3 },
+        };
+        logLeadTimes(input);
+        expect(infoSpy).toHaveBeenCalledTimes(2);
+        expect(infoSpy).toHaveBeenNthCalledWith(1, {
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "lead-time",
+            customTarget: "device",
+            tookMs: 11,
+            customSource: "mqtt",
+            customPartition: 3,
+        });
+        expect(infoSpy).toHaveBeenNthCalledWith(2, {
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "process-time",
+            customTarget: "device",
+            tookMs: 22,
+            customSource: "mqtt",
+            customPartition: 3,
+        });
+    });
+    test("logLeadTimes ignores non-safe values", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        logLeadTimes({
+            target: "x",
+            leadTimeMs: 1.5,
+            processTimeMs: Number.MAX_SAFE_INTEGER + 1,
+        });
+        logLeadTimes({
+            target: "x",
+            leadTimeMs: Number.NaN,
+            processTimeMs: Infinity,
+        });
+        logLeadTimes({ target: "x" });
+        expect(infoSpy).toHaveBeenCalledTimes(0);
+    });
+    test("logLeadTimes logs negative safe integer values", () => {
+        const infoSpy = vi
+            .spyOn(logger, "info")
+            .mockImplementation(() => undefined);
+        logLeadTimes({ target: "x", leadTimeMs: -5 });
+        expect(infoSpy).toHaveBeenCalledTimes(1);
+        expect(infoSpy).toHaveBeenNthCalledWith(1, {
+            method: "LeadTimeLogging.logLeadTime",
+            customLeadTime: true,
+            customName: "lead-time",
+            customTarget: "x",
+            tookMs: -5,
+        });
+    });
+});
+//# sourceMappingURL=lead-time-logging.test.js.map

package/dist/aws/infra/canaries/database-checker.js

@@ -1,6 +1,5 @@
 import synthetics from "Synthetics";
 import { inDatabaseReadonly } from "../../../database/database.js";
-import { getEnvVariable } from "../../../utils/utils.js";
 import { logger } from "../../runtime/dt-logger-default.js";
 import { ProxyHolder } from "../../runtime/secrets/proxy-holder.js";
 import { RdsHolder } from "../../runtime/secrets/rds-holder.js";
@@ -66,10 +65,10 @@ export class DatabaseCountChecker {
         synthetics.getConfiguration().withFailedCanaryMetric(true);
     }
     static createForProxy() {
-        return new DatabaseCountChecker(() => new ProxyHolder(getEnvVariable("SECRET_ID")).setCredentials());
+        return new DatabaseCountChecker(() => ProxyHolder.create().setCredentials());
     }
     static createForRds() {
-        return new DatabaseCountChecker(() => new RdsHolder(getEnvVariable("SECRET_ID")).setCredentials());
+        return new DatabaseCountChecker(() => RdsHolder.create().setCredentials());
     }
     /**
      * Expect that the count is 1

package/dist/aws/runtime/secrets/proxy-holder.d.ts

@@ -1,9 +1,14 @@
+import type { RdsProxySecret } from "./dbsecret.js";
+import { SecretHolder } from "./secret-holder.js";
 /**
  * Holds credentials for RDS Proxy access.
  */
 export declare class ProxyHolder {
     private readonly secretHolder;
-    constructor(secretId: string);
+    private constructor();
+    /** Creates a new instance of ProxyHolder from given SecretHolder. */
+    static create(secretHolder: SecretHolder<RdsProxySecret>): ProxyHolder;
+    /** Creates a new instance of ProxyHolder with a new default SecretHolder(using env variable SECRET_ID). */
     static create(): ProxyHolder;
     setCredentials(): Promise<void>;
 }

package/dist/aws/runtime/secrets/proxy-holder.js

@@ -8,11 +8,13 @@ const RDS_PROXY_SECRET_KEYS = Object.values(RdsProxySecretKey);
  */
 export class ProxyHolder {
     secretHolder;
-    constructor(secretId) {
-        this.secretHolder = new SecretHolder(secretId, "", RDS_PROXY_SECRET_KEYS);
+    constructor(secretHolder) {
+        this.secretHolder = secretHolder;
     }
-    static create() {
-        return new ProxyHolder(getEnvVariable("SECRET_ID"));
+    static create(secretHolder) {
+        const holder = secretHolder ??
+            new SecretHolder(getEnvVariable("SECRET_ID"), "", RDS_PROXY_SECRET_KEYS);
+        return new ProxyHolder(holder);
     }
     async setCredentials() {
         const secret = await this.secretHolder.get();

package/dist/aws/runtime/secrets/rds-holder.d.ts

@@ -1,9 +1,12 @@
+import type { RdsSecret } from "./dbsecret.js";
+import { SecretHolder } from "./secret-holder.js";
 /**
  * Holds credentials for RDS access.
  */
 export declare class RdsHolder {
     private readonly secretHolder;
-    constructor(secretId: string);
+    private constructor();
+    static create(rdsHolder: SecretHolder<RdsSecret>): RdsHolder;
     static create(): RdsHolder;
     setCredentials(): Promise<void>;
 }

package/dist/aws/runtime/secrets/rds-holder.js

@@ -8,11 +8,13 @@ const RDS_SECRET_KEYS = Object.values(RdsSecretKey);
  */
 export class RdsHolder {
     secretHolder;
-    constructor(secretId) {
-        this.secretHolder = new SecretHolder(secretId, "", RDS_SECRET_KEYS);
+    constructor(secretHolder) {
+        this.secretHolder = secretHolder;
     }
-    static create() {
-        return new RdsHolder(getEnvVariable("SECRET_ID"));
+    static create(secretHolder) {
+        const holder = secretHolder ??
+            new SecretHolder(getEnvVariable("SECRET_ID"), "", RDS_SECRET_KEYS);
+        return new RdsHolder(holder);
     }
     async setCredentials() {
         const secret = await this.secretHolder.get();

package/dist/utils/lead-time-logging.d.ts

@@ -0,0 +1,10 @@
+import type { CustomParams } from "../aws/runtime/dt-logger.js";
+export interface LeadTimeLogging {
+    readonly target: string;
+    readonly leadTimeMs?: number;
+    readonly processTimeMs?: number;
+    readonly extraFields?: CustomParams;
+}
+export type LeadTimeType = "lead-time" | "process-time" | "mqtt-time";
+export declare function logLeadTime(name: LeadTimeType, target: string, tookMs: number, extraFields?: CustomParams): void;
+export declare function logLeadTimes(ptl: LeadTimeLogging): void;

package/dist/utils/lead-time-logging.js

@@ -0,0 +1,33 @@
+import { logger } from "../aws/runtime/dt-logger-default.js";
+export function logLeadTime(name, target, tookMs, extraFields) {
+    const method = "LeadTimeLogging.logLeadTime";
+    try {
+        logger.info({
+            method,
+            customLeadTime: true,
+            customName: name,
+            customTarget: target,
+            tookMs,
+            ...(extraFields || {}),
+        });
+    }
+    catch (error) {
+        logger.error({
+            method,
+            message: "Error logging lead time",
+            error,
+        });
+    }
+}
+function isSafe(value) {
+    return Number.isSafeInteger(value);
+}
+export function logLeadTimes(ptl) {
+    if (isSafe(ptl.leadTimeMs)) {
+        logLeadTime("lead-time", ptl.target, ptl.leadTimeMs, ptl.extraFields);
+    }
+    if (isSafe(ptl.processTimeMs)) {
+        logLeadTime("process-time", ptl.target, ptl.processTimeMs, ptl.extraFields);
+    }
+}
+//# sourceMappingURL=lead-time-logging.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitraffic/common",
-  "version": "2026.5.27-1",
+  "version": "2026.6.29-1",
   "private": false,
   "description": "",
   "repository": {
@@ -36,6 +36,7 @@
     "./dist/marine/id_utils": "./dist/marine/id_utils.js",
     "./dist/index": "./dist/index.js",
     "./dist/utils/api-model": "./dist/utils/api-model.js",
+    "./dist/utils/lead-time-logging": "./dist/utils/lead-time-logging.js",
     "./dist/utils/logging": "./dist/utils/logging.js",
     "./dist/utils/base64": "./dist/utils/base64.js",
     "./dist/utils/date-utils": "./dist/utils/date-utils.js",
@@ -126,7 +127,7 @@
     "@types/geojson-validation": "1.0.3",
     "@types/madge": "5.0.3",
     "@types/node": "24.12.4",
-    "@vitest/coverage-v8": "4.1.6",
+    "@vitest/coverage-v8": "4.1.9",
     "aws-cdk-lib": "2.254.0",
     "change-case": "5.4.4",
     "constructs": "10.6.0",
@@ -144,7 +145,7 @@
     "sort-package-json": "3.6.1",
     "typescript": "5.9.3",
     "velocityjs": "2.1.6",
-    "vitest": "4.1.6",
+    "vitest": "4.1.9",
     "zod": "4.4.3"
   },
   "peerDependencies": {