CCM-12614: add call to pdm and various other bits

Author: Ian-Hodges

infrastructure/terraform/components/dl/README.md

@@ -11,7 +11,7 @@ No requirements.
 |------|-------------|------|---------|:--------:|
 | <a name="input_apim_auth_token_schedule"></a> [apim\_auth\_token\_schedule](#input\_apim\_auth\_token\_schedule) | Schedule to renew the APIM auth token | `string` | `"rate(9 minutes)"` | no |
 | <a name="input_apim_auth_token_url"></a> [apim\_auth\_token\_url](#input\_apim\_auth\_token\_url) | URL to generate an APIM auth token | `string` | `"https://int.api.service.nhs.uk/oauth2/token"` | no |
-| <a name="input_apim_base_url"></a> [apim\_base\_url](#input\_apim\_base\_url) | The URL used to send requests to Notify and PDM | `string` | `"https://sandbox.api.service.nhs.uk"` | no |
+| <a name="input_apim_base_url"></a> [apim\_base\_url](#input\_apim\_base\_url) | The URL used to send requests to Notify and PDM | `string` | `"https://int.api.service.nhs.uk"` | no |
 | <a name="input_apim_keygen_schedule"></a> [apim\_keygen\_schedule](#input\_apim\_keygen\_schedule) | Schedule to refresh key pairs if necessary | `string` | `"cron(0 14 * * ? *)"` | no |
 | <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID (numeric) | `string` | n/a | yes |
 | <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"dl"` | no |

infrastructure/terraform/components/dl/locals.tf

@@ -1,11 +1,11 @@
 locals {
-  aws_lambda_functions_dir_path = "../../../../lambdas"
-  log_destination_arn           = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"
+  aws_lambda_functions_dir_path        = "../../../../lambdas"
+  log_destination_arn                  = "arn:aws:logs:${var.region}:${var.shared_infra_account_id}:destination:nhs-main-obs-firehose-logs"
   apim_access_token_ssm_parameter_name = "/${var.component}/${var.environment}/apim/access_token"
   apim_api_key_ssm_parameter_name      = "/${var.component}/${var.environment}/apim/api_key"
   apim_private_key_ssm_parameter_name  = "/${var.component}/${var.environment}/apim/private_key"
   apim_keystore_s3_bucket              = "nhs-${var.aws_account_id}-${var.region}-${var.environment}-${var.component}-static-assets"
   root_domain_name                     = "${var.environment}.${local.acct.route53_zone_names["digital-letters"]}"
   root_domain_id                       = local.acct.route53_zone_ids["digital-letters"]
-  ttl_shard_count = 3
+  ttl_shard_count                      = 3
 }

infrastructure/terraform/components/dl/module_lambda_pdm_poll.tf

@@ -40,10 +40,25 @@ module "pdm_poll" {
     "APIM_ACCESS_TOKEN_SSM_PARAMETER_NAME" = local.apim_access_token_ssm_parameter_name
     "EVENT_PUBLISHER_EVENT_BUS_ARN"        = aws_cloudwatch_event_bus.main.arn
     "EVENT_PUBLISHER_DLQ_URL"              = module.sqs_event_publisher_errors.sqs_queue_url
+    "POLL_MAX_RETRIES"                     = 10
   }
 }
 
 data "aws_iam_policy_document" "pdm_poll_lambda" {
+  statement {
+    sid    = "AllowSSMParam"
+    effect = "Allow"
+
+    actions = [
+      "ssm:GetParameter",
+      "ssm:GetParameters",
+      "ssm:GetParametersByPath"
+    ]
+
+    resources = [
+      "arn:aws:ssm:${var.region}:${var.aws_account_id}:parameter/${var.component}/${var.environment}/apim/*"
+    ]
+  }
   statement {
     sid    = "PutEvents"
     effect = "Allow"

infrastructure/terraform/components/dl/variables.tf

@@ -119,7 +119,7 @@ variable "ttl_poll_schedule" {
 variable "apim_base_url" {
   type        = string
   description = "The URL used to send requests to Notify and PDM"
-  default     = "https://sandbox.api.service.nhs.uk"
+  default     = "https://int.api.service.nhs.uk"
 }
 
 variable "apim_auth_token_url" {

lambdas/pdm-poll-lambda/src/__tests__/apis/sqs-handler.test.ts

@@ -24,8 +24,9 @@ mockDate.mockReturnValue('2023-06-20T12:00:00.250Z');
 
 const handler = createHandler({
   eventPublisher,
-  pdm,
   logger,
+  pdm,
+  pollMaxRetries: 10,
 });
 
 describe('SQS Handler', () => {
@@ -71,7 +72,7 @@ describe('SQS Handler', () => {
           type: 'uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1',
           data: {
             ...pdmResourceSubmittedEvent.data,
-            retryCount: 1,
+            retryCount: 0,
           },
         },
       ]);

lambdas/pdm-poll-lambda/src/__tests__/app/pdm.test.ts

@@ -1,33 +1,59 @@
 import { mock } from 'jest-mock-extended';
-import { Logger } from 'utils';
+import { IPdmClient, Logger } from 'utils';
 import { Pdm, PdmDependencies } from 'app/pdm';
 import { pdmResourceSubmittedEvent } from '__tests__/test-data';
 
 const logger = mock<Logger>();
+const pdmClient = mock<IPdmClient>();
 const validConfig = (): PdmDependencies => ({
-  pdmUrl: 'https://example.com/pdm',
+  pdmClient,
   logger,
 });
 
+const availableResponse = {
+  resourceType: 'DocumentReference',
+  id: '4c5af7c3-ca21-31b8-924b-fa526db5379b',
+  meta: {
+    versionId: '1',
+    lastUpdated: '2025-12-10T09:00:47.068021Z'
+  },
+  status: 'current',
+  subject: {
+    identifier: {
+      system: 'https://fhir.nhs.uk/Id/nhs-number',
+      value: '9912003071'
+    }
+  },
+  content: [
+    {
+      attachment: {
+        contentType: 'application/pdf',
+        data: 'base64-encoded-pdf',
+        title: 'Dummy PDF'
+      }
+    }
+  ]
+}
+
 describe('Pdm', () => {
   describe('constructor', () => {
     it('is created when required deps are provided', () => {
       const cfg = validConfig();
       expect(() => new Pdm(cfg)).not.toThrow();
     });
 
-    it('throws if pdmUrl is not provided', () => {
+    it('throws if pdmClient is not provided', () => {
       const cfg = {
         logger,
       } as unknown as PdmDependencies;
 
-      expect(() => new Pdm(cfg)).toThrow('pdmUrl has not been specified');
+      expect(() => new Pdm(cfg)).toThrow('pdmClient has not been specified');
     });
 
     it('throws if logger is not provided', () => {
       const cfg = {
-        pdmUrl: 'https://example.com/pdm',
-      } as PdmDependencies;
+        pdmClient,
+      } as unknown as PdmDependencies;
 
       expect(() => new Pdm(cfg)).toThrow('logger has not been provided');
     });
@@ -36,6 +62,8 @@ describe('Pdm', () => {
   describe('poll', () => {
     it('returns available when the document is ready', async () => {
       const cfg = validConfig();
+      pdmClient.getDocumentReference.mockResolvedValue(availableResponse);
+
       const pdm = new Pdm(cfg);
 
       const result = await pdm.poll(pdmResourceSubmittedEvent);
@@ -45,21 +73,28 @@ describe('Pdm', () => {
 
     it('returns unavailable when the document is not ready', async () => {
       const cfg = validConfig();
-      const pdm = new Pdm(cfg);
+      const unavailableResponse = {
+        ...availableResponse,
+        content: [{
+          attachment: {
+            contentType: 'application/pdf',
+            title: 'Dummy PDF'
+          }
+        }]
+      };
+      pdmClient.getDocumentReference.mockResolvedValue(unavailableResponse);
 
-      pdmResourceSubmittedEvent.data.messageReference = 'ref2';
+      const pdm = new Pdm(cfg);
 
       const result = await pdm.poll(pdmResourceSubmittedEvent);
 
       expect(result).toBe('unavailable');
     });
 
-    it('returns failed and logs error when logger.info throws', async () => {
+    it('logs and throws error when error from PDM', async () => {
       const cfg = validConfig();
-      const thrown = new Error('logger failure');
-      cfg.logger.info = jest.fn(() => {
-        throw thrown;
-      });
+      const thrown = new Error('pdm failure');
+      pdmClient.getDocumentReference.mockRejectedValueOnce(thrown)
 
       const pdm = new Pdm(cfg);
 
@@ -69,7 +104,7 @@ describe('Pdm', () => {
       expect(logger.error).toHaveBeenCalledWith(
         expect.objectContaining({
           description: 'Error getting document resource from PDM',
-          err: thrown,
+          err: new Error('pdm failure'),
         }),
       );
     });

lambdas/pdm-poll-lambda/src/__tests__/container.test.ts

@@ -6,16 +6,18 @@ jest.mock('infra/config', () => ({
     apimAccessTokenSsmParameterName: 'test-ssm-parameter-name',
     eventPublisherDlqUrl: 'test-url',
     eventPublisherEventBusArn: 'test-arn',
+    maxPollCount: 10,
   })),
 }));
 
 jest.mock('utils', () => ({
-  EventPublisher: jest.fn(() => ({})),
+  createGetApimAccessToken: jest.fn(() => ({})),
   eventBridgeClient: {},
+  EventPublisher: jest.fn(() => ({})),
   logger: {},
-  sqsClient: {},
   ParameterStoreCache: jest.fn(() => ({})),
-  createGetApimAccessToken: jest.fn(() => ({})),
+  PdmClient: jest.fn(() => ({})),
+  sqsClient: {},
 }));
 
 describe('container', () => {

lambdas/pdm-poll-lambda/src/apis/sqs-handler.ts

@@ -12,12 +12,14 @@ export interface HandlerDependencies {
   eventPublisher: EventPublisher;
   logger: Logger;
   pdm: Pdm;
+  pollMaxRetries: number;
 }
 
 export const createHandler = ({
   eventPublisher,
   logger,
   pdm,
+  pollMaxRetries,
 }: HandlerDependencies) =>
   async function handler(sqsEvent: SQSEvent): Promise<SQSBatchResponse> {
     const receivedItemCount = sqsEvent.Records.length;
@@ -34,14 +36,14 @@ export const createHandler = ({
 
           const result = await pdm.poll(eventDetail);
 
-          const retries = (eventDetail.data?.retryCount ?? 0) + 1;
+          const retries = (eventDetail.data?.retryCount ?? -1) + 1;
           const eventTime = new Date().toISOString();
           let eventType =
             'uk.nhs.notify.digital.letters.pdm.resource.available.v1';
 
           if (result === 'unavailable') {
             eventType =
-              retries >= 10
+              retries >= pollMaxRetries
                 ? 'uk.nhs.notify.digital.letters.pdm.resource.retries.exceeded.v1'
                 : 'uk.nhs.notify.digital.letters.pdm.resource.unavailable.v1';
           }

lambdas/pdm-poll-lambda/src/app/pdm.ts

@@ -1,33 +1,44 @@
-import { Logger } from 'utils';
+import { IPdmClient, Logger } from 'utils';
 
 export type PdmOutcome = 'available' | 'unavailable';
 
 export interface PdmDependencies {
-  pdmUrl: string;
+  pdmClient: IPdmClient;
   logger: Logger;
 }
 
 export class Pdm {
-  private readonly pdmUrl: string;
+  private readonly pdmClient: IPdmClient;
 
   private readonly logger: Logger;
 
   constructor(config: PdmDependencies) {
-    if (!config.pdmUrl) {
-      throw new Error('pdmUrl has not been specified');
+    if (!config.pdmClient) {
+      throw new Error('pdmClient has not been specified');
     }
     if (!config.logger) {
       throw new Error('logger has not been provided');
     }
 
-    this.pdmUrl = config.pdmUrl;
+    this.pdmClient = config.pdmClient;
     this.logger = config.logger;
   }
 
   async poll(item: any): Promise<PdmOutcome> {
     try {
       this.logger.info(item);
-      if (item.data.messageReference === 'ref1') {
+
+      const requestId = crypto.randomUUID();
+
+      const response = await this.pdmClient.getDocumentReference(
+        item.data.resourceId,
+        requestId,
+        item.id,
+      );
+
+      this.logger.info(response);
+
+      if (response.content[0].attachment.data) {
         return 'available';
       }
       return 'unavailable';

lambdas/pdm-poll-lambda/src/container.ts

@@ -1,10 +1,24 @@
 import { HandlerDependencies } from 'apis/sqs-handler';
 import { Pdm } from 'app/pdm';
 import { loadConfig } from 'infra/config';
-import { EventPublisher, eventBridgeClient, logger, sqsClient } from 'utils';
+import {
+  EventPublisher,
+  ParameterStoreCache,
+  PdmClient,
+  createGetApimAccessToken,
+  eventBridgeClient,
+  logger,
+  sqsClient,
+} from 'utils';
 
 export const createContainer = (): HandlerDependencies => {
-  const { eventPublisherDlqUrl, eventPublisherEventBusArn } = loadConfig();
+  const {
+    apimAccessTokenSsmParameterName,
+    apimBaseUrl,
+    eventPublisherDlqUrl,
+    eventPublisherEventBusArn,
+    pollMaxRetries,
+  } = loadConfig();
 
   const eventPublisher = new EventPublisher({
     eventBusArn: eventPublisherEventBusArn,
@@ -14,12 +28,24 @@ export const createContainer = (): HandlerDependencies => {
     eventBridgeClient,
   });
 
+  const parameterStore = new ParameterStoreCache();
+
+  const accessTokenRepository = {
+    getAccessToken: createGetApimAccessToken(
+      apimAccessTokenSsmParameterName,
+      logger,
+      parameterStore,
+    ),
+  };
+
+  const pdmClient = new PdmClient(accessTokenRepository, apimBaseUrl, logger);
+
   const pdm = new Pdm({
-    pdmUrl: 'pdmUrl',
+    pdmClient,
     logger,
   });
 
-  return { eventPublisher, pdm, logger };
+  return { eventPublisher, logger, pdm, pollMaxRetries };
 };
 
 export default createContainer;