fix: issue where attachments columns in CSVs could only start with at…

…tachment
icdocsoc · Aug 13, 2024 · 181353f · 181353f
1 parent 79697c5
commit 181353f
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 22 deletions.
diff --git a/email/mailmerge/src/pipelines/generate.spec.ts b/email/mailmerge/src/pipelines/generate.spec.ts
@@ -28,7 +28,7 @@ describe("generatePreviews", () => {
         mockDataSource = {
             loadRecords: jest.fn().mockResolvedValue({
                 headers: new Set(["header1", "header2"]),
-                records: [{ header1: "value1", header2: "value2" }],
+                records: [{ header1: "value1", header2: "value2", addThis: "./test.txt" }],
             }),
         };
 
@@ -64,7 +64,7 @@ describe("generatePreviews", () => {
                     ["header1", "field1"],
                     ["header2", "field2"],
                 ]),
-                keysForAttachments: [],
+                keysForAttachments: ["addThis"],
             },
         };
 
@@ -74,7 +74,27 @@ describe("generatePreviews", () => {
         expect(mockEngine.loadTemplate).toHaveBeenCalled();
         expect(mockEngine.extractFields).toHaveBeenCalled();
         expect(mockEngine.renderPreview).toHaveBeenCalled();
-        expect(mockStorageBackend.storeOriginalMergeResults).toHaveBeenCalled();
+        expect(mockStorageBackend.storeOriginalMergeResults).toHaveBeenCalledWith(
+            [
+                {
+                    record: {
+                        field1: "value1",
+                        field2: "value2",
+                    },
+                    previews: { preview: "preview" },
+                    engineInfo: {
+                        name: "testEngine",
+                        options: {},
+                    },
+                    attachmentPaths: ["./test.txt"],
+                    email: { email: "emailData" },
+                },
+            ],
+            {
+                headers: new Set(["header1", "header2"]),
+                records: [{ header1: "value1", header2: "value2", addThis: "./test.txt" }],
+            },
+        );
     });
 
     it("should handle attachments provided in options", async () => {

diff --git a/email/mailmerge/src/pipelines/generate.ts b/email/mailmerge/src/pipelines/generate.ts
@@ -3,7 +3,7 @@ import "dotenv/config";
 
 import { TemplateEngineOptions, TemplateEngine, TemplatePreviews } from "../engines/index.js";
 import { validateRecord, createEmailData } from "../previews/index.js";
-import { DEFAULT_FIELD_NAMES, MappedRecord } from "../util/index.js";
+import { DEFAULT_FIELD_NAMES, MappedRecord, RawRecord } from "../util/index.js";
 import { DataSource } from "./loaders";
 import { StorageBackend, MergeResult } from "./storage/types";
 
@@ -119,10 +119,12 @@ export async function generatePreviews(
 
     // 6.5: handle attachments
     logger.debug("Handling attachments...");
-    let getAttachmentsFromRecord: (record: MappedRecord) => string[];
+    // NOTE: This is designed to operate on the original record
+    let getAttachmentsFromRecord: (record: RawRecord) => string[];
+    let attachmentHeaders: string[] = [];
     if (typeof opts.attachments === "undefined" || opts.attachments.length <= 0) {
         logger.info("Using attachments from records");
-        const attachmentHeaders = Array.isArray(opts.mappings.keysForAttachments)
+        attachmentHeaders = Array.isArray(opts.mappings.keysForAttachments)
             ? opts.mappings.keysForAttachments
             : await opts.mappings.keysForAttachments(headers);
         getAttachmentsFromRecord = (record) =>
@@ -135,21 +137,22 @@ export async function generatePreviews(
     // 8: Render intermediate results
     logger.info("Rendering template previews/intermediates...");
     // NOTE: MappedRecord here is the record with its fields mapped to the template fields, rather than with the raw template fields
-    const previews: [TemplatePreviews, MappedRecord][] = await Promise.all(
+    const previews: [TemplatePreviews, MappedRecord, RawRecord][] = await Promise.all(
         records
-            .map((record) =>
+            .map((originalRecord) =>
                 // Only include fields that are mapped
-                Object.fromEntries(
-                    Object.entries(record)
-                        .filter(
-                            ([key]) => fieldsMaptoTemplate.has(key) || key.startsWith("attachment"),
-                        )
-                        .map(([key, value]) => {
-                            return [fieldsMaptoTemplate.get(key) ?? key, value];
-                        }),
-                ),
+                [
+                    Object.fromEntries(
+                        Object.entries(originalRecord)
+                            .filter(([key]) => fieldsMaptoTemplate.has(key))
+                            .map(([key, value]) => {
+                                return [fieldsMaptoTemplate.get(key) ?? key, value];
+                            }),
+                    ),
+                    originalRecord,
+                ],
             )
-            .filter((preparedRecord) => {
+            .filter(([preparedRecord]) => {
                 const validState = validateRecord(preparedRecord);
                 if (!validState.valid) {
                     logger.warn(
@@ -161,22 +164,23 @@ export async function generatePreviews(
                 }
                 return true;
             })
-            .map(async (preparedRecord) => [
+            .map(async ([preparedRecord, originalRecord]) => [
                 await engine.renderPreview(preparedRecord),
                 preparedRecord,
+                originalRecord,
             ]),
     );
 
     // 9: Write to file
     logger.info("Writing results...");
-    const results: MergeResult[] = previews.map(([previews, record]) => ({
+    const results: MergeResult[] = previews.map(([previews, record, originalRecord]) => ({
         record,
         previews,
         engineInfo: {
             name: opts.engineInfo.name,
             options: opts.engineInfo.options,
         },
-        attachmentPaths: getAttachmentsFromRecord(record),
+        attachmentPaths: getAttachmentsFromRecord(originalRecord),
         email: createEmailData(record),
     }));
 

diff --git a/email/workspace/data/names.csv b/email/workspace/data/names.csv
@@ -1,3 +1,3 @@
-name,to,subject,attachment1,attachment2,bcc,cc
+name,to,subject,a1,a2,bcc,cc
 Kishan,kishansambhi@hotmail.co.uk,DoCSoc x Kishan,./attachments/DoCSoc Sponsorship Proposal 24-25.pdf,./attachments/munch.jpg,kishansambhi@hotmail.co.uk,jaskishansaran@gmail.com kishansambhi@outlook.com
 NotKishan,kishansambhi@hotmail.co.uk," DoCSoc x NotKishan",./attachments/DoCSoc Sponsorship Proposal 24-25.pdf,./attachments/munch.jpg,,