letter test data utility manual fixes

Author: nhsd-david-wass

package-lock.json

@@ -4,6 +4,7 @@
     "@aws-sdk/client-s3": "^3.858.0",
     "@aws-sdk/lib-dynamodb": "^3.858.0",
     "@internal/datastore": "*",
+    "@jest/globals": "^30.2.0",
     "esbuild": "^0.25.11",
     "pino": "^9.7.0",
     "yargs": "^17.7.2"

scripts/utilities/letter-test-data/package.json

@@ -3,10 +3,10 @@ import { LetterStatusType } from "@internal/datastore";
 import {
   createLetter,
   createLetterDto,
-} from "../../helpers/create_letter_helpers";
-import { uploadFile } from "../../helpers/s3_helpers";
+} from "../../helpers/create-letter-helpers";
+import uploadFile from "../../helpers/s3-helpers";
 
-jest.mock("../../helpers/s3_helpers");
+jest.mock("../../helpers/s3-helpers");
 
 describe("Create letter helpers", () => {
   beforeEach(() => {

…__/helpers/create_letter_helpers.test.ts …__/helpers/create-letter-helpers.test.tsscripts/utilities/letter-test-data/src/__test__/helpers/create_letter_helpers.test.ts renamed to scripts/utilities/letter-test-data/src/__test__/helpers/create-letter-helpers.test.ts scripts/utilities/letter-test-data/src/__test__/helpers/create_letter_helpers.test.ts renamed to scripts/utilities/letter-test-data/src/__test__/helpers/create-letter-helpers.test.ts

@@ -0,0 +1,79 @@
+import { jest } from "@jest/globals";
+
+import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import { readFileSync } from "node:fs";
+import uploadFile from "../../helpers/s3-helpers";
+
+jest.mock("@aws-sdk/client-s3", () => ({
+  S3Client: jest.fn(),
+  PutObjectCommand: jest.fn((params: unknown) => params),
+}));
+
+jest.mock("node:fs", () => ({
+  readFileSync: jest.fn(() => Buffer.from("pdf-data")),
+}));
+
+describe("s3-helpers - uploadFile", () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it("uploads file with correct params", async () => {
+    const bucket = "my-bucket";
+    const supplierId = "supplier-123";
+    const sourceFilename = "fixtures/sample.pdf";
+    const targetFilename = "upload.pdf";
+
+    const sendMock = jest.fn().mockResolvedValue({ ETag: "etag-value" });
+    (S3Client as unknown as jest.Mock).mockImplementation(() => ({
+      send: sendMock,
+    }));
+
+    const result = await uploadFile(
+      bucket,
+      supplierId,
+      sourceFilename,
+      targetFilename,
+    );
+
+    expect(readFileSync).toHaveBeenCalled();
+    expect(PutObjectCommand).toHaveBeenCalledWith({
+      Bucket: bucket,
+      Key: `${supplierId}/${targetFilename}`,
+      Body: expect.any(Buffer),
+      ContentType: "application/pdf",
+    });
+
+    const putArgs = (PutObjectCommand as jest.Mock).mock.results[0].value;
+    expect(sendMock).toHaveBeenCalledWith(putArgs);
+    expect(result).toEqual({ ETag: "etag-value" });
+  });
+
+  it("throws and logs error when upload fails", async () => {
+    const bucket = "my-bucket";
+    const supplierId = "supplier-err";
+    const sourceFilename = "fixtures/missing.pdf";
+    const targetFilename = "upload.pdf";
+
+    const sendMock = jest.fn().mockRejectedValue(new Error("S3 failure"));
+    (S3Client as unknown as jest.Mock).mockImplementation(() => ({
+      send: sendMock,
+    }));
+
+    const consoleErrorSpy = jest
+      .spyOn(console, "error")
+      .mockImplementation(() => {});
+
+    await expect(
+      uploadFile(bucket, supplierId, sourceFilename, targetFilename),
+    ).rejects.toThrow("S3 failure");
+
+    expect(sendMock).toHaveBeenCalled();
+    expect(consoleErrorSpy).toHaveBeenCalledWith(
+      "Error uploading file:",
+      expect.any(Error),
+    );
+
+    consoleErrorSpy.mockRestore();
+  });
+});

scripts/utilities/letter-test-data/src/__test__/helpers/s3-helpers.test.ts

@@ -5,9 +5,9 @@ import { randomUUID } from "node:crypto";
 import {
   createLetter,
   createLetterDto,
-} from "../helpers/create_letter_helpers";
-import { createLetterRepository } from "../infrastructure/letter-repo-factory";
-import { uploadFile } from "../helpers/s3_helpers";
+} 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))
@@ -64,13 +64,11 @@ async function main() {
       },
       async (argv) => {
         const { supplierId } = argv;
-        const letterId = argv.letterId ? argv.letterId : randomUUID();
+        const letterId = argv.letterId ?? randomUUID();
         const bucketName = `nhs-${argv.awsAccountId}-eu-west-2-${argv.environment}-supapi-test-letters`;
         const targetFilename = `${letterId}.pdf`;
-        const groupId = argv.groupId ? argv.groupId : randomUUID();
-        const specificationId = argv.specificationId
-          ? argv.specificationId
-          : randomUUID();
+        const groupId = argv.groupId ?? randomUUID();
+        const specificationId = argv.specificationId ?? randomUUID();
         const { status } = argv;
         const { environment } = argv;
         const { ttlHours } = argv;
@@ -145,10 +143,8 @@ async function main() {
 
         // parse args
         const { supplierId } = argv;
-        const groupId = argv.groupId ? argv.groupId : randomUUID();
-        const specificationId = argv.specificationId
-          ? argv.specificationId
-          : randomUUID();
+        const groupId = argv.groupId ?? randomUUID();
+        const specificationId = argv.specificationId ?? randomUUID();
         const { status } = argv;
         const { environment } = argv;
         const { ttlHours } = argv;

scripts/utilities/letter-test-data/src/cli/index.ts

@@ -3,7 +3,7 @@ import {
   LetterRepository,
   LetterStatusType,
 } from "@internal/datastore";
-import { uploadFile } from "./s3_helpers";
+import uploadFile from "./s3-helpers";
 
 export async function createLetter(params: {
   letterId: string;

…ata/src/helpers/create_letter_helpers.ts …ata/src/helpers/create-letter-helpers.tsscripts/utilities/letter-test-data/src/helpers/create_letter_helpers.ts renamed to scripts/utilities/letter-test-data/src/helpers/create-letter-helpers.ts scripts/utilities/letter-test-data/src/helpers/create_letter_helpers.ts renamed to scripts/utilities/letter-test-data/src/helpers/create-letter-helpers.ts

@@ -2,7 +2,7 @@ import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
 import { readFileSync } from "node:fs";
 import path from "node:path";
 
-export async function uploadFile(
+export default async function uploadFile(
   bucketName: string,
   supplierId: string,
   sourceFilename: string,
@@ -24,5 +24,6 @@ export async function uploadFile(
     return await s3.send(command);
   } catch (error) {
     console.error("Error uploading file:", error);
+    throw error;
   }
 }

…tter-test-data/src/helpers/s3_helpers.ts …tter-test-data/src/helpers/s3-helpers.tsscripts/utilities/letter-test-data/src/helpers/s3_helpers.ts renamed to scripts/utilities/letter-test-data/src/helpers/s3-helpers.ts scripts/utilities/letter-test-data/src/helpers/s3_helpers.ts renamed to scripts/utilities/letter-test-data/src/helpers/s3-helpers.ts

@@ -3,7 +3,7 @@ import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
 import { pino } from "pino";
 import { LetterRepository } from "@internal/datastore";
 
-export function createLetterRepository(
+export default function createLetterRepository(
   environment: string,
   ttlHours: number,
 ): LetterRepository {