Split upsert operations

Author: francisco-videira-nhs

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

@@ -7,7 +7,7 @@ import {
   setupDynamoDBContainer,
 } from "./db";
 import { LetterRepository } from "../letter-repository";
-import { InsertLetter, Letter, UpdateLetter, UpsertLetter } from "../types";
+import { InsertLetter, Letter, UpdateLetter } from "../types";
 import { LogStream, createTestLogger } from "./logs";
 
 function createLetter(
@@ -484,149 +484,4 @@ describe("LetterRepository", () => {
       ]),
     ).rejects.toThrow("Cannot do operations on a non-existent table");
   });
-
-  test("successful upsert (update status) returns updated letter", async () => {
-    const letter: InsertLetter = createLetter(
-      "supplier1",
-      "letter1",
-      "PENDING",
-      new Date(2020, 0, 1).toISOString(),
-    );
-    const existingLetter: Letter = await letterRepository.putLetter(letter);
-
-    const updateLetterStatus: UpsertLetter = {
-      id: "letter1",
-      supplierId: "supplier1",
-      status: "REJECTED",
-      reasonCode: "R01",
-      reasonText: "R01 text",
-      source: "/data-plane/letter-rendering/pdf",
-      subject: "client/1/letter-request/letter1",
-    };
-
-    const before = Date.now();
-
-    const result: Letter =
-      await letterRepository.upsertLetter(updateLetterStatus);
-
-    const after = Date.now();
-
-    expect(result).toEqual(
-      expect.objectContaining({
-        id: "letter1",
-        status: "REJECTED",
-        specificationId: "specification1",
-        groupId: "group1",
-        reasonCode: "R01",
-        reasonText: "R01 text",
-        supplierId: "supplier1",
-        url: "s3://bucket/letter1.pdf",
-        supplierStatus: "supplier1#REJECTED",
-        source: "/data-plane/letter-rendering/pdf",
-        subject: "client/1/letter-request/letter1",
-      }),
-    );
-    expect(Date.parse(result.updatedAt)).toBeGreaterThan(
-      Date.parse(existingLetter.updatedAt),
-    );
-    expect(result.createdAt).toBe(existingLetter.createdAt);
-    expect(result.createdAt).toBe(result.supplierStatusSk);
-    assertTtl(result.ttl, before, after);
-  });
-
-  test("successful upsert (insert letter) returns created letter", async () => {
-    const insertLetter: UpsertLetter = {
-      id: "letter1",
-      status: "PENDING",
-      specificationId: "specification1",
-      groupId: "group1",
-      supplierId: "supplier1",
-      url: "s3://bucket/letter1.pdf",
-      source: "/data-plane/letter-rendering/pdf",
-      subject: "client/1/letter-request/letter1",
-    };
-
-    const before = Date.now();
-
-    const result: Letter = await letterRepository.upsertLetter(insertLetter);
-
-    const after = Date.now();
-
-    expect(result).toEqual(
-      expect.objectContaining({
-        id: "letter1",
-        status: "PENDING",
-        specificationId: "specification1",
-        groupId: "group1",
-        supplierId: "supplier1",
-        url: "s3://bucket/letter1.pdf",
-        source: "/data-plane/letter-rendering/pdf",
-        subject: "client/1/letter-request/letter1",
-      }),
-    );
-
-    expect(Date.parse(result.createdAt)).toBeGreaterThanOrEqual(before);
-    expect(Date.parse(result.createdAt)).toBeLessThanOrEqual(after);
-    expect(result.updatedAt).toBe(result.createdAt);
-    expect(result.supplierStatusSk).toBe(result.createdAt);
-    assertTtl(result.ttl, before, after);
-  });
-
-  test("successful upsert without status change (update url)", async () => {
-    const insertLetter: InsertLetter = createLetter(
-      "supplier1",
-      "letter1",
-      "PENDING",
-      new Date(2020, 0, 1).toISOString(),
-    );
-    const existingLetter = await letterRepository.putLetter(insertLetter);
-
-    const before = Date.now();
-
-    const result = await letterRepository.upsertLetter({
-      id: "letter1",
-      supplierId: "supplier1",
-      url: "s3://updateToPdf",
-    });
-
-    const after = Date.now();
-
-    expect(result).toEqual(
-      expect.objectContaining({
-        id: "letter1",
-        status: "PENDING",
-        specificationId: "specification1",
-        groupId: "group1",
-        supplierId: "supplier1",
-        url: "s3://updateToPdf",
-        supplierStatus: "supplier1#PENDING",
-        source: "/data-plane/letter-rendering/pdf",
-        subject: "client/1/letter-request/letter1",
-      }),
-    );
-    expect(Date.parse(result.updatedAt)).toBeGreaterThan(
-      Date.parse(existingLetter.updatedAt),
-    );
-    expect(result.createdAt).toBe(existingLetter.createdAt);
-    expect(result.createdAt).toBe(result.supplierStatusSk);
-    assertTtl(result.ttl, before, after);
-  });
-
-  test("unsuccessful upsert should throw error", async () => {
-    const mockSend = jest.fn().mockResolvedValue({ Items: null });
-    const mockDdbClient = { send: mockSend } as any;
-    const repo = new LetterRepository(
-      mockDdbClient,
-      { debug: jest.fn() } as any,
-      { lettersTableName: "letters", lettersTtlHours: 1 },
-    );
-
-    await expect(
-      repo.upsertLetter({
-        id: "letter1",
-        status: "PENDING",
-        supplierId: "supplier1",
-      }),
-    ).rejects.toThrow("upsertLetter: no attributes returned");
-  });
 });

internal/datastore/src/letter-repository.ts

@@ -16,7 +16,6 @@ import {
   LetterSchema,
   LetterSchemaBase,
   UpdateLetter,
-  UpsertLetter,
 } from "./types";
 
 export type PagingOptions = Partial<{
@@ -250,103 +249,4 @@ export class LetterRepository {
     );
     return z.array(LetterSchemaBase).parse(result.Items ?? []);
   }
-
-  async upsertLetter(upsert: UpsertLetter): Promise<Letter> {
-    const now = new Date();
-    const ttl = Math.floor(
-      now.valueOf() / 1000 + 60 * 60 * this.config.lettersTtlHours,
-    );
-
-    const setParts: string[] = [];
-    const exprAttrNames: Record<string, string> = {};
-    const exprAttrValues: Record<string, any> = {};
-
-    // updateAt is always updated
-    setParts.push("updatedAt = :updatedAt");
-    exprAttrValues[":updatedAt"] = now.toISOString();
-
-    // ttl is always updated
-    setParts.push("#ttl = :ttl");
-    exprAttrNames["#ttl"] = "ttl";
-    exprAttrValues[":ttl"] = ttl;
-
-    // createdAt only if first time
-    setParts.push("createdAt = if_not_exists(createdAt, :createdAt)");
-    exprAttrValues[":createdAt"] = now.toISOString();
-
-    // status and related supplierStatus if provided
-    if (upsert.status !== undefined) {
-      exprAttrNames["#status"] = "status";
-      setParts.push("#status = :status");
-      exprAttrValues[":status"] = upsert.status;
-
-      setParts.push("supplierStatus = :supplierStatus");
-      exprAttrValues[":supplierStatus"] =
-        `${upsert.supplierId}#${upsert.status}`;
-
-      // supplierStatusSk should replicate createdAt
-      setParts.push(
-        "supplierStatusSk = if_not_exists(supplierStatusSk, :supplierStatusSk)",
-      );
-      exprAttrValues[":supplierStatusSk"] = now.toISOString();
-    }
-
-    // fields that could be updated
-
-    if (upsert.specificationId !== undefined) {
-      setParts.push("specificationId = :specificationId");
-      exprAttrValues[":specificationId"] = upsert.specificationId;
-    }
-
-    if (upsert.url !== undefined) {
-      setParts.push("#url = :url");
-      exprAttrNames["#url"] = "url";
-      exprAttrValues[":url"] = upsert.url;
-    }
-
-    if (upsert.groupId !== undefined) {
-      setParts.push("groupId = :groupId");
-      exprAttrValues[":groupId"] = upsert.groupId;
-    }
-
-    if (upsert.reasonCode !== undefined) {
-      setParts.push("reasonCode = :reasonCode");
-      exprAttrValues[":reasonCode"] = upsert.reasonCode;
-    }
-    if (upsert.reasonText !== undefined) {
-      setParts.push("reasonText = :reasonText");
-      exprAttrValues[":reasonText"] = upsert.reasonText;
-    }
-
-    if (upsert.source !== undefined) {
-      setParts.push("#source = :source");
-      exprAttrNames["#source"] = "source";
-      exprAttrValues[":source"] = upsert.source;
-    }
-
-    if (upsert.subject !== undefined) {
-      setParts.push("subject = :subject");
-      exprAttrValues[":subject"] = upsert.subject;
-    }
-
-    const updateExpression = `SET ${setParts.join(", ")}`;
-
-    const command = new UpdateCommand({
-      TableName: this.config.lettersTableName,
-      Key: { supplierId: upsert.supplierId, id: upsert.id },
-      UpdateExpression: updateExpression,
-      ExpressionAttributeNames: exprAttrNames,
-      ExpressionAttributeValues: exprAttrValues,
-      ReturnValues: "ALL_NEW",
-    });
-
-    const result = await this.ddbClient.send(command);
-
-    if (!result.Attributes) {
-      throw new Error("upsertLetter: no attributes returned");
-    }
-
-    this.log.debug({ exprAttrValues }, `Upsert to letter=${upsert.id}`);
-    return LetterSchema.parse(result.Attributes);
-  }
 }

internal/datastore/src/types.ts

@@ -71,19 +71,6 @@ export type UpdateLetter = {
   reasonCode?: string;
   reasonText?: string;
 };
-export type UpsertLetter = {
-  id: string;
-  supplierId: string;
-  // fields that might set/overwrite
-  status?: Letter["status"];
-  specificationId?: string;
-  groupId?: string;
-  url?: string;
-  reasonCode?: string;
-  reasonText?: string;
-  source?: string;
-  subject?: string;
-};
 
 export const MISchemaBase = z.object({
   id: z.string(),

lambdas/upsert-letter/package.json

@@ -5,6 +5,7 @@
     "@internal/datastore": "*",
     "@nhsdigital/nhs-notify-event-schemas-letter-rendering": "^2.0.0",
     "@nhsdigital/nhs-notify-event-schemas-letter-rendering-v1": "npm:@nhsdigital/nhs-notify-event-schemas-letter-rendering@^1.1.5",
+    "@nhsdigital/nhs-notify-event-schemas-supplier-api": "^1.0.5",
     "@types/aws-lambda": "^8.10.148",
     "aws-lambda": "^1.0.7",
     "esbuild": "^0.24.0",