CCM-11192: re-commit changes

Author: masl2

internal/datastore/src/__test__/letter-repository.test.ts

@@ -274,4 +274,59 @@ describe('LetterRepository', () => {
     const letters = await repo.getLettersBySupplier('supplier1', 'PENDING', 10);
     expect(letters).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('should skip array gaps', async () => {
+    const letters = [
+      createLetter('supplier1', 'letter1'),
+      createLetter('supplier1', 'letter2'),
+      createLetter('supplier1', 'letter3')
+    ];
+
+    delete letters[1];
+
+    await letterRepository.putLetterBatch(letters);
+
+    await checkLetterExists('supplier1', 'letter1');
+    await checkLetterExists('supplier1', 'letter3');
+  });
+
+  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');
+  });
 });

internal/datastore/src/letter-repository.ts

@@ -1,4 +1,5 @@
 import {
+  BatchWriteCommand,
   DynamoDBDocumentClient,
   GetCommand,
   PutCommand,
@@ -52,6 +53,41 @@ export class LetterRepository {
     return LetterSchema.parse(letterDb);
   }
 
+  async putLetterBatch(letters: Omit<Letter, 'ttl' | 'supplierStatus'| 'supplierStatusSk'>[]): Promise<void> {
+    let lettersDb: Letter[] = [];
+    for (let i = 0; i < letters.length; i++) {
+
+      const letter = letters[i];
+
+      if(!letter){
+        continue;
+      }
+
+      lettersDb.push({
+        ...letter,
+        supplierStatus: `${letter.supplierId}#${letter.status}`,
+        supplierStatusSk: Date.now().toString(),
+        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,
@@ -149,4 +185,5 @@ export class LetterRepository {
     }));
     return z.array(LetterSchemaBase).parse(result.Items ?? []);
   }
+
 }

package.json

@@ -71,6 +71,7 @@
   "workspaces": [
     "lambdas/api-handler",
     "lambdas/authorizer",
-    "internal/datastore"
+    "internal/datastore",
+    "scripts/test-data"
   ]
 }

scripts/test-data/.eslintignore

@@ -0,0 +1 @@
+dist

scripts/test-data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+node_modules
+dist
+.reports

scripts/test-data/README.md

@@ -0,0 +1,62 @@
+import type { Config } from 'jest';
+
+export const baseJestConfig: Config = {
+  preset: 'ts-jest',
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: './.reports/unit/coverage',
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'babel',
+
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: -10,
+    },
+  },
+
+  coveragePathIgnorePatterns: ['/__tests__/'],
+  transform: { '^.+\\.ts$': 'ts-jest' },
+  testPathIgnorePatterns: ['.build'],
+  testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
+
+  // Use this configuration option to add custom reporters to Jest
+  reporters: [
+    'default',
+    [
+      'jest-html-reporter',
+      {
+        pageTitle: 'Test Report',
+        outputPath: './.reports/unit/test-report.html',
+        includeFailureMsg: true,
+      },
+    ],
+  ],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+};
+
+const utilsJestConfig = {
+  ...baseJestConfig,
+
+  testEnvironment: 'node',
+
+  coveragePathIgnorePatterns: [
+    ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
+    'cli/index.ts',
+    'helpers/s3_helpers.ts',
+    'letter-repo-factory.ts',
+  ],
+};
+
+export default utilsJestConfig;

scripts/test-data/jest.config.ts

@@ -0,0 +1,27 @@
+{
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.858.0",
+    "esbuild": "^0.24.0",
+    "pino": "^9.7.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.2",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.7",
+    "typescript": "^5.8.2"
+  },
+  "license": "MIT",
+  "main": "src/cli/index.ts",
+  "name": "nhs-notify-supplier-api-data-generator",
+  "private": true,
+  "scripts": {
+    "cli": "tsx ./src/cli/index.ts",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test:unit": "jest",
+    "typecheck": "tsc --noEmit"
+  },
+  "version": "0.0.1"
+}

scripts/test-data/package.json

@@ -0,0 +1,86 @@
+import { LetterRepository } from "../../../../../internal/datastore/src/letter-repository";
+import { LetterStatusType } from "../../../../../internal/datastore/src/types";
+import { createLetter, createLetterDto } from "../../helpers/create_letter_helpers";
+import { uploadFile } from "../../helpers/s3_helpers";
+
+jest.mock("../../helpers/s3_helpers");
+
+describe("Create letter helpers", () => {
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it("create letter", async () => {
+    jest.useFakeTimers();
+    jest.setSystemTime(new Date(2020, 1, 1));
+
+    const mockPutLetter = jest.fn();
+    const mockedLetterRepository = {
+      putLetter: mockPutLetter,
+    } as any as LetterRepository;
+    const mockedUploadFile = uploadFile as jest.Mock;
+
+    const supplierId = "supplierId";
+    const letterId = "letterId";
+    const bucketName = "bucketName";
+    const targetFilename = "targetFilename";
+    const groupId = "groupId";
+    const specificationId = "specificationId";
+    const status = "PENDING" as LetterStatusType;
+
+    await createLetter({
+      letterId,
+      bucketName,
+      supplierId,
+      targetFilename,
+      groupId,
+      specificationId,
+      status,
+      letterRepository: mockedLetterRepository,
+    });
+
+    expect(mockedUploadFile).toHaveBeenCalledWith(
+      "bucketName",
+      "supplierId",
+      "../../test_letter.pdf",
+      "targetFilename",
+    );
+    expect(mockPutLetter).toHaveBeenCalledWith({
+      createdAt: "2020-02-01T00:00:00.000Z",
+      groupId: "groupId",
+      id: "letterId",
+      specificationId: "specificationId",
+      status: "PENDING",
+      supplierId: "supplierId",
+      updatedAt: "2020-02-01T00:00:00.000Z",
+      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",
+    });
+  });
+});