@tsed/platform-test-sdk 7.62.1 → 7.62.3

package/lib/types/index.d.ts

@@ -14,8 +14,8 @@ export * from "./tests/testBodyParams";
 export * from "./tests/testCache";
 export * from "./tests/testChildrenControllers";
 export * from "./tests/testCookies";
-export * from "./tests/testCtrlInheritance";
 export * from "./tests/testCustom404";
+export * from "./tests/testDeepQueryParams";
 export * from "./tests/testErrors";
 export * from "./tests/testHandlers";
 export * from "./tests/testHeaderParams";
@@ -35,4 +35,5 @@ export * from "./tests/testRouting";
 export * from "./tests/testScopeRequest";
 export * from "./tests/testSession";
 export * from "./tests/testStatics";
+export * from "./tests/testStream";
 export * from "./tests/testView";

package/lib/types/tests/testDeepQueryParams.d.ts

@@ -0,0 +1,3 @@
+import "@tsed/ajv";
+import { PlatformTestingSdkOpts } from "../interfaces";
+export declare function testDeepQueryParams(options: PlatformTestingSdkOpts): void;

package/lib/types/tests/testInheritanceController.d.ts

@@ -24,5 +24,19 @@ declare abstract class AttachmentController {
 export declare class FindingsController extends AttachmentController {
     get(): string;
 }
+export declare abstract class TestBaseController {
+    scenario3(search: string): {
+        search: string;
+    };
+    scenario5(q: string): {
+        data: string;
+    };
+}
+export declare class TestChildController extends TestBaseController {
+    scenario4(id: string): any;
+    scenario5(s: string): {
+        data: string;
+    };
+}
 export declare function testInheritanceController(options: PlatformTestingSdkOpts): void;
 export {};

package/lib/types/tests/testStream.d.ts

@@ -0,0 +1,2 @@
+import { PlatformTestingSdkOpts } from "../interfaces";
+export declare function testStream(options: PlatformTestingSdkOpts): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/platform-test-sdk",
-  "version": "7.62.1",
+  "version": "7.62.3",
   "description": "Package to test platform adapter integration with Ts.ED",
   "source": "./src/index.ts",
   "main": "./lib/cjs/index.js",
@@ -25,24 +25,24 @@
     "Adapter"
   ],
   "dependencies": {
-    "@tsed/ajv": "7.62.1",
-    "@tsed/common": "7.62.1",
-    "@tsed/core": "7.62.1",
-    "@tsed/di": "7.62.1",
-    "@tsed/json-mapper": "7.62.1",
+    "@tsed/ajv": "7.62.3",
+    "@tsed/common": "7.62.3",
+    "@tsed/core": "7.62.3",
+    "@tsed/di": "7.62.3",
+    "@tsed/json-mapper": "7.62.3",
     "@tsed/logger": "6.6.3",
-    "@tsed/platform-cache": "7.62.1",
-    "@tsed/platform-params": "7.62.1",
-    "@tsed/platform-router": "7.62.1",
-    "@tsed/platform-views": "7.62.1",
-    "@tsed/schema": "7.62.1",
-    "@tsed/swagger": "7.62.1",
+    "@tsed/platform-cache": "7.62.3",
+    "@tsed/platform-params": "7.62.3",
+    "@tsed/platform-router": "7.62.3",
+    "@tsed/platform-views": "7.62.3",
+    "@tsed/schema": "7.62.3",
+    "@tsed/swagger": "7.62.3",
     "ajv": "^8.12.0",
     "axios": "1.6.7",
     "read-pkg-up": "7.0.1"
   },
   "devDependencies": {
-    "@tsed/typescript": "7.62.1",
+    "@tsed/typescript": "7.62.3",
     "barrelsby": "^2.8.1",
     "eslint": "^8.12.0",
     "jest": "^29.2.0"

package/src/index.ts

@@ -15,8 +15,8 @@ export * from "./tests/testBodyParams";
 export * from "./tests/testCache";
 export * from "./tests/testChildrenControllers";
 export * from "./tests/testCookies";
-export * from "./tests/testCtrlInheritance";
 export * from "./tests/testCustom404";
+export * from "./tests/testDeepQueryParams";
 export * from "./tests/testErrors";
 export * from "./tests/testHandlers";
 export * from "./tests/testHeaderParams";
@@ -36,4 +36,5 @@ export * from "./tests/testRouting";
 export * from "./tests/testScopeRequest";
 export * from "./tests/testSession";
 export * from "./tests/testStatics";
+export * from "./tests/testStream";
 export * from "./tests/testView";

package/src/tests/exports.ts

@@ -4,8 +4,8 @@ import {testAuth} from "./testAuth";
 import {testBodyParams} from "./testBodyParams";
 import {testChildrenControllers} from "./testChildrenControllers";
 import {testCookies} from "./testCookies";
-import {testCtrlInheritance} from "./testCtrlInheritance";
 import {testCustom404} from "./testCustom404";
+import {testDeepQueryParams} from "./testDeepQueryParams";
 import {testErrors} from "./testErrors";
 import {testHandlers} from "./testHandlers";
 import {testHeaderParams} from "./testHeaderParams";
@@ -25,6 +25,7 @@ import {testRouting} from "./testRouting";
 import {testScopeRequest} from "./testScopeRequest";
 import {testSession} from "./testSession";
 import {testStatics} from "./testStatics";
+import {testStream} from "./testStream";
 import {testView} from "./testView";
 import {testCache} from "./testCache";
 
@@ -43,6 +44,7 @@ specsContainer.set("redirect", testRedirect);
 specsContainer.set("view", testView);
 specsContainer.set("errors", testErrors);
 specsContainer.set("response", testResponse);
+specsContainer.set("stream", testStream);
 specsContainer.set("responseFilter", testResponseFilter);
 specsContainer.set("custom404", testCustom404);
 specsContainer.set("statics", testStatics);
@@ -55,13 +57,13 @@ specsContainer.set("headerParams", testHeaderParams);
 specsContainer.set("bodyParams", testBodyParams);
 specsContainer.set("pathParams", testPathParams);
 specsContainer.set("queryParams", testQueryParams);
+specsContainer.set("deepQueryParams", testDeepQueryParams);
 specsContainer.set("locals", testLocals);
 specsContainer.set("multer", testMulter);
 
 // ROUTING
 specsContainer.set("scopeRequest", testScopeRequest);
 specsContainer.set("routing", testRouting);
-specsContainer.set("inheritance", testCtrlInheritance);
 
 // CODE ORGANIZATION
 specsContainer.set("childrenControllers", testChildrenControllers);

package/src/tests/testBodyParams.ts

@@ -1,6 +1,19 @@
 import "@tsed/ajv";
 import {BodyParams, Context, Controller, HeaderParams, PlatformTest, RawBodyParams} from "@tsed/common";
-import {Post, Default, Description, GenericOf, Generics, Maximum, Minimum, Nullable, Property, Required, Status} from "@tsed/schema";
+import {
+  Post,
+  Default,
+  Description,
+  GenericOf,
+  Generics,
+  Maximum,
+  Minimum,
+  Nullable,
+  Property,
+  Required,
+  Status,
+  Consumes
+} from "@tsed/schema";
 import SuperTest from "supertest";
 import {PlatformTestingSdkOpts} from "../interfaces";
 
@@ -134,6 +147,12 @@ class TestBodyParamsCtrl {
   ) {
     return {param1, param2};
   }
+
+  @Post("/scenario-11")
+  @Consumes("application/x-www-form-urlencoded")
+  testScenario11(@Required() @BodyParams("client_id") client_id: string) {
+    return {client_id};
+  }
 }
 
 export function testBodyParams(options: PlatformTestingSdkOpts) {
@@ -201,7 +220,7 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       expect(response.body).toEqual({value: ["value"]});
     });
     it("should return an empty array (1)", async () => {
-      const response = await request.post("/rest/body-params/scenario-3").send().expect(200);
+      const response = await request.post("/rest/body-params/scenario-3").send({}).expect(200);
 
       expect(response.body).toEqual({value: [{}]});
     });
@@ -235,7 +254,6 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       });
     });
   });
-
   describe("Scenario4b: with expression required String", () => {
     it("should return value", async () => {
       const response = await request.post("/rest/body-params/scenario-4b").send({test: "value"}).expect(200);
@@ -321,7 +339,6 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       });
     });
   });
-
   describe("Scenario6: Enum", () => {
     it("should return value", async () => {
       const response = await request.post("/rest/body-params/scenario-6").send({
@@ -333,7 +350,6 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       });
     });
   });
-
   describe("Scenario7: payload with Null", () => {
     it("should return value", async () => {
       const response = await request.post("/rest/body-params/scenario-7").send({
@@ -345,7 +361,6 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       });
     });
   });
-
   describe("Scenario8: payload with props to null", () => {
     it("should return value with null value", async () => {
       const response = await request.post("/rest/body-params/scenario-8").send({
@@ -365,7 +380,6 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
       });
     });
   });
-
   describe("Scenario9: payload with Generics", () => {
     it("should return value", async () => {
       const response = await request
@@ -452,4 +466,13 @@ export function testBodyParams(options: PlatformTestingSdkOpts) {
         .expect(200);
     });
   });
+  describe("Scenario11: validate application/x-www-form-urlencoded body", () => {
+    it("should validate the body params", async () => {
+      await request
+        .post("/rest/body-params/scenario-11")
+        .set("Content-Type", "application/x-www-form-urlencoded")
+        .send("client_id=id&grant_type=grant")
+        .expect(200);
+    });
+  });
 }

package/src/tests/testCache.ts

@@ -117,12 +117,21 @@ export function testCache(options: PlatformTestingSdkOpts) {
         const platformCache = PlatformTest.get<PlatformCache>(PlatformCache);
 
         const response = await request.get("/rest/caches/scenario-1").expect(200);
-
-        await request.get("/rest/caches/scenario-1").set("if-none-match", response.headers["etag"]).expect(304);
-
-        await platformCache.reset();
-
-        await request.get("/rest/caches/scenario-1").set("if-none-match", response.headers["etag"]).expect(200);
+        console.log(response.headers);
+        if (response.headers["etag"]) {
+          // platform koa doesn't support Etag
+          await request
+            .get("/rest/caches/scenario-1")
+            .set("if-none-match", response.headers["etag"] || "")
+            .expect(304);
+
+          await platformCache.reset();
+
+          await request
+            .get("/rest/caches/scenario-1")
+            .set("if-none-match", response.headers["etag"] || "")
+            .expect(200);
+        }
       });
 
       it("should return fresh data if cache-control is set to no-cache", async () => {

package/src/tests/testDeepQueryParams.ts

@@ -0,0 +1,119 @@
+import "@tsed/ajv";
+import {Controller, Get, PlatformTest, QueryParams} from "@tsed/common";
+import {Default, GenericOf, Generics, Maximum, Minimum, Property, Required} from "@tsed/schema";
+import SuperTest from "supertest";
+import {PlatformTestingSdkOpts} from "../interfaces";
+
+class FindQuery {
+  @Property()
+  a?: number;
+
+  @Property()
+  b?: number;
+}
+
+@Generics("T")
+class PaginationQuery<T> {
+  // things about pagination
+  @Minimum(0)
+  @Default(0)
+  offset?: number;
+
+  @Minimum(1)
+  @Maximum(1000)
+  @Default(50)
+  limit?: number;
+
+  @Property("T")
+  where?: T;
+}
+
+@Controller("/deep-query-params")
+class TestDeepQueryParamsCtrl {
+  @Get("/scenario-1")
+  testScenario6(@QueryParams() @GenericOf(FindQuery) q: PaginationQuery<FindQuery>, @QueryParams() qs: any) {
+    return {q};
+  }
+
+  @Get("/scenario-2")
+  testScenario7(@QueryParams("q") @GenericOf(FindQuery) q: PaginationQuery<FindQuery>) {
+    return {q};
+  }
+}
+
+export function testDeepQueryParams(options: PlatformTestingSdkOpts) {
+  let request: SuperTest.Agent;
+
+  beforeAll(
+    PlatformTest.bootstrap(options.server, {
+      ...options,
+      ajv: {
+        verbose: false
+      },
+      mount: {
+        "/rest": [TestDeepQueryParamsCtrl]
+      }
+    })
+  );
+  beforeAll(() => {
+    request = SuperTest(PlatformTest.callback());
+  });
+  afterAll(PlatformTest.reset);
+  describe("Scenario1: DeepObject", () => {
+    const endpoint = "/rest/deep-query-params/scenario-1";
+    it("should return 0 when query is 0", async () => {
+      const response = await request.get(`${endpoint}?offset=0&limit=10&where[a]=0&where[b]=1`).expect(200);
+
+      expect(response.body).toEqual({
+        q: {
+          limit: 10,
+          offset: 0,
+          where: {
+            a: 0,
+            b: 1
+          }
+        }
+      });
+    });
+  });
+  describe("Scenario2: DeepObject", () => {
+    const endpoint = "/rest/deep-query-params/scenario-2";
+    it("should return the query value", async () => {
+      const response = await request.get(`${endpoint}?q[offset]=0&q[limit]=10&q[where][a]=0&q[where][b]=1`).expect(200);
+
+      expect(response.body).toEqual({
+        q: {
+          limit: 10,
+          offset: 0,
+          where: {
+            a: 0,
+            b: 1
+          }
+        }
+      });
+    });
+    it("should throw a bad request", async () => {
+      const response = await request.get(`${endpoint}?q[offset]=0&q[limit]=10&q[where][a]=ca&q[where][b]=1`).expect(400);
+
+      expect(response.body).toEqual({
+        errors: [
+          {
+            data: "ca",
+            dataPath: ".where.a",
+            instancePath: "/where/a",
+            keyword: "type",
+            message: "must be number",
+            modelName: "PaginationQuery",
+            params: {
+              type: "number"
+            },
+            schemaPath: "#/properties/where/properties/a/type"
+          }
+        ],
+        message: 'Bad request on parameter "request.query.q".\nPaginationQuery.where.a must be number. Given value: "ca"',
+        name: "AJV_VALIDATION_ERROR",
+        status: 400
+      });
+    });
+  });
+}

package/src/tests/testErrors.ts

@@ -167,7 +167,7 @@ export function testErrors(options: PlatformTestingSdkOpts) {
   });
 
   it("Scenario 5: POST /rest/errors/scenario-5", async () => {
-    const response: any = await request.post("/rest/errors/scenario-5").expect(400);
+    const response: any = await request.post("/rest/errors/scenario-5").send({}).expect(400);
 
     expect(response.body).toEqual({
       errors: [

package/src/tests/testHeaderParams.ts

@@ -81,6 +81,7 @@ export function testHeaderParams(options: PlatformTestingSdkOpts) {
     it("should return a response with the extracted contentType from the request headers", async () => {
       const response = await request
         .post("/rest/header-params/scenario-2")
+        .send({})
         .set({
           "Content-Type": "application/json"
         })

package/src/tests/testInheritanceController.ts

@@ -1,4 +1,4 @@
-import {BodyParams, Controller, Get, Middleware, PathParams, PlatformTest, Post, UseAuth} from "@tsed/common";
+import {BodyParams, Controller, Get, Middleware, PathParams, PlatformTest, Post, QueryParams, UseAuth} from "@tsed/common";
 import {NotFound} from "@tsed/exceptions";
 import {Description, MaxLength, MinLength, Property, Returns, Summary} from "@tsed/schema";
 import SuperTest from "supertest";
@@ -91,6 +91,33 @@ export class FindingsController extends AttachmentController {
   }
 }
 
+export abstract class TestBaseController {
+  @Get("/")
+  scenario3(@QueryParams("search") search: string) {
+    return {
+      search
+    };
+  }
+
+  @Get("/override")
+  scenario5(@QueryParams("q") q: string) {
+    return {data: q};
+  }
+}
+
+@Controller("/test")
+export class TestChildController extends TestBaseController {
+  @Get("/:id")
+  scenario4(@PathParams("id") id: string): any {
+    return {id};
+  }
+
+  @Get("/override")
+  scenario5(@QueryParams("s") s: string) {
+    return {data: s};
+  }
+}
+
 export function testInheritanceController(options: PlatformTestingSdkOpts) {
   let request: SuperTest.Agent;
 
@@ -98,7 +125,7 @@ export function testInheritanceController(options: PlatformTestingSdkOpts) {
     PlatformTest.bootstrap(options.server, {
       ...options,
       mount: {
-        "/rest": [ResourcesCtrl, FindingsController]
+        "/rest": [ResourcesCtrl, FindingsController, TestChildController]
       }
     })
   );
@@ -147,10 +174,27 @@ export function testInheritanceController(options: PlatformTestingSdkOpts) {
       expect(text).toEqual("All attachments of 1");
     });
 
-    it("should call /rest/findings/", async () => {
+    it("should call /rest/findings", async () => {
       const {text} = await request.get("/rest/findings").expect(200);
 
       expect(text).toEqual("hello Finding");
     });
   });
+
+  it("Scenario3: should call inherited method", async () => {
+    const {body} = await request.get("/rest/test?search=test").expect(200);
+    expect(body).toEqual({
+      search: "test"
+    });
+  });
+
+  it("Scenario4: should the Child method", async () => {
+    const {body} = await request.get("/rest/test/1").expect(200);
+    expect(body).toEqual({id: "1"});
+  });
+
+  it("Scenario5: should call the Child method and not the base method", async () => {
+    const {body} = await request.get("/rest/test/1").expect(200);
+    expect(body).toEqual({id: "1"});
+  });
 }

package/src/tests/testQueryParams.ts

@@ -1,6 +1,6 @@
 import "@tsed/ajv";
 import {Controller, Get, PlatformTest, QueryParams} from "@tsed/common";
-import {Default, GenericOf, Generics, Maximum, Minimum, Property, Required} from "@tsed/schema";
+import {Maximum, Minimum, Required} from "@tsed/schema";
 import SuperTest from "supertest";
 import {PlatformTestingSdkOpts} from "../interfaces";
 
@@ -11,30 +11,6 @@ export class RandomStringModel {
   length: number;
 }
 
-class FindQuery {
-  @Property()
-  a?: number;
-
-  @Property()
-  b?: number;
-}
-
-@Generics("T")
-class PaginationQuery<T> {
-  // things about pagination
-  @Minimum(0)
-  @Default(0)
-  offset?: number;
-
-  @Minimum(1)
-  @Maximum(1000)
-  @Default(50)
-  limit?: number;
-
-  @Property("T")
-  where?: T;
-}
-
 @Controller("/query-params")
 class TestQueryParamsCtrl {
   @Get("/scenario-1")
@@ -63,16 +39,6 @@ class TestQueryParamsCtrl {
   }
 
   @Get("/scenario-6")
-  testScenario6(@QueryParams() @GenericOf(FindQuery) q: PaginationQuery<FindQuery>, @QueryParams() qs: any) {
-    return {q};
-  }
-
-  @Get("/scenario-7")
-  testScenario7(@QueryParams("q") @GenericOf(FindQuery) q: PaginationQuery<FindQuery>) {
-    return {q};
-  }
-
-  @Get("/scenario-8")
   testScenario8(@QueryParams("test", String) value: string[]): any {
     return {value};
   }
@@ -250,65 +216,8 @@ export function testQueryParams(options: PlatformTestingSdkOpts) {
       expect(response.body).toEqual({});
     });
   });
-  describe("Scenario6: DeepObject", () => {
+  describe("Scenario6: String[] value", () => {
     const endpoint = "/rest/query-params/scenario-6";
-    it("should return 0 when query is 0", async () => {
-      const response = await request.get(`${endpoint}?offset=0&limit=10&where[a]=0&where[b]=1`).expect(200);
-
-      expect(response.body).toEqual({
-        q: {
-          limit: 10,
-          offset: 0,
-          where: {
-            a: 0,
-            b: 1
-          }
-        }
-      });
-    });
-  });
-  describe("Scenario7: DeepObject", () => {
-    const endpoint = "/rest/query-params/scenario-7";
-    it("should return the query value", async () => {
-      const response = await request.get(`${endpoint}?q[offset]=0&q[limit]=10&q[where][a]=0&q[where][b]=1`).expect(200);
-
-      expect(response.body).toEqual({
-        q: {
-          limit: 10,
-          offset: 0,
-          where: {
-            a: 0,
-            b: 1
-          }
-        }
-      });
-    });
-    it("should throw a bad request", async () => {
-      const response = await request.get(`${endpoint}?q[offset]=0&q[limit]=10&q[where][a]=ca&q[where][b]=1`).expect(400);
-
-      expect(response.body).toEqual({
-        errors: [
-          {
-            data: "ca",
-            dataPath: ".where.a",
-            instancePath: "/where/a",
-            keyword: "type",
-            message: "must be number",
-            modelName: "PaginationQuery",
-            params: {
-              type: "number"
-            },
-            schemaPath: "#/properties/where/properties/a/type"
-          }
-        ],
-        message: 'Bad request on parameter "request.query.q".\nPaginationQuery.where.a must be number. Given value: "ca"',
-        name: "AJV_VALIDATION_ERROR",
-        status: 400
-      });
-    });
-  });
-  describe("Scenario8: String[] value", () => {
-    const endpoint = "/rest/query-params/scenario-8";
     it("should return 0 when query is 0", async () => {
       const response = await request.get(`${endpoint}?test=0`).expect(200);
 

package/src/tests/testResponse.ts

@@ -1,15 +1,12 @@
 import {Context, Controller, Get, getContext, PathParams, PlatformResponse, PlatformTest, Post, Res} from "@tsed/common";
-import {CollectionOf, ContentType, Enum, ForwardGroups, Groups, Ignore, Name, Property, Required, Returns, Status} from "@tsed/schema";
+import {CollectionOf, Enum, ForwardGroups, Groups, Ignore, Name, Property, Required, Returns, Status} from "@tsed/schema";
 import axios from "axios";
-import filedirname from "filedirname";
-import {createReadStream} from "fs";
-import {join} from "path";
 import {of} from "rxjs";
 import {agent, SuperAgentStatic} from "superagent";
 import SuperTest from "supertest";
 import {PlatformTestingSdkOpts} from "../interfaces";
+
 // FIXME remove when esm is ready
-const [, rootDir] = filedirname();
 
 class Base {
   @Ignore()
@@ -131,18 +128,6 @@ class TestResponseParamsCtrl {
     return Promise.resolve(of({id: 1}));
   }
 
-  @Get("/scenario7")
-  @ContentType("application/json")
-  testScenario7Stream() {
-    return createReadStream(join(rootDir, "../data/response.data.json"));
-  }
-
-  @Get("/scenario7b")
-  @ContentType("application/json")
-  testScenario7bStream() {
-    return Promise.resolve(createReadStream(join(rootDir, "../data/response.data.json")));
-  }
-
   @Get("/scenario9/static")
   public testScenario9Get(): string {
     return "value";
@@ -338,24 +323,6 @@ export function testResponse(options: PlatformTestingSdkOpts) {
     });
   });
 
-  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 () => {