@terreno/api 0.20.2 → 0.21.0

package/dist/expressServer.js

@@ -97,24 +97,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapScript = exports.cronjob = exports.setupServer = exports.createRouterWithAuth = exports.createRouter = exports.logRequests = exports.setupEnvironment = void 0;
+exports.wrapScript = exports.cronjob = exports.createRouterWithAuth = exports.createRouter = exports.logRequests = exports.setupEnvironment = void 0;
 var Sentry = __importStar(require("@sentry/bun"));
-var cors_1 = __importDefault(require("cors"));
 var cron_1 = __importDefault(require("cron"));
 var express_1 = __importDefault(require("express"));
 var cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 var on_finished_1 = __importDefault(require("on-finished"));
 var passport_1 = __importDefault(require("passport"));
-var qs_1 = __importDefault(require("qs"));
-var auth_1 = require("./auth");
-var errors_1 = require("./errors");
-var githubAuth_1 = require("./githubAuth");
 var logger_1 = require("./logger");
 var notifiers_1 = require("./notifiers");
-var openApiCompat_1 = require("./openApiCompat");
-var openApiEtag_1 = require("./openApiEtag");
-var requestContext_1 = require("./requestContext");
-var index_1 = __importDefault(require("./vendor/wesleytodd-openapi/index"));
 var SLOW_READ_MAX = 200;
 var SLOW_WRITE_MAX = 500;
 var IS_JEST = process.env.JEST_WORKER_ID !== undefined;
@@ -232,121 +223,6 @@ var createRouterWithAuth = function (rootPath, addRoutes, middleware) {
     ], __read(middleware), false));
 };
 exports.createRouterWithAuth = createRouterWithAuth;
-var initializeRoutes = function (UserModel, addRoutes, options) {
-    var _a;
-    if (options === void 0) { options = {}; }
-    var app = (0, express_1.default)();
-    // 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)({
-        origin: (_a = options.corsOrigin) !== null && _a !== void 0 ? _a : "*",
-    }));
-    if (options.addMiddleware) {
-        options.addMiddleware(app);
-    }
-    app.use(express_1.default.json({ limit: "50mb" }));
-    // Add login/signup/refresh_token before the JWT/auth middlewares
-    (0, auth_1.addAuthRoutes)(app, UserModel, options === null || options === void 0 ? void 0 : options.authOptions);
-    (0, auth_1.setupAuth)(app, UserModel);
-    app.use(function (req, res, next) {
-        (0, requestContext_1.updateRequestContextFromRequest)(req, res);
-        next();
-    });
-    if (options.logRequests !== false) {
-        app.use(exports.logRequests);
-    }
-    // Store the logging options on the request so we can access them later.
-    app.use(function (_req, res, next) {
-        res.locals.loggingOptions = options.loggingOptions;
-        next();
-    });
-    // Add Sentry scopes for session, transaction, and userId if any are set
-    app.use(function (req, _res, next) {
-        var _a, _b;
-        var context = (0, requestContext_1.getCurrentRequestContext)();
-        var transactionId = req.header("X-Transaction-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 ((_b = req.user) === null || _b === void 0 ? void 0 : _b._id) {
-            Sentry.getCurrentScope().setTag("user", String(req.user._id));
-        }
-        next();
-    });
-    // Add ETag middleware for OpenAPI JSON endpoint before the openapi middleware
-    app.use(openApiCompat_1.openApiCompatMiddleware);
-    app.use(openApiEtag_1.openApiEtagMiddleware);
-    var oapi = (0, index_1.default)({
-        info: {
-            description: "Generated docs from an Express api",
-            title: "Express Application",
-            version: "1.0.0",
-        },
-        openapi: "3.0.0",
-    });
-    app.use(oapi);
-    if (process.env.ENABLE_SWAGGER === "true") {
-        app.use("/swagger", oapi.swaggerui());
-    }
-    (0, auth_1.addMeRoutes)(app, UserModel, options === null || options === void 0 ? void 0 : options.authOptions);
-    // Set up GitHub OAuth if configured (works with JWT auth)
-    if (options.githubAuth) {
-        (0, githubAuth_1.setupGitHubAuth)(app, UserModel, options.githubAuth);
-        (0, githubAuth_1.addGitHubAuthRoutes)(app, UserModel, options.githubAuth, options.authOptions);
-    }
-    addRoutes(app, { openApi: oapi });
-    Sentry.setupExpressErrorHandler(app);
-    // Catch any thrown APIErrors and return them in an OpenAPI compatible format
-    app.use(errors_1.apiUnauthorizedMiddleware);
-    app.use(errors_1.apiErrorMiddleware);
-    app.use(errors_1.apiFallthroughErrorMiddleware);
-    return app;
-};
-var setupServer = function (options) {
-    var UserModel = options.userModel;
-    var addRoutes = options.addRoutes;
-    (0, logger_1.setupLogging)(options.loggingOptions);
-    var app;
-    try {
-        app = initializeRoutes(UserModel, addRoutes, {
-            addMiddleware: options.addMiddleware,
-            authOptions: options.authOptions,
-            corsOrigin: options.corsOrigin,
-            githubAuth: options.githubAuth,
-            loggingOptions: options.loggingOptions,
-            logRequests: options.logRequests,
-        });
-    }
-    catch (error) {
-        var stack = error instanceof Error && error.stack ? error.stack : String(error);
-        logger_1.logger.error("Error initializing routes: ".concat(stack));
-        throw error;
-    }
-    if (!options.skipListen) {
-        var port_1 = process.env.PORT || "9000";
-        try {
-            app.listen(port_1, function () {
-                logger_1.logger.info("Listening on port ".concat(port_1));
-            });
-        }
-        catch (error) {
-            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);
-        }
-    }
-    return app;
-};
-exports.setupServer = setupServer;
 var cronjob = function (name, schedule, callback) {
     var cronSchedule = schedule === "hourly" ? "0 * * * *" : schedule === "minutely" ? "* * * * *" : schedule;
     logger_1.logger.info("Adding cronjob ".concat(name, ", running at: ").concat(cronSchedule));

package/dist/expressServer.test.js

@@ -127,6 +127,7 @@ var supertest_1 = __importDefault(require("supertest"));
 var winston_1 = __importDefault(require("winston"));
 var expressServer_1 = require("./expressServer");
 var logger_1 = require("./logger");
+var terrenoApp_1 = require("./terrenoApp");
 var tests_1 = require("./tests");
 (0, bun_test_1.describe)("expressServer", function () {
     (0, bun_test_1.describe)("setupEnvironment", function () {
@@ -175,8 +176,8 @@ var tests_1 = require("./tests");
                             format: winston_1.default.format.json(),
                             stream: logStream,
                         });
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: function (router) {
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: function (router) {
                                 router.get("/context-test", function (req, res) {
                                     logger_1.logger.info("context route log");
                                     return res.json({ requestId: req.requestId, sessionId: req.sessionId });
@@ -185,7 +186,7 @@ var tests_1 = require("./tests");
                             logRequests: false,
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         logger_1.winstonLogger.add(transport);
                         return [4 /*yield*/, (0, supertest_1.default)(app)
                                 .get("/context-test")
@@ -537,7 +538,7 @@ var tests_1 = require("./tests");
             });
         }); });
     });
-    (0, bun_test_1.describe)("setupServer", function () {
+    (0, bun_test_1.describe)("TerrenoApp", function () {
         var originalEnv = process.env;
         (0, bun_test_1.beforeEach)(function () {
             process.env = __assign(__assign({}, originalEnv), { REFRESH_TOKEN_SECRET: "test-refresh-secret", SESSION_SECRET: "test-session-secret", TOKEN_EXPIRES_IN: "1h", TOKEN_ISSUER: "test-issuer", TOKEN_SECRET: "test-secret" });
@@ -546,51 +547,50 @@ var tests_1 = require("./tests");
             process.env = originalEnv;
         });
         (0, bun_test_1.it)("creates server with skipListen option", function () {
-            var addRoutes = function () { };
-            var app = (0, expressServer_1.setupServer)({
-                addRoutes: addRoutes,
+            var configureApp = function () { };
+            var app = new terrenoApp_1.TerrenoApp({
+                configureApp: configureApp,
                 skipListen: true,
                 userModel: tests_1.UserModel,
-            });
+            }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
-        (0, bun_test_1.it)("creates server with addMiddleware option", function () {
+        (0, bun_test_1.it)("creates server with beforeJsonSetup option", function () {
             var middlewareCalled = false;
-            var addMiddleware = function (app) {
-                middlewareCalled = true;
-                app.use(function (_req, _res, next) { return next(); });
-            };
-            var addRoutes = function () { };
-            var app = (0, expressServer_1.setupServer)({
-                addMiddleware: addMiddleware,
-                addRoutes: addRoutes,
+            var configureApp = function () { };
+            var app = new terrenoApp_1.TerrenoApp({
+                beforeJsonSetup: function (httpApp) {
+                    middlewareCalled = true;
+                    httpApp.use(function (_req, _res, next) { return next(); });
+                },
+                configureApp: configureApp,
                 skipListen: true,
                 userModel: tests_1.UserModel,
-            });
+            }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
             (0, bun_test_1.expect)(middlewareCalled).toBe(true);
         });
         (0, bun_test_1.it)("creates server with custom corsOrigin", function () {
-            var addRoutes = function () { };
-            var app = (0, expressServer_1.setupServer)({
-                addRoutes: addRoutes,
+            var configureApp = function () { };
+            var app = new terrenoApp_1.TerrenoApp({
+                configureApp: configureApp,
                 corsOrigin: "https://example.com",
                 skipListen: true,
                 userModel: tests_1.UserModel,
-            });
+            }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
         (0, bun_test_1.it)("creates server with authOptions", function () {
-            var addRoutes = function () { };
-            var app = (0, expressServer_1.setupServer)({
-                addRoutes: addRoutes,
+            var configureApp = function () { };
+            var app = new terrenoApp_1.TerrenoApp({
                 authOptions: {
                     generateJWTPayload: function (user) { return ({ customField: "test", id: user._id }); },
                     generateTokenExpiration: function () { return "2h"; },
                 },
+                configureApp: configureApp,
                 skipListen: true,
                 userModel: tests_1.UserModel,
-            });
+            }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
     });
@@ -633,7 +633,7 @@ var tests_1 = require("./tests");
             });
         }); });
     });
-    (0, bun_test_1.describe)("setupServer with full integration", function () {
+    (0, bun_test_1.describe)("TerrenoApp with full integration", function () {
         var originalEnv = process.env;
         (0, bun_test_1.beforeEach)(function () {
             process.env = __assign(__assign({}, originalEnv), { REFRESH_TOKEN_SECRET: "test-refresh-secret", SESSION_SECRET: "test-session-secret", TOKEN_EXPIRES_IN: "1h", TOKEN_ISSUER: "test-issuer", TOKEN_SECRET: "test-secret" });
@@ -642,20 +642,20 @@ var tests_1 = require("./tests");
             process.env = originalEnv;
         });
         (0, bun_test_1.it)("sets Sentry transaction ID tag from header", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function (app) {
-                            app.get("/test", function (_req, res) {
+                        configureApp = function (httpApp) {
+                            httpApp.get("/test", function (_req, res) {
                                 res.json({ ok: true });
                             });
                         };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         return [4 /*yield*/, (0, supertest_1.default)(app).get("/test").set("X-Transaction-ID", "txn-123").expect(200)];
                     case 1:
                         _a.sent();
@@ -664,20 +664,20 @@ var tests_1 = require("./tests");
             });
         }); });
         (0, bun_test_1.it)("sets Sentry session ID tag from header", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function (app) {
-                            app.get("/test", function (_req, res) {
+                        configureApp = function (httpApp) {
+                            httpApp.get("/test", function (_req, res) {
                                 res.json({ ok: true });
                             });
                         };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         return [4 /*yield*/, (0, supertest_1.default)(app).get("/test").set("X-Session-ID", "session-456").expect(200)];
                     case 1:
                         _a.sent();
@@ -686,20 +686,20 @@ var tests_1 = require("./tests");
             });
         }); });
         (0, bun_test_1.it)("sets both transaction and session ID tags", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function (app) {
-                            app.get("/test", function (_req, res) {
+                        configureApp = function (httpApp) {
+                            httpApp.get("/test", function (_req, res) {
                                 res.json({ ok: true });
                             });
                         };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         return [4 /*yield*/, (0, supertest_1.default)(app)
                                 .get("/test")
                                 .set("X-Transaction-ID", "txn-123")
@@ -712,20 +712,20 @@ var tests_1 = require("./tests");
             });
         }); });
         (0, bun_test_1.it)("handles fallthrough error handler", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function (app) {
-                            app.get("/error", function (_req, _res) {
+                        configureApp = function (httpApp) {
+                            httpApp.get("/error", function (_req, _res) {
                                 throw new Error("Unexpected error");
                             });
                         };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         return [4 /*yield*/, (0, supertest_1.default)(app).get("/error").expect(500)];
                     case 1:
                         _a.sent();
@@ -733,25 +733,25 @@ var tests_1 = require("./tests");
                 }
             });
         }); });
-        (0, bun_test_1.it)("handles loggingOptions passed to setupServer", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+        (0, bun_test_1.it)("handles loggingOptions passed to TerrenoApp", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function (app) {
-                            app.get("/test", function (_req, res) {
+                        configureApp = function (httpApp) {
+                            httpApp.get("/test", function (_req, res) {
                                 res.json({ ok: true });
                             });
                         };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             loggingOptions: {
                                 logSlowRequests: true,
                                 logSlowRequestsReadMs: 100,
                             },
                             skipListen: true,
                             userModel: tests_1.UserModel,
-                        });
+                        }).build();
                         return [4 /*yield*/, (0, supertest_1.default)(app).get("/test").expect(200)];
                     case 1:
                         _a.sent();
@@ -759,16 +759,16 @@ var tests_1 = require("./tests");
                 }
             });
         }); });
-        (0, bun_test_1.it)("re-throws when addRoutes throws during route initialization", function () {
-            var addRoutes = function () {
+        (0, bun_test_1.it)("re-throws when configureApp throws during build", function () {
+            var configureApp = function () {
                 throw new Error("Route init boom");
             };
             (0, bun_test_1.expect)(function () {
-                return (0, expressServer_1.setupServer)({
-                    addRoutes: addRoutes,
+                return new terrenoApp_1.TerrenoApp({
+                    configureApp: configureApp,
                     skipListen: true,
                     userModel: tests_1.UserModel,
-                });
+                }).build();
             }).toThrow("Route init boom");
         });
     });
@@ -1021,7 +1021,7 @@ var tests_1 = require("./tests");
             });
         }); });
     });
-    (0, bun_test_1.describe)("setupServer with listen (skipListen false)", function () {
+    (0, bun_test_1.describe)("TerrenoApp with listen (skipListen false)", function () {
         var originalEnv = process.env;
         (0, bun_test_1.beforeEach)(function () {
             process.env = __assign(__assign({}, originalEnv), { PORT: "0", REFRESH_TOKEN_SECRET: "test-refresh-secret", SESSION_SECRET: "test-session-secret", TOKEN_EXPIRES_IN: "1h", TOKEN_ISSUER: "test-issuer", TOKEN_SECRET: "test-secret" });
@@ -1030,16 +1030,16 @@ var tests_1 = require("./tests");
             process.env = originalEnv;
         });
         (0, bun_test_1.it)("starts the server when skipListen is false", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, express, originalListen, app;
+            var configureApp, http, originalListen, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function () { };
-                        return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("express")); })];
+                        configureApp = function () { };
+                        return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("node:http")); })];
                     case 1:
-                        express = _a.sent();
-                        originalListen = express.default.application.listen;
-                        express.default.application.listen = (0, bun_test_1.mock)(function () {
+                        http = _a.sent();
+                        originalListen = http.Server.prototype.listen;
+                        http.Server.prototype.listen = (0, bun_test_1.mock)(function () {
                             var args = [];
                             for (var _i = 0; _i < arguments.length; _i++) {
                                 args[_i] = arguments[_i];
@@ -1051,15 +1051,15 @@ var tests_1 = require("./tests");
                             return this;
                         });
                         try {
-                            app = (0, expressServer_1.setupServer)({
-                                addRoutes: addRoutes,
+                            app = new terrenoApp_1.TerrenoApp({
+                                configureApp: configureApp,
                                 skipListen: false,
                                 userModel: tests_1.UserModel,
-                            });
+                            }).start();
                             (0, bun_test_1.expect)(app).toBeDefined();
                         }
                         finally {
-                            express.default.application.listen = originalListen;
+                            http.Server.prototype.listen = originalListen;
                         }
                         return [2 /*return*/];
                 }
@@ -1067,16 +1067,15 @@ var tests_1 = require("./tests");
         }); });
         (0, bun_test_1.it)("handles listen error with invalid port", function () {
             process.env.PORT = "-1";
-            var addRoutes = function () { };
-            // Using an invalid port should trigger the catch block and process.exit(1)
+            var configureApp = function () { };
             var originalExit = process.exit;
             process.exit = (function () { });
             try {
-                (0, expressServer_1.setupServer)({
-                    addRoutes: addRoutes,
+                new terrenoApp_1.TerrenoApp({
+                    configureApp: configureApp,
                     skipListen: false,
                     userModel: tests_1.UserModel,
-                });
+                }).start();
             }
             catch (_a) {
                 // May throw
@@ -1084,7 +1083,7 @@ var tests_1 = require("./tests");
             process.exit = originalExit;
         });
     });
-    (0, bun_test_1.describe)("setupServer with listen", function () {
+    (0, bun_test_1.describe)("TerrenoApp with listen", function () {
         var originalEnv = process.env;
         var http = require("node:http");
         var activeServer = null;
@@ -1118,16 +1117,16 @@ var tests_1 = require("./tests");
             });
         }); });
         (0, bun_test_1.it)("starts listening on a port when skipListen is false", function () { return __awaiter(void 0, void 0, void 0, function () {
-            var addRoutes, app;
+            var configureApp, app;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        addRoutes = function () { };
-                        app = (0, expressServer_1.setupServer)({
-                            addRoutes: addRoutes,
+                        configureApp = function () { };
+                        app = new terrenoApp_1.TerrenoApp({
+                            configureApp: configureApp,
                             skipListen: false,
                             userModel: tests_1.UserModel,
-                        });
+                        }).start();
                         (0, bun_test_1.expect)(app).toBeDefined();
                         return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 100); })];
                     case 1:
@@ -1196,7 +1195,7 @@ var tests_1 = require("./tests");
             });
         }); });
     });
-    (0, bun_test_1.describe)("setupServer error handling", function () {
+    (0, bun_test_1.describe)("TerrenoApp error handling", function () {
         var originalEnv = process.env;
         (0, bun_test_1.beforeEach)(function () {
             process.env = __assign(__assign({}, originalEnv), { REFRESH_TOKEN_SECRET: "test-refresh-secret", SESSION_SECRET: "test-session-secret", TOKEN_EXPIRES_IN: "1h", TOKEN_ISSUER: "test-issuer", TOKEN_SECRET: "test-secret" });
@@ -1204,16 +1203,16 @@ var tests_1 = require("./tests");
         (0, bun_test_1.afterEach)(function () {
             process.env = originalEnv;
         });
-        (0, bun_test_1.it)("catches and rethrows errors from initializeRoutes", function () {
-            var addRoutes = function () {
+        (0, bun_test_1.it)("throws when configureApp throws during build", function () {
+            var configureApp = function () {
                 throw new Error("route initialization failed");
             };
             (0, bun_test_1.expect)(function () {
-                return (0, expressServer_1.setupServer)({
-                    addRoutes: addRoutes,
+                return new terrenoApp_1.TerrenoApp({
+                    configureApp: configureApp,
                     skipListen: true,
                     userModel: tests_1.UserModel,
-                });
+                }).build();
             }).toThrow("route initialization failed");
         });
     });