fix(platform-params): resolve dataPath when the data is a Query/Path …

…params
tsedio · Apr 8, 2024 · cf007e2 · cf007e2
1 parent faa658b
commit cf007e2
Show file tree

Hide file tree

Showing 55 changed files with 376 additions and 101 deletions.
diff --git a/packages/core/jest.config.js b/packages/core/jest.config.js
@@ -6,8 +6,8 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 98.75,
-      branches: 94.67,
-      functions: 95.41,
+      branches: 94,
+      functions: 94,
       lines: 98.75
     }
   }

diff --git a/packages/di/jest.config.js b/packages/di/jest.config.js
@@ -8,7 +8,7 @@ module.exports = {
       statements: 99.08,
       branches: 96.79,
       lines: 99.08,
-      functions: 99.17
+      functions: 99.04
     }
   }
 };
diff --git a/packages/orm/adapters-redis/jest.config.js b/packages/orm/adapters-redis/jest.config.js
@@ -5,7 +5,7 @@ module.exports = {
   ...require("@tsed/jest-config"),
   coverageThreshold: {
     global: {
-      branches: 93.68,
+      branches: 93.54,
       functions: 100,
       lines: 100,
       statements: 100

diff --git a/packages/orm/adapters/jest.config.js b/packages/orm/adapters/jest.config.js
@@ -9,7 +9,7 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      branches: 88.6,
+      branches: 87.5,
       functions: 100,
       lines: 100,
       statements: 100

diff --git a/packages/orm/mikro-orm/jest.config.js b/packages/orm/mikro-orm/jest.config.js
@@ -6,7 +6,7 @@ module.exports = {
   roots: ["<rootDir>/src", "<rootDir>/test"],
   coverageThreshold: {
     global: {
-      branches: 87.17,
+      branches: 87.05,
       functions: 97.56,
       lines: 98.24,
       statements: 98.24

diff --git a/packages/orm/mongoose/jest.config.js b/packages/orm/mongoose/jest.config.js
@@ -9,10 +9,10 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      statements: 98.95,
-      branches: 95,
-      functions: 99,
-      lines: 98.95
+      statements: 99.07,
+      branches: 95.02,
+      functions: 100,
+      lines: 99.07
     }
   }
 };
diff --git a/packages/orm/objection/jest.config.js b/packages/orm/objection/jest.config.js
@@ -9,8 +9,8 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      branches: 96.87,
-      functions: 91.48,
+      branches: 96.2,
+      functions: 100,
       lines: 98.26,
       statements: 98.26
     }

diff --git a/packages/orm/prisma/jest.config.js b/packages/orm/prisma/jest.config.js
@@ -8,8 +8,8 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 98.8,
-      branches: 94.3,
-      functions: 96.96,
+      branches: 93.47,
+      functions: 95.65,
       lines: 98.8
     }
   }

diff --git a/packages/platform/common/jest.config.js b/packages/platform/common/jest.config.js
@@ -10,7 +10,7 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 98.3,
-      branches: 91.52,
+      branches: 90.09,
       functions: 95.78,
       lines: 98.3
     }

diff --git a/...t/integration/returns.spec.integration.ts → ...egration/returns.spec.integration.spec.ts b/...t/integration/returns.spec.integration.ts → ...egration/returns.spec.integration.spec.ts
diff --git a/packages/platform/platform-cache/jest.config.js b/packages/platform/platform-cache/jest.config.js
@@ -9,7 +9,7 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      branches: 94.53,
+      branches: 94.26,
       functions: 100,
       lines: 100,
       statements: 100

diff --git a/packages/platform/platform-exceptions/jest.config.js b/packages/platform/platform-exceptions/jest.config.js
@@ -6,7 +6,7 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 100,
-      branches: 95.34,
+      branches: 94.73,
       functions: 100,
       lines: 100
     }

diff --git a/packages/platform/platform-express/jest.config.js b/packages/platform/platform-express/jest.config.js
@@ -7,10 +7,10 @@ module.exports = {
   collectCoverageFrom: ["src/**/*.{ts,tsx}", "!src/**/*.d.ts"],
   coverageThreshold: {
     global: {
-      statements: 90,
-      branches: 79.66,
-      functions: 90,
-      lines: 90
+      statements: 98.37,
+      branches: 93.54,
+      functions: 100,
+      lines: 98.37
     }
   }
 };
diff --git a/packages/platform/platform-express/test/ajv-errors.spec.ts b/packages/platform/platform-express/test/ajv-errors.spec.ts
@@ -84,6 +84,7 @@ describe("AJV Errors", () => {
             data: {
               foo: 1
             },
+            requestPath: "body",
             dataPath: "",
             instancePath: "",
             keyword: "errorMessage",
@@ -121,6 +122,7 @@ describe("AJV Errors", () => {
         errors: [
           {
             data: [],
+            requestPath: "body",
             dataPath: "",
             instancePath: "",
             keyword: "errorMessage",
@@ -161,6 +163,7 @@ describe("AJV Errors", () => {
               foo: "foo",
               test: "hey"
             },
+            requestPath: "body",
             dataPath: "",
             instancePath: "",
             keyword: "errorMessage",
@@ -198,6 +201,7 @@ describe("AJV Errors", () => {
         errors: [
           {
             data: [],
+            requestPath: "body",
             dataPath: "",
             instancePath: "",
             keyword: "errorMessage",

diff --git a/packages/platform/platform-express/test/array-body.spec.ts b/packages/platform/platform-express/test/array-body.spec.ts
@@ -141,6 +141,7 @@ describe("Array Body", () => {
       expect(body).toEqual({
         errors: [
           {
+            requestPath: "body",
             data: [
               {
                 test: "1"

diff --git a/packages/platform/platform-express/test/discriminator.spec.ts b/packages/platform/platform-express/test/discriminator.spec.ts
@@ -129,6 +129,7 @@ describe("Discriminator", () => {
       expect(body).toEqual({
         errors: [
           {
+            requestPath: "body",
             data: {
               type: "test",
               url: "https://url.com",

diff --git a/packages/platform/platform-express/test/pageable.spec.ts b/packages/platform/platform-express/test/pageable.spec.ts
@@ -357,6 +357,7 @@ describe("Pageable", () => {
       errors: [
         {
           data: -1,
+          requestPath: "query",
           dataPath: ".page",
           instancePath: "/page",
           keyword: "minimum",

diff --git a/packages/platform/platform-express/test/validation-error.spec.ts b/packages/platform/platform-express/test/validation-error.spec.ts
@@ -0,0 +1,172 @@
+import {BodyParams, Controller, PlatformTest, Post, QueryParams} from "@tsed/common";
+import {PlatformTestSdk} from "@tsed/platform-test-sdk";
+import {email, Email, Required} from "@tsed/schema";
+import SuperTest from "supertest";
+import {PlatformExpress} from "../src/index";
+import {rootDir, Server} from "./app/Server";
+
+class Model {
+  @Required()
+  phone: string;
+}
+
+@Controller("/query-params-validation")
+class TestQueryParamsCtrl {
+  @Post("/scenario-1")
+  testScenario1(
+    @QueryParams("email")
+    @Required()
+    @Email()
+    email: string,
+    @BodyParams(Model) @Required() body: Model
+  ) {
+    return {email, body};
+  }
+
+  @Post("/scenario-2")
+  testScenario2(@BodyParams(Model) @Required() body: Model) {
+    return {body};
+  }
+}
+
+const utils = PlatformTestSdk.create({
+  rootDir,
+  platform: PlatformExpress,
+  server: Server
+});
+
+describe("QueryParamValidation", () => {
+  let request: SuperTest.Agent;
+
+  beforeEach(
+    utils.bootstrap({
+      mount: {
+        "/rest": [TestQueryParamsCtrl]
+      }
+    })
+  );
+  beforeEach(() => {
+    request = SuperTest(PlatformTest.callback());
+  });
+  afterEach(utils.reset);
+
+  describe("scenario 1", () => {
+    it("should validate the email", async () => {
+      const response = await request
+        .post("/rest/query-params-validation/[email protected]")
+        .send({
+          phone: "phone"
+        })
+        .expect(200);
+
+      expect(response.body).toEqual({email: "[email protected]", body: {phone: "phone"}});
+    });
+
+    it("should validate the email (REQUIRED)", async () => {
+      const response = await request.post("/rest/query-params-validation/scenario-1").send({}).expect(400);
+
+      expect(response.body).toEqual({
+        errors: [
+          {
+            requestPath: "query",
+            keyword: "required",
+            message: "It should have required parameter 'email'",
+            modelName: "query",
+            params: {
+              missingProperty: "email"
+            },
+            schemaPath: "#/required",
+            dataPath: ".email"
+          }
+        ],
+        message: "Bad request on parameter \"request.query.email\".\nIt should have required parameter 'email'",
+        name: "REQUIRED_VALIDATION_ERROR",
+        status: 400
+      });
+    });
+
+    it("should validate the email (FORMAT)", async () => {
+      const response = await request.post("/rest/query-params-validation/scenario-1?email=wrong").send({}).expect(400);
+
+      expect(response.body).toEqual({
+        errors: [
+          {
+            data: "wrong",
+            requestPath: "query",
+            dataPath: ".email",
+            instancePath: "",
+            keyword: "format",
+            message: 'must match format "email"',
+            params: {
+              format: "email"
+            },
+            schemaPath: "#/format"
+          }
+        ],
+        message: 'Bad request on parameter "request.query.email".\nValue must match format "email". Given value: "wrong"',
+        name: "AJV_VALIDATION_ERROR",
+        status: 400
+      });
+    });
+  });
+  describe("scenario 2", () => {
+    it("should validate the email", async () => {
+      const response = await request
+        .post("/rest/query-params-validation/[email protected]")
+        .send({
+          phone: "phone"
+        })
+        .expect(200);
+
+      expect(response.body).toEqual({email: "[email protected]", body: {phone: "phone"}});
+    });
+
+    it("should validate the email (REQUIRED)", async () => {
+      const response = await request.post("/rest/query-params-validation/scenario-2").send({}).expect(400);
+
+      expect(response.body).toEqual({
+        errors: [
+          {
+            dataPath: ".phone",
+            instancePath: "",
+            keyword: "required",
+            message: "must have required property 'phone'",
+            modelName: "Model",
+            params: {
+              missingProperty: "phone"
+            },
+            requestPath: "body",
+            schemaPath: "#/required"
+          }
+        ],
+        message: 'Bad request on parameter "request.body".\nModel must have required property \'phone\'. Given value: "undefined"',
+        name: "AJV_VALIDATION_ERROR",
+        status: 400
+      });
+    });
+
+    it("should validate the email (FORMAT)", async () => {
+      const response = await request.post("/rest/query-params-validation/scenario-2?email=wrong").send({}).expect(400);
+
+      expect(response.body).toEqual({
+        errors: [
+          {
+            dataPath: ".phone",
+            instancePath: "",
+            keyword: "required",
+            message: "must have required property 'phone'",
+            modelName: "Model",
+            params: {
+              missingProperty: "phone"
+            },
+            requestPath: "body",
+            schemaPath: "#/required"
+          }
+        ],
+        message: 'Bad request on parameter "request.body".\nModel must have required property \'phone\'. Given value: "undefined"',
+        name: "AJV_VALIDATION_ERROR",
+        status: 400
+      });
+    });
+  });
+});
diff --git a/packages/platform/platform-koa/jest.config.js b/packages/platform/platform-koa/jest.config.js
@@ -9,10 +9,10 @@ module.exports = {
   },
   coverageThreshold: {
     global: {
-      statements: 99.48,
-      branches: 94.5,
+      statements: 99.49,
+      branches: 95.65,
       functions: 100,
-      lines: 99.48
+      lines: 99.49
     }
   }
 };
diff --git a/packages/platform/platform-params/jest.config.js b/packages/platform/platform-params/jest.config.js
@@ -6,7 +6,7 @@ module.exports = {
   coverageThreshold: {
     global: {
       statements: 99.81,
-      branches: 93.04,
+      branches: 90.9,
       functions: 100,
       lines: 99.81
     }

diff --git a/packages/platform/platform-params/src/errors/ParamValidationError.spec.ts b/packages/platform/platform-params/src/errors/ParamValidationError.spec.ts
@@ -57,7 +57,8 @@ describe("ParseExpressionError", () => {
       origin: {
         errors: [
           {
-            dataPath: "",
+            requestPath: "name",
+            dataPath: ".expression",
             keyword: "required",
             message: "It should have required parameter 'expression'",
             modelName: "name",
@@ -101,6 +102,7 @@ describe("ParseExpressionError", () => {
       origin: {
         errors: [
           {
+            requestPath: "name",
             dataPath: "hello"
           }
         ],