chore: add more unit tests

Author: craigzour

test/lib/formsClient/getFormTemplate.test.ts

@@ -1,5 +1,6 @@
 import {
   type PrismaClient,
+  type Template,
   type TemplateVersion,
   prisma,
 } from "@gcforms/database";
@@ -50,6 +51,35 @@ describe("getFormTemplate should", () => {
     });
   });
 
+  // This test can be deleted once form versioning is implemented in Production and migrated old form template database entries to the new versioned schema
+  it("return a form template even if form versioning is not fully deployed (testing fallback Prisma query)", async () => {
+    prismaMock.templateVersion.findUnique.mockResolvedValue(null);
+
+    prismaMock.template.findUnique.mockResolvedValue({
+      jsonConfig: {
+        elements: [
+          {
+            id: 1,
+            type: "textField",
+          },
+        ],
+      },
+    } as unknown as Template);
+
+    const formTemplate = await getFormTemplate("clzamy5qv0000115huc4bh90m", 1);
+
+    expect(formTemplate).toEqual({
+      jsonConfig: {
+        elements: [
+          {
+            id: 1,
+            type: "textField",
+          },
+        ],
+      },
+    });
+  });
+
   it("throw an error if database has an internal failure", async () => {
     const customError = new Error("custom error");
     prismaMock.templateVersion.findUnique.mockRejectedValueOnce(customError);

test/lib/vault/mappers/formSubmission.mapper.test.ts

@@ -21,6 +21,20 @@ describe("in formSubmission mapper", () => {
       });
     });
 
+    // This test can be deleted once form versioning is well established in Production
+    it("return proper NewFormSubmission when DynamoDB response does not include a Version attribute (testing backward compatibility with submissions that were produced when form versioning did not exist)", () => {
+      const newFormSubmission = mapNewFormSubmissionFromDynamoDbResponse({
+        Name: "18-06-977e7",
+        CreatedAt: 1750263415913,
+      });
+
+      expect(newFormSubmission).toEqual(
+        expect.objectContaining({
+          version: 1,
+        }),
+      );
+    });
+
     it("throw an error when DynamoDB response is incomplete", () => {
       expect(() =>
         mapNewFormSubmissionFromDynamoDbResponse({
@@ -135,6 +149,23 @@ describe("in formSubmission mapper", () => {
       });
     });
 
+    // This test can be deleted once form versioning is well established in Production
+    it("return proper FormSubmission when DynamoDB response does not include a Version attribute (testing backward compatibility with submissions that were produced when form versioning did not exist)", () => {
+      const formSubmission = mapFormSubmissionFromDynamoDbResponse({
+        CreatedAt: 1750263415913,
+        "Status#CreatedAt": "New#1750263415913",
+        ConfirmationCode: "99063d75-9804-4efa-8f4c-605b4ba6ad95",
+        FormSubmission: '{"1":"Test response"}',
+        FormSubmissionHash: "5981e9cd2a2f0032e9b8c99eb7bb8841",
+      });
+
+      expect(formSubmission).toEqual(
+        expect.objectContaining({
+          version: 1,
+        }),
+      );
+    });
+
     it("throw an error when SubmissionAttachments in DynamoDB response is present but invalid", () => {
       expect(() =>
         mapFormSubmissionFromDynamoDbResponse({

test/mocks/dynamodb.ts

@@ -10,5 +10,6 @@ export function buildMockedVaultItem(
     ConfirmationCode: confirmationCode,
     FormSubmission: '{"1":"Test response"}',
     FormSubmissionHash: "5981e9cd2a2f0032e9b8c99eb7bb8841",
+    Version: 8,
   };
 }

test/operations/retrieveNewSubmissions.v1.test.ts

@@ -53,6 +53,7 @@ describe("retrieveNewSubmissionsOperation handler should", () => {
       {
         name: "ABC",
         createdAt: 123,
+        version: 8,
       },
     ]);
 
@@ -66,6 +67,7 @@ describe("retrieveNewSubmissionsOperation handler should", () => {
       {
         createdAt: 123,
         name: "ABC",
+        version: 8,
       },
     ]);
     expect(auditLogSpy).toHaveBeenNthCalledWith(1, {

test/operations/retrieveSubmission.v1.test.ts

@@ -60,6 +60,7 @@ describe("retrieveSubmissionOperation handler should", () => {
       answers: "",
       checksum: "",
       attachments: [],
+      version: 8,
     });
     getPublicKeyMock.mockResolvedValueOnce("publicKey");
     encryptResponseMock.mockReturnValueOnce({
@@ -91,6 +92,7 @@ describe("retrieveSubmissionOperation handler should", () => {
         confirmationCode: "",
         answers: "",
         checksum: "",
+        version: 8,
       }),
     );
 
@@ -117,6 +119,7 @@ describe("retrieveSubmissionOperation handler should", () => {
           scanStatus: AttachmentScanStatus.noThreatsFound,
         },
       ],
+      version: 8,
     });
     getFormSubmissionAttachmentDownloadLinkMock.mockResolvedValueOnce(
       "https://download-link",
@@ -160,6 +163,7 @@ describe("retrieveSubmissionOperation handler should", () => {
             isPotentiallyMalicious: false,
           },
         ],
+        version: 8,
       }),
     );
 
@@ -224,6 +228,7 @@ describe("retrieveSubmissionOperation handler should", () => {
             scanStatus: attachmentScanStatus,
           },
         ],
+        version: 8,
       });
       getFormSubmissionAttachmentDownloadLinkMock.mockResolvedValueOnce(
         "https://download-link",
@@ -253,6 +258,7 @@ describe("retrieveSubmissionOperation handler should", () => {
               isPotentiallyMalicious,
             },
           ],
+          version: 8,
         }),
       );
     },
@@ -274,6 +280,7 @@ describe("retrieveSubmissionOperation handler should", () => {
           scanStatus: AttachmentScanStatus.noThreatsFound,
         },
       ],
+      version: 8,
     });
     getFormSubmissionAttachmentDownloadLinkMock.mockRejectedValueOnce(
       new Error("custom error"),
@@ -300,6 +307,7 @@ describe("retrieveSubmissionOperation handler should", () => {
       answers: "",
       checksum: "",
       attachments: [],
+      version: 8,
     });
     getPublicKeyMock.mockImplementationOnce(() => {
       throw new Error("custom error");

test/operations/retrieveTemplate.v1.test.ts

@@ -17,21 +17,14 @@ vi.mocked(retrieveRequestContextData).mockReturnValue(
 );
 
 describe("retrieveTemplateOperation handler should", () => {
-  const requestMock = getMockReq({
-    params: {
-      formId: "clzsn6tao000611j50dexeob0",
-    },
-    serviceUserId: "clzsn6tao000611j50dexeob0",
-  });
-
   const { res: responseMock, next: nextMock, clearMockRes } = getMockRes();
 
   beforeEach(() => {
     vi.clearAllMocks();
     clearMockRes();
   });
 
-  it("respond with success when form submission does exist", async () => {
+  it("respond with success when form template does exist", async () => {
     getFormTemplateMock.mockResolvedValueOnce({
       jsonConfig: {
         elements: [
@@ -43,6 +36,56 @@ describe("retrieveTemplateOperation handler should", () => {
       },
     });
 
+    const requestMock = getMockReq({
+      params: {
+        formId: "clzsn6tao000611j50dexeob0",
+      },
+      serviceUserId: "clzsn6tao000611j50dexeob0",
+    });
+
+    await retrieveTemplateOperationV1.handler(
+      requestMock,
+      responseMock,
+      nextMock,
+    );
+
+    expect(responseMock.json).toHaveBeenCalledWith({
+      elements: [
+        {
+          id: 1,
+          type: "textField",
+        },
+      ],
+    });
+    expect(auditLogSpy).toHaveBeenNthCalledWith(1, {
+      userId: "clzsn6tao000611j50dexeob0",
+      subject: { type: "Form", id: "clzsn6tao000611j50dexeob0" },
+      event: "RetrieveTemplate",
+    });
+  });
+
+  it("respond with success when specific version of a form template does exist", async () => {
+    getFormTemplateMock.mockResolvedValueOnce({
+      jsonConfig: {
+        elements: [
+          {
+            id: 1,
+            type: "textField",
+          },
+        ],
+      },
+    });
+
+    const requestMock = getMockReq({
+      params: {
+        formId: "clzsn6tao000611j50dexeob0",
+      },
+      query: {
+        version: "8",
+      },
+      serviceUserId: "clzsn6tao000611j50dexeob0",
+    });
+
     await retrieveTemplateOperationV1.handler(
       requestMock,
       responseMock,
@@ -67,6 +110,13 @@ describe("retrieveTemplateOperation handler should", () => {
   it("respond with error when form template does not exist", async () => {
     getFormTemplateMock.mockResolvedValueOnce(undefined);
 
+    const requestMock = getMockReq({
+      params: {
+        formId: "clzsn6tao000611j50dexeob0",
+      },
+      serviceUserId: "clzsn6tao000611j50dexeob0",
+    });
+
     await retrieveTemplateOperationV1.handler(
       requestMock,
       responseMock,
@@ -79,9 +129,41 @@ describe("retrieveTemplateOperation handler should", () => {
     });
   });
 
+  it("respond with error when 'version' query parameter is not a number", async () => {
+    getFormTemplateMock.mockRejectedValueOnce(new Error("custom error"));
+
+    const requestMock = getMockReq({
+      params: {
+        formId: "clzsn6tao000611j50dexeob0",
+      },
+      query: {
+        version: "hello",
+      },
+      serviceUserId: "clzsn6tao000611j50dexeob0",
+    });
+
+    await retrieveTemplateOperationV1.handler(
+      requestMock,
+      responseMock,
+      nextMock,
+    );
+
+    expect(responseMock.status).toHaveBeenCalledWith(400);
+    expect(responseMock.json).toHaveBeenCalledWith({
+      error: "URL parameter 'version' should be a number",
+    });
+  });
+
   it("pass error to next function when processing fails due to internal error", async () => {
     getFormTemplateMock.mockRejectedValueOnce(new Error("custom error"));
 
+    const requestMock = getMockReq({
+      params: {
+        formId: "clzsn6tao000611j50dexeob0",
+      },
+      serviceUserId: "clzsn6tao000611j50dexeob0",
+    });
+
     await retrieveTemplateOperationV1.handler(
       requestMock,
       responseMock,