New: [AEA-5696] - Add feedback into EPS Assist Me (#40)

## Summary

- Routine Change

### Details

- add feedback
- use layers for python dependencies
- add working cdk-watch makefile target

---------

Co-authored-by: Kris Szlapa <kris.szlapa1@nhs.net>

Author: anthony-nhs

.flake8

@@ -1,5 +1,5 @@
 [flake8]
 max-line-length = 120
 exclude = .*,venv,node_modules,cdk.out
-max-complexity = 10
+max-complexity = 12
 ignore = F821,E203,W503

.github/scripts/fix_cdk_json.sh

@@ -15,8 +15,8 @@ fix_string_key() {
     jq \
         --arg key_value "${KEY_VALUE}" \
         --arg key_name "${KEY_NAME}" \
-        '.context += {($key_name): $key_value}' .build/cdk.json > .build/cdk.new.json
-    mv .build/cdk.new.json .build/cdk.json
+        '. += {($key_name): $key_value}' "$OUTPUT_FILE_NAME" > "${TEMP_FILE}"
+    mv "${TEMP_FILE}" "$OUTPUT_FILE_NAME"
 }
 
 # helper function to set boolean and number values (without quotes)
@@ -31,17 +31,27 @@ fix_boolean_number_key() {
     jq \
         --argjson key_value "${KEY_VALUE}" \
         --arg key_name "${KEY_NAME}" \
-        '.context += {($key_name): $key_value}' .build/cdk.json > .build/cdk.new.json
-    mv .build/cdk.new.json .build/cdk.json
+        '. += {($key_name): $key_value}' "$OUTPUT_FILE_NAME" > "${TEMP_FILE}"
+    mv "${TEMP_FILE}" "$OUTPUT_FILE_NAME"
 }
 
+
+OUTPUT_FILE_NAME=$1
+if [ -z "${OUTPUT_FILE_NAME}" ]; then
+    echo "OUTPUT_FILE_NAME value is unset or set to the empty string"
+    exit 1
+fi
+echo "{}" > "$OUTPUT_FILE_NAME"
+TEMP_FILE=$(mktemp)
+
 CFN_DRIFT_DETECTION_GROUP="epsam"
+IS_PULL_REQUEST="false"
 if [[ "$STACK_NAME" =~ -pr-[0-9]+$ ]]; then
   CFN_DRIFT_DETECTION_GROUP="epsam-pull-request"
+  IS_PULL_REQUEST="true"
 fi
 
 # go through all the key values we need to set
-fix_string_key accountId "${ACCOUNT_ID}"
 fix_string_key stackName "${STACK_NAME}"
 fix_string_key versionNumber "${VERSION_NUMBER}"
 fix_string_key commitId "${COMMIT_ID}"
@@ -50,3 +60,4 @@ fix_string_key logLevel "${LOG_LEVEL}"
 fix_string_key slackBotToken "${SLACK_BOT_TOKEN}"
 fix_string_key slackSigningSecret "${SLACK_SIGNING_SECRET}"
 fix_string_key cfnDriftDetectionGroup "${CFN_DRIFT_DETECTION_GROUP}"
+fix_boolean_number_key isPullRequest "${IS_PULL_REQUEST}"

.github/workflows/cdk_package_code.yml

@@ -63,8 +63,8 @@ jobs:
         run: |
           poetry export --without-hashes --format=requirements.txt --with slackBotFunction > requirements_slackBotFunction
           poetry export --without-hashes --format=requirements.txt --with syncKnowledgeBaseFunction > requirements_syncKnowledgeBaseFunction
-          pip3 install -r requirements_slackBotFunction -t packages/slackBotFunction
-          pip3 install -r requirements_syncKnowledgeBaseFunction -t packages/syncKnowledgeBaseFunction
+          pip3 install -r requirements_slackBotFunction -t .dependencies/slackBotFunction/python
+          pip3 install -r requirements_syncKnowledgeBaseFunction -t .dependencies/syncKnowledgeBaseFunction/python
 
       - name: 'Tar files'
         run: |
@@ -75,7 +75,8 @@ jobs:
             package.json \
             package-lock.json \
             tsconfig.defaults.json \
-            cdk.json
+            cdk.json \
+            .dependencies
 
       - uses: actions/upload-artifact@v4
         name: upload build artifact

.github/workflows/cdk_release_code.yml

@@ -107,7 +107,7 @@ jobs:
 
       - name: fix cdk.json for deployment
         run: |
-          ./.github/scripts/fix_cdk_json.sh
+          ./.github/scripts/fix_cdk_json.sh .build/epsam_app.json
         env:
           ACCOUNT_ID: "${{ env.ACCOUNT_ID }}"
           STACK_NAME: "${{ inputs.STACK_NAME }}"
@@ -128,6 +128,7 @@ jobs:
             -e AWS_REGION="eu-west-2" \
             -e SHOW_DIFF="true" \
             -e DEPLOY_CODE="false" \
+            -e CONFIG_FILE_NAME="epsam_app.json" \
             -e CDK_APP_PATH="packages/cdk/bin/EpsAssistMeApp.ts" \
             cdk-utils-build-repo:latest
 
@@ -142,6 +143,7 @@ jobs:
             -e AWS_REGION="eu-west-2" \
             -e SHOW_DIFF="false" \
             -e DEPLOY_CODE="true" \
+            -e CONFIG_FILE_NAME="epsam_app.json" \
             -e CDK_APP_PATH="packages/cdk/bin/EpsAssistMeApp.ts" \
             cdk-utils-build-repo:latest
         shell: bash

.gitignore

@@ -30,3 +30,7 @@ vendor
 .npmrc
 cdk.out
 .build
+.requirements_slackBotFunction
+.requirements_syncKnowledgeBaseFunction
+.local_config/
+.dependencies/

Makefile

@@ -54,10 +54,13 @@ clean:
 	rm -rf packages/cdk/lib
 	rm -rf packages/slackBotFunction/coverage
 	rm -rf packages/slackBotFunction/.coverage
+	rm -rf packages/slackBotFunction/.dependencies
 	rm -rf packages/syncKnowledgeBaseFunction/coverage
-	rm -rf packages/syncKnowledgeBaseFunction/.coverage
+	rm -rf .dependencies/
 	rm -rf cdk.out
 	rm -rf .build
+	rm -rf .local_config
+	rm -rf cfn_guard_output
 	find . -name '.pytest_cache' -type d -prune -exec rm -rf '{}' +
 
 deep-clean: clean
@@ -98,17 +101,20 @@ cdk-deploy: guard-STACK_NAME
 		--context slackBotToken=$$SLACK_BOT_TOKEN \
 		--context slackSigningSecret=$$SLACK_SIGNING_SECRET
 cdk-synth:
-	npx cdk synth \
+	mkdir -p .dependencies/slackBotFunction
+	mkdir -p .dependencies/syncKnowledgeBaseFunction
+	mkdir -p .local_config
+	STACK_NAME=epsam \
+	COMMIT_ID=undefined \
+	VERSION_NUMBER=undefined \
+	SLACK_BOT_TOKEN=dummy_token \
+	SLACK_SIGNING_SECRET=dummy_secret \
+	LOG_RETENTION_IN_DAYS=30 \
+	LOG_LEVEL=debug \
+		 ./.github/scripts/fix_cdk_json.sh .local_config/epsam.config.json
+	CONFIG_FILE_NAME=.local_config/epsam.config.json npx cdk synth \
 		--quiet \
-		--app "npx ts-node --prefer-ts-exts packages/cdk/bin/EpsAssistMeApp.ts" \
-		--context accountId=123456789012 \
-		--context stackName=epsam \
-		--context versionNumber=undefined \
-		--context commitId=undefined \
-		--context logRetentionInDays=30 \
-		--context slackBotToken=dummy \
-		--context slackSigningSecret=dummy \
-		--context cfnDriftDetectionGroup=dummy
+		--app "npx ts-node --prefer-ts-exts packages/cdk/bin/EpsAssistMeApp.ts"
 
 cdk-diff:
 	npx cdk diff \
@@ -119,23 +125,8 @@ cdk-diff:
 		--context commitId=$$COMMIT_ID \
 		--context logRetentionInDays=$$LOG_RETENTION_IN_DAYS
 
-cdk-watch: guard-STACK_NAME
-	REQUIRE_APPROVAL="$${REQUIRE_APPROVAL:-any-change}" && \
-	VERSION_NUMBER="$${VERSION_NUMBER:-undefined}" && \
-	COMMIT_ID="$${COMMIT_ID:-undefined}" && \
-		npx cdk deploy \
-		--app "npx ts-node --prefer-ts-exts packages/cdk/bin/EpsAssistMeApp.ts" \
-		--watch \
-		--all \
-		--ci true \
-		--require-approval $${REQUIRE_APPROVAL} \
-		--context accountId=$$ACCOUNT_ID \
-		--context stackName=$$STACK_NAME \
-		--context versionNumber=$$VERSION_NUMBER \
-		--context commitId=$$COMMIT_ID \
-		--context logRetentionInDays=$$LOG_RETENTION_IN_DAYS \
-		--context slackBotToken=$$SLACK_BOT_TOKEN \
-		--context slackSigningSecret=$$SLACK_SIGNING_SECRET
+cdk-watch:
+	./scripts/run_sync.sh
 
 sync-docs: 
 	./scripts/sync_docs.sh

cdk.context.json

@@ -0,0 +1,5 @@
+{
+  "acknowledged-issue-numbers": [
+    34892
+  ]
+}

packages/cdk/bin/EpsAssistMeApp.ts

@@ -3,8 +3,18 @@ import {App, Aspects, Tags} from "aws-cdk-lib"
 import {AwsSolutionsChecks} from "cdk-nag"
 import {EpsAssistMeStack} from "../stacks/EpsAssistMeStack"
 import {applyCfnGuardSuppressions} from "./utils/appUtils"
+import fs from "fs"
 
-const app = new App()
+// read the config in
+const configFileName = process.env["CONFIG_FILE_NAME"]
+if (configFileName === undefined) {
+  throw new Error("Can not read config file")
+}
+
+const configDetails = JSON.parse(fs.readFileSync(configFileName, "utf-8"))
+
+// create the app using the config details
+const app = new App({context: configDetails})
 
 /* Required Context:
 - accountId
@@ -13,7 +23,6 @@ const app = new App()
 - commit
 */
 
-const accountId = app.node.tryGetContext("accountId")
 const stackName = app.node.tryGetContext("stackName")
 const version = app.node.tryGetContext("versionNumber")
 const commit = app.node.tryGetContext("commitId")
@@ -22,16 +31,14 @@ const cfnDriftDetectionGroup = app.node.tryGetContext("cfnDriftDetectionGroup")
 Aspects.of(app).add(new AwsSolutionsChecks({verbose: true}))
 
 Tags.of(app).add("cdkApp", "EpsAssistMe")
-Tags.of(app).add("accountId", accountId)
 Tags.of(app).add("stackName", stackName)
 Tags.of(app).add("version", version)
 Tags.of(app).add("commit", commit)
 Tags.of(app).add("cfnDriftDetectionGroup", cfnDriftDetectionGroup)
 
 const EpsAssistMe = new EpsAssistMeStack(app, "EpsAssistMeStack", {
   env: {
-    region: "eu-west-2",
-    account: accountId
+    region: "eu-west-2"
   },
   stackName: stackName,
   version: version,

packages/cdk/constructs/LambdaFunction.ts

@@ -28,6 +28,7 @@ export interface LambdaFunctionProps {
   readonly additionalPolicies?: Array<IManagedPolicy>
   readonly logRetentionInDays: number
   readonly logLevel: string
+  readonly dependencyLocation?: string
 }
 
 // Lambda Insights layer for enhanced monitoring
@@ -115,6 +116,16 @@ export class LambdaFunction extends Construct {
       managedPolicies: requiredPolicies
     })
 
+    const layers = [insightsLambdaLayer]
+    if (props.dependencyLocation) {
+      const dependencyLayer = new LayerVersion(this, "DependencyLayer", {
+        removalPolicy: RemovalPolicy.DESTROY,
+        code: Code.fromAsset(props.dependencyLocation),
+        compatibleArchitectures: [Architecture.X86_64]
+      })
+      layers.push(dependencyLayer)
+    }
+
     // Create Lambda function with Python runtime and monitoring
     const lambdaFunction = new LambdaFunctionResource(this, props.functionName, {
       runtime: Runtime.PYTHON_3_13,
@@ -129,7 +140,7 @@ export class LambdaFunction extends Construct {
         POWERTOOLS_LOG_LEVEL: props.logLevel
       },
       logGroup,
-      layers: [insightsLambdaLayer]
+      layers: layers
     })
 
     // Suppress CFN guard rules for Lambda function

packages/cdk/resources/Functions.ts

@@ -52,6 +52,7 @@ export class Functions extends Construct {
       logRetentionInDays: props.logRetentionInDays,
       logLevel: props.logLevel,
       additionalPolicies: [props.slackBotManagedPolicy],
+      dependencyLocation: ".dependencies/slackBotFunction",
       environmentVariables: {
         "RAG_MODEL_ID": RAG_MODEL_ID,
         "QUERY_REFORMULATION_MODEL_ID": QUERY_REFORMULATION_MODEL_ID,
@@ -80,6 +81,7 @@ export class Functions extends Construct {
       handler: "app.handler.handler",
       logRetentionInDays: props.logRetentionInDays,
       logLevel: props.logLevel,
+      dependencyLocation: ".dependencies/syncKnowledgeBaseFunction",
       environmentVariables: {
         "KNOWLEDGEBASE_ID": props.knowledgeBaseId,
         "DATA_SOURCE_ID": props.dataSourceId