@terreno/api 0.20.1 → 0.21.0

package/dist/terrenoApp.test.js

@@ -104,6 +104,7 @@ var mongoose_1 = __importStar(require("mongoose"));
 var supertest_1 = __importDefault(require("supertest"));
 var api_1 = require("./api");
 var configurationPlugin_1 = require("./configurationPlugin");
+var errors_1 = require("./errors");
 var permissions_1 = require("./permissions");
 var plugins_1 = require("./plugins");
 var terrenoApp_1 = require("./terrenoApp");
@@ -125,6 +126,24 @@ var typedUserModel = tests_1.UserModel;
             }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
+        (0, bun_test_1.it)("does not add requestId to GET /openapi.json document bodies", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var app, res;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: typedUserModel,
+                        }).build();
+                        return [4 /*yield*/, (0, supertest_1.default)(app).get("/openapi.json").expect(200)];
+                    case 1:
+                        res = _d.sent();
+                        (0, bun_test_1.expect)(res.body.openapi).toBe("3.0.0");
+                        (0, bun_test_1.expect)(res.body.requestId).toBeUndefined();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
         (0, bun_test_1.it)("creates server with custom corsOrigin", function () {
             var app = new terrenoApp_1.TerrenoApp({
                 corsOrigin: "https://example.com",
@@ -196,6 +215,7 @@ var typedUserModel = tests_1.UserModel;
                         res = _d.sent();
                         (0, bun_test_1.expect)(res.body.data).toHaveLength(1);
                         (0, bun_test_1.expect)(res.body.data[0].name).toBe("Apple");
+                        (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
                         return [2 /*return*/];
                 }
             });
@@ -301,6 +321,7 @@ var typedUserModel = tests_1.UserModel;
                     case 2:
                         res = _d.sent();
                         (0, bun_test_1.expect)(res.status).toBe(200);
+                        (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
                         return [2 /*return*/];
                 }
             });
@@ -356,6 +377,37 @@ var typedUserModel = tests_1.UserModel;
                     case 1:
                         res = _d.sent();
                         (0, bun_test_1.expect)(res.status).toBe(500);
+                        (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
+                        (0, bun_test_1.expect)(res.body.status).toBe(500);
+                        (0, bun_test_1.expect)(res.body.title).toBe("Internal server error");
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("adds requestId to APIError JSON responses", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var plugin, app, res;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        plugin = {
+                            register: function (pluginApp) {
+                                pluginApp.get("/api-error-route", function () {
+                                    throw new errors_1.APIError({ status: 400, title: "Bad request test" });
+                                });
+                            },
+                        };
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: typedUserModel,
+                        })
+                            .register(plugin)
+                            .build();
+                        return [4 /*yield*/, (0, supertest_1.default)(app).get("/api-error-route").set("X-Request-ID", "api-err-rid")];
+                    case 1:
+                        res = _d.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(400);
+                        (0, bun_test_1.expect)(res.body.requestId).toBe("api-err-rid");
+                        (0, bun_test_1.expect)(res.body.title).toBe("Bad request test");
                         return [2 /*return*/];
                 }
             });

package/dist/tests/bunSetup.js

@@ -1,4 +1,37 @@
 "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) {
@@ -72,16 +105,32 @@ var winston_1 = __importDefault(require("winston"));
 var expressServer_1 = require("../expressServer");
 var logger_1 = require("../logger");
 var shouldConnectToTestDb = process.env.BUN_TEST_DISABLE_DB !== "true";
+var defaultLocalMongoUri = "mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000";
+/** When set by {@link TERRENO_TEST_USE_MEMORY_MONGO}, holds the server to stop in afterAll. */
+var memoryMongo;
 // Connect to MongoDB once for all tests
 if (shouldConnectToTestDb) {
     (0, bun_test_1.beforeAll)(function () { return __awaiter(void 0, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, mongoose_1.default
-                        .connect("mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000")
-                        .catch(logger_1.logger.catch)];
+        var uri, MongoMemoryServer, connectUri;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    uri = (_a = process.env.TERRENO_TEST_MONGODB_URI) === null || _a === void 0 ? void 0 : _a.trim();
+                    if (!(!uri && process.env.TERRENO_TEST_USE_MEMORY_MONGO === "true")) return [3 /*break*/, 3];
+                    return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("mongodb-memory-server")); })];
                 case 1:
-                    _a.sent();
+                    MongoMemoryServer = (_b.sent()).MongoMemoryServer;
+                    return [4 /*yield*/, MongoMemoryServer.create()];
+                case 2:
+                    memoryMongo = _b.sent();
+                    uri = memoryMongo.getUri();
+                    _b.label = 3;
+                case 3:
+                    connectUri = uri !== null && uri !== void 0 ? uri : defaultLocalMongoUri;
+                    return [4 /*yield*/, mongoose_1.default.connect(connectUri).catch(logger_1.logger.catch)];
+                case 4:
+                    _b.sent();
                     return [2 /*return*/];
             }
         });
@@ -95,7 +144,12 @@ if (shouldConnectToTestDb) {
                 case 0: return [4 /*yield*/, mongoose_1.default.connection.close()];
                 case 1:
                     _a.sent();
-                    return [2 /*return*/];
+                    if (!memoryMongo) return [3 /*break*/, 3];
+                    return [4 /*yield*/, memoryMongo.stop()];
+                case 2:
+                    _a.sent();
+                    _a.label = 3;
+                case 3: return [2 /*return*/];
             }
         });
     }); });

package/dist/tests.js

@@ -192,7 +192,7 @@ var getBaseServer = function () {
     app.set("query parser", function (str) { return qs_1.default.parse(str, { arrayLimit: 200 }); });
     // Express 5 defaults to 'simple' query parser (Node querystring) which doesn't
     // support nested bracket notation like name[$regex]=Green. Use qs to match
-    // what setupServer() configures.
+    // what TerrenoApp.build() configures.
     app.set("query parser", function (str) { return qs_1.default.parse(str, { arrayLimit: 200 }); });
     // Record mount paths on layers for Express 5 → OpenAPI compat
     (0, openApiCompat_1.patchAppUse)(app);
@@ -230,13 +230,36 @@ var authAsUser = function (app, type) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 exports.authAsUser = authAsUser;
+var defaultTestMongoUri = "mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000";
+/** Ensures Mongoose is connected without replacing an existing test connection (e.g. MongoMemoryServer from bunSetup). */
+var ensureTestMongooseConnected = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var uri;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                if (mongoose_1.default.connection.readyState === 1) {
+                    return [2 /*return*/];
+                }
+                if (!(mongoose_1.default.connection.readyState === 2)) return [3 /*break*/, 2];
+                return [4 /*yield*/, mongoose_1.default.connection.asPromise()];
+            case 1:
+                _b.sent();
+                return [2 /*return*/];
+            case 2:
+                uri = ((_a = process.env.TERRENO_TEST_MONGODB_URI) === null || _a === void 0 ? void 0 : _a.trim()) || defaultTestMongoUri;
+                return [4 /*yield*/, mongoose_1.default.connect(uri).catch(logger_1.logger.catch)];
+            case 3:
+                _b.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
 var setupDb = function () { return __awaiter(void 0, void 0, void 0, function () {
     var _a, notAdmin, admin, adminOther, error_1;
     return __generator(this, function (_b) {
         switch (_b.label) {
-            case 0: return [4 /*yield*/, mongoose_1.default
-                    .connect("mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000")
-                    .catch(logger_1.logger.catch)];
+            case 0: return [4 /*yield*/, ensureTestMongooseConnected()];
             case 1:
                 _b.sent();
                 process.env.REFRESH_TOKEN_SECRET = "refresh_secret";

package/package.json

@@ -109,5 +109,5 @@
     "updateSnapshot": "bun test --update-snapshots"
   },
   "types": "dist/index.d.ts",
-  "version": "0.20.1"
+  "version": "0.21.0"
 }

package/src/__tests__/versionCheckPlugin.test.ts

@@ -30,19 +30,27 @@ describe("VersionCheckPlugin", () => {
   it("returns ok when no VersionConfig exists", async () => {
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({pollingIntervalMs: 86400000, status: "ok"});
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
+    expect(res.body).toEqual(
+      expect.objectContaining({
+        pollingIntervalMs: 86400000,
+        status: "ok",
+      })
+    );
   });
 
   it("returns ok when version param is missing", async () => {
     const res = await app.get("/version-check");
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({status: "ok"});
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
+    expect(res.body).toEqual(expect.objectContaining({status: "ok"}));
   });
 
   it("returns ok when version param is invalid", async () => {
     const res = await app.get("/version-check").query({platform: "web", version: "invalid"});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({status: "ok"});
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
+    expect(res.body).toEqual(expect.objectContaining({status: "ok"}));
   });
 
   it("returns ok when client version >= warning and required (web)", async () => {
@@ -53,12 +61,15 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 150});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({
-      pollingIntervalMs: 86400000,
-      requiredVersion: 50,
-      status: "ok",
-      warningVersion: 100,
-    });
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
+    expect(res.body).toEqual(
+      expect.objectContaining({
+        pollingIntervalMs: 86400000,
+        requiredVersion: 50,
+        status: "ok",
+        warningVersion: 100,
+      })
+    );
   });
 
   it("returns warning when client version < warning (web)", async () => {
@@ -70,6 +81,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 80});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("warning");
     expect(res.body.message).toBe("Please update!");
   });
@@ -84,6 +96,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 50});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("required");
     expect(res.body.message).toBe("Update required");
     expect(res.body.updateUrl).toBe("https://example.com/update");
@@ -98,9 +111,11 @@ describe("VersionCheckPlugin", () => {
     });
 
     const webRes = await app.get("/version-check").query({platform: "web", version: 100});
+    expect(webRes.body.requestId).toBe(webRes.headers["x-request-id"]);
     expect(webRes.body.status).toBe("ok");
 
     const mobileRes = await app.get("/version-check").query({platform: "mobile", version: 100});
+    expect(mobileRes.body.requestId).toBe(mobileRes.headers["x-request-id"]);
     expect(mobileRes.body.status).toBe("required");
   });
 
@@ -111,6 +126,7 @@ describe("VersionCheckPlugin", () => {
     });
 
     const res = await app.get("/version-check").query({platform: "invalid", version: 50});
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("required");
   });
 
@@ -122,12 +138,15 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
-    expect(res.body).toEqual({
-      pollingIntervalMs: 86400000,
-      requiredVersion: 50,
-      status: "ok",
-      warningVersion: 100,
-    });
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
+    expect(res.body).toEqual(
+      expect.objectContaining({
+        pollingIntervalMs: 86400000,
+        requiredVersion: 50,
+        status: "ok",
+        warningVersion: 100,
+      })
+    );
   });
 
   it("returns pollingIntervalMs from config pollingIntervalMinutes", async () => {
@@ -139,6 +158,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.pollingIntervalMs).toBe(3600000);
   });
 
@@ -150,6 +170,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.pollingIntervalMs).toBe(86400000);
   });
 
@@ -161,6 +182,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check?version=50&platform=web");
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("required");
   });
 
@@ -172,6 +194,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 50});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("warning");
     expect(res.body.message).toBe(
       "A new version is available. Please update for the best experience."
@@ -186,6 +209,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 50});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("required");
     expect(res.body.message).toBe(
       "This version is no longer supported. Please update to continue."
@@ -200,6 +224,7 @@ describe("VersionCheckPlugin", () => {
 
     const res = await app.get("/version-check").query({platform: "web", version: 100});
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
     expect(res.body.status).toBe("warning");
   });
 
@@ -210,12 +235,14 @@ describe("VersionCheckPlugin", () => {
     });
 
     const warningRes = await app.get("/version-check").query({platform: "web", version: 150});
+    expect(warningRes.body.requestId).toBe(warningRes.headers["x-request-id"]);
     expect(warningRes.body.status).toBe("warning");
     expect(warningRes.body.message).toBe(
       "A new version is available. Please update for the best experience."
     );
 
     const requiredRes = await app.get("/version-check").query({platform: "web", version: 50});
+    expect(requiredRes.body.requestId).toBe(requiredRes.headers["x-request-id"]);
     expect(requiredRes.body.status).toBe("required");
     expect(requiredRes.body.message).toBe(
       "This version is no longer supported. Please update to continue."
@@ -225,6 +252,7 @@ describe("VersionCheckPlugin", () => {
   it("handles numeric version parameter", async () => {
     const res = await app.get("/version-check?version=50&platform=web");
     expect(res.status).toBe(200);
+    expect(res.body.requestId).toBe(res.headers["x-request-id"]);
   });
 });
 

package/src/actions.openApi.test.ts

@@ -3,8 +3,6 @@ import {beforeEach, describe, expect, it} from "bun:test";
 import type express from "express";
 import supertest from "supertest";
 import {type ModelRouterOptions, modelRouter} from "./api";
-import {addAuthRoutes, setupAuth} from "./auth";
-import {setupServer} from "./expressServer";
 import {Permissions} from "./permissions";
 import {TerrenoApp} from "./terrenoApp";
 import {FoodModel, setupDb, UserModel} from "./tests";
@@ -57,6 +55,8 @@ const primeActionOpenApiRoutes = async (
 };
 
 const assertActionOpenApiSpec = (spec: Record<string, unknown>): void => {
+  expect(spec.requestId).toBeUndefined();
+
   const paths = spec.paths as Record<string, Record<string, unknown>>;
   const collectionPath = paths["/food/summarize"];
   const instancePath = paths["/food/{id}/ping"];
@@ -139,14 +139,18 @@ describe("action OpenAPI emission", () => {
 
       const specRes = await server.get("/openapi.json").expect(200);
       assertActionOpenApiSpec(specRes.body);
+
+      const pingRes = await server.get(`/food/${foodId}/ping`).expect(200);
+      expect(pingRes.body.data).toEqual({id: foodId});
+      expect(pingRes.body.requestId).toBe(pingRes.headers["x-request-id"]);
     });
   });
 
-  describe("setupServer", () => {
+  describe("configureApp", () => {
     let app: express.Application;
 
     beforeEach(() => {
-      const addRoutes = (
+      const configureApp = (
         router: express.Router,
         routerOptions?: Partial<ModelRouterOptions<unknown>>
       ): void => {
@@ -156,16 +160,14 @@ describe("action OpenAPI emission", () => {
         );
       };
 
-      app = setupServer({
-        addRoutes,
+      app = new TerrenoApp({
+        configureApp,
         skipListen: true,
         userModel: UserModel as any,
-      });
-      setupAuth(app, UserModel as any);
-      addAuthRoutes(app, UserModel as any);
+      }).build();
     });
 
-    it("emits the same action operations on first hit via legacy setupServer", async () => {
+    it("emits the same action operations on first hit via configureApp", async () => {
       const server = supertest(app);
       await primeActionOpenApiRoutes(server, foodId);
 

package/src/api.query.test.ts

@@ -95,7 +95,17 @@ describe("query and list methods", () => {
           update: [Permissions.IsOwner],
         },
         populatePaths: [{path: "ownerId"}],
-        queryFields: ["hidden", "name", "calories", "created", "source.name", "tags", "eatenBy"],
+        queryFields: [
+          "hidden",
+          "name",
+          "calories",
+          "created",
+          "created_gte",
+          "created_lte",
+          "source.name",
+          "tags",
+          "eatenBy",
+        ],
         sort: {created: "descending"},
       })
     );
@@ -190,6 +200,19 @@ describe("query and list methods", () => {
     expect(res.body.data[0].id).toBe((apple as any).id);
   });
 
+  it("list applies created_gte and created_lte as a Date range", async () => {
+    const res = await agent
+      .get("/food")
+      .query({
+        created_gte: "2021-12-03T00:00:05.000Z",
+        created_lte: "2021-12-03T00:00:25.000Z",
+        limit: 10,
+      })
+      .expect(200);
+    const names = (res.body.data as {name: string}[]).map((d) => d.name).sort();
+    expect(names).toEqual(["Pizza", "Spinach"]);
+  });
+
   it("list query params not in list", async () => {
     const res = await agent.get(`/food?ownerId=${admin._id}`).expect(400);
     expect(res.body.title).toBe("ownerId is not allowed as a query param.");