Chore: [AEA-5828] - report ODS code (#2315)

## Summary

- 🤖 Operational or Infrastructure Change

### Details

Log additionally the ODS code and message status needed for reports

Author: tstephen-nhs

packages/nhsNotifyLambda/src/utils/notify.ts

@@ -191,9 +191,11 @@ export async function makeRealNotifyRequest(
         messageReferences: messages.map(e => ({
           nhsNumber: e.recipient.nhsNumber,
           messageReference: e.messageReference,
-          psuRequestId: data.find((el) => el.messageReference === e.messageReference)?.PSUDataItem.RequestID
+          psuRequestId: data.find((el) => el.messageReference === e.messageReference)?.PSUDataItem.RequestID,
+          pharmacyODSCode: e.originator.odsCode
         })),
-        deliveryStatus: "requested" // TODO: change splunk report query to messageStatus
+        deliveryStatus: "requested", // TODO: remove once Splunk report adopts messageStatus
+        messageStatus: "requested"
       })
 
       // Map each input item to a NotifyDataItemMessage, marking success and attaching the notify ID.

packages/updatePrescriptionStatus/src/utils/sqsClient.ts

@@ -114,10 +114,6 @@ export async function pushPrescriptionToNotificationSQS(
 
   // Only allow through sites and systems that are allowedSitesAndSystems
   const allowedSitesAndSystemsData = await checkSiteOrSystemIsNotifyEnabled(data)
-  logger.info(
-    "Filtered out sites and suppliers that are not enabled, or are explicitly disabled",
-    {numItemsAllowed: allowedSitesAndSystemsData.length}
-  )
 
   function norm(str: string) {
     return str.toLowerCase().trim()

packages/updatePrescriptionStatus/src/validation/notificationSiteAndSystemFilters.ts

@@ -1,5 +1,6 @@
 import {PSUDataItemWithPrevious} from "@PrescriptionStatusUpdate_common/commonTypes"
 import {SSMProvider} from "@aws-lambda-powertools/parameters/ssm"
+import {Logger} from "@aws-lambda-powertools/logger"
 
 const ssm = new SSMProvider()
 
@@ -41,15 +42,18 @@ async function loadConfig(): Promise<{
  * - AND are NOT blocked at the site level.
  *
  * @param data - Array of PSUDataItem to be processed
+ * @param logger - Optional logger instance
  * @returns - the filtered array
  */
 export async function checkSiteOrSystemIsNotifyEnabled(
-  data: Array<PSUDataItemWithPrevious>
+  data: Array<PSUDataItemWithPrevious>,
+  logger?: Logger
 ): Promise<Array<PSUDataItemWithPrevious>> {
   // Get the configuration from either the cache or SSM
   const {enabledSiteODSCodes, enabledSystems, blockedSiteODSCodes} = await loadConfig()
+  const unfilteredItemCount = data.length
 
-  return data.filter((item) => {
+  const filteredItems = data.filter((item) => {
     const appName = item.current.ApplicationName.trim().toLowerCase()
     const odsCode = item.current.PharmacyODSCode.trim().toLowerCase()
 
@@ -66,4 +70,13 @@ export async function checkSiteOrSystemIsNotifyEnabled(
 
     return true
   })
+
+  if (logger) {
+    logger.info(
+      "Filtered out sites and suppliers that are not enabled, or are explicitly disabled",
+      {numItemsReceived: unfilteredItemCount, numItemsAllowed: filteredItems.length}
+    )
+  }
+
+  return filteredItems
 }

packages/updatePrescriptionStatus/tests/testSqsClient.test.ts

@@ -293,6 +293,14 @@ describe("Unit tests for getSaltValue", () => {
   })
 })
 describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
+  let logger: Logger
+  let infoSpy: SpiedFunction<(input: LogItemMessage, ...extraInput: LogItemExtraInput) => void>
+  beforeEach(() => {
+    // Fresh logger and spies
+    logger = new Logger({serviceName: "test-service"})
+    infoSpy = jest.spyOn(logger, "info")
+  })
+
   it("includes an item with an enabled ODS code", async () => {
     const previous = createMockDataItem({
       PharmacyODSCode: "FA565",
@@ -303,8 +311,9 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
       PharmacyODSCode: "FA565",
       ApplicationName: "not a real test supplier"
     })
-    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}])
+    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}], logger)
     expect(result).toStrictEqual([{previous, current}])
+    expectLogReceivedAndAllowed(infoSpy, 1, 1)
   })
 
   it("includes an item with an enabled ApplicationName", async () => {
@@ -317,8 +326,9 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
       PharmacyODSCode: "ZZZ999",
       ApplicationName: "Internal Test System"
     })
-    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}])
+    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}], logger)
     expect(result).toEqual([{previous, current}])
+    expectLogReceivedAndAllowed(infoSpy, 1, 1)
   })
 
   it("is case insensitive for both ODS code and ApplicationName", async () => {
@@ -339,7 +349,7 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
         previous: item2,
         current: item2
       }
-    ])
+    ], logger)
     expect(result).toEqual([
       {
         previous: item1,
@@ -362,8 +372,9 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
       PharmacyODSCode: "b3j1z",
       ApplicationName: "Internal Test System"
     })
-    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}])
+    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}], logger)
     expect(result).toEqual([])
+    expectLogReceivedAndAllowed(infoSpy, 1, 0)
   })
 
   it("excludes items that are neither enabled nor blocked", async () => {
@@ -376,8 +387,18 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
       PharmacyODSCode: "NOTINLIST",
       ApplicationName: "Some Other System"
     })
-    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}])
+    const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}], logger)
     expect(result).toEqual([])
+    expectLogReceivedAndAllowed(infoSpy, 1, 0)
   })
 
 })
+function expectLogReceivedAndAllowed(
+  infoSpy: SpiedFunction<(input: LogItemMessage, ...extraInput: LogItemExtraInput) => void>,
+  numItemsReceived: number,
+  numItemsAllowed: number) {
+  expect(infoSpy).toHaveBeenCalledWith(
+    expect.stringContaining("Filtered out sites and suppliers that are not enabled, or are explicitly disabled"),
+    expect.objectContaining({numItemsReceived, numItemsAllowed})
+  )
+}