New: [AEA-0000] - Add notifications reporting lambda for testing purposes

.github/scripts/release_code.sh

@@ -61,6 +61,7 @@ sam deploy \
             LogRetentionInDays="$LOG_RETENTION_DAYS" \
             Environment="$TARGET_ENVIRONMENT" \
             DeployCheckPrescriptionStatusUpdate="$DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE" \
+            DeployNotificationsReporting="$DEPLOY_NOTIFICATIONS_REPORTING" \
             EnableAlerts="$ENABLE_ALERTS" \
             StateMachineLogLevel="$STATE_MACHINE_LOG_LEVEL" \
             EnableNotificationsInternal="$ENABLE_NOTIFICATIONS_INTERNAL" \

.github/workflows/pull_request.yml

@@ -131,6 +131,7 @@ jobs:
       TEST_PRESCRIPTIONS_3: ${{ vars.TEST_PRESCRIPTIONS_3_VALUES }}
       TEST_PRESCRIPTIONS_4: ${{ vars.TEST_PRESCRIPTIONS_4_VALUES }}
       FORWARD_CSOC_LOGS: false
+      DEPLOY_NOTIFICATIONS_REPORTING_ENDPOINT: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
       PROXYGEN_ROLE: ${{ secrets.PROXYGEN_PTL_ROLE }}
@@ -166,6 +167,7 @@ jobs:
       MTLS_KEY: psu-mtls-1
       IS_PULL_REQUEST: true
       FORWARD_CSOC_LOGS: false
+      DEPLOY_NOTIFICATIONS_REPORTING_ENDPOINT: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
       PROXYGEN_ROLE: ${{ secrets.PROXYGEN_PTL_ROLE }}

.github/workflows/run_release_code_and_api.yml

@@ -124,6 +124,9 @@ on:
       FORWARD_CSOC_LOGS:
         required: true
         type: boolean
+      DEPLOY_NOTIFICATIONS_REPORTING_ENDPOINT:
+        type: boolean
+        default: false
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE:
         required: true
@@ -231,6 +234,7 @@ jobs:
           TEST_PRESCRIPTIONS_3: ${{ inputs.TEST_PRESCRIPTIONS_3 || 'noval' }}
           TEST_PRESCRIPTIONS_4: ${{ inputs.TEST_PRESCRIPTIONS_4 || 'noval' }}
           FORWARD_CSOC_LOGS: ${{ inputs.FORWARD_CSOC_LOGS }}
+          DEPLOY_NOTIFICATIONS_REPORTING: ${{ inputs.DEPLOY_NOTIFICATIONS_REPORTING_ENDPOINT }}
         run: ./release_code.sh
 
       - name: get mtls secrets

.vscode/eps-prescription-status-update-api.code-workspace

@@ -32,6 +32,10 @@
       "name": "packages/nhsNotifyLambda",
       "path": "../packages/nhsNotifyLambda"
     },
+    {
+      "name": "packages/notificationsReportingLambda",
+      "path": "../packages/notificationsReportingLambda"
+    },
     {
       "name": "packages/postDatedLambda",
       "path": "../packages/postDatedLambda"
@@ -156,8 +160,14 @@
       "versionable",
       "whens"
     ],
-    "cSpell.dictionaries": ["en-GB"],
-    "cSpell.ignorePaths": ["package-lock.json", "node_modules", ".vscode"],
+    "cSpell.dictionaries": [
+      "en-GB"
+    ],
+    "cSpell.ignorePaths": [
+      "package-lock.json",
+      "node_modules",
+      ".vscode"
+    ],
     "jest.jestCommandLine": "NODE_OPTIONS=--experimental-vm-modules node_modules/.bin/jest --no-cache",
     "jest.nodeEnv": {
       "POWERTOOLS_DEV": true

Makefile

@@ -42,6 +42,7 @@ sam-sync: guard-AWS_DEFAULT_PROFILE guard-stack_name compile
 			  LogLevel=$${LOG_LEVEL:-INFO} \
 			  LogRetentionInDays=$${LOG_RETENTION_DAYS:-30} \
 			  DeployCheckPrescriptionStatusUpdate=true \
+			  DeployNotificationsReporting=true \
 			  EnableAlerts=false \
 			  Environment=$$AWS_ENVIRONMENT \
 			  StateMachineLogLevel=$${STATE_MACHINE_LOG_LEVEL:-ALL} \
@@ -74,6 +75,7 @@ sam-deploy: guard-AWS_DEFAULT_PROFILE guard-stack_name
 			  LogLevel=$${LOG_LEVEL:-INFO} \
 			  LogRetentionInDays=$${LOG_RETENTION_DAYS:-30} \
 			  DeployCheckPrescriptionStatusUpdate=true \
+			  DeployNotificationsReporting=true \
 			  EnableAlerts=false \
 			  Environment=$$AWS_ENVIRONMENT \
 			  StateMachineLogLevel=$${STATE_MACHINE_LOG_LEVEL:-ALL} \
@@ -168,6 +170,7 @@ lint-node: compile-node
 	npm run lint --workspace packages/cpsuLambda
 	npm run lint --workspace packages/checkPrescriptionStatusUpdates
 	npm run lint --workspace packages/nhsNotifyLambda
+	npm run lint --workspace packages/notificationsReportingLambda
 	npm run lint --workspace packages/postDatedLambda
 	npm run lint --workspace packages/nhsNotifyUpdateCallback
 	npm run lint --workspace packages/common/testing
@@ -201,6 +204,7 @@ test: compile
 	npm run test --workspace packages/cpsuLambda
 	npm run test --workspace packages/checkPrescriptionStatusUpdates
 	npm run test --workspace packages/nhsNotifyLambda
+	npm run test --workspace packages/notificationsReportingLambda
 	npm run test --workspace packages/postDatedLambda
 	npm run test --workspace packages/nhsNotifyUpdateCallback
 	npm run test --workspace packages/common/middyErrorHandler
@@ -222,6 +226,8 @@ clean:
 	rm -rf packages/cpsuLambda/lib
 	rm -rf packages/nhsNotifyLambda/coverage
 	rm -rf packages/nhsNotifyLambda/lib
+	rm -rf packages/notificationsReportingLambda/coverage
+	rm -rf packages/notificationsReportingLambda/lib
 	rm -rf packages/postDatedLambda/coverage
 	rm -rf packages/postDatedLambda/lib
 	rm -rf packages/nhsNotifyUpdateCallback/coverage

SAMtemplates/apis/main.yaml

@@ -62,6 +62,14 @@ Parameters:
     Type: String
     Default: none
 
+  NotificationsReportingFunctionName:
+    Type: String
+    Default: none
+
+  NotificationsReportingFunctionArn:
+    Type: String
+    Default: none
+
   LogRetentionInDays:
     Type: Number
 
@@ -71,6 +79,10 @@ Parameters:
   DeployCheckPrescriptionStatusUpdate:
     Type: String
 
+  DeployNotificationsReporting:
+    Type: String
+    Default: false
+
   ForwardCsocLogs:
     Type: String
     Default: false
@@ -81,6 +93,9 @@ Conditions:
   ShouldDeployCheckPrescriptionStatusUpdate: !Equals
     - true
     - !Ref DeployCheckPrescriptionStatusUpdate
+  ShouldDeployNotificationsReporting: !Equals
+    - true
+    - !Ref DeployNotificationsReporting
 
 Resources:
   GenerateCertificate:
@@ -549,11 +564,53 @@ Resources:
       Timeout: "1"
       Count: 0
 
+  NotificationsReportingResource:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::ApiGateway::Resource
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ParentId: !GetAtt RestApiGateway.RootResourceId
+      PathPart: notifications-reporting
+
+  NotificationsReportingMethod:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::ApiGateway::Method
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ResourceId: !Ref NotificationsReportingResource
+      HttpMethod: GET
+      AuthorizationType: NONE
+      Integration:
+        Type: AWS_PROXY
+        Credentials: !GetAtt RestApiGatewayResources.Outputs.ApiGwRoleArn
+        IntegrationHttpMethod: POST
+        Uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${NotificationsReportingFunctionArn}/invocations
+
+  NotificationsReportingHandle:
+    Condition: ShouldDeployNotificationsReporting
+    DependsOn: NotificationsReportingMethod
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  NotificationsReportingWaitHandle:
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  NotificationsReportingWaitCondition:
+    Type: "AWS::CloudFormation::WaitCondition"
+    Properties:
+      Handle:
+        !If [
+          ShouldDeployNotificationsReporting,
+          !Ref NotificationsReportingHandle,
+          !Ref NotificationsReportingWaitHandle,
+        ]
+      Timeout: "1"
+      Count: 0
+
   # *********************************************************************
   # if you add a new endpoint, then change the name of this resource
   # also need to change it in RestApiGatewayStage.Properties.DeploymentId
   # *********************************************************************
-  RestApiGatewayDeploymentV2f:
+  RestApiGatewayDeploymentV2g:
     Type: AWS::ApiGateway::Deployment
     DependsOn:
       # see note above if you add something in here when you add a new endpoint
@@ -563,6 +620,7 @@ Resources:
       - Format1UpdatePrescriptionStatusMethod
       - CheckPrescriptionStatusUpdatesWaitCondition
       - NotificationDeliveryStatusCallbackMethod
+      - NotificationsReportingMethod
       # see note above if you add something in here when you add a new endpoint
     Properties:
       RestApiId: !Ref RestApiGateway
@@ -571,7 +629,7 @@ Resources:
     Type: AWS::ApiGateway::Stage
     Properties:
       RestApiId: !Ref RestApiGateway
-      DeploymentId: !Ref RestApiGatewayDeploymentV2f
+      DeploymentId: !Ref RestApiGatewayDeploymentV2g
       StageName: prod
       TracingEnabled: true
       AccessLogSetting:
@@ -600,6 +658,10 @@ Resources:
               - ShouldDeployCheckPrescriptionStatusUpdate
               - Fn::ImportValue: !Sub ${StackName}:functions:${CheckPrescriptionStatusUpdatesFunctionName}:ExecuteLambdaPolicyArn
               - !Ref AWS::NoValue
+            - !If
+              - ShouldDeployNotificationsReporting
+              - Fn::ImportValue: !Sub ${StackName}:functions:${NotificationsReportingFunctionName}:ExecuteLambdaPolicyArn
+              - !Ref AWS::NoValue
 
         ApiName: !Sub ${StackName}-apigw
         LogRetentionInDays: !Ref LogRetentionInDays

SAMtemplates/functions/main.yaml

@@ -90,6 +90,10 @@ Parameters:
   DeployCheckPrescriptionStatusUpdate:
     Type: String
 
+  DeployNotificationsReporting:
+    Type: String
+    Default: false
+
   Environment:
     Type: String
 
@@ -113,6 +117,10 @@ Conditions:
     - true
     - !Ref DeployCheckPrescriptionStatusUpdate
 
+  ShouldDeployNotificationsReporting: !Equals
+    - true
+    - !Ref DeployNotificationsReporting
+
   EnableBackupCondition: !Equals
     - "True"
     - !Ref EnableBackup
@@ -402,6 +410,53 @@ Resources:
         SplunkSubscriptionFilterRole: !ImportValue lambda-resources:SplunkSubscriptionFilterRole
         SplunkDeliveryStreamArn: !ImportValue lambda-resources:SplunkDeliveryStream
 
+  NotificationsReporting:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::Serverless::Function
+    Properties:
+      FunctionName: !Sub ${StackName}-NotificationsReporting
+      CodeUri: ../../packages
+      Handler: notificationsReportingLambda.handler
+      Role: !GetAtt NotificationsReportingResources.Outputs.LambdaRoleArn
+      Environment:
+        Variables:
+          TABLE_NAME: !Ref PrescriptionNotificationStatesTableName
+    Metadata:
+      BuildMethod: esbuild
+      guard:
+        SuppressedRules:
+          - LAMBDA_DLQ_CHECK
+          - LAMBDA_INSIDE_VPC
+          - LAMBDA_CONCURRENCY_CHECK
+      BuildProperties:
+        Minify: true
+        Target: es2020
+        Sourcemap: true
+        tsconfig: notificationsReportingLambda/tsconfig.json
+        packages: bundle
+        EntryPoints:
+          - notificationsReportingLambda/src/notificationsReportingLambda.ts
+
+  NotificationsReportingResources:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::Serverless::Application
+    Properties:
+      Location: lambda_resources.yaml
+      Parameters:
+        StackName: !Ref StackName
+        LambdaName: !Sub ${StackName}-NotificationsReporting
+        LambdaArn: !Sub arn:aws:lambda:${AWS::Region}:${AWS::AccountId}:function:${StackName}-NotificationsReporting
+        IncludeAdditionalPolicies: true
+        AdditionalPolicies: !Join
+          - ","
+          - - Fn::ImportValue: !Sub ${StackName}:tables:${PrescriptionNotificationStatesTableName}:TableReadPolicyArn
+            - Fn::ImportValue: !Sub ${StackName}:tables:UsePrescriptionNotificationStatesKMSKeyPolicyArn
+        LogRetentionInDays: !Ref LogRetentionInDays
+        CloudWatchKMSKeyId: !ImportValue account-resources:CloudwatchLogsKmsKeyArn
+        EnableSplunk: !Ref EnableSplunk
+        SplunkSubscriptionFilterRole: !ImportValue lambda-resources:SplunkSubscriptionFilterRole
+        SplunkDeliveryStreamArn: !ImportValue lambda-resources:SplunkDeliveryStream
+
   NotifyProcessorScheduleEventRole:
     Type: AWS::IAM::Role
     Properties:
@@ -823,6 +878,20 @@ Outputs:
     Description: The function ARN of the NHSNotifyUpdateCallback lambda
     Value: !GetAtt NHSNotifyUpdateCallback.Arn
 
+  NotificationsReportingFunctionName:
+    Description: The function name of the NotificationsReporting lambda
+    Value: !If
+      - ShouldDeployNotificationsReporting
+      - !Ref NotificationsReporting
+      - ""
+
+  NotificationsReportingFunctionArn:
+    Description: The function ARN of the NotificationsReporting lambda
+    Value: !If
+      - ShouldDeployNotificationsReporting
+      - !GetAtt NotificationsReporting.Arn
+      - ""
+
   # Post-dated lambda outputs
   PostDatedNotifyLambdaFunctionName:
     Description: The function name of the postDatedNotifyLambda

SAMtemplates/main_template.yaml

@@ -71,6 +71,10 @@ Parameters:
   DeployCheckPrescriptionStatusUpdate:
     Type: String
 
+  DeployNotificationsReporting:
+    Type: String
+    Default: false
+
   Environment:
     Type: String
 
@@ -225,9 +229,12 @@ Resources:
         CheckPrescriptionStatusUpdatesFunctionArn: !GetAtt Functions.Outputs.CheckPrescriptionStatusUpdatesFunctionArn
         NHSNotifyUpdateCallbackFunctionName: !GetAtt Functions.Outputs.NHSNotifyUpdateCallbackFunctionName
         NHSNotifyUpdateCallbackFunctionArn: !GetAtt Functions.Outputs.NHSNotifyUpdateCallbackFunctionArn
+        NotificationsReportingFunctionName: !GetAtt Functions.Outputs.NotificationsReportingFunctionName
+        NotificationsReportingFunctionArn: !GetAtt Functions.Outputs.NotificationsReportingFunctionArn
         LogRetentionInDays: !Ref LogRetentionInDays
         EnableSplunk: !Ref EnableSplunk
         DeployCheckPrescriptionStatusUpdate: !Ref DeployCheckPrescriptionStatusUpdate
+        DeployNotificationsReporting: !Ref DeployNotificationsReporting
         ForwardCsocLogs: !Ref ForwardCsocLogs
 
   Functions:
@@ -255,6 +262,7 @@ Resources:
         VersionNumber: !Ref VersionNumber
         CommitId: !Ref CommitId
         DeployCheckPrescriptionStatusUpdate: !Ref DeployCheckPrescriptionStatusUpdate
+        DeployNotificationsReporting: !Ref DeployNotificationsReporting
         Environment: !Ref Environment
         EnableBackup: !Ref EnableBackup
         RequireApplicationName: !Ref RequireApplicationName