rename personalisationFields to ...Parameters

Author: alexnuttall

lambdas/sftp-letters/src/__tests__/app/__snapshots__/send.test.ts.snap

@@ -7,7 +7,7 @@ exports[`App throws if proof request event is missing a property 1`] = `
     "expected": "array",
     "received": "undefined",
     "path": [
-      "personalisationFields"
+      "personalisationParameters"
     ],
     "message": "Required"
   }

lambdas/sftp-letters/src/__tests__/app/send.test.ts

@@ -48,25 +48,29 @@ function setup() {
 
 function mockEvent(
   hasTestData: boolean,
-  personalisationFields: string[]
+  personalisationParameters: string[]
 ): ProofingRequest {
   return {
     owner,
     templateId,
     pdfVersion,
     ...(hasTestData && { testDataVersion }),
-    personalisationFields,
+    personalisationParameters,
   };
 }
 
 describe('App', () => {
   test('calls dependencies to send a proofing request', async () => {
     const { app, mocks } = setup();
 
-    const personalisationFields = ['pdsField', 'custom1', 'custom2'];
-    const batchColumns = ['clientRef', 'template', ...personalisationFields];
+    const personalisationParameters = ['pdsField', 'custom1', 'custom2'];
+    const batchColumns = [
+      'clientRef',
+      'template',
+      ...personalisationParameters,
+    ];
 
-    const event = mockEvent(true, personalisationFields);
+    const event = mockEvent(true, personalisationParameters);
 
     const pdfContent = 'mock PDF content';
     const pdf = Readable.from(pdfContent);
@@ -172,13 +176,13 @@ describe('App', () => {
     expect(mocks.syntheticBatch.buildBatch).toHaveBeenCalledTimes(1);
     expect(mocks.syntheticBatch.buildBatch).toHaveBeenCalledWith(
       templateId,
-      personalisationFields,
+      personalisationParameters,
       testData
     );
 
     expect(mocks.syntheticBatch.getHeader).toHaveBeenCalledTimes(1);
     expect(mocks.syntheticBatch.getHeader).toHaveBeenCalledWith(
-      personalisationFields
+      personalisationParameters
     );
 
     expect(mocks.syntheticBatch.buildManifest).toHaveBeenCalledTimes(1);
@@ -253,7 +257,7 @@ describe('App', () => {
   test('throws if proof request event is missing a property', async () => {
     const { app, mocks } = setup();
 
-    const { personalisationFields: _, ...invalidEvent } = mockEvent(true, [
+    const { personalisationParameters: _, ...invalidEvent } = mockEvent(true, [
       'field',
     ]);
 
@@ -270,10 +274,14 @@ describe('App', () => {
   test('exits early and does not send if a lock is already in effect', async () => {
     const { app, mocks, logMessages } = setup();
 
-    const personalisationFields = ['pdsField'];
-    const batchColumns = ['clientRef', 'template', ...personalisationFields];
+    const personalisationParameters = ['pdsField'];
+    const batchColumns = [
+      'clientRef',
+      'template',
+      ...personalisationParameters,
+    ];
 
-    const event = mockEvent(true, personalisationFields);
+    const event = mockEvent(true, personalisationParameters);
 
     const pdfContent = 'mock PDF content';
     const pdf = Readable.from(pdfContent);
@@ -353,10 +361,14 @@ describe('App', () => {
   test('exits early and does not send if the manifest is already in the SFTP server, clears existing lock', async () => {
     const { app, mocks, logMessages } = setup();
 
-    const personalisationFields = ['pdsField'];
-    const batchColumns = ['clientRef', 'template', ...personalisationFields];
+    const personalisationParameters = ['pdsField'];
+    const batchColumns = [
+      'clientRef',
+      'template',
+      ...personalisationParameters,
+    ];
 
-    const event = mockEvent(true, personalisationFields);
+    const event = mockEvent(true, personalisationParameters);
 
     const pdfContent = 'mock PDF content';
     const pdf = Readable.from(pdfContent);
@@ -443,9 +455,9 @@ describe('App', () => {
   test('logs handled errors', async () => {
     const { app, mocks, logMessages } = setup();
 
-    const personalisationFields = ['pdsField', 'custom1', 'custom2'];
+    const personalisationParameters = ['pdsField', 'custom1', 'custom2'];
 
-    const event = mockEvent(true, personalisationFields);
+    const event = mockEvent(true, personalisationParameters);
 
     const batchId = 'template-id-0000000000000_pdfversionid';
 

lambdas/sftp-letters/src/app/send.ts

@@ -29,7 +29,7 @@ export class App {
       templateId,
       pdfVersion,
       testDataVersion,
-      personalisationFields,
+      personalisationParameters,
     } = this.parseProofingRequest(eventBody);
 
     const batchId = this.batch.getId(templateId, pdfVersion);
@@ -53,7 +53,7 @@ export class App {
         templateId,
         pdfVersion,
         testDataVersion,
-        personalisationFields,
+        personalisationParameters,
         batchId
       );
 
@@ -118,7 +118,7 @@ export class App {
         templateId: z.string(),
         pdfVersion: z.string(),
         testDataVersion: z.string().optional(),
-        personalisationFields: z.array(z.string()),
+        personalisationParameters: z.array(z.string()),
       })
       .parse(JSON.parse(event));
   }

lambdas/sftp-letters/src/infra/types.ts

@@ -12,5 +12,5 @@ export type ProofingRequest = {
   templateId: string;
   pdfVersion: string;
   testDataVersion?: string;
-  personalisationFields: string[];
+  personalisationParameters: string[];
 };

tests/test-team/template-mgmt-e2e-tests/template-mgmt-sftp-send-proof.e2e.spec.ts

@@ -50,7 +50,7 @@ test.describe('SFTP proof send', () => {
   test('Sends PDF and test batch to SFTP, updates template @debug', async () => {
     const templateId = randomUUID();
 
-    const personalisationFields = [
+    const personalisationParameters = [
       'date',
       'nhsNumber',
       'fullName',
@@ -74,11 +74,11 @@ test.describe('SFTP proof send', () => {
         'send-proof-letter',
         'PASSED'
       ),
-      // The status PENDING_PROOF_REQUEST doesn't exist yet
-      // the template's 'personalisationFields' has no effect on the test
+      // The status PENDING_PROOF doesn't exist yet
+      // the template's 'personalisationParameters' has no effect on the test
       // the sender lambda does not read the template
       templateStatus: 'PENDING_PROOF',
-      personalisationFields,
+      personalisationParameters,
     };
 
     const key = {
@@ -108,7 +108,7 @@ test.describe('SFTP proof send', () => {
       owner: key.owner,
       pdfVersion,
       testDataVersion: csvVersion,
-      personalisationFields,
+      personalisationParameters,
     };
 
     await sqsHelper.sendMessage(process.env.SEND_PROOF_QUEUE_URL, proofRequest);