Fix: Make DynamoDb tables with prefix work with the GS DB Abstraction [GS-102]

Author: Carlos J. Ramirez

.chalice/config-example.json

@@ -20,7 +20,8 @@
     "FLASK_APP": "FLASK_APP_placeholder",
     "APP_HOST_NAME": "APP_HOST_NAME_placeholder",
     "CLOUD_PROVIDER": "CLOUD_PROVIDER_placeholder",
-    "AWS_REGION": "AWS_REGION_placeholder"
+    "AWS_REGION": "AWS_REGION_placeholder",
+    "DYNAMDB_PREFIX": "DYNAMDB_PREFIX_placeholder"
   },
   "stages": {
     "dev": {

CHANGELOG.md

@@ -17,7 +17,18 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a Ch
 ### Breaks
 
 
-## 1.0.11 (2024-07-27)
+## Unreleased
+## 1.0.12 (2024-08-04)
+---
+
+### New
+Add: ".nvmrc" file to set the repo default node version.
+
+### Fixes
+Make DynamoDb tables with prefix work with the GS DB Abstraction [GS-102]
+
+
+## 1.0.11 (2024-07-19)
 ---
 
 ### New
@@ -37,7 +48,6 @@ Add: Secret and KMS access policies to the "template-sam.yml" file [GS-41].
 Add: "scripts/aws_cf_processor/test_localstack.sh" to test localstack EC2 functionality with the LOCALSTACK_AUTH_TOKEN envvar [GS-97].
 Add LOCAL_DNS_DISABLED and BRIDGE_PROXY_DISABLED envvars to disable local services working on the road.
 Add NGROK_ENABLED envvar to enable/disable Ngrok service in the URL_MASK_EXTERNAL_HOSTNAME and DEV_MASK_EXT_HOSTNAME assignments on "scripts/get_domain_name_dev.sh".
-Add: ".nvmrc" file to set the repo default node version.
 
 ### Changes
 Change APP_STAGE dynamic assignment in run_aws.sh, set_chalice_cnf.sh, and big_lambdas_manager.sh, and secure_local_server/docker_entrypoint.sh [GS-41].

scripts/aws/run_aws.sh

@@ -188,6 +188,7 @@ if [[ "$1" = "run_local" || "$1" = "" ]]; then
     # To avoid message from langsmith:
     # USER_AGENT environment variable not set, consider setting it to identify your requests.
     export USER_AGENT="${APP_NAME_LOWERCASE}-${STAGE}"
+    export DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
     echo ""
     echo "APP_STAGE: ${APP_STAGE}"
     echo "USER_AGENT: ${USER_AGENT}"

scripts/aws/set_chalice_cnf.sh

@@ -130,6 +130,7 @@ APP_DB_URI_QA=${APP_DB_URI_QA//@/\\@}
 APP_DB_URI_STAGING=${APP_DB_URI_STAGING//@/\\@}
 APP_DB_URI_PROD=${APP_DB_URI_PROD//@/\\@}
 APP_DB_URI_DEMO=${APP_DB_URI_DEMO//@/\\@}
+DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
 
 if [ "${APP_CORS_ORIGIN_DEV}" = "" ]; then
     APP_CORS_ORIGIN_DEV="*"
@@ -223,6 +224,7 @@ perl -i -pe"s|AWS_S3_CHATBOT_ATTACHMENTS_BUCKET_PROD_placeholder|${AWS_S3_CHATBO
 perl -i -pe"s|APP_HOST_NAME_placeholder|${APP_HOST_NAME}|g" "${CONFIG_FILE}"
 perl -i -pe"s|CLOUD_PROVIDER_placeholder|${CLOUD_PROVIDER}|g" "${CONFIG_FILE}"
 perl -i -pe"s|AWS_REGION_placeholder|${AWS_REGION}|g" "${CONFIG_FILE}"
+perl -i -pe"s|DYNAMDB_PREFIX_placeholder|${DYNAMDB_PREFIX}|g" "${CONFIG_FILE}"
 
 if [ -f "${REPO_BASEDIR}/scripts/aws/update_additional_envvars.sh" ]; then
     . "${REPO_BASEDIR}/scripts/aws/update_additional_envvars.sh" "${CONFIG_FILE}" "${REPO_BASEDIR}"

scripts/aws_big_lambda/big_lambdas_manager.sh

@@ -327,6 +327,7 @@ export GIT_SUBMODULE_LOCAL_PATH="${GIT_SUBMODULE_LOCAL_PATH}"
 export OPENAI_MODEL="${OPENAI_MODEL}"
 export OPENAI_TEMPERATURE="${OPENAI_TEMPERATURE}"
 export USER_AGENT="${APP_NAME_LOWERCASE}-${STAGE}"
+export DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
 export LANGCHAIN_PROJECT="${LANGCHAIN_PROJECT}"
 export HUGGINGFACE_ENDPOINT_URL="${HUGGINGFACE_ENDPOINT_URL}"
 export SMTP_SERVER="${SMTP_SERVER}"

scripts/aws_dynamodb/generate_dynamodb_cf/generate_dynamodb_cf.py

@@ -177,11 +177,20 @@ def get_dynamodb_definition(config: dict, table_prefix: str) -> dict:
     write_capacity_units = config.get('WriteCapacityUnits', "1")
 
     dynamodb_output = {
-        table_name: {
-            "Descriptzion": f"Name for the {table_name} DynamoDB table",
+        # This gives the error "Template format error:
+        #   Outputs name 'xxx_xxxx_xxx' is non alphanumeric."
+        # table_name: {
+        definition_name: {
+            # "Description": f"Name for the {table_name} DynamoDB table",
+            "Description": table_name,
             "Value": SubRep(dynamodb_table_name),
             "Export": {
-                "Name": SubRep(f"{dynamodb_table_name}-TableName")
+                # This gives the error "Template format error:
+                #   Output XxxxxTable is malformed. The Name field of every
+                #   Export member must be specified and consist only of
+                #   alphanumeric characters, colons, or hyphens."
+                # "Name": SubRep(f"{dynamodb_table_name}-TableName")
+                "Name": SubRep(f"{definition_name}Name")
             }
         }
     }

scripts/aws_ec2_elb/run-fastapi-ecr-creation.sh

@@ -181,6 +181,7 @@ OPENAI_MODEL="${OPENAI_MODEL}"
 OPENAI_TEMPERATURE="${OPENAI_TEMPERATURE}"
 LANGCHAIN_PROJECT="${LANGCHAIN_PROJECT}"
 USER_AGENT="${APP_NAME_LOWERCASE}-${STAGE}"
+DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
 HUGGINGFACE_ENDPOINT_URL="${HUGGINGFACE_ENDPOINT_URL}"
 SMTP_SERVER="${SMTP_SERVER}"
 SMTP_PORT="${SMTP_PORT}"

scripts/aws_secrets/aws_secrets_manager.sh

@@ -144,7 +144,7 @@ get_secret_var_list() {
 
     # Environment variables (will be plain, unencrypted)
     # Core
-    export CORE_ENVS="APP_NAME APP_VERSION FLASK_APP APP_DEBUG APP_STAGE APP_CORS_ORIGIN APP_DB_ENGINE APP_DB_NAME CURRENT_FRAMEWORK DEFAULT_LANG GIT_SUBMODULE_URL GIT_SUBMODULE_LOCAL_PATH SMTP_SERVER SMTP_PORT SMTP_DEFAULT_SENDER APP_HOST_NAME CLOUD_PROVIDER AWS_REGION"
+    export CORE_ENVS="APP_NAME APP_VERSION FLASK_APP APP_DEBUG APP_STAGE APP_CORS_ORIGIN APP_DB_ENGINE APP_DB_NAME CURRENT_FRAMEWORK DEFAULT_LANG GIT_SUBMODULE_URL GIT_SUBMODULE_LOCAL_PATH SMTP_SERVER SMTP_PORT SMTP_DEFAULT_SENDER APP_HOST_NAME CLOUD_PROVIDER AWS_REGION DYNAMDB_PREFIX"
     # AI
     export EXTENSION_ENVS="AI_ASSISTANT_NAME AWS_S3_CHATBOT_ATTACHMENTS_BUCKET OPENAI_MODEL OPENAI_TEMPERATURE LANGCHAIN_PROJECT USER_AGENT HUGGINGFACE_ENDPOINT_URL"
     # App specific
@@ -213,6 +213,7 @@ prepare_envars() {
     export APP_VERSION=$(cat ${REPO_BASEDIR}/version.txt)
     export APP_STAGE="${STAGE}"
     export USER_AGENT="${APP_NAME_LOWERCASE}-${STAGE}"
+    export DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
 
     # Build the App backend host name
     if [ "${AWS_DEPLOYMENT_TYPE}" = "lambda" ]; then

scripts/secure_local_server/docker_entrypoint.sh

@@ -71,6 +71,7 @@ export APP_HOST_NAME="${DOMAIN_NAME}"
 export APP_VERSION=$(cat version.txt)
 export APP_DB_ENGINE=$(eval echo \$APP_DB_ENGINE_${STAGE_UPPERCASE})
 export APP_DB_NAME=$(eval echo \$APP_DB_NAME_${STAGE_UPPERCASE})
+export DYNAMDB_PREFIX="${APP_NAME_LOWERCASE}_${STAGE}_"
 # export APP_DB_URI=$(eval echo \$APP_DB_URI_${STAGE_UPPERCASE})
 export APP_CORS_ORIGIN="$(eval echo \"\$APP_CORS_ORIGIN_${STAGE_UPPERCASE}\")"
 export AWS_S3_CHATBOT_ATTACHMENTS_BUCKET=$(eval echo \$AWS_S3_CHATBOT_ATTACHMENTS_BUCKET_${STAGE_UPPERCASE})