feat: add debugging option to skip validation when generating Digital…

…PlanningPayload (#353) See theopensystemslab/planx-new#3021
theopensystemslab · Apr 16, 2024 · 15bde6b · 15bde6b
1 parent 9910b2c
commit 15bde6b
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 19 deletions.
diff --git a/src/export/digitalPlanning/index.ts b/src/export/digitalPlanning/index.ts
@@ -4,10 +4,15 @@ import { ExportParams } from "..";
 import { DigitalPlanning } from "./model";
 import { DigitalPlanningApplication as DigitalPlanningPayload } from "./schema/types";
 
+interface DigitalPlanningExportParams extends ExportParams {
+  skipValidation?: boolean;
+}
+
 export async function generateDigitalPlanningPayload({
   client,
   sessionId,
-}: ExportParams): Promise<DigitalPlanningPayload> {
+  skipValidation,
+}: DigitalPlanningExportParams): Promise<DigitalPlanningPayload> {
   const session = await getSessionById(client, sessionId);
   if (!session) throw new Error(`Cannot find session ${sessionId}`);
 
@@ -28,5 +33,5 @@ export async function generateDigitalPlanningPayload({
     breadcrumbs,
     flow,
     metadata,
-  }).getPayload();
+  }).getPayload(skipValidation);
 }
diff --git a/src/export/digitalPlanning/model.test.ts b/src/export/digitalPlanning/model.test.ts
@@ -106,14 +106,36 @@ describe("DigitalPlanning", () => {
       });
     });
 
+    describe("skipping validation", () => {
+      test("shouldn't throw an error", () => {
+        const instance = new DigitalPlanning(mockParams);
+
+        // @ts-expect-error - The operand of a 'delete' operator must be optional
+        delete instance.payload.data.applicant;
+
+        expect(() => instance.getPayload(true)).not.toThrow();
+      });
+
+      test("should return invalid JSON data", () => {
+        const instance = new DigitalPlanning(mockParams);
+
+        // @ts-expect-error - Type 'number' is not assignable to type 'string'
+        instance.payload.data.applicant.name = 12345;
+
+        const payload = instance.getPayload(true);
+
+        expect(payload).toHaveProperty("data.applicant.name", 12345);
+      });
+    });
+
     describe("invalid payloads", () => {
       test("missing values", () => {
         const instance = new DigitalPlanning(mockParams);
 
         // @ts-expect-error - The operand of a 'delete' operator must be optional
         delete instance.payload.data.applicant;
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -124,7 +146,7 @@ describe("DigitalPlanning", () => {
         // @ts-expect-error - Type 'undefined' is not assignable to type 'Applicant'
         instance.payload.data.applicant = undefined;
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -135,7 +157,7 @@ describe("DigitalPlanning", () => {
         // @ts-expect-error - Type 'number' is not assignable to type 'string'
         instance.payload.data.applicant.name = 12345;
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -146,7 +168,7 @@ describe("DigitalPlanning", () => {
         instance.payload.metadata.schema =
           "not a valid URL, but still a string";
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -157,7 +179,7 @@ describe("DigitalPlanning", () => {
         instance.payload.metadata.submittedAt =
           "not a valid datetime, but still a string";
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -167,7 +189,7 @@ describe("DigitalPlanning", () => {
 
         instance.payload.metadata.submittedAt = "2023-01-01 00:00:00";
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });
@@ -178,7 +200,7 @@ describe("DigitalPlanning", () => {
         // @ts-expect-error Type '"invalid enum"' is not assignable to type '"applicant" | "agent" | "proxy"'
         instance.payload.data.user.role = "tester";
 
-        expect(() => instance.getPayload()).toThrowError(
+        expect(() => instance.getPayload()).toThrow(
           /Invalid DigitalPlanning payload/,
         );
       });

diff --git a/src/export/digitalPlanning/model.ts b/src/export/digitalPlanning/model.ts
@@ -82,9 +82,13 @@ export class DigitalPlanning {
     this.payload = this.mapPassportToPayload();
   }
 
-  getPayload(): Payload {
-    this.validatePayload();
-    return this.payload;
+  getPayload(skipValidation: boolean = false): Payload {
+    if (skipValidation) {
+      return this.payload;
+    } else {
+      this.validatePayload();
+      return this.payload;
+    }
   }
 
   mapPassportToPayload(): Payload {

diff --git a/src/export/index.ts b/src/export/index.ts
@@ -53,8 +53,13 @@ export class ExportClient {
 
   digitalPlanningDataPayload(
     sessionId: string,
+    skipValidation?: boolean,
   ): Promise<DigitalPlanningApplication> {
-    return generateDigitalPlanningPayload({ client: this.client, sessionId });
+    return generateDigitalPlanningPayload({
+      client: this.client,
+      sessionId,
+      skipValidation,
+    });
   }
 
   async oneAppPayload(sessionId: string): Promise<string> {

diff --git a/src/export/oneApp/OneApp.test.ts b/src/export/oneApp/OneApp.test.ts
@@ -766,7 +766,7 @@ test("Parsing error", () => {
     sessionId: "abc123",
     passport: new Passport({ data: { invalid: "invalid" } }),
   };
-  expect(() => new OneAppPayload(invalidConfig).buildXML()).toThrowError(
+  expect(() => new OneAppPayload(invalidConfig).buildXML()).toThrow(
     /Invalid OneApp Payload/,
   );
 });
@@ -783,7 +783,7 @@ test("Unhandled error", () => {
   payload.getXMLBuilder = jest.fn().mockImplementation(() => {
     throw Error();
   });
-  expect(() => payload.buildXML()).toThrowError(/Unhandled exception/);
+  expect(() => payload.buildXML()).toThrow(/Unhandled exception/);
 });
 
 describe("Refinement rules", () => {
@@ -802,7 +802,7 @@ describe("Refinement rules", () => {
         sessionId,
         passport,
       }).buildXML(),
-    ).toThrowError(
+    ).toThrow(
       /An email address must be supplied for either applicant or agent/,
     );
   });
@@ -820,7 +820,7 @@ describe("Refinement rules", () => {
         sessionId,
         passport,
       }).buildXML(),
-    ).not.toThrowError();
+    ).not.toThrow();
   });
 
   test("An error is thrown if no telephone values are submitted", () => {
@@ -836,7 +836,7 @@ describe("Refinement rules", () => {
         sessionId,
         passport,
       }).buildXML(),
-    ).toThrowError(
+    ).toThrow(
       /A telephone number must be supplied for either applicant or agent/,
     );
   });
@@ -854,6 +854,6 @@ describe("Refinement rules", () => {
         sessionId,
         passport,
       }).buildXML(),
-    ).not.toThrowError();
+    ).not.toThrow();
   });
 });