CCM-14201 - Client Subscription Management

.github/workflows/cicd-1-pull-request.yaml

@@ -15,6 +15,7 @@ permissions:
   id-token: write
   contents: write
   packages: read
+  pull-requests: read
 
 
 jobs:

infrastructure/terraform/components/callbacks/module_transform_filter_lambda.tf

@@ -35,6 +35,9 @@ module "client_transform_filter_lambda" {
   log_subscription_role_arn = local.acct.log_subscription_role_arn
 
   lambda_env_vars = {
+    CLIENT_SUBSCRIPTION_CONFIG_BUCKET     = module.client_config_bucket.id
+    CLIENT_SUBSCRIPTION_CONFIG_PREFIX     = "client_subscriptions/"
+    CLIENT_SUBSCRIPTION_CACHE_TTL_SECONDS = "60"
   }
 }
 

lambdas/client-transform-filter-lambda/package.json

@@ -1,11 +1,12 @@
 {
   "dependencies": {
+    "@aws-sdk/client-s3": "^3.821.0",
     "aws-embedded-metrics": "^4.2.1",
     "cloudevents": "^8.0.2",
     "esbuild": "^0.25.0",
     "p-map": "^4.0.0",
-    "pino": "^9.5.0",
-    "zod": "^3.25.76"
+    "pino": "^9.6.0",
+    "zod": "^4.1.13"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.2",

lambdas/client-transform-filter-lambda/src/__tests__/index.cache-ttl-invalid.test.ts

@@ -0,0 +1,11 @@
+import { resolveCacheTtlMs } from "..";
+
+describe("cache ttl configuration", () => {
+  it("falls back to default TTL when invalid", () => {
+    const ttlMs = resolveCacheTtlMs({
+      CLIENT_SUBSCRIPTION_CACHE_TTL_SECONDS: "not-a-number",
+    } as NodeJS.ProcessEnv);
+
+    expect(ttlMs).toBe(60_000);
+  });
+});

lambdas/client-transform-filter-lambda/src/__tests__/index.cache-ttl-valid.test.ts

@@ -0,0 +1,11 @@
+import { resolveCacheTtlMs } from "..";
+
+describe("cache ttl configuration", () => {
+  it("uses the configured TTL when valid", () => {
+    const ttlMs = resolveCacheTtlMs({
+      CLIENT_SUBSCRIPTION_CACHE_TTL_SECONDS: "120",
+    } as NodeJS.ProcessEnv);
+
+    expect(ttlMs).toBe(120_000);
+  });
+});

lambdas/client-transform-filter-lambda/src/__tests__/index.config-prefix.test.ts

@@ -0,0 +1,134 @@
+/* eslint-disable import-x/first */
+// eslint-disable-next-line unicorn/no-useless-undefined
+const mockLoadClientConfig = jest.fn().mockResolvedValue(undefined);
+const mockConfigLoader = jest.fn().mockImplementation(() => ({
+  loadClientConfig: mockLoadClientConfig,
+}));
+
+jest.mock("services/config-loader", () => ({
+  ConfigLoader: mockConfigLoader,
+}));
+
+jest.mock("aws-embedded-metrics", () => ({
+  createMetricsLogger: jest.fn(() => ({
+    setNamespace: jest.fn(),
+    setDimensions: jest.fn(),
+    putMetric: jest.fn(),
+    flush: jest.fn().mockResolvedValue(undefined as unknown),
+  })),
+  Unit: {
+    Count: "Count",
+    Milliseconds: "Milliseconds",
+  },
+}));
+
+import type { SQSRecord } from "aws-lambda";
+import { EventTypes } from "models/status-transition-event";
+import { handler, resetConfigLoader } from "..";
+
+const makeSqsRecord = (body: object): SQSRecord => ({
+  messageId: "sqs-id",
+  receiptHandle: "receipt",
+  body: JSON.stringify(body),
+  attributes: {
+    ApproximateReceiveCount: "1",
+    SentTimestamp: "1519211230",
+    SenderId: "ABCDEFGHIJ",
+    ApproximateFirstReceiveTimestamp: "1519211230",
+  },
+  messageAttributes: {},
+  md5OfBody: "md5",
+  eventSource: "aws:sqs",
+  eventSourceARN: "arn:aws:sqs:eu-west-2:123456789:queue",
+  awsRegion: "eu-west-2",
+});
+
+const validEvent = {
+  specversion: "1.0",
+  id: "event-id",
+  source: "/nhs/england/notify/development/primary/data-plane/client-callbacks",
+  subject: "customer/test/message/msg-123",
+  type: EventTypes.MESSAGE_STATUS_TRANSITIONED,
+  time: "2025-01-01T10:00:00.000Z",
+  datacontenttype: "application/json",
+  dataschema: "https://nhs.uk/schemas/notify/message-status-data.v1.json",
+  traceparent: "00-4d678967f96e353c07a0a31c1849b500-07f83ba58dd8df70-01",
+  data: {
+    messageId: "msg-123",
+    messageReference: "ref-123",
+    messageStatus: "DELIVERED",
+    channels: [{ type: "NHSAPP", channelStatus: "DELIVERED" }],
+    timestamp: "2025-01-01T10:00:00Z",
+    routingPlan: {
+      id: "plan-id",
+      name: "plan-name",
+      version: "1",
+      createdDate: "2025-01-01T10:00:00Z",
+    },
+    clientId: "client-1",
+  },
+};
+
+describe("config prefix resolution", () => {
+  beforeEach(() => {
+    mockLoadClientConfig.mockClear();
+    mockConfigLoader.mockClear();
+    resetConfigLoader(); // force lazy re-creation of ConfigLoader on next call
+  });
+
+  it("uses the default prefix when env is not set", async () => {
+    const originalBucket = process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET;
+    const originalPrefix = process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX;
+
+    process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET = "bucket";
+    delete process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX;
+
+    await handler([makeSqsRecord(validEvent)]);
+
+    expect(mockConfigLoader).toHaveBeenCalledWith(
+      expect.objectContaining({
+        keyPrefix: "client_subscriptions/",
+      }),
+    );
+
+    if (originalBucket === undefined) {
+      delete process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET;
+    } else {
+      process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET = originalBucket;
+    }
+
+    if (originalPrefix === undefined) {
+      delete process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX;
+    } else {
+      process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX = originalPrefix;
+    }
+  });
+
+  it("uses the configured prefix when env is set", async () => {
+    const originalBucket = process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET;
+    const originalPrefix = process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX;
+
+    process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET = "bucket";
+    process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX = "custom_prefix/";
+
+    await handler([makeSqsRecord(validEvent)]);
+
+    expect(mockConfigLoader).toHaveBeenCalledWith(
+      expect.objectContaining({
+        keyPrefix: "custom_prefix/",
+      }),
+    );
+
+    if (originalBucket === undefined) {
+      delete process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET;
+    } else {
+      process.env.CLIENT_SUBSCRIPTION_CONFIG_BUCKET = originalBucket;
+    }
+
+    if (originalPrefix === undefined) {
+      delete process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX;
+    } else {
+      process.env.CLIENT_SUBSCRIPTION_CONFIG_PREFIX = originalPrefix;
+    }
+  });
+});