♻️ Rename AWS_SQS_QUEUE_NAME_BUILDER to BUILDER_QUEUE_NAME (#559)

fastapi · Dec 18, 2024 · 9cbdc6b · 9cbdc6b
1 parent 9e8cb20
commit 9cbdc6b
Show file tree

Hide file tree

Showing 13 changed files with 22 additions and 23 deletions.
diff --git a/.env b/.env
@@ -52,7 +52,7 @@ MESSENGER_SENTRY_DSN=https://01d9690bab0a81b2cb08d503d4cfb3b1@o4506985151856640.
 
 # AWS
 DEPLOYMENTS_BUCKET_NAME=fastapicloud-deployments-local
-AWS_SQS_BUILDER_QUEUE_NAME=fastapicloud-builder-local
+BUILDER_QUEUE_NAME=fastapicloud-builder-local
 ECR_REGISTRY_URL=992382821657.dkr.ecr.us-east-1.amazonaws.com
 AWS_REGION=us-east-1
 # LocalStack

diff --git a/.github/workflows/deploy-backend.yml b/.github/workflows/deploy-backend.yml
@@ -121,7 +121,7 @@ jobs:
         DOCKER_IMAGE_FRONTEND: "${{ vars.DOCKER_IMAGE_FRONTEND }}"
         DEPLOYMENTS_BUCKET_NAME: "${{ vars.DEPLOYMENTS_BUCKET_NAME }}"
         ECR_REGISTRY_URL: "${{ vars.ECR_REGISTRY_URL }}"
-        AWS_SQS_BUILDER_QUEUE_NAME: "${{ vars.AWS_SQS_BUILDER_QUEUE_NAME }}"
+        BUILDER_QUEUE_NAME: "${{ vars.BUILDER_QUEUE_NAME }}"
         BUILDER_API_URL: "${{ vars.BUILDER_API_URL }}"
         SECRET_KEY: "${{ secrets.SECRET_KEY }}"
         FIRST_SUPERUSER_PASSWORD: "${{ secrets.FIRST_SUPERUSER_PASSWORD }}"
@@ -164,7 +164,7 @@ jobs:
         DOCKER_IMAGE_FRONTEND: "${{ vars.DOCKER_IMAGE_FRONTEND }}"
         DEPLOYMENTS_BUCKET_NAME: "${{ vars.DEPLOYMENTS_BUCKET_NAME }}"
         ECR_REGISTRY_URL: "${{ vars.ECR_REGISTRY_URL }}"
-        AWS_SQS_BUILDER_QUEUE_NAME: "${{ vars.AWS_SQS_BUILDER_QUEUE_NAME }}"
+        BUILDER_QUEUE_NAME: "${{ vars.BUILDER_QUEUE_NAME }}"
         DEPOT_PROJECT_ID: "${{ vars.DEPOT_PROJECT_ID }}"
         BUILDER_API_URL: "${{ vars.BUILDER_API_URL }}"
         SECRET_KEY: "${{ secrets.SECRET_KEY }}"

diff --git a/.github/workflows/deploy-messenger.yml b/.github/workflows/deploy-messenger.yml
@@ -92,6 +92,7 @@ jobs:
         AWS_REGION: "${{ vars.AWS_REGION }}"
         DEPLOYMENTS_BUCKET_NAME: "${{ vars.DEPLOYMENTS_BUCKET_NAME }}"
         AWS_SQS_BUILDER_QUEUE_NAME: "${{ vars.AWS_SQS_BUILDER_QUEUE_NAME }}"
+        BUILDER_QUEUE_NAME: "${{ vars.BUILDER_QUEUE_NAME }}"
         BUILDER_API_KEY: "${{ secrets.BUILDER_API_KEY }}"
         BUILDER_API_URL: "${{ vars.BUILDER_API_URL }}"
         MESSENGER_SENTRY_DSN: "${{ secrets.MESSENGER_SENTRY_DSN }}"

diff --git a/backend/app/api/routes/deployments.py b/backend/app/api/routes/deployments.py
@@ -253,7 +253,7 @@ def upload_complete(
     session.commit()
 
     queue_url = sqs.get_queue_url(
-        QueueName=CommonSettings.get_settings().AWS_SQS_BUILDER_QUEUE_NAME
+        QueueName=CommonSettings.get_settings().BUILDER_QUEUE_NAME
     )["QueueUrl"]
     sqs.send_message(QueueUrl=queue_url, MessageBody=str(deployment_id))
 

diff --git a/backend/app/core/config.py b/backend/app/core/config.py
@@ -80,7 +80,7 @@ class CommonSettings(SettingsEnv):
     LOGFIRE_TOKEN: str | None = None
     LOCALSTACK_HOST_NAME: str | None = None
     ENABLE_LOCALSTACK: bool = False
-    AWS_SQS_BUILDER_QUEUE_NAME: str = "fastapicloud-builder"
+    BUILDER_QUEUE_NAME: str = "fastapicloud-builder"
     AWS_REGION: str = "us-east-1"
     BUILDER_API_URL: str
 

diff --git a/backend/app/messenger.py b/backend/app/messenger.py
@@ -47,19 +47,17 @@ async def process_message(
         response.raise_for_status()
         with logfire.span("Delete message"):
             await asyncify(sqs.delete_message)(
-                QueueUrl=common_settings.AWS_SQS_BUILDER_QUEUE_NAME,
+                QueueUrl=common_settings.BUILDER_QUEUE_NAME,
                 ReceiptHandle=receipt_handle,
             )
 
 
 async def main() -> None:
     # Run in asyncify to not block the event loop, in case we call this function
     # concurrently later
-    with logfire.span(
-        "Process queue: {name}", name=common_settings.AWS_SQS_BUILDER_QUEUE_NAME
-    ):
+    with logfire.span("Process queue: {name}", name=common_settings.BUILDER_QUEUE_NAME):
         queue_url_response = await asyncify(sqs.get_queue_url)(
-            QueueName=common_settings.AWS_SQS_BUILDER_QUEUE_NAME
+            QueueName=common_settings.BUILDER_QUEUE_NAME
         )
         queue_url = queue_url_response.get("QueueUrl")
         assert queue_url

diff --git a/compose.yml b/compose.yml
@@ -260,7 +260,7 @@ services:
     command: >
       bash -c "
       aws --endpoint-url=http://localstack:4566 s3api create-bucket --bucket "${DEPLOYMENTS_BUCKET_NAME}" --region us-east-1
-      && aws --endpoint-url=http://localstack:4566 sqs create-queue --queue-name "${AWS_SQS_BUILDER_QUEUE_NAME}" --attributes VisibilityTimeout=600
+      && aws --endpoint-url=http://localstack:4566 sqs create-queue --queue-name "${BUILDER_QUEUE_NAME}" --attributes VisibilityTimeout=600
       "
 
 volumes:

diff --git a/infra/__main__.py b/infra/__main__.py
@@ -320,4 +320,4 @@
 pulumi.export("aws_lb_controller_role_arn", aws_lb_controller_role.arn)
 pulumi.export("fastapicloud_iam_role_arn", fastapicloud_iam_role.arn)
 pulumi.export("ecr_iam_role_arn", ecr_iam_role.arn)
-pulumi.export("sqs_builder_queue_name", sqs.sqs_builder_queue.name)
+pulumi.export("builder_queue_name", sqs.builder_queue.name)
diff --git a/infra/env-vars-01.sh b/infra/env-vars-01.sh
@@ -40,8 +40,8 @@ REDIS_SERVER="$(pulumi stack output redis_backend --stack fastapilabs/$ENVIRONME
 export REDIS_SERVER
 echo "export REDIS_SERVER='${REDIS_SERVER}'"
 
-AWS_SQS_BUILDER_QUEUE_NAME="$(pulumi stack output sqs_builder_queue_name --stack fastapilabs/$ENVIRONMENT)"
-export AWS_SQS_BUILDER_QUEUE_NAME
-echo "export AWS_SQS_BUILDER_QUEUE_NAME='${AWS_SQS_BUILDER_QUEUE_NAME}'"
+BUILDER_QUEUE_NAME="$(pulumi stack output builder_queue_name --stack fastapilabs/$ENVIRONMENT)"
+export BUILDER_QUEUE_NAME
+echo "export BUILDER_QUEUE_NAME='${BUILDER_QUEUE_NAME}'"
 
 echo '# Once this works, run it with: eval $(bash env-vars-01.sh)'
diff --git a/infra/k8s/messenger/messenger.yaml b/infra/k8s/messenger/messenger.yaml
@@ -35,8 +35,8 @@ spec:
             value: "${AWS_REGION}"
           - name: DEPLOYMENTS_BUCKET_NAME
             value: "${DEPLOYMENTS_BUCKET_NAME}"
-          - name: AWS_SQS_BUILDER_QUEUE_NAME
-            value: "${AWS_SQS_BUILDER_QUEUE_NAME}"
+          - name: BUILDER_QUEUE_NAME
+            value: "${BUILDER_QUEUE_NAME}"
           - name: BUILDER_API_KEY
             value: "${BUILDER_API_KEY}"
           - name: BUILDER_API_URL

diff --git a/infra/pulumi_deployment_workflow/iam.py b/infra/pulumi_deployment_workflow/iam.py
@@ -73,7 +73,7 @@
                         "sqs:StartMessageMoveTask",
                         "sqs:SetQueueAttributes",
                     ],
-                    "Resource": sqs.sqs_builder_queue.arn,
+                    "Resource": sqs.builder_queue.arn,
                 },
             ],
         }

diff --git a/infra/pulumi_deployment_workflow/sqs.py b/infra/pulumi_deployment_workflow/sqs.py
@@ -3,7 +3,7 @@
 
 
 # Reference: https://www.pulumi.com/registry/packages/aws/api-docs/sqs/queue/
-sqs_builder_queue = aws.sqs.Queue(
+builder_queue = aws.sqs.Queue(
     f"fastapicloud-builder-queue-{stack_name}",
     name=f"fastapicloud-builder-queue-{stack_name}",
     visibility_timeout_seconds=600,

diff --git a/infra/set_vars.py b/infra/set_vars.py
@@ -34,7 +34,7 @@ class GitHubSettings(BaseSettings):
     deployments_bucket_name: str
     ecr_registry_url: str
     redis_server: str
-    aws_sqs_builder_queue_name: str
+    builder_queue_name: str
 
 
 def main():
@@ -61,10 +61,10 @@ def main():
     logging.info("Updating REDIS_SERVER")
     environment.delete_variable("REDIS_SERVER")
     environment.create_variable("REDIS_SERVER", github_settings.redis_server)
-    logging.info("Updating AWS_SQS_BUILDER_QUEUE_NAME")
-    environment.delete_variable("AWS_SQS_BUILDER_QUEUE_NAME")
+    logging.info("Updating BUILDER_QUEUE_NAME")
+    environment.delete_variable("BUILDER_QUEUE_NAME")
     environment.create_variable(
-        "AWS_SQS_BUILDER_QUEUE_NAME", github_settings.aws_sqs_builder_queue_name
+        "BUILDER_QUEUE_NAME", github_settings.builder_queue_name
     )
 
     cloudflare = Cloudflare(