Update: [AEA-4176] - add check prescription status endpoint to PTL environment

.github/scripts/deploy_api.sh

@@ -10,6 +10,7 @@ echo "AWS environment: ${AWS_ENVIRONMENT}"
 echo "Apigee environment: ${APIGEE_ENVIRONMENT}"
 echo "Proxygen private key name: ${PROXYGEN_PRIVATE_KEY_NAME}"
 echo "Proxygen KID: ${PROXYGEN_KID}"
+echo "Deploy Check Prescription Status Update: ${DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE}"
 echo "Dry run: ${DRY_RUN}"
 
 is_pull_request=false
@@ -71,6 +72,14 @@ else
         jq '.components.securitySchemes."app-level0" = {"$ref": "https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/app-level0"}' "${SPEC_PATH}" > temp.json && mv temp.json "${SPEC_PATH}"
     fi
 fi
+# remove checkprescriptionstatusupdates if its not needed
+if [[ "${DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE}" == "false" ]]; then
+    if [[ "${API_TYPE}" == "standard" ]]; then
+        echo "Removing checkprescriptionstatusupdates endpoint"
+        jq 'del(.paths."/checkprescriptionstatusupdates")' "$SPEC_PATH" > temp.json && mv temp.json "$SPEC_PATH"
+    fi
+fi
+
 
 echo
 

.github/workflows/ci.yml

@@ -111,6 +111,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
       DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
@@ -135,6 +136,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -155,5 +157,6 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.QA_CLOUD_FORMATION_DEPLOY_ROLE }}

.github/workflows/pull_request.yml

@@ -74,6 +74,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -94,5 +95,6 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}

.github/workflows/release.yml

@@ -130,6 +130,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
       DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
@@ -154,6 +155,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -182,6 +184,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: true
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.REF_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -210,6 +213,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.QA_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -233,6 +237,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.INT_CLOUD_FORMATION_DEPLOY_ROLE }}
       DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}
@@ -257,6 +262,7 @@ jobs:
       DEPLOY_APIGEE: true
       DYNAMODB_AUTOSCALE: false
       DEPLOY_APIGEE_CPSU: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.INT_CLOUD_FORMATION_DEPLOY_ROLE }}
 
@@ -287,6 +293,7 @@ jobs:
       DEPLOY_APIGEE: false
       DYNAMODB_AUTOSCALE: true
       DEPLOY_APIGEE_CPSU: false
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: false
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.PROD_CLOUD_FORMATION_DEPLOY_ROLE }}
       DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_CHECK_VERSION_ROLE }}

.github/workflows/run_release_code_and_api.yml

@@ -58,6 +58,9 @@ on:
       DEPLOY_APIGEE_CPSU:
         type: boolean
         default: true
+      DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE:
+        type: boolean
+        default: false
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE:
         required: true
@@ -174,6 +177,7 @@ jobs:
           TRUSTSTORE_FILE: ${{ inputs.TRUSTSTORE_FILE }}
           VERSION_NUMBER: ${{ inputs.VERSION_NUMBER }}
           DYNAMODB_AUTOSCALE: ${{ inputs.DYNAMODB_AUTOSCALE }}
+          DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: ${{ inputs.DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE }}
         run: ./release_code.sh
 
       - name: Deploy PSU API
@@ -191,6 +195,7 @@ jobs:
           PROXYGEN_PRIVATE_KEY_NAME: PSUProxygenPrivateKey
           PROXYGEN_KID: "eps-cli-key-1"
           DRY_RUN: false
+          DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: ${{ inputs.DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE }}
         run: poetry run ./deploy_api.sh
 
       - name: Deploy CPSU API
@@ -208,6 +213,7 @@ jobs:
           PROXYGEN_PRIVATE_KEY_NAME: CPSUProxygenPrivateKey
           PROXYGEN_KID: eps-cli-key-cpsu-1
           DRY_RUN: false
+          DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE: ${{ inputs.DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE }}
         run: poetry run ./deploy_api.sh
 
       - name: create_int_release_notes

.pre-commit-config.yaml

@@ -77,6 +77,16 @@ repos:
         types_or: [ts, tsx, javascript, jsx, json]
         pass_filenames: false
 
+      - id: lint-checkPrescriptionStatusUpdates
+        name: Lint checkPrescriptionStatusUpdates
+        entry: npm
+        args:
+          ["run", "--prefix=packages/checkPrescriptionStatusUpdates", "lint"]
+        language: system
+        files: ^packages\/checkPrescriptionStatusUpdates
+        types_or: [ts, tsx, javascript, jsx, json]
+        pass_filenames: false
+
       - id: lint-commonTesting
         name: Lint common/testing
         entry: npm

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

@@ -32,6 +32,10 @@
       "name": "packages/capabilityStatement",
       "path": "../packages/capabilityStatement"
     },
+    {
+      "name": "packages/checkPrescriptionStatusUpdates",
+      "path": "../packages/checkPrescriptionStatusUpdates"
+    },
     {
       "name": "packages/common/testing",
       "path": "../packages/common/testing"

Makefile

@@ -89,7 +89,8 @@ sam-deploy-package: guard-artifact_bucket guard-artifact_bucket_prefix guard-sta
 			  CommitId=$$COMMIT_ID \
 			  LogLevel=$$LOG_LEVEL \
 			  LogRetentionInDays=$$LOG_RETENTION_DAYS \
-			  Env=$$TARGET_ENVIRONMENT
+			  Env=$$TARGET_ENVIRONMENT \
+			  DeployCheckPrescriptionStatusUpdate=$$DEPLOY_CHECK_PRESCRIPTION_STATUS_UPDATE 
 
 compile-node:
 	npx tsc --build tsconfig.build.json
@@ -107,6 +108,7 @@ lint-node: compile-node
 	npm run lint --workspace packages/statusLambda
 	npm run lint --workspace packages/capabilityStatement
 	npm run lint --workspace packages/cpsuLambda
+	npm run lint --workspace packages/checkPrescriptionStatusUpdates
 	npm run lint --workspace packages/common/testing
 	npm run lint --workspace packages/common/middyErrorHandler
 
@@ -134,6 +136,7 @@ test: compile
 	npm run test --workspace packages/statusLambda
 	npm run test --workspace packages/capabilityStatement
 	npm run test --workspace packages/cpsuLambda
+	npm run test --workspace packages/checkPrescriptionStatusUpdates
 	npm run test --workspace packages/common/middyErrorHandler
 
 clean:
@@ -149,6 +152,7 @@ clean:
 	rm -rf packages/capabilityStatement/lib
 	rm -rf packages/cpsuLambda/coverage
 	rm -rf packages/cpsuLambda/lib
+	rm -rf packages/checkPrescriptionStatusUpdates/lib
 	rm -rf packages/common/testing/lib
 	rm -rf packages/common/middyErrorHandler/lib
 	rm -rf .aws-sam

SAMtemplates/apis/main.yaml

@@ -46,16 +46,30 @@ Parameters:
     Type: String
     Default: none
 
+  CheckPrescriptionStatusUpdatesFunctionName:
+    Type: String
+    Default: none
+
+  CheckPrescriptionStatusUpdatesFunctionArn:
+    Type: String
+    Default: none
+
   LogRetentionInDays:
     Type: Number
 
   EnableSplunk:
     Type: String
 
+  DeployCheckPrescriptionStatusUpdate:
+    Type: String
+
 Conditions:
   ShouldUseMutualTLS: !Equals
     - true
     - !Ref EnableMutualTLS
+  ShouldDeployCheckPrescriptionStatusUpdate: !Equals
+    - true
+    - !Ref DeployCheckPrescriptionStatusUpdate
 
 Resources:
   GenerateCertificate:
@@ -453,18 +467,64 @@ Resources:
         IntegrationHttpMethod: POST
         Uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${CapabilityStatementFunctionArn}/invocations
 
+  CheckPrescriptionStatusUpdatesResource:
+    Condition: ShouldDeployCheckPrescriptionStatusUpdate
+    Type: AWS::ApiGateway::Resource
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ParentId: !GetAtt RestApiGateway.RootResourceId
+      PathPart: checkprescriptionstatusupdates
+
+  CheckPrescriptionStatusUpdatesMethod:
+    Condition: ShouldDeployCheckPrescriptionStatusUpdate
+    Type: AWS::ApiGateway::Method
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ResourceId: !Ref CheckPrescriptionStatusUpdatesResource
+      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/${CheckPrescriptionStatusUpdatesFunctionArn}/invocations
+
+  # we can not use a conditional in depends on in ApiGateway::Deployment
+  # so instead we use a wait condition that has the conditional in it and use that as a dependency
+  # taken from https://garbe.io/blog/2017/07/17/cloudformation-hacks/
+  CheckPrescriptionStatusUpdatesHandle:
+    Condition: ShouldDeployCheckPrescriptionStatusUpdate
+    DependsOn: CheckPrescriptionStatusUpdatesMethod
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  CheckPrescriptionStatusUpdatesWaitHandle:
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  CheckPrescriptionStatusUpdatesWaitCondition:
+    Type: "AWS::CloudFormation::WaitCondition"
+    Properties:
+      Handle:
+        !If [
+          ShouldDeployCheckPrescriptionStatusUpdate,
+          !Ref CheckPrescriptionStatusUpdatesHandle,
+          !Ref CheckPrescriptionStatusUpdatesWaitHandle,
+        ]
+      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
   # *********************************************************************
-  RestApiGatewayDeploymentV1d:
+  RestApiGatewayDeploymentV1e:
     Type: AWS::ApiGateway::Deployment
     DependsOn:
       # see note above if you add something in here when you add a new endpoint
       - UpdatePrescriptionStatusMethod
       - StatusLambdaMethod
       - CapabilityStatementMethod
       - Format1UpdatePrescriptionStatusMethod
+      - CheckPrescriptionStatusUpdatesWaitCondition
       # see note above if you add something in here when you add a new endpoint
     Properties:
       RestApiId: !Ref RestApiGateway
@@ -473,7 +533,7 @@ Resources:
     Type: AWS::ApiGateway::Stage
     Properties:
       RestApiId: !Ref RestApiGateway
-      DeploymentId: !Ref RestApiGatewayDeploymentV1d
+      DeploymentId: !Ref RestApiGatewayDeploymentV1e
       StageName: prod
       TracingEnabled: true
       AccessLogSetting:
@@ -498,6 +558,11 @@ Resources:
             - Fn::ImportValue: !Sub ${StackName}:functions:${StatusFunctionName}:ExecuteLambdaPolicyArn
             - Fn::ImportValue: !Sub ${StackName}:functions:${CapabilityStatementFunctionName}:ExecuteLambdaPolicyArn
             - Fn::ImportValue: !Sub ${StackName}:state-machines:${Format1UpdatePrescriptionsStatusStateMachineName}:ExecuteStateMachinePolicy
+            - !If
+              - ShouldDeployCheckPrescriptionStatusUpdate
+              - Fn::ImportValue: !Sub ${StackName}:functions:${CheckPrescriptionStatusUpdatesFunctionName}:ExecuteLambdaPolicyArn
+              - !Ref AWS::NoValue
+
         ApiName: !Sub ${StackName}-apigw
         LogRetentionInDays: !Ref LogRetentionInDays
         EnableSplunk: !Ref EnableSplunk