@terreno/api 0.20.2 → 0.21.0

package/dist/logger.test.js

@@ -18,8 +18,10 @@ var bun_test_1 = require("bun:test");
 var node_fs_1 = __importDefault(require("node:fs"));
 var node_os_1 = __importDefault(require("node:os"));
 var node_path_1 = __importDefault(require("node:path"));
+var node_stream_1 = require("node:stream");
 var winston_1 = __importDefault(require("winston"));
 var logger_1 = require("./logger");
+var requestContext_1 = require("./requestContext");
 (0, bun_test_1.describe)("logger", function () {
     var OLD_ENV = process.env;
     (0, bun_test_1.beforeEach)(function () {
@@ -51,6 +53,402 @@ var logger_1 = require("./logger");
         (0, bun_test_1.expect)(function () { return logger_1.logger.catch(new Error("captured")); }).not.toThrow();
     });
 });
+(0, bun_test_1.describe)("formatLogContextSuffix", function () {
+    (0, bun_test_1.it)("includes request ids and sorts terrenoLabels for stable output", function () {
+        var suffix = (0, logger_1.formatLogContextSuffix)({
+            requestId: "r1",
+            terrenoLabels: { alpha: "a", zebra: "z" },
+        });
+        (0, bun_test_1.expect)(suffix).toContain("requestId=r1");
+        (0, bun_test_1.expect)(suffix.indexOf("alpha=a")).toBeLessThan(suffix.indexOf("zebra=z"));
+    });
+    (0, bun_test_1.it)("returns empty string when no fields are set", function () {
+        (0, bun_test_1.expect)((0, logger_1.formatLogContextSuffix)({})).toBe("");
+    });
+    (0, bun_test_1.it)("includes terrenoLogPrefix in suffix", function () {
+        var suffix = (0, logger_1.formatLogContextSuffix)({
+            requestId: "r1",
+            terrenoLogPrefix: "[Job]",
+        });
+        (0, bun_test_1.expect)(suffix).toContain("logPrefix=[Job]");
+        (0, bun_test_1.expect)(suffix).toContain("requestId=r1");
+    });
+});
+(0, bun_test_1.describe)("createScopedLogger", function () {
+    (0, bun_test_1.afterEach)(function () {
+        (0, logger_1.setupLogging)({ disableFileLogging: true });
+    });
+    (0, bun_test_1.it)("returns the global logger when prefix and labels are empty", function () {
+        (0, bun_test_1.expect)((0, logger_1.createScopedLogger)({})).toBe(logger_1.logger);
+        (0, bun_test_1.expect)((0, logger_1.createScopedLogger)({ labels: { skipped: undefined } })).toBe(logger_1.logger);
+    });
+    (0, bun_test_1.it)("prefixes messages when only prefix is set", function () {
+        var lines = [];
+        var snapshots = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.combine(winston_1.default.format(function (info) {
+                snapshots.push({
+                    terrenoLogPrefix: info.terrenoLogPrefix,
+                });
+                return info;
+            })(), winston_1.default.format.printf(function (info) {
+                var msg = typeof info.message === "string" ? info.message : String(info.message);
+                return "".concat(info.level, ": ").concat(msg);
+            })),
+            stream: new node_stream_1.Writable({
+                write: function (chunk, _encoding, callback) {
+                    lines.push(chunk.toString().trim());
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            (0, logger_1.createScopedLogger)({ prefix: "[ScopedTest]" }).info("hello");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(lines.some(function (l) { return l.includes("[ScopedTest]") && l.includes("hello"); })).toBe(true);
+        (0, bun_test_1.expect)(snapshots.some(function (s) { return s.terrenoLogPrefix === "[ScopedTest]"; })).toBe(true);
+    });
+    (0, bun_test_1.it)("attaches terrenoLabels to winston metadata for structured transports", function () {
+        var snapshots = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format(function (info) {
+                snapshots.push({
+                    level: info.level,
+                    message: info.message,
+                    terrenoLabels: info.terrenoLabels,
+                });
+                return info;
+            })(),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            (0, logger_1.createScopedLogger)({ labels: { billingId: "b1" } }).warn("charged");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(snapshots.some(function (s) { var _a; return ((_a = s.terrenoLabels) === null || _a === void 0 ? void 0 : _a.billingId) === "b1"; })).toBe(true);
+    });
+    (0, bun_test_1.it)("includes terrenoLogPrefix alongside terrenoLabels in metadata", function () {
+        var snapshots = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format(function (info) {
+                snapshots.push({
+                    terrenoLabels: info.terrenoLabels,
+                    terrenoLogPrefix: info.terrenoLogPrefix,
+                });
+                return info;
+            })(),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            (0, logger_1.createScopedLogger)({ labels: { x: "1" }, prefix: "[Both]" }).info("m");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(snapshots.some(function (s) {
+            var _a;
+            return ((_a = s.terrenoLabels) === null || _a === void 0 ? void 0 : _a.x) === "1" &&
+                s.terrenoLogPrefix === "[Both]";
+        })).toBe(true);
+    });
+    (0, bun_test_1.it)("merges all request context fields including jobId, sessionId, spanId, traceId, traceSampled", function () {
+        var snapshots = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format(function (info) {
+                snapshots.push({
+                    jobId: info.jobId,
+                    requestId: info.requestId,
+                    sessionId: info.sessionId,
+                    spanId: info.spanId,
+                    traceId: info.traceId,
+                    traceSampled: info.traceSampled,
+                    userId: info.userId,
+                });
+                return info;
+            })(),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            (0, requestContext_1.runWithRequestContext)({
+                jobId: "job-42",
+                requestId: "req-full",
+                sessionId: "sess-7",
+                spanId: "span-abc",
+                traceId: "trace-xyz",
+                traceSampled: true,
+                userId: "user-1",
+            }, function () {
+                logger_1.logger.info("full context");
+            });
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        var entry = snapshots.find(function (s) { return s.requestId === "req-full"; });
+        (0, bun_test_1.expect)(entry).toBeDefined();
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.jobId).toBe("job-42");
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.sessionId).toBe("sess-7");
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.spanId).toBe("span-abc");
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.traceId).toBe("trace-xyz");
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.traceSampled).toBe(true);
+        (0, bun_test_1.expect)(entry === null || entry === void 0 ? void 0 : entry.userId).toBe("user-1");
+    });
+    (0, bun_test_1.it)("exercises all scoped logger methods (debug, error, catch)", function () {
+        var lines = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function (info) {
+                var msg = typeof info.message === "string" ? info.message : String(info.message);
+                return "".concat(info.level, ": ").concat(msg);
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (chunk, _encoding, callback) {
+                    lines.push(chunk.toString().trim());
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var scoped = (0, logger_1.createScopedLogger)({ prefix: "[Methods]" });
+            scoped.debug("d-msg");
+            scoped.error("e-msg");
+            scoped.catch(new Error("caught-msg"));
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(lines.some(function (l) { return l.includes("[Methods]") && l.includes("d-msg"); })).toBe(true);
+        (0, bun_test_1.expect)(lines.some(function (l) { return l.includes("[Methods]") && l.includes("e-msg"); })).toBe(true);
+        (0, bun_test_1.expect)(lines.some(function (l) { return l.includes("[Methods]") && l.includes("caught-msg"); })).toBe(true);
+    });
+    (0, bun_test_1.it)("scoped logger catch with Sentry enabled and Error instance", function () {
+        var OLD_ENV = process.env;
+        process.env = __assign(__assign({}, OLD_ENV), { USE_SENTRY_LOGGING: "true" });
+        try {
+            var scoped_1 = (0, logger_1.createScopedLogger)({ prefix: "[Sentry]" });
+            (0, bun_test_1.expect)(function () { return scoped_1.catch(new Error("sentry scoped error")); }).not.toThrow();
+        }
+        finally {
+            process.env = OLD_ENV;
+        }
+    });
+    (0, bun_test_1.it)("attaches terrenoRequestLog while request ALS scope is active", function () {
+        var _a, _b;
+        var snapshots = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format(function (info) {
+                snapshots.push({
+                    terrenoRequestLog: info
+                        .terrenoRequestLog,
+                });
+                return info;
+            })(),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            (0, requestContext_1.runWithRequestContext)({ requestId: "req-als-1", userId: "user-99" }, function () {
+                logger_1.logger.info("in scope");
+            });
+            (0, requestContext_1.runWithRequestContext)({ requestId: "req-als-2" }, function () {
+                logger_1.logger.info("anon");
+            });
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        var withUser = snapshots.find(function (s) { var _a; return ((_a = s.terrenoRequestLog) === null || _a === void 0 ? void 0 : _a.requestId) === "req-als-1"; });
+        (0, bun_test_1.expect)((_a = withUser === null || withUser === void 0 ? void 0 : withUser.terrenoRequestLog) === null || _a === void 0 ? void 0 : _a.userId).toBe("user-99");
+        var anon = snapshots.find(function (s) { var _a; return ((_a = s.terrenoRequestLog) === null || _a === void 0 ? void 0 : _a.requestId) === "req-als-2"; });
+        (0, bun_test_1.expect)((_b = anon === null || anon === void 0 ? void 0 : anon.terrenoRequestLog) === null || _b === void 0 ? void 0 : _b.userId).toBeNull();
+    });
+});
+(0, bun_test_1.describe)("createFeatureFlaggedLogger", function () {
+    (0, bun_test_1.afterEach)(function () {
+        (0, logger_1.setupLogging)({ disableFileLogging: true });
+    });
+    (0, bun_test_1.it)("drops info lines while disabled", function () {
+        var hits = 0;
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function () {
+                hits += 1;
+                return "";
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({ isEnabled: function () { return false; }, target: logger_1.logger });
+            log.info("hidden");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(hits).toBe(0);
+    });
+    (0, bun_test_1.it)("forwards lines when enabled", function () {
+        var hits = 0;
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function () {
+                hits += 1;
+                return "";
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({ isEnabled: function () { return true; }, target: logger_1.logger });
+            log.info("visible");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(hits).toBeGreaterThan(0);
+    });
+    (0, bun_test_1.it)("forwards catch while disabled when gateCatch is false", function () {
+        var hits = 0;
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function () {
+                hits += 1;
+                return "";
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({
+                gateCatch: false,
+                isEnabled: function () { return false; },
+                target: logger_1.logger,
+            });
+            log.catch(new Error("still-logged"));
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(hits).toBeGreaterThan(0);
+    });
+    (0, bun_test_1.it)("forwards all methods when enabled (debug, warn, error)", function () {
+        var levels = [];
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format(function (info) {
+                levels.push(info.level);
+                return info;
+            })(),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({ isEnabled: function () { return true; }, target: logger_1.logger });
+            log.debug("d");
+            log.warn("w");
+            log.error("e");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(levels.some(function (l) { return l === "debug"; })).toBe(true);
+        (0, bun_test_1.expect)(levels.some(function (l) { return l === "warn"; })).toBe(true);
+        (0, bun_test_1.expect)(levels.some(function (l) { return l === "error"; })).toBe(true);
+    });
+    (0, bun_test_1.it)("drops debug, warn, error lines when disabled", function () {
+        var hits = 0;
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function () {
+                hits += 1;
+                return "";
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({ isEnabled: function () { return false; }, target: logger_1.logger });
+            log.debug("hidden-d");
+            log.warn("hidden-w");
+            log.error("hidden-e");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(hits).toBe(0);
+    });
+    (0, bun_test_1.it)("uses the global logger as default target when target is not provided", function () {
+        var log = (0, logger_1.createFeatureFlaggedLogger)({ isEnabled: function () { return true; } });
+        (0, bun_test_1.expect)(function () { return log.info("default target"); }).not.toThrow();
+    });
+    (0, bun_test_1.it)("drops catch while disabled when gateCatch is true", function () {
+        var hits = 0;
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.printf(function () {
+                hits += 1;
+                return "";
+            }),
+            stream: new node_stream_1.Writable({
+                write: function (_chunk, _encoding, callback) {
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            var log = (0, logger_1.createFeatureFlaggedLogger)({
+                gateCatch: true,
+                isEnabled: function () { return false; },
+                target: logger_1.logger,
+            });
+            log.catch(new Error("suppressed"));
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(hits).toBe(0);
+    });
+});
 (0, bun_test_1.describe)("setupLogging", function () {
     var tempDir;
     (0, bun_test_1.beforeEach)(function () {
@@ -140,4 +538,41 @@ var logger_1 = require("./logger");
         });
         (0, bun_test_1.expect)(true).toBe(true);
     });
+    (0, bun_test_1.it)("console format includes timestamps when showConsoleTimestamps is true", function () {
+        var lines = [];
+        (0, logger_1.setupLogging)({
+            disableFileLogging: true,
+            showConsoleTimestamps: true,
+        });
+        var captureTransport = new winston_1.default.transports.Stream({
+            format: winston_1.default.format.combine(winston_1.default.format.timestamp(), winston_1.default.format.printf(function (info) {
+                if (info.timestamp) {
+                    return "".concat(info.timestamp, " - ").concat(info.level, ": ").concat(info.message);
+                }
+                return "".concat(info.level, ": ").concat(info.message);
+            })),
+            stream: new node_stream_1.Writable({
+                write: function (chunk, _encoding, callback) {
+                    lines.push(chunk.toString().trim());
+                    callback();
+                },
+            }),
+        });
+        logger_1.winstonLogger.add(captureTransport);
+        try {
+            logger_1.logger.info("timestamp-test");
+        }
+        finally {
+            logger_1.winstonLogger.remove(captureTransport);
+        }
+        (0, bun_test_1.expect)(lines.some(function (l) { return l.includes("timestamp-test"); })).toBe(true);
+    });
+    (0, bun_test_1.it)("disableTerrenoDevJsonlLog skips the dev JSONL transport", function () {
+        (0, bun_test_1.expect)(function () {
+            return (0, logger_1.setupLogging)({
+                disableFileLogging: true,
+                disableTerrenoDevJsonlLog: true,
+            });
+        }).not.toThrow();
+    });
 });

package/dist/middleware.d.ts

@@ -8,3 +8,10 @@ import type { NextFunction, Request, Response } from "express";
  * Expected header: `App-Version`
  */
 export declare const sentryAppVersionMiddleware: (req: Request, _res: Response, next: NextFunction) => void;
+/**
+ * TerrenoApp middleware: augments `res.json` so plain-object payloads include
+ * `requestId` for client correlation. Skips OpenAPI tooling GET JSON routes
+ * (`/openapi.json`, `/openapi/components/...json`, `/openapi/validate`) so
+ * machine-consumed payloads stay valid. Does not wrap arrays or primitives.
+ */
+export declare const jsonResponseRequestIdMiddleware: (req: Request, res: Response, next: NextFunction) => void;

package/dist/middleware.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -33,8 +44,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sentryAppVersionMiddleware = void 0;
+exports.jsonResponseRequestIdMiddleware = exports.sentryAppVersionMiddleware = void 0;
 var Sentry = __importStar(require("@sentry/bun"));
+var requestContext_1 = require("./requestContext");
 /**
  * Express middleware that captures the app version from the request header
  * and adds it as a tag to the current Sentry scope.
@@ -51,3 +63,48 @@ var sentryAppVersionMiddleware = function (req, _res, next) {
     next();
 };
 exports.sentryAppVersionMiddleware = sentryAppVersionMiddleware;
+/**
+ * OpenAPI vendor routes that must return pristine JSON (no injected requestId).
+ * Matches @wesleytodd/openapi: main spec, per-component JSON, and validate payload.
+ */
+var isOpenApiToolingJsonRequest = function (req) {
+    if (req.method !== "GET") {
+        return false;
+    }
+    var path = req.path;
+    if (path === "/openapi.json") {
+        return true;
+    }
+    if (path === "/openapi/validate") {
+        return true;
+    }
+    if (path.startsWith("/openapi/components/") && path.endsWith(".json")) {
+        return true;
+    }
+    return false;
+};
+/**
+ * TerrenoApp middleware: augments `res.json` so plain-object payloads include
+ * `requestId` for client correlation. Skips OpenAPI tooling GET JSON routes
+ * (`/openapi.json`, `/openapi/components/...json`, `/openapi/validate`) so
+ * machine-consumed payloads stay valid. Does not wrap arrays or primitives.
+ */
+var jsonResponseRequestIdMiddleware = function (req, res, next) {
+    var originalJson = res.json.bind(res);
+    res.json = function (body) {
+        var _a, _b;
+        if (isOpenApiToolingJsonRequest(req)) {
+            return originalJson(body);
+        }
+        var requestId = (_a = req.requestId) !== null && _a !== void 0 ? _a : (_b = (0, requestContext_1.getCurrentRequestContext)()) === null || _b === void 0 ? void 0 : _b.requestId;
+        if (!requestId) {
+            return originalJson(body);
+        }
+        if (body !== null && body !== undefined && typeof body === "object" && !Array.isArray(body)) {
+            return originalJson(__assign(__assign({}, body), { requestId: requestId }));
+        }
+        return originalJson(body);
+    };
+    next();
+};
+exports.jsonResponseRequestIdMiddleware = jsonResponseRequestIdMiddleware;