feature: Include md5 digest on file attachment payload (#249)

Author: bryan-robitaille

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

@@ -115,6 +115,7 @@ function partialAttachmentFromSubmissionAttachmentsAsJson(
 
   return attachments.map((item) => {
     if (
+      item.id === undefined ||
       item.name === undefined ||
       item.path === undefined ||
       item.scanStatus === undefined
@@ -123,7 +124,8 @@ function partialAttachmentFromSubmissionAttachmentsAsJson(
     }
 
     if (
-      (typeof item.id !== "string" && typeof item.id !== "undefined") ||
+      (typeof item.md5 !== "string" && typeof item.md5 !== "undefined") ||
+      typeof item.id !== "string" ||
       typeof item.name !== "string" ||
       typeof item.path !== "string" ||
       typeof item.scanStatus !== "string"
@@ -136,6 +138,7 @@ function partialAttachmentFromSubmissionAttachmentsAsJson(
       name: item.name,
       path: item.path,
       scanStatus: attachmentScanStatusFromScanStatus(item.scanStatus),
+      md5: item.md5,
     };
   });
 }

src/lib/vault/types/formSubmission.types.ts

@@ -20,10 +20,11 @@ export enum AttachmentScanStatus {
 // id is marked as optional to ensure backwards compatibility.
 // it can be marked as required in the future once we are sure all attachment responses contain id's
 export type PartialAttachment = {
-  id?: string;
+  id: string;
   name: string;
   path: string;
   scanStatus: AttachmentScanStatus;
+  md5?: string;
 };
 
 export type FormSubmission = {

src/operations/retrieveSubmission.v1.ts

@@ -100,6 +100,7 @@ function buildJsonResponse(
         isPotentiallyMalicious: isAttachmentPotentiallyMalicious(
           attachment.scanStatus,
         ),
+        md5: attachment.md5,
       })),
     }),
   });

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

@@ -72,8 +72,8 @@ describe("in formSubmission mapper", () => {
       });
     });
 
-    // This test should be deleted once `PartialAttachment` has its `id` property set to non optional
-    it("return proper FormSubmission when DynamoDB response is complete and valid (testing backwards compatibility with file attachments not having defined 'id')", () => {
+    // This test should be deleted once `PartialAttachment` has its `md5` property set to non optional
+    it("return proper FormSubmission when DynamoDB response is complete and valid (testing backwards compatibility with file attachments not having defined 'md5')", () => {
       const formSubmission = mapFormSubmissionFromDynamoDbResponse({
         CreatedAt: 1750263415913,
         "Status#CreatedAt": "New#1750263415913",
@@ -82,6 +82,7 @@ describe("in formSubmission mapper", () => {
         FormSubmissionHash: "5981e9cd2a2f0032e9b8c99eb7bb8841",
         SubmissionAttachments: JSON.stringify([
           {
+            id: "test",
             name: "output.txt",
             path: "filePath",
             scanStatus: "NO_THREATS_FOUND",
@@ -97,10 +98,11 @@ describe("in formSubmission mapper", () => {
         checksum: "5981e9cd2a2f0032e9b8c99eb7bb8841",
         attachments: [
           {
-            id: undefined,
+            id: "test",
             name: "output.txt",
             path: "filePath",
             scanStatus: AttachmentScanStatus.NoThreatsFound,
+            md5: undefined,
           },
         ],
       });