@terreno/api 0.13.2 → 0.14.0

package/dist/requestContext.test.js

@@ -0,0 +1,241 @@
+"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 __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var node_stream_1 = require("node:stream");
+var Sentry = __importStar(require("@sentry/bun"));
+var express_1 = __importDefault(require("express"));
+var supertest_1 = __importDefault(require("supertest"));
+var winston_1 = __importDefault(require("winston"));
+var logger_1 = require("./logger");
+var requestContext_1 = require("./requestContext");
+(0, bun_test_1.describe)("request context job propagation", function () {
+    (0, bun_test_1.beforeEach)(function () {
+        var scope = Sentry.getCurrentScope();
+        scope.setContext.mockClear();
+        scope.setTag.mockClear();
+        scope.setUser.mockClear();
+    });
+    (0, bun_test_1.afterEach)(function () {
+        (0, logger_1.setupLogging)({ disableFileLogging: true });
+    });
+    (0, bun_test_1.it)("serializes the current context for downstream jobs", function () {
+        (0, requestContext_1.runWithRequestContext)({
+            jobId: "job-1",
+            requestId: "request-1",
+            sessionId: "session-1",
+            spanId: "span-1",
+            traceId: "trace-1",
+            traceSampled: false,
+            userId: "user-1",
+        }, function () {
+            (0, bun_test_1.expect)((0, requestContext_1.getCurrentRequestContextAttributes)()).toEqual({
+                "x-job-id": "job-1",
+                "x-request-id": "request-1",
+                "x-session-id": "session-1",
+                "x-span-id": "span-1",
+                "x-trace-id": "trace-1",
+                "x-trace-sampled": "false",
+                "x-user-id": "user-1",
+            });
+        });
+    });
+    (0, bun_test_1.it)("allows downstream jobs to replace only the job id", function () {
+        (0, requestContext_1.runWithRequestContext)({ jobId: "job-parent", requestId: "request-1", sessionId: "session-1" }, function () {
+            (0, bun_test_1.expect)((0, requestContext_1.getCurrentRequestContextAttributes)({ jobId: "job-child" })).toEqual({
+                "x-job-id": "job-child",
+                "x-request-id": "request-1",
+                "x-session-id": "session-1",
+            });
+        });
+    });
+    (0, bun_test_1.it)("restores worker context from message attributes", function () {
+        var scope = Sentry.getCurrentScope();
+        var setContextMock = scope.setContext;
+        var setTagMock = scope.setTag;
+        var setUserMock = scope.setUser;
+        (0, requestContext_1.runWithRequestContextAttributes)({
+            traceparent: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
+            "x-job-id": "job-worker-1",
+            "x-request-id": "request-1",
+            "x-session-id": "session-1",
+            "x-user-id": "user-1",
+        }, function () {
+            (0, bun_test_1.expect)((0, requestContext_1.getCurrentRequestContext)()).toEqual({
+                jobId: "job-worker-1",
+                requestId: "request-1",
+                sessionId: "session-1",
+                spanId: "00f067aa0ba902b7",
+                traceId: "4bf92f3577b34da6a3ce929d0e0e4736",
+                traceSampled: true,
+                userId: "user-1",
+            });
+        });
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("request_id", "request-1");
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("session_id", "session-1");
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("job_id", "job-worker-1");
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("user_id", "user-1");
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("trace_id", "4bf92f3577b34da6a3ce929d0e0e4736");
+        (0, bun_test_1.expect)(setUserMock).toHaveBeenCalledWith({ id: "user-1" });
+        (0, bun_test_1.expect)(setContextMock).toHaveBeenCalledWith("request_context", {
+            jobId: "job-worker-1",
+            requestId: "request-1",
+            sessionId: "session-1",
+            spanId: "00f067aa0ba902b7",
+            traceId: "4bf92f3577b34da6a3ce929d0e0e4736",
+            traceSampled: true,
+            userId: "user-1",
+        });
+    });
+    (0, bun_test_1.it)("sends context updates to Sentry for auth session changes", function () {
+        var scope = Sentry.getCurrentScope();
+        var setTagMock = scope.setTag;
+        var setUserMock = scope.setUser;
+        (0, requestContext_1.runWithRequestContext)({ requestId: "request-auth-1" }, function () {
+            setTagMock.mockClear();
+            setUserMock.mockClear();
+            (0, requestContext_1.setRequestContext)({ sessionId: "session-auth-1", userId: "user-auth-1" });
+        });
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("session_id", "session-auth-1");
+        (0, bun_test_1.expect)(setTagMock).toHaveBeenCalledWith("user_id", "user-auth-1");
+        (0, bun_test_1.expect)(setUserMock).toHaveBeenCalledWith({ id: "user-auth-1" });
+    });
+    (0, bun_test_1.it)("uses trace id as request id when attributes do not include request id", function () {
+        var context = (0, requestContext_1.getRequestContextFromAttributes)({
+            traceparent: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
+            "x-job-id": "job-worker-1",
+        });
+        (0, bun_test_1.expect)(context).toEqual({
+            jobId: "job-worker-1",
+            requestId: "4bf92f3577b34da6a3ce929d0e0e4736",
+            sessionId: undefined,
+            spanId: "00f067aa0ba902b7",
+            traceId: "4bf92f3577b34da6a3ce929d0e0e4736",
+            traceSampled: false,
+            userId: undefined,
+        });
+    });
+    (0, bun_test_1.it)("accepts job id from HTTP headers", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    app = (0, express_1.default)();
+                    app.use(requestContext_1.requestContextMiddleware);
+                    app.get("/job", function (req, res) {
+                        res.json({ context: (0, requestContext_1.getCurrentLogContext)(), jobId: req.jobId });
+                    });
+                    return [4 /*yield*/, (0, supertest_1.default)(app)
+                            .get("/job")
+                            .set("X-Job-ID", "job-http-1")
+                            .set("X-Request-ID", "request-http-1")
+                            .expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.headers["x-job-id"]).toBe("job-http-1");
+                    (0, bun_test_1.expect)(res.body).toEqual({
+                        context: { jobId: "job-http-1", requestId: "request-http-1" },
+                        jobId: "job-http-1",
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("adds job id to logger context", function () {
+        var output = "";
+        var stream = new node_stream_1.Writable({
+            write: function (chunk, _encoding, callback) {
+                output += chunk.toString();
+                callback();
+            },
+        });
+        (0, logger_1.setupLogging)({
+            disableConsoleLogging: true,
+            disableFileLogging: true,
+            transports: [
+                new winston_1.default.transports.Stream({
+                    format: winston_1.default.format.printf(function (info) {
+                        return "".concat(info.level, ": ").concat(info.message, " requestId=").concat(info.requestId, " jobId=").concat(info.jobId);
+                    }),
+                    stream: stream,
+                }),
+            ],
+        });
+        (0, requestContext_1.runWithRequestContext)({ jobId: "job-log-1", requestId: "request-log-1" }, function () {
+            logger_1.logger.info("worker handled job");
+        });
+        (0, bun_test_1.expect)(output).toContain("requestId=request-log-1");
+        (0, bun_test_1.expect)(output).toContain("jobId=job-log-1");
+    });
+});

package/dist/terrenoApp.d.ts

@@ -6,6 +6,7 @@ import { type ConfigurationAppOptions } from "./configurationApp";
 import { type AuthOptions } from "./expressServer";
 import { type GitHubAuthOptions } from "./githubAuth";
 import { type LoggingOptions } from "./logger";
+import type { RealtimeAppOptions } from "./realtime/types";
 import type { TerrenoPlugin } from "./terrenoPlugin";
 type CorsOrigin = string | boolean | RegExp | Array<boolean | string | RegExp> | ((requestOrigin: string | undefined, callback: (err: Error | null, origin?: boolean | string | RegExp | Array<boolean | string | RegExp>) => void) => void);
 /**
@@ -30,6 +31,13 @@ export interface TerrenoAppOptions {
     arrayLimit?: number;
     /** Whether to log all incoming requests (default: true) */
     logRequests?: boolean;
+    /**
+     * Real-time sync configuration. When provided, Socket.io and MongoDB change streams
+     * are set up automatically — no need to register RealtimeApp as a separate plugin.
+     *
+     * Set to `true` for defaults, or pass a RealtimeAppOptions object for full control.
+     */
+    realtime?: boolean | RealtimeAppOptions;
 }
 /**
  * Fluent API for building Express applications with Terreno framework.

package/dist/terrenoApp.js

@@ -59,6 +59,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TerrenoApp = void 0;
+var node_http_1 = require("node:http");
 var Sentry = __importStar(require("@sentry/bun"));
 var cors_1 = __importDefault(require("cors"));
 var express_1 = __importDefault(require("express"));
@@ -71,6 +72,8 @@ var githubAuth_1 = require("./githubAuth");
 var logger_1 = require("./logger");
 var openApiCompat_1 = require("./openApiCompat");
 var openApiEtag_1 = require("./openApiEtag");
+var realtimeApp_1 = require("./realtime/realtimeApp");
+var requestContext_1 = require("./requestContext");
 var index_1 = __importDefault(require("./vendor/wesleytodd-openapi/index"));
 /**
  * Fluent API for building Express applications with Terreno framework.
@@ -211,7 +214,9 @@ var TerrenoApp = /** @class */ (function () {
      *   .start();
      * ```
      */
-    TerrenoApp.prototype.configure = function (model, options) {
+    TerrenoApp.prototype.configure = function (
+    // biome-ignore lint/suspicious/noExplicitAny: Model<any> required for invariance — consumers pass arbitrary configuration models
+    model, options) {
         this.configurationApp = new configurationApp_1.ConfigurationApp(__assign({ model: model }, options));
         return this;
     };
@@ -247,6 +252,7 @@ var TerrenoApp = /** @class */ (function () {
         // Record mount paths on layers for Express 5 → OpenAPI compat
         (0, openApiCompat_1.patchAppUse)(app);
         app.set("query parser", function (str) { var _a; return qs_1.default.parse(str, { arrayLimit: (_a = options.arrayLimit) !== null && _a !== void 0 ? _a : 200 }); });
+        app.use(requestContext_1.requestContextMiddleware);
         app.use((0, cors_1.default)({ credentials: true, origin: (_c = options.corsOrigin) !== null && _c !== void 0 ? _c : "*" }));
         try {
             // Apply custom middleware before JSON parsing
@@ -273,6 +279,10 @@ var TerrenoApp = /** @class */ (function () {
         // Auth routes (login/signup/refresh_token) before JWT middleware
         (0, auth_1.addAuthRoutes)(app, options.userModel, options.authOptions);
         (0, auth_1.setupAuth)(app, options.userModel);
+        app.use(function (req, res, next) {
+            (0, requestContext_1.updateRequestContextFromRequest)(req, res);
+            next();
+        });
         if (options.logRequests !== false) {
             app.use(expressServer_1.logRequests);
         }
@@ -283,17 +293,21 @@ var TerrenoApp = /** @class */ (function () {
         });
         // Sentry scopes
         app.use(function (req, _res, next) {
-            var _a;
+            var _a, _b;
+            var context = (0, requestContext_1.getCurrentRequestContext)();
             var transactionId = req.header("X-Transaction-ID");
-            var sessionId = req.header("X-Session-ID");
+            var sessionId = (_a = context === null || context === void 0 ? void 0 : context.sessionId) !== null && _a !== void 0 ? _a : req.header("X-Session-ID");
+            if (context === null || context === void 0 ? void 0 : context.requestId) {
+                Sentry.getCurrentScope().setTag("request_id", context.requestId);
+            }
             if (transactionId) {
                 Sentry.getCurrentScope().setTag("transaction_id", transactionId);
             }
             if (sessionId) {
                 Sentry.getCurrentScope().setTag("session_id", sessionId);
             }
-            if ((_a = req.user) === null || _a === void 0 ? void 0 : _a._id) {
-                Sentry.getCurrentScope().setTag("user", req.user._id);
+            if ((_b = req.user) === null || _b === void 0 ? void 0 : _b._id) {
+                Sentry.getCurrentScope().setTag("user", String(req.user._id));
             }
             next();
         });
@@ -348,12 +362,7 @@ var TerrenoApp = /** @class */ (function () {
         // Error middleware
         app.use(errors_1.apiUnauthorizedMiddleware);
         app.use(errors_1.apiErrorMiddleware);
-        app.use(function onError(err, _req, res, _next) {
-            logger_1.logger.error("Fallthrough error: ".concat(err).concat((err === null || err === void 0 ? void 0 : err.stack) ? "\n".concat(err.stack) : "", "}"));
-            Sentry.captureException(err);
-            res.statusCode = 500;
-            res.end("".concat(res.sentry, "\n"));
-        });
+        app.use(errors_1.apiFallthroughErrorMiddleware);
         return app;
     };
     /**
@@ -377,16 +386,44 @@ var TerrenoApp = /** @class */ (function () {
      * ```
      */
     TerrenoApp.prototype.start = function () {
+        var e_3, _a;
+        var _this = this;
+        // If realtime option is set, auto-register the RealtimeApp plugin
+        if (this.options.realtime) {
+            var hasRealtimePlugin = this.registrations.some(function (r) { return !_this.isModelRouterRegistration(r) && r instanceof realtimeApp_1.RealtimeApp; });
+            if (!hasRealtimePlugin) {
+                var realtimeConfig = typeof this.options.realtime === "object" ? this.options.realtime : {};
+                this.register(new realtimeApp_1.RealtimeApp(realtimeConfig));
+            }
+        }
         var app = this.build();
         if (!this.options.skipListen) {
             var port_1 = process.env.PORT || "9000";
             try {
-                app.listen(port_1, function () {
+                var server = (0, node_http_1.createServer)(app);
+                try {
+                    // Notify plugins that need access to the HTTP server (e.g. WebSocket plugins)
+                    for (var _b = __values(this.registrations), _c = _b.next(); !_c.done; _c = _b.next()) {
+                        var reg = _c.value;
+                        if (!this.isModelRouterRegistration(reg) && typeof reg.onServerCreated === "function") {
+                            reg.onServerCreated(server);
+                        }
+                    }
+                }
+                catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                finally {
+                    try {
+                        if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                    }
+                    finally { if (e_3) throw e_3.error; }
+                }
+                server.listen(port_1, function () {
                     logger_1.logger.info("Listening on port ".concat(port_1));
                 });
             }
             catch (error) {
-                logger_1.logger.error("Error trying to start HTTP server: ".concat(error, "\n").concat(error.stack));
+                var stack = error instanceof Error ? error.stack : String(error);
+                logger_1.logger.error("Error trying to start HTTP server: ".concat(error, "\n").concat(stack));
                 process.exit(1);
             }
         }