Add event-schemas-letter-rendering

Author: francisco-videira-nhs

.devcontainer/devcontainer.json

@@ -83,7 +83,8 @@
   },
   "mounts": [
     "source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,type=bind,consistency=cached",
-    "source=${localEnv:HOME}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached"
+    "source=${localEnv:HOME}/.aws,target=/home/vscode/.aws,type=bind,consistency=cached",
+    "source=${localEnv:HOME}/.npmrc,target=/home/vscode/.aws,type=bind,consistency=cached"
   ],
   "name": "Devcontainer",
   "postCreateCommand": "scripts/devcontainer/postcreatecommand.sh"

infrastructure/terraform/components/api/README.md

@@ -30,6 +30,7 @@ No requirements.
 | <a name="input_project"></a> [project](#input\_project) | The name of the tfscaffold project | `string` | n/a | yes |
 | <a name="input_region"></a> [region](#input\_region) | The AWS Region | `string` | n/a | yes |
 | <a name="input_shared_infra_account_id"></a> [shared\_infra\_account\_id](#input\_shared\_infra\_account\_id) | The AWS Account ID of the shared infrastructure account | `string` | `"000000000000"` | no |
+| <a name="input_variant_map"></a> [variant\_map](#input\_variant\_map) | n/a | `map(object({ supplier_id = string, spec_id = string }))` | <pre>{<br/>  "lv1": {<br/>    "spec_id": "spec1",<br/>    "supplier_id": "supplier1"<br/>  },<br/>  "lv2": {<br/>    "spec_id": "spec2",<br/>    "supplier_id": "supplier1"<br/>  },<br/>  "lv3": {<br/>    "spec_id": "spec3",<br/>    "supplier_id": "supplier2"<br/>  }<br/>}</pre> | no |
 ## Modules
 
 | Name | Source | Version |

infrastructure/terraform/components/api/module_lambda_upsert_letter.tf

@@ -35,7 +35,18 @@ module "upsert_letter" {
   log_destination_arn       = local.destination_arn
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
-  lambda_env_vars = merge(local.common_lambda_env_vars, {})
+  lambda_env_vars = merge(local.common_lambda_env_vars, {
+    VARIANT_MAP = jsonencode(var.variant_map)
+  })
+}
+
+variable "variant_map" {
+  type = map(object({ supplier_id = string, spec_id = string }))
+  default = {
+    "lv1" = { supplier_id = "supplier1", spec_id = "spec1" },
+    "lv2" = { supplier_id = "supplier1", spec_id = "spec2" },
+    "lv3" = { supplier_id = "supplier2", spec_id = "spec3" }
+  }
 }
 
 data "aws_iam_policy_document" "upsert_letter_lambda" {

lambdas/upsert-letter/package.json

@@ -3,6 +3,7 @@
     "@aws-sdk/client-dynamodb": "^3.858.0",
     "@aws-sdk/lib-dynamodb": "^3.858.0",
     "@internal/datastore": "*",
+    "@nhsdigital/nhs-notify-event-schemas-letter-rendering": "^1.1.5",
     "@types/aws-lambda": "^8.10.148",
     "esbuild": "^0.24.0",
     "pino": "^9.7.0",

lambdas/upsert-letter/src/config/__tests__/env.test.ts

@@ -17,31 +17,32 @@ describe("lambdaEnv", () => {
   it("should load all environment variables successfully", () => {
     process.env.LETTERS_TABLE_NAME = "letters-table";
     process.env.LETTER_TTL_HOURS = "12960";
+    process.env.VARIANT_MAP = `{
+      "lv1": {
+        "supplierId": "supplier1",
+        "specId": "spec1"
+      }
+    }`;
 
     const { envVars } = require("../env");
 
     expect(envVars).toEqual({
       LETTERS_TABLE_NAME: "letters-table",
       LETTER_TTL_HOURS: 12_960,
+      VARIANT_MAP: {
+        lv1: {
+          supplierId: "supplier1",
+          specId: "spec1",
+        },
+      },
     });
   });
 
   it("should throw if a required env var is missing", () => {
-    process.env.LETTERS_TABLE_NAME = undefined; // simulate missing var
+    process.env.LETTERS_TABLE_NAME = "table";
     process.env.LETTER_TTL_HOURS = "12960";
+    process.env.VARIANT_MAP = undefined;
 
     expect(() => require("../env")).toThrow(ZodError);
   });
-
-  it("should not throw if optional are not set", () => {
-    process.env.LETTERS_TABLE_NAME = "letters-table";
-    process.env.LETTER_TTL_HOURS = "12960";
-
-    const { envVars } = require("../env");
-
-    expect(envVars).toEqual({
-      LETTERS_TABLE_NAME: "letters-table",
-      LETTER_TTL_HOURS: 12_960,
-    });
-  });
 });

lambdas/upsert-letter/src/config/env.ts

@@ -1,8 +1,21 @@
 import { z } from "zod";
 
+const LetterVariantSchema = z.record(
+  z.string(),
+  z.object({
+    supplierId: z.string(),
+    specId: z.string(),
+  }),
+);
+export type LetterVariant = z.infer<typeof LetterVariantSchema>;
+
 const EnvVarsSchema = z.object({
   LETTERS_TABLE_NAME: z.string(),
   LETTER_TTL_HOURS: z.coerce.number().int(),
+  VARIANT_MAP: z.string().transform((str, _) => {
+    const parsed = JSON.parse(str);
+    return LetterVariantSchema.parse(parsed);
+  }),
 });
 
 export type EnvVars = z.infer<typeof EnvVarsSchema>;

lambdas/upsert-letter/src/contracts/letters.ts

@@ -1,10 +1,10 @@
 import { SQSEvent } from "aws-lambda";
 import pino from "pino";
 import { LetterRepository } from "internal/datastore/src";
-import createUpsertLetterHandler from "../handler/upsert-handler";
-import { Deps } from "../config/deps";
-import { EnvVars } from "../config/env";
-import { LetterRequestPreparedEvent } from "../contracts/letters";
+import { LetterRequestPreparedEvent } from "@nhsdigital/nhs-notify-event-schemas-letter-rendering";
+import createUpsertLetterHandler from "../upsert-handler";
+import { Deps } from "../../config/deps";
+import { EnvVars } from "../../config/env";
 
 function createValidEvent(
   overrides: Partial<any> = {},
@@ -17,15 +17,14 @@ function createValidEvent(
     id: overrides.id ?? "7b9a03ca-342a-4150-b56b-989109c45613",
     source: "/data-plane/letter-rendering/test",
     subject: "client/client1/letter-request/letterRequest1",
-    type: "uk.nhs.notify.letter-rendering.letter-request.PREPARED.v1",
+    type: "uk.nhs.notify.letter-rendering.letter-request.prepared.v1",
     time: now,
     dataschema:
-      "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.PREPARED.1.0.0.schema.json",
+      "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
     dataschemaversion: "1.0.0",
     data: {
       domainId: overrides.domainId ?? "letter1",
-      supplierId: overrides.supplierId ?? "supplier1",
-      specificationId: overrides.specificationId ?? "spec1",
+      letterVariantId: overrides.letterVariantId ?? "lv1",
       requestId: overrides.requestId ?? "request1",
       requestItemId: overrides.requestItemId ?? "requestItem1",
       requestItemPlanId: overrides.requestItemPlanId ?? "requestItemPlan1",
@@ -38,11 +37,12 @@ function createValidEvent(
       createdAt: now,
       pageCount: 1,
       status: "PREPARED",
-      urgency: "STANDARD",
     },
     traceparent: "00-0af7651916cd43dd8448eb211c803191-b7ad6b7169203331-01",
     recordedtime: now,
-    severitynumber: 1,
+    severitynumber: 2,
+    severitytext: "INFO",
+    plane: "data",
   };
 }
 
@@ -51,11 +51,17 @@ describe("createUpsertLetterHandler", () => {
     letterRepo: {
       upsertLetter: jest.fn(),
     } as unknown as LetterRepository,
-    logger: { info: jest.fn(), error: jest.fn() } as unknown as pino.Logger,
+    logger: { error: jest.fn() } as unknown as pino.Logger,
     env: {
       LETTERS_TABLE_NAME: "LETTERS_TABLE_NAME",
       LETTER_TTL_HOURS: 12_960,
-    } as unknown as EnvVars,
+      VARIANT_MAP: {
+        lv1: {
+          supplierId: "supplier1",
+          specId: "spec1",
+        },
+      },
+    } as EnvVars,
   } as Deps;
 
   beforeEach(() => {

…ter/src/__tests__/upsert-handler.test.ts …handler/__tests__/upsert-handler.test.tslambdas/upsert-letter/src/__tests__/upsert-handler.test.ts renamed to lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts lambdas/upsert-letter/src/__tests__/upsert-handler.test.ts renamed to lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts

@@ -1,43 +1,68 @@
 import { SQSBatchItemFailure, SQSEvent, SQSHandler } from "aws-lambda";
 import { UpsertLetter } from "@internal/datastore";
 import {
+  $LetterRequestPreparedEvent,
   LetterRequestPreparedEvent,
-  LetterRequestPreparedEventSchema,
-} from "../contracts/letters";
+} from "@nhsdigital/nhs-notify-event-schemas-letter-rendering";
+import { ZodError } from "zod";
 import { Deps } from "../config/deps";
 
+type SupplierSpec = { supplierId: string; specId: string };
+
 function mapToUpsertLetter(
   upsertRequest: LetterRequestPreparedEvent,
+  supplier: string,
+  spec: string,
 ): UpsertLetter {
   return {
     id: upsertRequest.data.domainId,
-    supplierId: upsertRequest.data.supplierId,
+    supplierId: supplier,
     status: "PENDING",
-    specificationId: upsertRequest.data.specificationId,
+    specificationId: spec,
     groupId:
       upsertRequest.data.clientId +
       upsertRequest.data.campaignId +
       upsertRequest.data.templateId,
     url: upsertRequest.data.url,
     // TODO CCM-12997 source
-    // TODO CCM-12997 urgency
     // TODO CCM-12997 queueVisibility
   };
 }
 
+function resolveSupplierForVariant(
+  variantId: string,
+  deps: Deps,
+): SupplierSpec {
+  return deps.env.VARIANT_MAP[variantId];
+}
+
 export default function createUpsertLetterHandler(deps: Deps): SQSHandler {
   return async (event: SQSEvent) => {
     const batchItemFailures: SQSBatchItemFailure[] = [];
 
     const tasks = event.Records.map(async (record) => {
       try {
         const upsertRequest: LetterRequestPreparedEvent =
-          LetterRequestPreparedEventSchema.parse(JSON.parse(record.body));
+          $LetterRequestPreparedEvent.parse(JSON.parse(record.body));
 
-        const letterToUpsert: UpsertLetter = mapToUpsertLetter(upsertRequest);
+        const supplierSpec: SupplierSpec = resolveSupplierForVariant(
+          upsertRequest.data.letterVariantId,
+          deps,
+        );
+        const letterToUpsert: UpsertLetter = mapToUpsertLetter(
+          upsertRequest,
+          supplierSpec.supplierId,
+          supplierSpec.specId,
+        );
 
         await deps.letterRepo.upsertLetter(letterToUpsert);
       } catch (error) {
+        if (error instanceof ZodError) {
+          deps.logger.error(
+            { issues: error.issues },
+            "Error parsing letter event in upsert",
+          );
+        }
         deps.logger.error({ err: error }, "Error processing upsert");
         batchItemFailures.push({ itemIdentifier: record.messageId });
       }