Chore: [AEA-6428] - Filter for notifications by application ID rather than name

packages/common/commonTypes/src/index.ts

@@ -10,6 +10,7 @@ export interface PSUDataItem {
   TaskID: string
   TerminalStatus: string
   ApplicationName: string
+  ApplicationID: string
   ExpiryTime: number
   // (Optional, legacy batch-processors only) Indicates that {@link LastModified} is postdated;
   // contains the ISO 8601 timestamp when the postdated update was set.

packages/specification/eps-prescription-status-update-api.yaml

@@ -439,6 +439,7 @@ security:
 x-nhsd-apim:
   temporary: false
   monitoring: true
+  productidcheck: true
   access:
     - title: Application Restricted
       grants:
@@ -459,6 +460,9 @@ x-nhsd-apim:
     - name: show-all-suppliers
       required: false
       header: show-all-suppliers
+    - name: id
+      required: false
+      header: nhsd-application-id
   ratelimiting:
     proxy:
       limit: 20000

packages/updatePrescriptionStatus/src/updatePrescriptionStatus.ts

@@ -106,6 +106,7 @@ const lambdaHandler = async (event: APIGatewayProxyEvent): Promise<APIGatewayPro
 
   const xRequestID = getXRequestID(event, responseEntries)
   const applicationName = event.headers["attribute-name"] ?? "unknown"
+  const applicationId = event.headers["nhsd-application-id"] ?? "unknown"
 
   if (!xRequestID) {
     return response(400, responseEntries)
@@ -131,7 +132,7 @@ const lambdaHandler = async (event: APIGatewayProxyEvent): Promise<APIGatewayPro
     return response(400, responseEntries)
   }
 
-  const dataItems = buildDataItems(requestEntries, xRequestID, applicationName)
+  const dataItems = buildDataItems(requestEntries, xRequestID, applicationName, applicationId)
 
   // If the dataItems contain any invalid ODS codes, then return an error
   const invalidODSCodes = dataItems
@@ -358,7 +359,8 @@ export function handleTransactionCancelledException(
 export function buildDataItems(
   requestEntries: Array<BundleEntry>,
   xRequestID: string,
-  applicationName: string
+  applicationName: string,
+  applicationId: string
 ): Array<PSUDataItem> {
   const dataItems: Array<PSUDataItem> = []
 
@@ -381,6 +383,7 @@ export function buildDataItems(
       TaskID: task.id!,
       TerminalStatus: task.status,
       ApplicationName: applicationName,
+      ApplicationID: applicationId,
       ExpiryTime: (Math.floor(Date.now() / 1000) + TTL_DELTA)
     }
 

packages/updatePrescriptionStatus/src/validation/notificationSiteAndSystemFilters.ts

@@ -13,7 +13,7 @@ function str2set(value: string | undefined): Set<string> {
 
 async function loadConfig(): Promise<{
   enabledSiteODSCodes: Set<string>,
-  enabledSystems: Set<string>,
+  enabledSystemAppIds: Set<string>,
   blockedSiteODSCodes: Set<string>
 }> {
   const paramNames = {
@@ -24,12 +24,12 @@ async function loadConfig(): Promise<{
   const all = await initiatedSSMProvider.getParametersByName(paramNames)
 
   const enabledSiteODSCodes = str2set(all[process.env.ENABLED_SITE_ODS_CODES_PARAM!] as string)
-  const enabledSystems = str2set(all[process.env.ENABLED_SYSTEMS_PARAM!] as string)
+  const enabledSystemAppIds = str2set(all[process.env.ENABLED_SYSTEMS_PARAM!] as string)
   const blockedSiteODSCodes = str2set(all[process.env.BLOCKED_SITE_ODS_CODES_PARAM!] as string)
 
   return {
     enabledSiteODSCodes,
-    enabledSystems,
+    enabledSystemAppIds,
     blockedSiteODSCodes
   }
 }
@@ -48,15 +48,15 @@ export async function checkSiteOrSystemIsNotifyEnabled(
   logger?: Logger
 ): Promise<Array<PSUDataItemWithPrevious>> {
   // Get the configuration from either the cache or SSM
-  const {enabledSiteODSCodes, enabledSystems, blockedSiteODSCodes} = await loadConfig()
+  const {enabledSiteODSCodes, enabledSystemAppIds, blockedSiteODSCodes} = await loadConfig()
   const unfilteredItemCount = data.length
 
   const filteredItems = data.filter((item) => {
-    const appName = item.current.ApplicationName.trim().toLowerCase()
+    const appId = item.current.ApplicationID.trim().toLowerCase()
     const odsCode = item.current.PharmacyODSCode.trim().toLowerCase()
 
     // Is this item either ODS enabled, or supplier enabled?
-    const isEnabledSystem = enabledSiteODSCodes.has(odsCode) || enabledSystems.has(appName)
+    const isEnabledSystem = enabledSiteODSCodes.has(odsCode) || enabledSystemAppIds.has(appId)
     if (!isEnabledSystem) {
       return false
     }

packages/updatePrescriptionStatus/tests/testDatabaseClient.test.ts

@@ -35,6 +35,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_1",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       },
       {
@@ -48,6 +49,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_2",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       }
     ]
@@ -87,6 +89,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_1",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       },
       {
@@ -100,6 +103,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_2",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       }
     ]
@@ -123,6 +127,7 @@ describe("Unit test persistDataItems", () => {
       TaskID: "TaskID_1",
       TerminalStatus: "TerminalStatus_1",
       ApplicationName: "name",
+      ApplicationID: "id",
       ExpiryTime: 10
     }
     const dataItems = Array(150).fill(dataItem)
@@ -148,6 +153,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_1",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       },
       {
@@ -161,6 +167,7 @@ describe("Unit test persistDataItems", () => {
         TaskID: "TaskID_1",
         TerminalStatus: "TerminalStatus_2",
         ApplicationName: "name",
+        ApplicationID: "id",
         ExpiryTime: 10
       }
     ]
@@ -194,6 +201,7 @@ describe("Unit test getPreviousItem", () => {
     TaskID: "previous-task-id",
     TerminalStatus: "ready to collect",
     ApplicationName: "Jim's Pills",
+    ApplicationID: "id",
     ExpiryTime: 123
   }
   const previousItem = {
@@ -207,6 +215,7 @@ describe("Unit test getPreviousItem", () => {
     TaskID: "previous-task-id",
     TerminalStatus: "ready to collect",
     ApplicationName: "Jim's Pills",
+    ApplicationID: "id",
     ExpiryTime: 123
   }
   const currentItem = {
@@ -220,6 +229,7 @@ describe("Unit test getPreviousItem", () => {
     TaskID: "current-task-id",
     TerminalStatus: "ready to collect",
     ApplicationName: "Jim's Pills",
+    ApplicationID: "id",
     ExpiryTime: 123
   }
 
@@ -334,6 +344,7 @@ describe("Unit test rollbackDataItems", () => {
     TaskID: "TaskID_1",
     TerminalStatus: "TerminalStatus_1",
     ApplicationName: "name",
+    ApplicationID: "id",
     ExpiryTime: 10,
     ...overrides
   })

packages/updatePrescriptionStatus/tests/testSqsClient.test.ts

@@ -487,7 +487,8 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
     })
     const item2 = createMockDataItem({
       PharmacyODSCode: "zzz999",
-      ApplicationName: "internal test SYSTEM"
+      ApplicationName: "internal test SYSTEM",
+      ApplicationID: "internal test SYSTEM"
     })
     const result = await checkSiteOrSystemIsNotifyEnabled([
       {
@@ -530,11 +531,13 @@ describe("Unit tests for checkSiteOrSystemIsNotifyEnabled", () => {
     const previous = createMockDataItem({
       PharmacyODSCode: "NOTINLIST",
       ApplicationName: "Some Other System",
+      ApplicationID: "Some Other System",
       Status: "previous"
     })
     const current = createMockDataItem({
       PharmacyODSCode: "NOTINLIST",
-      ApplicationName: "Some Other System"
+      ApplicationName: "Some Other System",
+      ApplicationID: "Some Other System"
     })
     const result = await checkSiteOrSystemIsNotifyEnabled([{previous, current}], logger)
     expect(result).toEqual([])

packages/updatePrescriptionStatus/tests/testUpdatePrescriptionStatus.test.ts

@@ -239,7 +239,7 @@ describe("buildDataItems", () => {
       fullUrl: ""
     }
 
-    const dataItems = buildDataItems([requestEntry], "", "")
+    const dataItems = buildDataItems([requestEntry], "", "", "")
 
     expect(dataItems[0].LineItemID).toEqual(lineItemID)
     expect(dataItems[0].PrescriptionID).toEqual(prescriptionID)
@@ -269,7 +269,7 @@ describe("buildDataItems", () => {
       fullUrl: ""
     }
 
-    const dataItems = buildDataItems([requestEntry], "", "")
+    const dataItems = buildDataItems([requestEntry], "", "", "")
 
     expect(dataItems[0].RepeatNo).toEqual(repeatNo)
   })
@@ -283,7 +283,7 @@ describe("buildDataItems", () => {
       fullUrl: ""
     }
 
-    const dataItems = buildDataItems([requestEntry], "", "")
+    const dataItems = buildDataItems([requestEntry], "", "", "")
 
     expect(dataItems[0].ExpiryTime).toBeGreaterThan(expectedExpiryTime)
   })
@@ -300,7 +300,7 @@ describe("buildDataItems", () => {
       fullUrl: ""
     }
 
-    const dataItems = buildDataItems([requestEntry], "", "")
+    const dataItems = buildDataItems([requestEntry], "", "", "")
     const first: any = dataItems[0]
     expect(first.PostDatedLastModifiedSetAt).toEqual(lastUpdated)
   })

packages/updatePrescriptionStatus/tests/utils/testUtils.ts

@@ -209,6 +209,7 @@ export function createMockDataItem(overrides: Partial<PSUDataItem>): PSUDataItem
     TaskID: "mnopqr-ghijkl-abcdef",
     TerminalStatus: "ready to collect",
     ApplicationName: "Internal Test System",
+    ApplicationID: "Internal Test System",
     ExpiryTime: 123,
     ...overrides
   }