New: [AEA-5367] - Silence notifications (#1775)

## Summary

- ✨ New Feature

### Details

Adds two new parameters, which toggle on or off the notifications
integration in two places:
- `EnableNotificationExternalLink`
- Does all the internal stuff, but instead of calling out to the notify
service, it just waits a few milliseconds and returns OK
- `EnableNotificationsInternal`
  - Skips the notify integration completely.

Both default to `False` in the event where there is an error fetching
them.

Author: wildjames

SAMtemplates/functions/main.yaml

@@ -51,6 +51,12 @@ Parameters:
   NotifyAPIBaseURLParam:
     Type: AWS::SSM::Parameter::Name<String>
 
+  EnableNotificationExternalLinkParam:
+    Type: AWS::SSM::Parameter::Name<String>
+
+  EnableNotificationsInternalParam:
+    Type: AWS::SSM::Parameter::Name<String>
+
   LogLevel:
     Type: String
 
@@ -93,6 +99,7 @@ Resources:
           ENABLED_SITE_ODS_CODES_PARAM: !Ref EnabledSiteODSCodesParam
           ENABLED_SYSTEMS_PARAM: !Ref EnabledSystemsParam
           BLOCKED_SITE_ODS_CODES_PARAM: !Ref BlockedSiteODSCodesParam
+          ENABLE_NOTIFICATIONS_PARAM: !Ref EnableNotificationsInternalParam
           LOG_LEVEL: !Ref LogLevel
           ENVIRONMENT: !Ref Environment
           TEST_PRESCRIPTIONS_1: "None"
@@ -396,6 +403,7 @@ Resources:
           API_KEY_SECRET:  secrets-PSU-Notify-API-Key
           NHS_NOTIFY_ROUTING_ID_PARAM: !Ref NotifyRoutingPlanIDParam
           NOTIFY_API_BASE_URL_PARAM: !Ref NotifyAPIBaseURLParam
+          MAKE_REAL_NOTIFY_REQUESTS_PARAM: !Ref EnableNotificationExternalLinkParam
       Events:
         ScheduleEvent:
           Type: ScheduleV2

SAMtemplates/main_template.yaml

@@ -159,6 +159,8 @@ Resources:
         BlockedSiteODSCodesParam: !GetAtt Parameters.Outputs.BlockedSiteODSCodesParameterName
         NotifyRoutingPlanIDParam: !GetAtt Parameters.Outputs.NotifyRoutingPlanIDParameterName
         NotifyAPIBaseURLParam: !GetAtt Parameters.Outputs.NotifyAPIBaseURLParameterName
+        EnableNotificationExternalLinkParam: !GetAtt Parameters.Outputs.EnableNotificationExternalLinkName
+        EnableNotificationsInternalParam: !GetAtt Parameters.Outputs.EnableNotificationsInternalName
         LogLevel: !Ref LogLevel
         LogRetentionInDays: !Ref LogRetentionInDays
         EnableSplunk: !Ref EnableSplunk

SAMtemplates/parameters/main.yaml

@@ -83,6 +83,22 @@ Resources:
         # Non-prod API URL (sandbox) (INT environment: https://int.api.service.nhs.uk/comms)
         - https://sandbox.api.service.nhs.uk/comms
 
+  EnableNotificationExternalLink:
+    Type: AWS::SSM::Parameter
+    Properties:
+      Name: !Sub ${StackName}-EnableNotificationExternalLink
+      Description: "Toggle on or off if we make real requests to the NHS notify service"
+      Type: String
+      Value: "false"
+      
+  EnableNotificationsInternal:
+    Type: AWS::SSM::Parameter
+    Properties:
+      Name: !Sub ${StackName}-EnableNotificationsInternal
+      Description: "Toggle the notifications integration entirely"
+      Type: String
+      Value: "true"
+
 Outputs:
   EnabledSiteODSCodesParameterName:
     Description: "Name of the SSM parameter holding enabled site ODS codes"
@@ -113,3 +129,15 @@ Outputs:
     Value: !Ref NotifyAPIBaseURLParameter
     Export:
       Name: !Sub ${StackName}-PSUNotifyApiBaseUrlParam
+
+  EnableNotificationExternalLinkName:
+    Description: "Name of the SSM parameter holding the Notify API Base URL"
+    Value: !Ref EnableNotificationExternalLink
+    Export:
+      Name: !Sub ${StackName}-EnableNotificationExternalLinkName
+
+  EnableNotificationsInternalName:
+    Description: "Name of the SSM parameter holding the Notify API Base URL"
+    Value: !Ref EnableNotificationsInternal
+    Export:
+      Name: !Sub ${StackName}-EnableNotificationsInternalName

packages/nhsNotifyLambda/.jest/setEnvVars.js

@@ -5,3 +5,4 @@ process.env.AWS_REGION = "eu-west-2";
 process.env.NHS_NOTIFY_ROUTING_ID_PARAM = "NHS_NOTIFY_ROUTING_ID_PARAM"
 process.env.NOTIFY_API_BASE_URL_PARAM = "NOTIFY_API_BASE_URL_PARAM"
 process.env.API_KEY_SECRET = "API_KEY_SECRET"
+process.env.MAKE_REAL_NOTIFY_REQUESTS_PARAM = "true"

packages/nhsNotifyLambda/src/utils.ts

@@ -24,10 +24,12 @@ const TTL_DELTA = 60 * 60 * 24 * 14 // Keep records for 2 weeks
 // For making the notify requests
 const NOTIFY_REQUEST_MAX_ITEMS = 45000
 const NOTIFY_REQUEST_MAX_BYTES = 5 * 1024 * 1024 // 5 MB
+const DUMMY_NOTIFY_DELAY_MS = 150
 
 // these are only ever changed by a deployment
 const dynamoTable = process.env.TABLE_NAME
 const sqsUrl = process.env.NHS_NOTIFY_PRESCRIPTIONS_SQS_QUEUE_URL
+const MAKE_REAL_NOTIFY_REQUESTS_PARAM = process.env.MAKE_REAL_NOTIFY_REQUESTS_PARAM
 
 // AWS clients
 const sqs = new SQSClient({region: process.env.AWS_REGION})
@@ -468,6 +470,24 @@ export async function makeBatchNotifyRequest(
     onRetry: onAxiosRetry
   })
 
+  let doRealRequest: boolean = false
+  if (MAKE_REAL_NOTIFY_REQUESTS_PARAM) doRealRequest = await getParameter(MAKE_REAL_NOTIFY_REQUESTS_PARAM) === "true"
+
+  if (!doRealRequest) {
+    logger.info("Not doing real Notify requests. Simply waiting for some time and returning success on all messages")
+    await new Promise(f => setTimeout(f, DUMMY_NOTIFY_DELAY_MS))
+
+    // Map each input item to a "successful" NotifyDataItemMessage
+    return data.map(item => {
+      return {
+        ...item,
+        messageBatchReference,
+        success: true,
+        notifyMessageId: v4() // Create a dummy UUID
+      }
+    })
+  }
+
   try {
     const resp = await axiosInstance.post<CreateMessageBatchResponse>("/v1/message-batches", body)
 

packages/nhsNotifyLambda/tests/testUtils.test.ts

@@ -15,7 +15,7 @@ const mockGetParameter = jest.fn().mockImplementation((name) => {
   if (name === "NOTIFY_API_BASE_URL_PARAM") {
     return TEST_URL
   }
-  return "parameter_value"
+  return name
 })
 jest.unstable_mockModule(
   "@aws-lambda-powertools/parameters/ssm",
@@ -701,5 +701,59 @@ describe("NHS notify lambda helper functions", () => {
 
       expect(result).toHaveLength(2)
     })
+
+    it("uses a dummy call when the MAKE_REAL_NOTIFY_REQUESTS_PARAM is false", async () => {
+      process.env.MAKE_REAL_NOTIFY_REQUESTS_PARAM = "false"
+      const {makeBatchNotifyRequest: fn} = await import("../src/utils")
+
+      const data = [
+        constructPSUDataItemMessage({
+          PSUDataItem: {
+            RequestID: "r1",
+            PatientNHSNumber: "n1",
+            PharmacyODSCode: "o1",
+            TaskID: "t1",
+            Status: "s1"
+          }
+        }),
+        constructPSUDataItemMessage({
+          PSUDataItem: {
+            RequestID: "r2",
+            PatientNHSNumber: "n2",
+            PharmacyODSCode: "o2",
+            TaskID: "t2",
+            Status: "s2"
+          }
+        })
+      ]
+
+      // nock the POST to fail, so if nock is called the test will fail
+      nock(TEST_URL)
+        .post("/v1/message-batches")
+        .reply(500)
+
+      const result = await fn(
+        logger,
+        "plan-123",
+        data
+      )
+
+      // Should return all successes
+      expect(result).toHaveLength(2)
+      expect(result[0]).toMatchObject({
+        PSUDataItem: data[0].PSUDataItem,
+        success: true,
+        notifyMessageId: expect.any(String), // it will be assigned a dummy ID
+        messageBatchReference: expect.any(String),
+        messageReference: expect.any(String)
+      })
+      expect(result[1]).toMatchObject({
+        PSUDataItem: data[1].PSUDataItem,
+        success: true,
+        notifyMessageId: expect.any(String),
+        messageBatchReference: expect.any(String),
+        messageReference: expect.any(String)
+      })
+    })
   })
 })

packages/updatePrescriptionStatus/.jest/setEnvVars.js

@@ -5,3 +5,4 @@ process.env.SQS_SALT = "the quick brown fox something something"
 process.env.ENABLED_SITE_ODS_CODES_PARAM = "ENABLED_SITE_ODS_CODES_PARAM"
 process.env.ENABLED_SYSTEMS_PARAM = "ENABLED_SYSTEMS_PARAM"
 process.env.BLOCKED_SITE_ODS_CODES_PARAM = "BLOCKED_SITE_ODS_CODES_PARAM"
+process.env.ENABLE_NOTIFICATIONS_PARAM = "ENABLE_NOTIFICATIONS_PARAM"

packages/updatePrescriptionStatus/src/updatePrescriptionStatus.ts

@@ -3,6 +3,7 @@ import {APIGatewayProxyEvent, APIGatewayProxyResult} from "aws-lambda"
 import {Logger} from "@aws-lambda-powertools/logger"
 import {injectLambdaContext} from "@aws-lambda-powertools/logger/middleware"
 import {TransactionCanceledException} from "@aws-sdk/client-dynamodb"
+import {getParameter} from "@aws-lambda-powertools/parameters/ssm"
 
 import middy from "@middy/core"
 import inputOutputLogger from "@middy/input-output-logger"
@@ -44,6 +45,8 @@ export const TEST_PRESCRIPTIONS_1 = (process.env.TEST_PRESCRIPTIONS_1 ?? "")
 export const TEST_PRESCRIPTIONS_2 = (process.env.TEST_PRESCRIPTIONS_2 ?? "")
   .split(",").map(item => item.trim()) || []
 
+const ENABLE_NOTIFICATIONS_PARAM = process.env.ENABLE_NOTIFICATIONS_PARAM
+
 const lambdaHandler = async (event: APIGatewayProxyEvent): Promise<APIGatewayProxyResult> => {
   logger.appendKeys({
     "nhsd-correlation-id": event.headers["nhsd-correlation-id"],
@@ -152,12 +155,26 @@ const lambdaHandler = async (event: APIGatewayProxyEvent): Promise<APIGatewayPro
 
   // This prescription was handled successfully,
   // so add a message to the notifications SQS
+  let enableNotifications: boolean = false
   try {
-    const requestId = event.headers["x-request-id"] ?? "x-request-id-not-found"
-    await pushPrescriptionToNotificationSQS(requestId, dataItems, logger)
-  } catch (err) {
-    logger.error("Failed to push prescriptions to the notifications SQS", {err})
-    // DO NOT throw an error here, since we want to still return the update!
+    if (ENABLE_NOTIFICATIONS_PARAM) enableNotifications = await getParameter(ENABLE_NOTIFICATIONS_PARAM) === "true"
+  } catch {
+    logger.error("Failed to fetch ENABLE_NOTIFICATIONS_PARAM. Defaulting to false.", {ENABLE_NOTIFICATIONS_PARAM})
+  }
+
+  if (enableNotifications) {
+    try {
+      const requestId = event.headers["x-request-id"] ?? "x-request-id-not-found"
+      await pushPrescriptionToNotificationSQS(requestId, dataItems, logger)
+    } catch (err) {
+      logger.error("Failed to push prescriptions to the notifications SQS", {err})
+      // DO NOT throw an error here, since we want to still return the update!
+    }
+  } else {
+    logger.info(
+      "enableNotifications is not true, skipping the notification request.",
+      {enableNotifications}
+    )
   }
 
   return response(201, responseEntries)

packages/updatePrescriptionStatus/tests/testHandler.test.ts

@@ -17,7 +17,6 @@ import {
   generateExpectedItems,
   generateMockEvent,
   mockDynamoDBClient,
-  mockSQSClient,
   TASK_VALUES
 } from "./utils/testUtils"
 
@@ -38,7 +37,21 @@ import {
 import {QueryCommand, TransactionCanceledException, TransactWriteItemsCommand} from "@aws-sdk/client-dynamodb"
 
 const {mockSend: dynamoDBMockSend} = mockDynamoDBClient()
-const {mockSend: sqsMockSend} = mockSQSClient()
+
+const mockPushPrescriptionToNotificationSQS = jest.fn().mockImplementation(async () => Promise.resolve())
+jest.unstable_mockModule("../src/utils/sqsClient", async () => ({
+  __esModule: true,
+  pushPrescriptionToNotificationSQS: mockPushPrescriptionToNotificationSQS
+}))
+
+export const mockGetParameter = jest.fn(async () => Promise.resolve("false"))
+jest.unstable_mockModule(
+  "@aws-lambda-powertools/parameters/ssm",
+  async () => ({
+    __esModule: true,
+    getParameter: mockGetParameter
+  })
+)
 
 const {handler, logger} = await import("../src/updatePrescriptionStatus")
 
@@ -416,7 +429,8 @@ describe("Integration tests for updatePrescriptionStatus handler", () => {
   })
 
   it("when the notification SQS push fails, the response still succeeds", async () => {
-    sqsMockSend.mockImplementation(
+    mockGetParameter.mockImplementation(async () => Promise.resolve("true"))
+    mockPushPrescriptionToNotificationSQS.mockImplementation(
       async () => {
         throw new Error("Test error")
       }
@@ -425,13 +439,12 @@ describe("Integration tests for updatePrescriptionStatus handler", () => {
     const event: APIGatewayProxyEvent = generateMockEvent(requestDispatched)
     const response: APIGatewayProxyResult = await handler(event, {})
     expect(response.statusCode).toBe(201)
+    expect(mockPushPrescriptionToNotificationSQS).toHaveBeenCalled()
   })
 
-  it("when SQS environment variables are not set, the response still succeeds", async () => {
-    process.env.NHS_NOTIFY_PRESCRIPTIONS_SQS_QUEUE_URL = undefined
-    process.env.AWS_REGION = undefined
-
-    sqsMockSend.mockImplementation(
+  it("when SQS push throws an error, the response still succeeds", async () => {
+    mockGetParameter.mockImplementation(async () => Promise.resolve("true"))
+    mockPushPrescriptionToNotificationSQS.mockImplementation(
       async () => {
         throw new Error("Test error")
       }
@@ -440,5 +453,33 @@ describe("Integration tests for updatePrescriptionStatus handler", () => {
     const event: APIGatewayProxyEvent = generateMockEvent(requestDispatched)
     const response: APIGatewayProxyResult = await handler(event, {})
     expect(response.statusCode).toBe(201)
+    expect(mockPushPrescriptionToNotificationSQS).toHaveBeenCalled()
+  })
+
+  it("When the get parameter call throws an error, the request succeeds and the sqs queue is untouched", async () => {
+    mockGetParameter.mockImplementation(async () => Promise.reject(new Error("Failed")))
+
+    const rejected_event: APIGatewayProxyEvent = generateMockEvent(requestDispatched)
+    const rejected_response: APIGatewayProxyResult = await handler(rejected_event, {})
+    expect(rejected_response.statusCode).toBe(201)
+    expect(mockPushPrescriptionToNotificationSQS).not.toHaveBeenCalled()
+  })
+
+  it("When the enable notifications parameter is false, the push to SQS is skipped", async () => {
+    mockGetParameter.mockImplementation(async () => Promise.resolve("false"))
+
+    const bypass_event: APIGatewayProxyEvent = generateMockEvent(requestDispatched)
+    const bypass_response: APIGatewayProxyResult = await handler(bypass_event, {})
+    expect(bypass_response.statusCode).toBe(201)
+    expect(mockPushPrescriptionToNotificationSQS).not.toHaveBeenCalled()
+  })
+
+  it("When the enable notifications parameter is true, the push to SQS is done", async () => {
+    mockGetParameter.mockImplementation(async () => Promise.resolve("true"))
+
+    const successful_event: APIGatewayProxyEvent = generateMockEvent(requestDispatched)
+    const successful_response: APIGatewayProxyResult = await handler(successful_event, {})
+    expect(successful_response.statusCode).toBe(201)
+    expect(mockPushPrescriptionToNotificationSQS).toHaveBeenCalled()
   })
 })