mail送信、batch処理（command）、job/workerのサンプルコードを追加

Author: endou-mame

.devcontainer/devcontainer.json

@@ -7,8 +7,8 @@
 		// "../compose.production.yaml",
 		"../compose.development.api.yaml",
 		"../compose.development.infra.yaml",
-		// "../compose.development.batch.yaml",
-		// "../compose.development.worker.yaml",
+		"../compose.development.batch.yaml",
+		"../compose.development.worker.yaml",
 		"./compose.yaml"
 	],
 	"service": "workspace",

compose.development.api.yaml

@@ -72,13 +72,13 @@ services:
       #   condition: service_healthy
     networks:
       - common
-      # healthcheck:
-      # NOTE: cgi-fcgi リクエストを送ると、zend_mm_heap corrupted が発生する重大な問題があるため、コメントアウト中。
+    healthcheck:
+      # NOTE: cgi-fcgi リクエストを送ると、zend_mm_heap corrupted が発生する重大な問題がある。
       #  参考: https://github.com/php/php-src/issues/15395
       # PHP8.2以降の最新パッチバージョンでは修正されているが、PHP8.1系はまだ対応されていないっぽい。
       # 参考: https://www.php.net/ChangeLog-8.php#PHP_8_1
-      # test: [ "CMD-SHELL", "cgi-fcgi -bind -connect /run/php-fpm/www.sock 2>&1 || exit 1" ]
-      # interval: 30s
-      # timeout: 5s
-      # start_period: 30s
-      # retries: 3
+      test: [ "CMD-SHELL", "cgi-fcgi -bind -connect /run/php-fpm/www.sock 2>&1 || exit 1" ]
+      interval: 30s
+      timeout: 5s
+      start_period: 30s
+      retries: 3

compose.development.batch.yaml

@@ -1,6 +1,6 @@
 services:
-  example-batch-1:
-    container_name: ${COMPOSE_PROJECT_NAME}_example-batch-1
+  example-emails-batch:
+    container_name: ${COMPOSE_PROJECT_NAME}_example-emails-batch
     build:
       target: development
       dockerfile: ./docker/app/php-fpm/Dockerfile
@@ -20,31 +20,6 @@ services:
     depends_on:
       db:
         condition: service_healthy
-    command: [ "php", "artisan", "example-batch-1" ]
-    networks:
-      - common
-
-  example-batch-2:
-    container_name: ${COMPOSE_PROJECT_NAME}_example-batch-2
-    build:
-      target: development
-      dockerfile: ./docker/app/php-fpm/Dockerfile
-      additional_contexts:
-        php-fpm-ctx: ./docker/app/php-fpm
-      args:
-        PHP_VERSION: ${PHP_VERSION}
-    env_file:
-      - ./src/.env
-    environment:
-      CONTAINER_ROLE: batch
-    volumes:
-      - type: bind
-        source: ./src
-        target: /var/www/src
-        consistency: cached
-    depends_on:
-      db:
-        condition: service_healthy
-    command: [ "php", "artisan", "example-batch-2" ]
+    command: [ "php", "artisan", "mail:send" ]
     networks:
       - common

compose.development.infra.yaml

@@ -52,8 +52,8 @@ services:
     profiles:
       - nosql
 
-  queue:
-    container_name: ${COMPOSE_PROJECT_NAME}_queue
+  elasticmq:
+    container_name: ${COMPOSE_PROJECT_NAME}_elasticmq
     image: softwaremill/elasticmq:latest
     ports:
       - "${HOST_ADDR}9324:9324"

compose.development.worker.yaml

@@ -1,6 +1,6 @@
 services:
-  example-worker-1:
-    container_name: ${COMPOSE_PROJECT_NAME}_example-worker-1
+  example-emails-worker:
+    container_name: ${COMPOSE_PROJECT_NAME}_example-emails-worker
     build:
       target: development
       dockerfile: ./docker/app/php-fpm/Dockerfile
@@ -12,40 +12,7 @@ services:
       - ./src/.env
     environment:
       CONTAINER_ROLE: worker
-      SQS_FIFO_QUEUE: "example-worker-1.fifo"
-    volumes:
-      - type: bind
-        source: ./src
-        target: /var/www/src
-        consistency: cached
-    depends_on:
-      db:
-        condition: service_healthy
-      elasticmq:
-        condition: service_healthy
-    networks:
-      - common
-    healthcheck:
-      test: [ "CMD-SHELL", "pgrep -f 'php artisan queue:work' || exit 1" ]
-      interval: 60s
-      timeout: 5s
-      start_period: 30s
-      retries: 3
-
-  example-worker-2:
-    container_name: ${COMPOSE_PROJECT_NAME}_example-worker-2
-    build:
-      target: development
-      dockerfile: ./docker/app/php-fpm/Dockerfile
-      additional_contexts:
-        php-fpm-ctx: ./docker/app/php-fpm
-      args:
-        PHP_VERSION: ${PHP_VERSION}
-    env_file:
-      - ./src/.env
-    environment:
-      CONTAINER_ROLE: worker
-      SQS_FIFO_QUEUE: "example-worker-2.fifo"
+      SQS_FIFO_QUEUE: "example-emails.fifo"
     volumes:
       - type: bind
         source: ./src

deploy/buildspec.yml

@@ -49,8 +49,7 @@ phases:
       - printf '{"name":"app","imageUri":"%s"},' ${APP_IMAGE_REPO_URI}:${IMAGE_TAG} >> apiImagedefinitions.json
 
       # For Worker Services
-      - printf '{"name":"example-worker-1","imageUri":"%s"},' ${APP_IMAGE_REPO_URI}:${IMAGE_TAG} >> workerImagedefinitions.json
-      - printf '{"name":"example-worker-2","imageUri":"%s"},' ${APP_IMAGE_REPO_URI}:${IMAGE_TAG} >> workerImagedefinitions.json
+      - printf '{"name":"example-emails-worker","imageUri":"%s"},' ${APP_IMAGE_REPO_URI}:${IMAGE_TAG} >> workerImagedefinitions.json
 
       # Close JSON array
       - sed -i '$ s/,$//' apiImagedefinitions.json

docker/queue/elasticmq/custom.conf

@@ -63,37 +63,20 @@ queues {
         fifo = true #FIFOキューの設定
     }
 
-    # http://localhost:9324/queue/example-worker-1.fifo
-    "example-worker-1.fifo" {
+    # http://localhost:9324/queue/example-emails.fifo
+    "example-emails.fifo" {
         defaultVisibilityTimeout = 10 seconds # 可視性タイムアウトの設定
         delay = 5 seconds # 遅延キューの設定
         receiveMessageWait = 0 seconds # ロングポーリング
         fifo = true #FIFOキューの設定
         contentBasedDeduplication = true # 重複排除ID
         deadLettersQueue {
-            name = "example-worker-1-dead-letters.fifo"
+            name = "example-emails-dead-letters.fifo"
             maxReceiveCount = 3 # from 1 to 1000
         }
     }
-    # http://localhost:9324/queue/example-worker-1-dead-letters.fifo
-    "example-worker-1-dead-letters.fifo" {
-        fifo = true #FIFOキューの設定
-    }
-
-    # http://localhost:9324/queue/example-worker-2.fifo
-    "example-worker-2.fifo" {
-        defaultVisibilityTimeout = 10 seconds # 可視性タイムアウトの設定
-        delay = 5 seconds # 遅延キューの設定
-        receiveMessageWait = 0 seconds # ロングポーリング
-        fifo = true #FIFOキューの設定
-        contentBasedDeduplication = true # 重複排除ID
-        deadLettersQueue {
-            name = "example-worker-2-dead-letters.fifo"
-            maxReceiveCount = 3 # from 1 to 1000
-        }
-    }
-    # http://localhost:9324/queue/example-worker-2-dead-letters.fifo
-    "example-worker-2-dead-letters.fifo" {
+    # http://localhost:9324/queue/example-emails-dead-letters.fifo
+    "example-emails-dead-letters.fifo" {
         fifo = true #FIFOキューの設定
     }
 }

src/.env.development.example

@@ -63,7 +63,7 @@ FILESYSTEM_DISK=local
 # QUEUE_CONNECTION=database
 QUEUE_CONNECTION=sqs-fifo
 
-SQS_PREFIX="http://queue:9324/queue"
+SQS_PREFIX="http://elasticmq:9324/queue"
 SQS_QUEUE="example"
 SQS_SUFFIX=-dev
 

src/.env.example

@@ -63,11 +63,11 @@ FILESYSTEM_DISK=local
 # QUEUE_CONNECTION=database
 QUEUE_CONNECTION=sqs-fifo
 
-SQS_PREFIX="http://queue:9324/queue"
+SQS_PREFIX="http://elasticmq:9324/queue"
 SQS_QUEUE="example"
 SQS_SUFFIX=
 
-SQS_FIFO_PREFIX="http://queue:9324/queue"
+SQS_FIFO_PREFIX="http://elasticmq:9324/queue"
 # NOTE: 個別のWorkerコンテナ起動時に環境変数で指定すること!!
 SQS_FIFO_QUEUE="example.fifo"
 SQS_FIFO_SUFFIX=

src/.env.production.example

@@ -63,7 +63,7 @@ FILESYSTEM_DISK=local
 # QUEUE_CONNECTION=database
 QUEUE_CONNECTION=sqs-fifo
 
-SQS_PREFIX="http://queue:9324/queue"
+SQS_PREFIX="http://elasticmq:9324/queue"
 SQS_QUEUE="example"
 SQS_SUFFIX=
 

src/app/Console/Commands/SendEmails.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Console\Commands;
+
+use App\Mail\ExampleMail;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Mail;
+
+class SendEmails extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'mail:send';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Send a mail for testing purposes';
+
+    /**
+     * Execute the console command.
+     */
+    public function handle(): void
+    {
+        // 送信先のメールアドレスを設定
+        $to = '[email protected]';
+
+        // メール送信
+        Mail::to($to)->send(new ExampleMail(
+            envelopeSubject: 'テストメール (Command から送信)',
+            envelopeFromName: 'From Command',
+            body: 'これは Command から送信されたテストメールです。',
+        ));
+
+        $this->info('Test email sent successfully to ' . $to);
+    }
+}

src/app/Jobs/SendEmailsJob.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Mail\ExampleMail;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Queue\Queueable;
+use Illuminate\Support\Facades\Mail;
+
+class SendEmailsJob implements ShouldQueue
+{
+    use Queueable;
+
+    /**
+     * Create a new job instance.
+     */
+    public function __construct()
+    {
+
+    }
+
+    /**
+     * Execute the job.
+     */
+    public function handle(): void
+    {
+        // 送信先のメールアドレスを設定
+        $to = '[email protected]';
+
+        // バックグラウンドでメール送信
+        Mail::to($to)->send(new ExampleMail(
+            envelopeSubject: 'テストメール (Background Job から送信)',
+            envelopeFromName: 'From Background Job',
+            body: 'これは Background Job から送信されたテストメールです。',
+        ));
+    }
+}

src/app/Mail/ExampleMail.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Mail;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Address;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+
+class ExampleMail extends Mailable
+{
+    use Queueable;
+    use SerializesModels;
+
+    /**
+     * Create a new message instance.
+     */
+    public function __construct(
+        private string $envelopeSubject,
+        private string $envelopeFromName,
+        private string $body
+    ) {
+
+    }
+
+    /**
+     * Get the message envelope.
+     */
+    public function envelope(): Envelope
+    {
+        return new Envelope(
+            subject: $this->envelopeSubject,
+            from: new Address('[email protected]', $this->envelopeFromName),
+        );
+    }
+
+    /**
+     * Get the message content definition.
+     */
+    public function content(): Content
+    {
+        return new Content(
+            view: 'mail.example',
+            with: [
+                'body' => $this->body,
+            ],
+        );
+    }
+
+    /**
+     * Get the attachments for the message.
+     *
+     * @return array<int, \Illuminate\Mail\Mailables\Attachment>
+     */
+    public function attachments(): array
+    {
+        return [];
+    }
+}