@terreno/api 0.0.1

package/dist/openApi.test.js

@@ -0,0 +1,445 @@
+"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 __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 __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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var supertest_1 = __importDefault(require("supertest"));
+var api_1 = require("./api");
+var auth_1 = require("./auth");
+var expressServer_1 = require("./expressServer");
+var permissions_1 = require("./permissions");
+var tests_1 = require("./tests");
+function getMessageSummaryOpenApiMiddleware(options) {
+    return options.openApi.path({
+        parameters: [
+            {
+                in: "query",
+                name: "foodIds",
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        responses: {
+            200: {
+                content: {
+                    "application/json": {
+                        schema: {
+                            properties: {
+                                message: {
+                                    type: "string",
+                                },
+                            },
+                            type: "object",
+                        },
+                    },
+                },
+                description: "Success",
+            },
+        },
+        tags: ["Food"],
+    });
+}
+function addRoutes(router, options) {
+    var _this = this;
+    router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, options), { allowAnonymous: true, openApiExtraModelProperties: {
+            foo: {
+                type: "string",
+            },
+        }, permissions: {
+            create: [permissions_1.Permissions.IsAny],
+            delete: [permissions_1.Permissions.IsAny],
+            list: [permissions_1.Permissions.IsAny],
+            read: [permissions_1.Permissions.IsAny],
+            update: [permissions_1.Permissions.IsAny],
+        }, populatePaths: [{ path: "ownerId" }, { path: "eatenBy" }], queryFields: ["calories"] })));
+    router.use("/food/count", getMessageSummaryOpenApiMiddleware, function (_req, res) { return __awaiter(_this, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            res.json({ message: "count" });
+            return [2 /*return*/];
+        });
+    }); });
+}
+(0, bun_test_1.describe)("openApi", function () {
+    var server;
+    var app;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
+            process.env.ENABLE_SWAGGER = "true";
+            app = (0, expressServer_1.setupServer)({
+                addRoutes: addRoutes,
+                skipListen: true,
+                userModel: tests_1.UserModel,
+            });
+            (0, auth_1.setupAuth)(app, tests_1.UserModel);
+            (0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
+            return [2 /*return*/];
+        });
+    }); });
+    (0, bun_test_1.it)("gets the openapi.json", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body).toMatchSnapshot();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("gets the openapi.json with ETag header", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.headers.etag).toBeDefined();
+                    (0, bun_test_1.expect)(res.headers.etag).toMatch(/^"[a-f0-9]{16}"$/);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns 304 when If-None-Match matches ETag", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var firstRes, etag, secondRes;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    firstRes = _a.sent();
+                    etag = firstRes.headers.etag;
+                    (0, bun_test_1.expect)(etag).toBeDefined();
+                    return [4 /*yield*/, server.get("/openapi.json").set("If-None-Match", etag).expect(304)];
+                case 2:
+                    secondRes = _a.sent();
+                    (0, bun_test_1.expect)(secondRes.body).toEqual({});
+                    (0, bun_test_1.expect)(secondRes.headers.etag).toBe(etag);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns 200 when If-None-Match does not match ETag", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server
+                            .get("/openapi.json")
+                            .set("If-None-Match", '"different-etag"')
+                            .expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body).toBeDefined();
+                    (0, bun_test_1.expect)(res.headers.etag).toBeDefined();
+                    (0, bun_test_1.expect)(res.headers.etag).not.toBe('"different-etag"');
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("gets the swagger ui", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/swagger/").expect(200)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("gets food with populated paths", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, _admin, notAdmin, food, res;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, (0, tests_1.setupDb)()];
+                case 1:
+                    _a = __read.apply(void 0, [_b.sent(), 2]), _admin = _a[0], notAdmin = _a[1];
+                    return [4 /*yield*/, tests_1.FoodModel.create({
+                            name: "test",
+                            ownerId: notAdmin._id,
+                        })];
+                case 2:
+                    food = _b.sent();
+                    return [4 /*yield*/, server.get("/food/".concat(food._id)).expect(200)];
+                case 3:
+                    res = _b.sent();
+                    (0, bun_test_1.expect)(res.body.data.ownerId._id).toEqual(notAdmin._id.toString());
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    // create a test for a custom express endpoint that doesnt use modelRouter and manually adds it
+    // to openapi
+    (0, bun_test_1.it)("gets the openapi.json with custom endpoint", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body).toMatchSnapshot();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("gets the openapi.json and has correct Number query fields", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res, foodQuery;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    foodQuery = res.body.paths["/food/"].get.parameters.find(function (p) { return p.name === "calories"; });
+                    // Ensure that a Number query field supports gt/gte/lt/lte and just a Number
+                    (0, bun_test_1.expect)(foodQuery.schema).toEqual({
+                        oneOf: [
+                            { type: "number" },
+                            {
+                                properties: {
+                                    $gt: { type: "number" },
+                                    $gte: { type: "number" },
+                                    $lt: { type: "number" },
+                                    $lte: { type: "number" },
+                                },
+                                type: "object",
+                            },
+                        ],
+                    });
+                    (0, bun_test_1.expect)(foodQuery).toMatchSnapshot();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+function addRoutesPopulate(router, options) {
+    options === null || options === void 0 ? void 0 : options.openApi.component("schemas", "LimitedUser", {
+        properties: {
+            email: {
+                description: "LimitedUser's email",
+                type: "string",
+            },
+            name: {
+                description: "LimitedUser's name",
+                type: "string",
+            },
+        },
+        type: "object",
+    });
+    router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, options), { allowAnonymous: true, openApiExtraModelProperties: {
+            foo: {
+                type: "string",
+            },
+        }, permissions: {
+            create: [permissions_1.Permissions.IsAny],
+            delete: [permissions_1.Permissions.IsAny],
+            list: [permissions_1.Permissions.IsAny],
+            read: [permissions_1.Permissions.IsAny],
+            update: [permissions_1.Permissions.IsAny],
+        }, populatePaths: [
+            { fields: ["name", "email"], path: "ownerId" },
+            {
+                fields: ["name", "email"],
+                openApiComponent: "LimitedUser",
+                path: "eatenBy",
+            },
+            {
+                fields: ["name", "email"],
+                openApiComponent: "LimitedUser",
+                path: "likesIds.userId",
+            },
+        ] })));
+}
+(0, bun_test_1.describe)("openApi without swagger", function () {
+    var server;
+    var app;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
+            process.env.ENABLE_SWAGGER = "false";
+            app = (0, expressServer_1.setupServer)({
+                addRoutes: addRoutes,
+                skipListen: true,
+                userModel: tests_1.UserModel,
+            });
+            (0, auth_1.setupAuth)(app, tests_1.UserModel);
+            (0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
+            return [2 /*return*/];
+        });
+    }); });
+    (0, bun_test_1.it)("does not have the swagger ui", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/swagger/").expect(404)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+(0, bun_test_1.describe)("openApi populate", function () {
+    var server;
+    var app;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
+            app = (0, expressServer_1.setupServer)({
+                addRoutes: addRoutesPopulate,
+                skipListen: true,
+                userModel: tests_1.UserModel,
+            });
+            (0, auth_1.setupAuth)(app, tests_1.UserModel);
+            (0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
+            return [2 /*return*/];
+        });
+    }); });
+    (0, bun_test_1.it)("gets the openapi.json with populate", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res, properties;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    server = (0, supertest_1.default)(app);
+                    return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    properties = res.body.paths["/food/{id}"].get.responses["200"].content["application/json"].schema
+                        .properties;
+                    // There's no component here, so we automatically generate the limited properties.
+                    (0, bun_test_1.expect)(properties.ownerId).toEqual({
+                        properties: {
+                            email: {
+                                type: "string",
+                            },
+                            name: {
+                                type: "string",
+                            },
+                        },
+                        type: "object",
+                    });
+                    // We only reference the component here, rather than listing each field each time.
+                    (0, bun_test_1.expect)(properties.eatenBy).toEqual({
+                        items: {
+                            $ref: "#/components/schemas/LimitedUser",
+                        },
+                        type: "array",
+                    });
+                    (0, bun_test_1.expect)(properties.likesIds).toEqual({
+                        items: {
+                            properties: {
+                                _id: {
+                                    type: "string",
+                                },
+                                likes: {
+                                    type: "boolean",
+                                },
+                                userId: {
+                                    $ref: "#/components/schemas/LimitedUser",
+                                },
+                            },
+                            required: [],
+                            type: "object",
+                        },
+                        type: "array",
+                    });
+                    // Ensure the component is registered and used.
+                    (0, bun_test_1.expect)(res.body.components.schemas.LimitedUser).toEqual({
+                        properties: {
+                            email: {
+                                description: "LimitedUser's email",
+                                type: "string",
+                            },
+                            name: {
+                                description: "LimitedUser's name",
+                                type: "string",
+                            },
+                        },
+                        type: "object",
+                    });
+                    (0, bun_test_1.expect)(res.body).toMatchSnapshot();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});