app-sf-46: Add email infrastructure

.env

@@ -52,8 +52,8 @@ OPENAI_API_KEY=!ChangeMe!
 ###> symfony/messenger ###
 # Choose one of the transports below
 # MESSENGER_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/messages
-# MESSENGER_TRANSPORT_DSN=redis://localhost:6379/messages
-MESSENGER_TRANSPORT_DSN=doctrine://default?auto_setup=0
+MESSENGER_TRANSPORT_DSN=redis://redis.app-sf.orb.local:6379/messages
+#MESSENGER_TRANSPORT_DSN=doctrine://default?auto_setup=0
 ###< symfony/messenger ###
 
 # SQL Runner
@@ -62,3 +62,11 @@ SQLRUNNER_URL=http://sqlrunner.app-sf.orb.local:8080
 ###> symfony/line-notify-notifier ###
 # LINE_NOTIFY_DSN=linenotify://TOKEN@default
 ###< symfony/line-notify-notifier ###
+
+###> symfony/amazon-mailer ###
+# MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+# MAILER_DSN=ses+smtp://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+###< symfony/amazon-mailer ###
+
+# Email
+[email protected]

.github/workflows/docker.yaml

@@ -1,10 +1,10 @@
-name: Create and Publish app-sf image
+name: Create and Publish app-sf and worker image
 
 on:
   push:
     branches:
-      - master
-      - distro/*
+      - "*"
+      - "*/*"
     tags:
       - v*
   workflow_dispatch:
@@ -17,12 +17,64 @@ permissions:
 
 env:
   REGISTRY: ghcr.io
-  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
-  docker-image:
+  docker-app-sf:
     runs-on: ubuntu-latest
 
+    env:
+      # app-sf
+      IMAGE_NAME: ${{ github.repository }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@master
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@master
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build Docker image
+        uses: docker/build-push-action@master
+        with:
+          context: .
+          push: false
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Conditional push for main branch
+        if: startsWith(github.ref, 'refs/heads/master') || startsWith(github.ref, 'refs/heads/distro/') || startsWith(github.ref, 'refs/tags/v')
+        uses: docker/build-push-action@master
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        if: startsWith(github.ref, 'refs/heads/master') || startsWith(github.ref, 'refs/heads/distro/') || startsWith(github.ref, 'refs/tags/v')
+        uses: actions/attest-build-provenance@main
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true
+
+  docker-app-sf-worker:
+    runs-on: ubuntu-latest
+
+    env:
+      # app-sf-worker
+      IMAGE_NAME: ${{ github.repository }}-worker
+
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -40,18 +92,29 @@ jobs:
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
-      - name: Build and push Docker image
-        id: push
+      - name: Build Docker image
+        uses: docker/build-push-action@master
+        with:
+          file: worker.Dockerfile
+          context: .
+          push: false
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Conditional push for main branch
+        if: startsWith(github.ref, 'refs/heads/master') || startsWith(github.ref, 'refs/heads/distro/') || startsWith(github.ref, 'refs/tags/v')
         uses: docker/build-push-action@master
         with:
+          file: worker.Dockerfile
           context: .
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
 
       - name: Generate artifact attestation
+        if: startsWith(github.ref, 'refs/heads/master') || startsWith(github.ref, 'refs/heads/distro/') || startsWith(github.ref, 'refs/tags/v')
         uses: actions/attest-build-provenance@main
         with:
-          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
           subject-digest: ${{ steps.push.outputs.digest }}
           push-to-registry: true

.gitignore

@@ -35,4 +35,5 @@ phpstan.neon
 ###< phpstan/phpstan ###
 
 # node_modules
-node_modules/
+node_modules/
+.pnpm-store/

README.md

@@ -42,8 +42,11 @@ The Database Playground is a platform designed to enhance your SQL skills throug
 1. Deploy Redis, PostgreSQL, Meilisearch, and Umami (for statistics) on Zeabur.
 2. Deploy [SQL runner](https://github.com/database-playground/sqlrunner-v2) on Zeabur, and rename the service host to
    `sqlrunner`.
-3. Deploy the application in Git mode on Zeabur.
-4. Add the following environment variables to the application:
+3. Deploy the application in Git mode on Zeabur. You can use our prebuilt image at
+   the GitHub Registry.
+4. Deploy the worker in Git mode on Zeabur. You can use our prebuilt image at
+   the GitHub Registry. Also, it is recommended to create more than 1 worker.
+5. Add the following environment variables to the application:
    ```env
    DATABASE_URL=postgresql://${POSTGRES_USERNAME}:${POSTGRES_PASSWORD}@postgresql.zeabur.internal:5432/${POSTGRES_DATABASE}?serverVersion=16&charset=utf8
    REDIS_URI=${REDIS_CONNECTION_STRING}
@@ -56,14 +59,28 @@ The Database Playground is a platform designed to enhance your SQL skills throug
    OPENAI_API_KEY=your-openai-api-key
    LINE_NOTIFY_DSN=linenotify://line-notify-token@default
    SQLRUNNER_URL=http://sqlrunner.zeabur.internal:8080
+   MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+   MESSENGER_TRANSPORT_DSN=${REDIS_URI}/messages
    ```
-5. Bind your domain, and the application will be ready for use. The Meilisearch index will be automatically created on start up.
+6. Add the following environment variables to the worker:
+   ```env
+   DATABASE_URL=postgresql://${POSTGRES_USERNAME}:${POSTGRES_PASSWORD}@postgresql.zeabur.internal:5432/${POSTGRES_DATABASE}?serverVersion=16&charset=utf8
+   REDIS_URI=${REDIS_CONNECTION_STRING}
+   MEILISEARCH_URL=http://meilisearch.zeabur.internal:7700
+   MEILISEARCH_API_KEY=${MEILI_MASTER_KEY}
+   APP_SECRET=${PASSWORD}
+   LINE_NOTIFY_DSN=linenotify://line-notify-token@default
+   MAILER_DSN=ses://ACCESS_KEY:SECRET_KEY@default?region=eu-west-1
+   MESSENGER_TRANSPORT_DSN=${REDIS_URI}/messages
+   MESSENGER_CONSUMER_NAME=app-sf-worker-1  # Change the number for each worker
+   ```
+7. Bind your domain, and the application will be ready for use. The Meilisearch index will be automatically created on start up.
 
 ### Docker
 
 We provide a Docker Compose configuration based on [Symfony Docker](https://github.com/dunglas/symfony-docker) for
 deployment. The prebuilt image is available at
-the [GitHub Registry](https://github.com/database-playground/app-sf/pkgs/container/app-sf).
+the [GitHub Registry](https://github.com/orgs/database-playground/packages).
 
 To deploy the application, you may need to update the secret or environment variables in the `compose.yaml` and
 `compose.prod.yaml` files, and then run the following command:

assets/styles/app.scss

@@ -413,3 +413,10 @@ ul.credit {
     }
   }
 }
+
+.app-email-preview {
+  &__rendered__content__html {
+    height: 60vh;
+    width: 100%;
+  }
+}

compose.override.yaml

@@ -26,4 +26,8 @@ services:
     environment:
       MP_SMTP_AUTH_ACCEPT_ANY: 1
       MP_SMTP_AUTH_ALLOW_INSECURE: 1
-###< symfony/mailer ###
+  ###< symfony/mailer ###
+
+  worker:
+    env_file:
+      - .env.local

compose.yaml

@@ -46,7 +46,7 @@ services:
   sqlrunner:
     image: ghcr.io/database-playground/sqlrunner-v2:main
   php:
-    image: ${IMAGES_PREFIX:-}app-php
+    image: ${IMAGES_PREFIX:-}app-sf
     restart: unless-stopped
     environment:
       SERVER_NAME: ${SERVER_NAME:-localhost}, php:80
@@ -55,6 +55,7 @@ services:
       MEILISEARCH_URL: "http://meilisearch:7700"
       MEILISEARCH_API_KEY: ${MEILI_MASTER_KEY:-!MasterChangeMe!}
       SQLRUNNER_URL: "http://sqlrunner:8080"
+      MESSENGER_TRANSPORT_DSN: "${REDIS_URI}/messages"
     volumes:
       - caddy_data:/data
       - caddy_config:/config
@@ -72,6 +73,27 @@ services:
       - target: 443
         published: ${HTTP3_PORT:-443}
         protocol: udp
+  worker:
+    image: ${IMAGES_PREFIX:-}app-sf-worker
+    build:
+      dockerfile: worker.Dockerfile
+      context: .
+    environment:
+      DATABASE_URL: "postgresql://${POSTGRES_USER:-app}:${POSTGRES_PASSWORD:-!ChangeMe!}@database:5432/${POSTGRES_DB:-app}?serverVersion=${POSTGRES_VERSION:-16}&charset=${POSTGRES_CHARSET:-utf8}"
+      REDIS_URI: "redis://redis:6379"
+      MEILISEARCH_URL: "http://meilisearch:7700"
+      MEILISEARCH_API_KEY: ${MEILI_MASTER_KEY:-!MasterChangeMe!}
+      MESSENGER_TRANSPORT_DSN: "${REDIS_URI}/messages"
+      MESSENGER_CONSUMER_NAME: app-sf-worker-1
+    restart: unless-stopped
+    depends_on:
+      php:
+        condition: service_healthy
+  worker-2:
+    extends:
+      service: worker
+    environment:
+      MESSENGER_CONSUMER_NAME: app-sf-worker-2
 
 volumes:
   ###> doctrine/doctrine-bundle ###

composer.json

@@ -20,12 +20,14 @@
     "jblond/php-diff": "dev-master",
     "league/commonmark": "dev-main",
     "meilisearch/search-bundle": "dev-main",
+    "notfloran/mjml-bundle": "dev-main",
     "nyholm/psr7": "dev-master",
     "openai-php/client": "dev-main",
     "oro/doctrine-extensions": "dev-master",
     "phpdocumentor/reflection-docblock": "5.*",
     "runtime/frankenphp-symfony": "dev-main",
     "sensiolabs/typescript-bundle": "dev-main",
+    "symfony/amazon-mailer": "7.3.*",
     "symfony/asset": "7.3.*",
     "symfony/asset-mapper": "7.3.*",
     "symfony/console": "7.3.*",
@@ -45,6 +47,7 @@
     "symfony/notifier": "7.3.*",
     "symfony/password-hasher": "7.3.*",
     "symfony/process": "7.3.*",
+    "symfony/redis-messenger": "7.3.*",
     "symfony/runtime": "7.3.*",
     "symfony/security-bundle": "7.3.*",
     "symfony/serializer": "7.3.*",