@tsed/platform-test-sdk 7.12.0

package/lib/cjs/tests/testResponse.js

@@ -0,0 +1,622 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testResponse = exports.ModelGroup = exports.TestNestedEnum = exports.NestedEnum = exports.EnumValue = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const schema_1 = require("@tsed/schema");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const fs_1 = require("fs");
+const path_1 = require("path");
+const rxjs_1 = require("rxjs");
+const superagent_1 = require("superagent");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+class Base {
+    ignoreMeBase;
+    fooBase;
+}
+tslib_1.__decorate([
+    (0, schema_1.Ignore)(),
+    tslib_1.__metadata("design:type", String)
+], Base.prototype, "ignoreMeBase", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], Base.prototype, "fooBase", void 0);
+class MyModel extends Base {
+    foo;
+    ignoreMe;
+    ignoreMe2;
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], MyModel.prototype, "foo", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Ignore)(),
+    tslib_1.__metadata("design:type", String)
+], MyModel.prototype, "ignoreMe", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Ignore)((value, ctx) => ctx.endpoint),
+    tslib_1.__metadata("design:type", String)
+], MyModel.prototype, "ignoreMe2", void 0);
+class EmptyModel {
+    raw;
+    affected;
+}
+var EnumValue;
+(function (EnumValue) {
+    EnumValue["One"] = "one";
+    EnumValue["Two"] = "two";
+})(EnumValue = exports.EnumValue || (exports.EnumValue = {}));
+class NestedEnum {
+    value;
+}
+tslib_1.__decorate([
+    (0, schema_1.Required)(),
+    (0, schema_1.Enum)(EnumValue),
+    tslib_1.__metadata("design:type", String)
+], NestedEnum.prototype, "value", void 0);
+exports.NestedEnum = NestedEnum;
+class TestNestedEnum {
+    nested;
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", NestedEnum)
+], TestNestedEnum.prototype, "nested", void 0);
+exports.TestNestedEnum = TestNestedEnum;
+class ModelGroup {
+    id;
+    groups;
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], ModelGroup.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Groups)("!creation"),
+    tslib_1.__metadata("design:type", String)
+], ModelGroup.prototype, "groups", void 0);
+exports.ModelGroup = ModelGroup;
+class TeamModel {
+    name;
+}
+tslib_1.__decorate([
+    (0, schema_1.Required)(),
+    (0, schema_1.Name)("teamName"),
+    tslib_1.__metadata("design:type", String)
+], TeamModel.prototype, "name", void 0);
+class TeamsModel {
+    teams;
+}
+tslib_1.__decorate([
+    (0, schema_1.Required)(),
+    (0, schema_1.CollectionOf)(TeamModel),
+    (0, schema_1.ForwardGroups)(),
+    tslib_1.__metadata("design:type", Array)
+], TeamsModel.prototype, "teams", void 0);
+class AllowedModel {
+    id;
+    description;
+    prop1; // not display by default
+    prop2; // not display by default
+    sensitiveProp; // not displayed because it's a sensitive props
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], AllowedModel.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], AllowedModel.prototype, "description", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Groups)("summary"),
+    tslib_1.__metadata("design:type", String)
+], AllowedModel.prototype, "prop1", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Groups)("details"),
+    tslib_1.__metadata("design:type", String)
+], AllowedModel.prototype, "prop2", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Groups)("admin"),
+    tslib_1.__metadata("design:type", String)
+], AllowedModel.prototype, "sensitiveProp", void 0);
+let TestResponseParamsCtrl = class TestResponseParamsCtrl {
+    testScenario1Get(id) {
+        return `hello-${id}`;
+    }
+    testScenario3EmptyResponse(id, ctx) {
+        if (id) {
+            return;
+        }
+        ctx.response.status(201);
+        return {
+            id: 1
+        };
+    }
+    async testScenario5Promise() {
+        await new Promise((resolve) => {
+            resolve(undefined);
+        });
+        return {
+            id: 1
+        };
+    }
+    testScenario6Observable() {
+        return (0, rxjs_1.of)({ id: 1 });
+    }
+    async testScenario6bObservable() {
+        return (0, rxjs_1.of)({ id: 1 });
+    }
+    testScenario7Stream() {
+        return (0, fs_1.createReadStream)((0, path_1.join)(__dirname, "../data/response.data.json"));
+    }
+    async testScenario7bStream() {
+        return (0, fs_1.createReadStream)((0, path_1.join)(__dirname, "../data/response.data.json"));
+    }
+    testScenario9Get() {
+        return "value";
+    }
+    testScenario9WithDynamicParam(id) {
+        return "value" + id;
+    }
+    testScenario10() {
+        const model = new MyModel();
+        model.foo = "foo";
+        model.ignoreMe = "ignoreMe";
+        model.ignoreMe2 = "ignoreMe2";
+        model.fooBase = "fooBase";
+        model.ignoreMeBase = "ignoreMeBase";
+        return model;
+    }
+    testScenario11() {
+        const t = new EmptyModel();
+        t.raw = 1;
+        t.affected = 1;
+        return t;
+    }
+    testScenario12(res) {
+        res.attachment("filename");
+        return Buffer.from("Hello");
+    }
+    async testScenario13(res) {
+        const http = (0, superagent_1.agent)();
+        const image_res = await http.get("https://www.google.com/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png");
+        res.setHeader("Content-Disposition", "inline;filename=googlelogo_color_272x92dp.png;");
+        res.setHeader("X-Content-Type-Options", "nosniff");
+        res.setHeader("Content-Type", "image/png");
+        return image_res.body;
+    }
+    scenario14() {
+        return {
+            jsonexample: 1
+        };
+    }
+    testScenario15a() {
+        return axios_1.default.get(`https://tsed.io/api.json`, {
+            responseType: "json"
+        });
+    }
+    async testScenario15b() {
+        return axios_1.default.get(`https://api.tsed.io/rest/github/typed/test`, {
+            responseType: "json"
+        });
+    }
+    async testScenario16() {
+        const test = new TestNestedEnum();
+        const nested = new NestedEnum();
+        nested.value = EnumValue.One;
+        test.nested = nested;
+        return test;
+    }
+    async testScenario17() {
+        const model = new ModelGroup();
+        model.id = "id";
+        model.groups = "groups";
+        return model;
+    }
+    testScenario18() {
+        const data = new TeamsModel();
+        const team = {};
+        team.name = "name";
+        data.teams = [team];
+        return data;
+    }
+    async testScenario19() {
+        const model = new AllowedModel();
+        model.id = "id";
+        model.prop1 = "prop1";
+        model.description = "description";
+        model.prop2 = "prop2";
+        model.sensitiveProp = "sensitiveProp";
+        return model;
+    }
+    async testScenario20() {
+        const $ctx = (0, common_1.getContext)();
+        return { id: $ctx?.request.query.id };
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario1/:id"),
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Number]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario1Get", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario3/:id?"),
+    (0, schema_1.Status)(204),
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__param(1, (0, common_1.Context)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Number, Object]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario3EmptyResponse", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario5"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario5Promise", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario6"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario6Observable", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario6b"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario6bObservable", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario7"),
+    (0, schema_1.ContentType)("application/json"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario7Stream", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario7b"),
+    (0, schema_1.ContentType)("application/json"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario7bStream", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario9/static"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", String)
+], TestResponseParamsCtrl.prototype, "testScenario9Get", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario9/:id"),
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Number]),
+    tslib_1.__metadata("design:returntype", String)
+], TestResponseParamsCtrl.prototype, "testScenario9WithDynamicParam", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario10"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario10", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario11"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario11", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario12"),
+    tslib_1.__param(0, (0, common_1.Res)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [common_1.PlatformResponse]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario12", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario13"),
+    tslib_1.__param(0, (0, common_1.Res)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [common_1.PlatformResponse]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario13", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario14"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "scenario14", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario15a"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario15a", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario15b"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario15b", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario16"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario16", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario17"),
+    (0, schema_1.Returns)(201, ModelGroup).Groups("creation"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario17", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario18"),
+    (0, schema_1.Returns)(200, TeamsModel),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestResponseParamsCtrl.prototype, "testScenario18", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario19"),
+    (0, schema_1.Returns)(200, AllowedModel).Groups("!admin").AllowedGroups("summary", "details"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario19", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario20"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestResponseParamsCtrl.prototype, "testScenario20", null);
+TestResponseParamsCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/response")
+], TestResponseParamsCtrl);
+function testResponse(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        mount: {
+            "/rest": [TestResponseParamsCtrl]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    describe("Scenario1: return the id (classic)", () => {
+        describe("GET /rest/response/scenario1/:id", () => {
+            it("should return the id + test", async () => {
+                const response = await request.get("/rest/response/scenario1/10").expect(200);
+                expect(response.text).toEqual("hello-10");
+            });
+        });
+    });
+    describe("Scenario3: when response is empty or created", () => {
+        describe("GET /rest/response/scenario3/:id?", () => {
+            it("should return nothing with a 204 status", async () => {
+                const response = await request.post("/rest/response/scenario3/10").expect(204);
+                expect(response.text).toEqual("");
+            });
+            it("should return a body", async () => {
+                const response = await request.post("/rest/response/scenario3").expect(201);
+                expect(response.body).toEqual({ id: 1 });
+            });
+        });
+    });
+    describe("Scenario5: when endpoint response from promise", () => {
+        describe("GET /rest/response/scenario5", () => {
+            it("should return a body", async () => {
+                const response = await request.get("/rest/response/scenario5");
+                expect(response.body).toEqual({ id: 1 });
+            });
+        });
+    });
+    describe("Scenario6: when endpoint return an observable", () => {
+        describe("GET /rest/response/scenario6", () => {
+            it("should return a body", async () => {
+                const response = await request.get("/rest/response/scenario6");
+                expect(response.body).toEqual({ id: 1 });
+            });
+        });
+        describe("GET /rest/response/scenario6b", () => {
+            it("should return a body", async () => {
+                const response = await request.get("/rest/response/scenario6b");
+                expect(response.body).toEqual({ id: 1 });
+            });
+        });
+    });
+    describe("Scenario7: when endpoint return a stream", () => {
+        describe("GET /rest/response/scenario7", () => {
+            it("should return a body", async () => {
+                const response = await request.get("/rest/response/scenario7");
+                expect(response.body).toEqual({ id: "1" });
+            });
+        });
+        describe("GET /rest/response/scenario7b", () => {
+            it("should return a body", async () => {
+                const response = await request.get("/rest/response/scenario7b");
+                expect(response.body).toEqual({ id: "1" });
+            });
+        });
+    });
+    describe("Scenario9: routes without parameters must be defined first", () => {
+        describe("GET /rest/response/scenario9/static", () => {
+            it("should return the test", async () => {
+                const response = await request.get("/rest/response/scenario9/static").expect(200);
+                expect(response.text).toEqual("value");
+            });
+        });
+        describe("GET /rest/response/scenario9/:dynamic", () => {
+            it("should return the test + id", async () => {
+                const response = await request.get("/rest/response/scenario9/10").expect(200);
+                expect(response.text).toEqual("value10");
+            });
+        });
+        describe("GET /rest/response/scenario9/:dynamic", () => {
+            it("should throw a badRequest when path params isn't set as number", async () => {
+                const response = await request.get("/rest/response/scenario9/kkk").expect(400);
+                expect(response.body).toEqual({
+                    errors: [
+                        {
+                            data: "kkk",
+                            dataPath: "",
+                            instancePath: "",
+                            keyword: "type",
+                            message: "must be number",
+                            params: {
+                                type: "number"
+                            },
+                            schemaPath: "#/type"
+                        }
+                    ],
+                    message: 'Bad request on parameter "request.path.id".\nValue must be number. Given value: "kkk"',
+                    name: "AJV_VALIDATION_ERROR",
+                    status: 400
+                });
+            });
+        });
+    });
+    describe("Scenario10: return a model with ignored props", () => {
+        it("should return a body", async () => {
+            const response = await request.get("/rest/response/scenario10");
+            expect(response.body).toEqual({
+                foo: "foo",
+                fooBase: "fooBase"
+            });
+        });
+    });
+    describe("Scenario11: return models without props", () => {
+        it("should return a body", async () => {
+            const response = await request.get("/rest/response/scenario11");
+            expect(response.body).toEqual({
+                affected: 1,
+                raw: 1
+            });
+        });
+    });
+    describe("Scenario12: Return buffer", () => {
+        it("should return a body", async () => {
+            const response = await request.get("/rest/response/scenario12");
+            expect(response.headers["content-disposition"]).toEqual('attachment; filename="filename"');
+            expect(response.headers["content-type"]).toContain("application/octet-stream");
+            expect(response.headers["content-length"]).toEqual("5");
+            expect(response.body.toString()).toEqual("Hello");
+        });
+    });
+    describe("Scenario13: Return buffer", () => {
+        it("should return image", async () => {
+            const response = await request.get("/rest/response/scenario13");
+            expect(response.headers["content-disposition"]).toEqual("inline;filename=googlelogo_color_272x92dp.png;");
+            expect(response.headers["content-type"]).toContain("image/png");
+            expect(response.headers["content-length"]).toEqual("5969");
+        });
+    });
+    describe("Scenario14: Return application/json when Accept is */*", () => {
+        it("should return a */* content-type", async () => {
+            const response = await request
+                .get("/rest/response/scenario14")
+                .set("Accept", "*/*")
+                .set("Content-Type", "application/json")
+                .expect(200);
+            expect(response.headers["content-type"]).toEqual("application/json; charset=utf-8");
+            expect(response.body).toEqual({
+                jsonexample: 1
+            });
+        });
+    });
+    describe("Scenario15: Use axios as proxy", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario15a").expect(200);
+            expect(response.headers["content-type"]).toEqual("application/json; charset=utf-8");
+        });
+        it("should return the response (401)", async () => {
+            const response = await request.get("/rest/response/scenario15b").expect(401);
+            expect(response.headers["content-type"]).toEqual("application/json; charset=utf-8");
+        });
+    });
+    describe("Scenario16: Return response with nested enum", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario16").expect(200);
+            expect(response.body).toEqual({ nested: { value: "one" } });
+        });
+    });
+    describe("Scenario17: Return response with groups on 201", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario17").expect(201);
+            expect(response.body).toEqual({ id: "id" });
+        });
+    });
+    describe("Scenario18: Return data with alias", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario18").expect(200);
+            expect(response.body).toEqual({
+                teams: [
+                    {
+                        teamName: "name"
+                    }
+                ]
+            });
+        });
+    });
+    describe("Scenario19: includes options", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario19").expect(200);
+            expect(response.body).toEqual({
+                description: "description",
+                id: "id",
+                prop1: "prop1",
+                prop2: "prop2"
+            });
+        });
+        it("should return the response (200 + [summary])", async () => {
+            const response = await request.get("/rest/response/scenario19?includes=summary").expect(200);
+            expect(response.body).toEqual({
+                description: "description",
+                id: "id",
+                prop1: "prop1"
+            });
+        });
+        it("should return the response (200 + [summary, details])", async () => {
+            const response = await request.get("/rest/response/scenario19?includes=summary&includes=details").expect(200);
+            expect(response.body).toEqual({
+                description: "description",
+                id: "id",
+                prop2: "prop2",
+                prop1: "prop1"
+            });
+        });
+        it("should return the response (200 + [summary, details, admin])", async () => {
+            const response = await request.get("/rest/response/scenario19?includes=summary&includes=details&includes=admin").expect(200);
+            expect(response.body).toEqual({
+                description: "description",
+                id: "id",
+                prop2: "prop2",
+                prop1: "prop1"
+            });
+        });
+        it("should return the response (200 + 'summary,details,admin')", async () => {
+            const response = await request.get("/rest/response/scenario19?includes=summary,details,admin").expect(200);
+            expect(response.body).toEqual({
+                description: "description",
+                id: "id",
+                prop2: "prop2",
+                prop1: "prop1"
+            });
+        });
+    });
+    describe("Scenario20: should return query data from Context", () => {
+        it("should return the response (200)", async () => {
+            const response = await request.get("/rest/response/scenario20?id=id").expect(200);
+            expect(response.body).toEqual({ id: "id" });
+        });
+    });
+}
+exports.testResponse = testResponse;
+//# sourceMappingURL=testResponse.js.map