@terreno/api 0.14.2 → 0.15.1

package/dist/__tests__/versionCheckPlugin.test.js

@@ -35,6 +35,33 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -429,4 +456,60 @@ var versionCheckPlugin_1 = require("../versionCheckPlugin");
             }
         });
     }); });
+    (0, bun_test_1.it)("handles a numeric version query parameter", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var express, expressApp, plugin, testApp, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, versionConfig_1.VersionConfig.deleteMany({})];
+                case 2:
+                    _a.sent();
+                    express = require("express");
+                    expressApp = express();
+                    // Use a custom query parser that coerces numeric strings to numbers so we
+                    // exercise the `typeof versionParam === "number"` branch.
+                    expressApp.set("query parser", function (qs) {
+                        var e_1, _a;
+                        var params = {};
+                        try {
+                            for (var _b = __values(qs.split("&")), _c = _b.next(); !_c.done; _c = _b.next()) {
+                                var pair = _c.value;
+                                var _d = __read(pair.split("="), 2), key = _d[0], val = _d[1];
+                                if (val !== undefined && /^\d+$/.test(val)) {
+                                    params[decodeURIComponent(key)] = Number(val);
+                                }
+                                else {
+                                    params[decodeURIComponent(key)] = decodeURIComponent(val !== null && val !== void 0 ? val : "");
+                                }
+                            }
+                        }
+                        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                        finally {
+                            try {
+                                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+                            }
+                            finally { if (e_1) throw e_1.error; }
+                        }
+                        return params;
+                    });
+                    plugin = new versionCheckPlugin_1.VersionCheckPlugin();
+                    plugin.register(expressApp);
+                    return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                            webRequiredVersion: 100,
+                            webWarningVersion: 150,
+                        })];
+                case 3:
+                    _a.sent();
+                    testApp = (0, supertest_1.default)(expressApp);
+                    return [4 /*yield*/, testApp.get("/version-check?version=50&platform=web")];
+                case 4:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.status).toBe("required");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
 });

package/dist/errors.test.js

@@ -155,6 +155,31 @@ var buildResponse = function () {
         (0, bun_test_1.expect)((0, errors_1.getDisableExternalErrorTracking)({ foo: "bar" })).toBeUndefined();
     });
 });
+(0, bun_test_1.describe)("errorMessage", function () {
+    (0, bun_test_1.it)("returns the message from an Error instance", function () {
+        (0, bun_test_1.expect)((0, errors_1.errorMessage)(new Error("boom"))).toBe("boom");
+    });
+    (0, bun_test_1.it)("returns the string representation of a non-Error value", function () {
+        (0, bun_test_1.expect)((0, errors_1.errorMessage)("raw string")).toBe("raw string");
+        (0, bun_test_1.expect)((0, errors_1.errorMessage)(42)).toBe("42");
+        (0, bun_test_1.expect)((0, errors_1.errorMessage)(null)).toBe("null");
+    });
+});
+(0, bun_test_1.describe)("errorStack", function () {
+    (0, bun_test_1.it)("returns the stack trace from an Error with a stack", function () {
+        var err = new Error("fail");
+        (0, bun_test_1.expect)((0, errors_1.errorStack)(err)).toBe(err.stack);
+    });
+    (0, bun_test_1.it)("returns the string representation when error has no stack", function () {
+        var err = new Error("no-stack");
+        Object.defineProperty(err, "stack", { value: undefined });
+        (0, bun_test_1.expect)((0, errors_1.errorStack)(err)).toBe("Error: no-stack");
+    });
+    (0, bun_test_1.it)("returns the string representation of a non-Error value", function () {
+        (0, bun_test_1.expect)((0, errors_1.errorStack)("plain")).toBe("plain");
+        (0, bun_test_1.expect)((0, errors_1.errorStack)(123)).toBe("123");
+    });
+});
 (0, bun_test_1.describe)("getAPIErrorBody", function () {
     (0, bun_test_1.it)("returns title and status by default", function () {
         var error = new errors_1.APIError({ status: 404, title: "Not Found" });

package/package.json

@@ -106,5 +106,5 @@
     "updateSnapshot": "bun test --update-snapshots"
   },
   "types": "dist/index.d.ts",
-  "version": "0.14.2"
+  "version": "0.15.1"
 }

package/src/__tests__/versionCheckPlugin.test.ts

@@ -244,4 +244,40 @@ describe("VersionCheckPlugin direct usage", () => {
     expect(res.status).toBe(200);
     expect(res.body.status).toBe("ok");
   });
+
+  it("handles a numeric version query parameter", async () => {
+    await setupDb();
+    await VersionConfig.deleteMany({});
+
+    const express = require("express");
+    const expressApp = express();
+
+    // Use a custom query parser that coerces numeric strings to numbers so we
+    // exercise the `typeof versionParam === "number"` branch.
+    expressApp.set("query parser", (qs: string) => {
+      const params: Record<string, string | number> = {};
+      for (const pair of qs.split("&")) {
+        const [key, val] = pair.split("=");
+        if (val !== undefined && /^\d+$/.test(val)) {
+          params[decodeURIComponent(key)] = Number(val);
+        } else {
+          params[decodeURIComponent(key)] = decodeURIComponent(val ?? "");
+        }
+      }
+      return params;
+    });
+
+    const plugin = new VersionCheckPlugin();
+    plugin.register(expressApp);
+
+    await VersionConfig.create({
+      webRequiredVersion: 100,
+      webWarningVersion: 150,
+    });
+
+    const testApp = supertest(expressApp);
+    const res = await testApp.get("/version-check?version=50&platform=web");
+    expect(res.status).toBe(200);
+    expect(res.body.status).toBe("required");
+  });
 });

package/src/errors.test.ts

@@ -7,6 +7,8 @@ import {
   APIError,
   apiErrorMiddleware,
   apiUnauthorizedMiddleware,
+  errorMessage,
+  errorStack,
   errorsPlugin,
   getAPIErrorBody,
   getDisableExternalErrorTracking,
@@ -154,6 +156,36 @@ describe("getDisableExternalErrorTracking", () => {
   });
 });
 
+describe("errorMessage", () => {
+  it("returns the message from an Error instance", () => {
+    expect(errorMessage(new Error("boom"))).toBe("boom");
+  });
+
+  it("returns the string representation of a non-Error value", () => {
+    expect(errorMessage("raw string")).toBe("raw string");
+    expect(errorMessage(42)).toBe("42");
+    expect(errorMessage(null)).toBe("null");
+  });
+});
+
+describe("errorStack", () => {
+  it("returns the stack trace from an Error with a stack", () => {
+    const err = new Error("fail");
+    expect(errorStack(err)).toBe(err.stack as string);
+  });
+
+  it("returns the string representation when error has no stack", () => {
+    const err = new Error("no-stack");
+    Object.defineProperty(err, "stack", {value: undefined});
+    expect(errorStack(err)).toBe("Error: no-stack");
+  });
+
+  it("returns the string representation of a non-Error value", () => {
+    expect(errorStack("plain")).toBe("plain");
+    expect(errorStack(123)).toBe("123");
+  });
+});
+
 describe("getAPIErrorBody", () => {
   it("returns title and status by default", () => {
     const error = new APIError({status: 404, title: "Not Found"});