CCM-11192: Add bulk write and test data push

masl2 · masl2 · commit 19f3540cf7e6 · 2025-09-18T16:30:09.000+01:00
diff --git a/internal/datastore/src/__test__/letter-repository.test.ts b/internal/datastore/src/__test__/letter-repository.test.ts
@@ -255,4 +255,44 @@ describe('LetterRepository', () => {
     const result = await repo.getLetterIdsBySupplier('supplier1');
     expect(result).toEqual([]);
   });
+
+  test('should batch write letters to the database', async () => {
+    const letters = [
+      createLetter('supplier1', 'letter1'),
+      createLetter('supplier1', 'letter2'),
+      createLetter('supplier1', 'letter3')
+    ];
+
+    await letterRepository.putLetterBatch(letters);
+
+    await checkLetterExists('supplier1', 'letter1');
+    await checkLetterExists('supplier1', 'letter2');
+    await checkLetterExists('supplier1', 'letter3');
+  });
+
+  test('should batch in calls upto 25', async () => {
+    const letters = []
+    for(let i=0; i<60; i++) {
+      letters.push(createLetter('supplier1', `letter${i}`));
+    }
+
+    const sendSpy = jest.spyOn(db.docClient, 'send');
+
+    await letterRepository.putLetterBatch(letters);
+
+    expect(sendSpy).toHaveBeenCalledTimes(3);
+
+    await checkLetterExists('supplier1', 'letter1');
+    await checkLetterExists('supplier1', 'letter6');
+    await checkLetterExists('supplier1', 'letter59');
+  });
+
+  test('rethrows errors from DynamoDB when batch creating letter', async () => {
+    const misconfiguredRepository = new LetterRepository(db.docClient, logger, {
+      ...db.config,
+      lettersTableName: 'nonexistent-table'
+    });
+    await expect(misconfiguredRepository.putLetterBatch([createLetter('supplier1', 'letter1')]))
+      .rejects.toThrow('Cannot do operations on a non-existent table');
+  });
 });
diff --git a/internal/datastore/src/letter-repository.ts b/internal/datastore/src/letter-repository.ts
@@ -2,6 +2,8 @@ import {
   DynamoDBDocumentClient,
   GetCommand,
   PutCommand,
+  BatchWriteCommand,
+  BatchWriteCommandOutput,
   QueryCommand,
   UpdateCommand,
   UpdateCommandOutput
@@ -25,8 +27,8 @@ export type LetterRepositoryConfig = {
 
 export class LetterRepository {
   constructor(readonly ddbClient: DynamoDBDocumentClient,
-              readonly log: Logger,
-              readonly config: LetterRepositoryConfig) {
+    readonly log: Logger,
+    readonly config: LetterRepositoryConfig) {
   }
 
   async putLetter(letter: Omit<Letter, 'ttl' | 'supplierStatus'>): Promise<Letter> {
@@ -50,6 +52,33 @@ export class LetterRepository {
     return LetterSchema.parse(letterDb);
   }
 
+  async putLetterBatch(letters: Omit<Letter, 'ttl' | 'supplierStatus'>[]): Promise<void> {
+    let lettersDb: Letter[] = [];
+    for (let i = 0; i < letters.length; i++) {
+      lettersDb.push({
+        ...letters[i],
+        supplierStatus: `${letters[i].supplierId}#${letters[i].status}`,
+        ttl: Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours)
+      });
+
+      if (lettersDb.length === 25 || i === letters.length - 1) {
+        const input = {
+          RequestItems: {
+            [this.config.lettersTableName]: lettersDb.map((item: any) => ({
+              PutRequest: {
+                Item: item
+              }
+            }))
+          }
+        };
+
+        await this.ddbClient.send(new BatchWriteCommand(input));
+
+        lettersDb = [];
+      }
+    }
+  }
+
   async getLetterById(supplierId: string, letterId: string): Promise<Letter> {
     const result = await this.ddbClient.send(new GetCommand({
       TableName: this.config.lettersTableName,
diff --git a/scripts/test-data/src/__test__/helpers/create_letter_helpers.test.ts b/scripts/test-data/src/__test__/helpers/create_letter_helpers.test.ts
@@ -1,8 +1,7 @@
 import { LetterRepository } from "../../../../../internal/datastore/src/letter-repository";
 import { LetterStatusType } from "../../../../../internal/datastore/src/types";
-import { createLetter } from "../../helpers/create_letter_helpers";
+import { createLetter, createLetterDto } from "../../helpers/create_letter_helpers";
 import { uploadFile } from "../../helpers/s3_helpers";
-import { mockDeep } from "jest-mock-extended";
 
 jest.mock("../../helpers/s3_helpers");
 
@@ -57,4 +56,31 @@ describe("Create letter helpers", () => {
       url: "s3://bucketName/supplierId/targetFilename",
     });
   });
+
+  it("should create a letter DTO with correct fields", () => {
+    jest.useFakeTimers();
+    jest.setSystemTime(new Date(2020, 1, 1));
+
+    const params = {
+      letterId: "testLetterId",
+      supplierId: "testSupplierId",
+      specificationId: "testSpecId",
+      groupId: "testGroupId",
+      status: "PENDING" as LetterStatusType,
+      url: "s3://bucket/testSupplierId/testLetter.pdf",
+    };
+
+    const result = createLetterDto(params);
+
+    expect(result).toEqual({
+      id: "testLetterId",
+      supplierId: "testSupplierId",
+      specificationId: "testSpecId",
+      groupId: "testGroupId",
+      url: "s3://bucket/testSupplierId/testLetter.pdf",
+      status: "PENDING",
+      createdAt: "2020-02-01T00:00:00.000Z",
+      updatedAt: "2020-02-01T00:00:00.000Z",
+    });
+  });
 });
diff --git a/scripts/test-data/src/cli/index.ts b/scripts/test-data/src/cli/index.ts
@@ -4,8 +4,9 @@ import {
   LetterStatusType,
 } from "../../../../internal/datastore/src/types";
 import { randomUUID } from "crypto";
-import { createLetter } from "../helpers/create_letter_helpers";
+import { createLetter, createLetterDto } from "../helpers/create_letter_helpers";
 import { createLetterRepository } from "../infrastructure/letter-repo-factory";
+import { uploadFile } from "../helpers/s3_helpers";
 
 async function main() {
   await yargs(hideBin(process.argv))
@@ -37,6 +38,11 @@ async function main() {
           type: "string",
           demandOption: false,
         },
+        "ttl-hours": {
+          type: "number",
+          demandOption: false,
+          default: 336,
+        },
         status: {
           type: "string",
           demandOption: true,
@@ -67,7 +73,8 @@ async function main() {
           : randomUUID();
         const status = argv.status;
         const environment = argv.environment;
-        const letterRepository = createLetterRepository(environment);
+        const ttlHours = argv.ttlHours;
+        const letterRepository = createLetterRepository(environment, ttlHours);
 
         createLetter({
           letterId,
@@ -81,6 +88,99 @@ async function main() {
         });
       },
     )
+    .command(
+      "create-letter-batch",
+      "Create a batch of letters",
+      {
+        "supplier-id": {
+          type: "string",
+          demandOption: true,
+        },
+        environment: {
+          type: "string",
+          demandOption: true,
+        },
+        awsAccountId: {
+          type: "string",
+          demandOption: true,
+        },
+        "group-id": {
+          type: "string",
+          demandOption: false,
+        },
+        "specification-id": {
+          type: "string",
+          demandOption: false,
+        },
+        "ttl-hours": {
+          type: "number",
+          demandOption: false,
+          default: 336,
+        },
+        "count": {
+          type: "number",
+          demandOption: true,
+        },
+        status: {
+          type: "string",
+          demandOption: true,
+          choices: [
+            "PENDING",
+            "ACCEPTED",
+            "REJECTED",
+            "PRINTED",
+            "ENCLOSED",
+            "CANCELLED",
+            "DISPATCHED",
+            "FAILED",
+            "RETURNED",
+            "DESTROYED",
+            "FORWARDED",
+            "DELIVERED",
+          ],
+        },
+      },
+      async (argv) => {
+
+        // set batch ID
+        const batchId = randomUUID();
+
+        // parse args
+        const supplierId = argv.supplierId;
+        const groupId = argv.groupId ? argv.groupId : randomUUID();
+        const specificationId = argv.specificationId
+          ? argv.specificationId
+          : randomUUID();
+        const status = argv.status;
+        const environment = argv.environment;
+        const ttlHours = argv.ttlHours;
+        const letterRepository = createLetterRepository(environment, ttlHours);
+        const count = argv.count;
+
+
+        // Upload a test file for this batch
+        const bucketName = `nhs-${argv.awsAccountId}-eu-west-2-${argv.environment}-supapi-test-letters`;
+        const targetFilename = `${batchId}-${status}.pdf`;
+        const url = `s3://${bucketName}/${batchId}/${targetFilename}`;
+        await uploadFile(bucketName, batchId, "../../test_letter.pdf", targetFilename);
+
+        // Create letter DTOs
+        let letterDtos = [];
+        for (let i = 0; i < count; i++) {
+          letterDtos.push(createLetterDto({
+            letterId: randomUUID(),
+            supplierId,
+            groupId,
+            specificationId,
+            status: status as LetterStatusType,
+            url,
+          }));
+        };
+
+        // Upload Letters
+        await letterRepository.putLetterBatch(letterDtos);
+      },
+    )
     .demandCommand(1)
     .parse();
 }
diff --git a/scripts/test-data/src/helpers/create_letter_helpers.ts b/scripts/test-data/src/helpers/create_letter_helpers.ts
@@ -47,3 +47,34 @@ export async function createLetter(params: {
   const letterRecord = await letterRepository.putLetter(letter);
   console.log(letterRecord);
 }
+
+export function createLetterDto(params: {
+  letterId: string;
+  supplierId: string;
+  specificationId: string;
+  groupId: string;
+  status: LetterStatusType;
+  url: string;
+}) {
+  const {
+    letterId,
+    supplierId,
+    specificationId,
+    groupId,
+    status,
+    url,
+  } = params;
+
+  const letter: Omit<Letter, "ttl" | "supplierStatus"> = {
+    id: letterId,
+    supplierId,
+    specificationId,
+    groupId,
+    url: url,
+    status: status,
+    createdAt: new Date().toISOString(),
+    updatedAt: new Date().toISOString(),
+  };
+
+  return letter;
+}
diff --git a/scripts/test-data/src/infrastructure/letter-repo-factory.ts b/scripts/test-data/src/infrastructure/letter-repo-factory.ts
@@ -3,13 +3,13 @@ import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
 import pino from 'pino';
 import { LetterRepository } from '../../../../internal/datastore';
 
-export function createLetterRepository(environment: string): LetterRepository {
+export function createLetterRepository(environment: string, ttlHours:number): LetterRepository {
   const ddbClient = new DynamoDBClient({});
   const docClient = DynamoDBDocumentClient.from(ddbClient);
   const log = pino();
   const config = {
     lettersTableName: `nhs-${environment}-supapi-letters`,
-    ttlHours: 24,
+    ttlHours: ttlHours,
   };
 
   return new LetterRepository(docClient, log, config);
