Algorithm

継続的インテグレーション＆継続的デリバリーの略で、アプリケーションの構築、テスト、および展開の自動化を指す

CI/CD

コンテナ仮想化を用いてアプリケーションを開発・配置・実行するためのDocker​社製オープンソースソフトウェア

Docker

GitHub社によって運営されているソースコードの変更履歴を管理するホスティングサービス

GitHub

静的なHTMLをベースに、JavaScriptを用いたAPIを通じて動的なコンテンツを扱うWebサービスのアーキテクチャ

Jamstack

Facebook社がOSSとして開発を進めているJavaScript用テスティングフレームワーク

Jest

MVCモデルでWebアプリケーションを開発できるオープンソースWebアプリケーションフレームワーク

Laravel

GoogleのMaterialデザインをベースに開発された、ウェブ開発をより高速かつ簡単にするReactコンポーネント

Material-UI

Oracle社が中心となって開発しているオープンソースのリレーショナルデータベース管理システム

MySQL

Vercel社がOSSとして開発を進めているReactベースのフロントエンドフレームワーク

Next.js

The PHP Groupによってコミュニティベースで開発されているオープンソースの汎用プログラミング言語。

Facebook社とコミュニティによって開発されているUI構築のためのJavaScriptライブラリ

React

マイクロソフトが開発・販売しているGUIを採用したオペレーティングシステムの製品群

Windows

AWS - Breathnote

Laravelを使ったとあるWEBシステムに、メール送信機能を実装しました。このシステムでは、メールを一括送信する要件があったため、メール送信部分は非同期で実装しました。

Laravelでは、タスクをバックグラウンドで処理させる仕組みとして「キュー」が存在します。Laravelキューは、データベース、Amazon SQS、Redisといったドライバをサポートしていますが、今回はAmazon SQSの「FIFOキュー」を利用して実装しました。

この記事では、Amazon SQSを用いたメールキューの実装方法をまとめています。

- [Laravel Queueを利用して非同期によるメール送信](https://noumenon-th.net/programming/2020/06/02/laravel-queue/)
- [LaravelでAmazon SQSのFIFOキューを使う方法](https://qiita.com/suzumurakk/items/d23e39c322c44c99f0ed)

## 動作環境

- Laravel 7.0
- `aws/aws-sdk-php`を導入済み
- メール送信機能を実装済み
- Amazon SQSのFIFOキューを準備済み

## 実装

### 1. キューにメッセージを送るサービスを作成

<div className="codeblock-filename">SqsFifoQueue.php</div>

```php
<?php

namespace App\Services;

use Illuminate\Queue\SqsQueue;

class SqsFifoQueue extends SqsQueue
{
    public function pushRaw($payload, $queue = null, $options = [])
    {
        $response = $this->sqs->sendMessage([
            'QueueUrl' => $this->getQueue($queue),
            'MessageBody' => $payload,
            'MessageGroupId' => uniqid(),
            'MessageDeduplicationId' => uniqid(),
        ]);

        return $response->get('MessageId');
    }
}
```

### 2. キューに接続するサービスを作成

<div className="codeblock-filename">SqsFifoConnector.php</div>

```php
<?php

namespace App\Services;

use Aws\Sqs\SqsClient;
use Illuminate\Support\Arr;
use Illuminate\Queue\Connectors\SqsConnector;

class SqsFifoConnector extends SqsConnector
{
    public function connect($config)
    {
        $config = $this->getDefaultConfiguration($config);

        if ($config['key'] && $config['secret']) {
            $config['credentials'] = Arr::only($config, ['key', 'secret']);
        }

        return new SqsFifoQueue(new SqsClient($config), $config['queue']);
    }
}
```

### 3. キュー接続用のサービスプロバイダを作成

<div className="codeblock-filename">SqsFifoServiceProvider.php</div>

```php
<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

use App\Services\SqsFifoConnector;

class SqsFifoServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->afterResolving('queue', function ($manager) {
            $manager->addConnector('sqsfifo', function () {
                return new SqsFifoConnector;
            });
        });
    }
}
```

<div className="codeblock-filename">config/app.php</div>

```php
return [
    'providers' => [
        App\Providers\SqsFifoServiceProvider::class,
    ],
];
```

### 4. キューの接続情報を追加

<div className="codeblock-filename">config/queue.php</div>

```php
return [
    'connections' => [
        'sqsfifo' => [
            'driver' => 'sqsfifo',
            'key' => env('AWS_QUEUE_ACCESS_KEY_ID'),
            'secret' => env('AWS_QUEUE_SECRET_ACCESS_KEY'),
            'queue' => env('SQS_QUEUE'),
            'region' => env('AWS_DEFAULT_REGION'),
        ],
    ],
];
```

### 5. 環境変数を追加

<div className="codeblock-filename">.env</div>

```ini
# 変更
QUEUE_CONNECTION=sqsfifo

# 新規追加
AWS_QUEUE_ACCESS_KEY_ID=<[KEY_ID]>
AWS_QUEUE_SECRET_ACCESS_KEY=<[SECRET_KEY]>
SQS_QUEUE=<[END_POINT]>
AWS_DEFAULT_REGION=<[REGION]>
```

### 6. ジョブクラスの作成

<div className="codeblock-filename">SendSampleMail.php</div>

```php
<?php

namespace App\Jobs;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Foundation\Bus\Dispatchable;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Illuminate\Support\Facades\Mail;

use App\Mail\SampleMail;

class SendSampleMail implements ShouldQueue
{
    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;

    public $tries = 3; // 処理失敗時の最大試行回数

    public $data;

    public function __construct(array $data)
    {
        $this->data = $data;
    }

    public function handle()
    {
        Mail::to('<[YOUR_ADDRESS]>')->send(new SampleMail(
            $this->data,
        ));
    }
}
```

### 7. メール送信部分を修正

実装済みのメール送信部分を`dispatch()`に置き換えます。

<div className="codeblock-filename">SampleController.php</div>

```php
<?php

namespace App\Http\Controllers;

class SampleController extends Controller
{
    public function index(Request $request)
    {
        // Mail::to('<[YOUR_ADDRESS]>')->send(new SampleMail($request));

        SendSampleMail::dispatch($request);
    }
}
```

### 8. キューワーカーを起動して動作確認

`php artisan queue:work`でキューワーカーを起動して、実際にメールを送信してみましょう。

Amazon SQSのモニタリング画面でレスポンスの返却が確認できればOKです。

## 所感

本番環境でキューサービスを利用する際は、Supervisorの導入が欠かせません。

[こちらの記事](/posts/amazon-ilnux-2-supervisor)でSupervisorの導入方法を説明しています。興味のある方はどうぞ。

Webアプリケーションによくあるメール一括送信機能ですが、「キュー」を用いてバックグラウンドで処理させる場合が多いです。今回は、Amazon SQSを利用したキューサービスを、Laravelのメール送信機能に追加してみます。

Amazon SQSを使ったLaravelメールキューを実装する

Laravelのキューワーカーを用いたメール送信機能を実装したのですが、コマンド永続化のため、サーバへSupervisorを導入する必要がありました。

今回の案件では、サーバにAWSのEC2（Amazon Linux 2）を採用していたので、以下の記事を参考にしながら作業を行いました。

本記事は参考記事とほぼ同じ内容ですが、自分で見返してサッと導入できるようにまとめています。

- [Amazon Linux 2にSupervisorを設定する](https://blog.e2info.co.jp/2021/04/11/amazon-linux-2_supervisor/)

## 手順書

これより下のコマンドでは`sudo`を省略しています。コマンドの実行ユーザに応じて追加してください。

### 1. サーバ環境を確認

Supervisorが未導入であることを確認します。

<div className="codeblock-filename">shell</div>

```
supervisord -v
```

Supervisorのインストールに必要な`pip3`が導入済みであることを確認します。

<div className="codeblock-filename">shell</div>

```
pip3 -V
```

### 2. インストール

<div className="codeblock-filename">shell</div>

```
pip3 install supervisor
```

### 3. Supervisorを設定

各種ディレクトリを作成します。

<div className="codeblock-filename">shell</div>

```
mkdir /etc/supervisord

mkdir /etc/supervisord/conf.d
```

設定ファイルの雛形を作成します。

<div className="codeblock-filename">shell</div>

```
echo_supervisord_conf > /etc/supervisord/supervisord.conf
```

設定ファイルの最下部に、ファイルパスを追加します。

<div className="codeblock-filename">supervisord.conf</div>

```
[include]
files = /etc/supervisord/conf.d/*.conf
```

### 4. Laravel用の設定ファイルを追加

`/etc/supervisord/conf.d`の直下に`laravel-queue-worker.conf`を作成します。

<div className="codeblock-filename">laravel-queue-worker.conf</div>

```
[program:laravel-queue-worker]
process_name=%(program_name)s_%(process_num)02d
command=php /<[PROJECT_PATH]>/artisan queue:work --sleep=60
autostart=true
autorestart=true
user=ec2-user
numprocs=1
redirect_stderr=true
stdout_logfile=/<[PROJECT_PATH]>/storage/logs/laravel-worker.log
```

### 5. サービスとして登録

`systemctl`コマンドで呼び出せるようにします。

<div className="codeblock-filename">shell</div>

```
vi /etc/systemd/system/supervisord.service
```

<div className="codeblock-filename">supervisord.service</div>

```
[Unit]
Documentation=http://supervisord.org
After=network.target

[Service]
Type=forking
ExecStart=/usr/local/bin/supervisord -c /etc/supervisord/supervisord.conf
ExecReload=/usr/local/bin/supervisorctl reload
ExecStop=/usr/local/bin/supervisorctl shutdown
User=root
KillMode=process
Restart=on-failure
RestartSec=50s

[Install]
WantedBy=multi-user.target
```

### 6. 動作確認 ＆ 自動起動の設定

各種`systemctl`コマンドで動作確認。

<div className="codeblock-filename">shell</div>

```
# 起動
systemctl start supervisord

# 再起動
systemctl restart supervisord

# ステータスを確認
systemctl status supervisord

# 停止
systemctl stop supervisord
```

問題なければ自動起動するよう設定しておきます。

<div className="codeblock-filename">shell</div>

```
systemctl enable supervisord
```

## 所感

どうでもいい話ですが、稼働中の本番環境でこういった作業するの緊張しますよね。

Supervisorの導入に関連して、[Amazon SQSを使ったLaravelメールキューの実装に関する記事](/posts/laravel-mail-queue-amazon-sqs)も書いてます。

興味のある方はどうぞ。

サーバ上で、Laravelのキューワーカーを永続的に実行させるためにSupervisorを導入しました。その際の知見をまとめておきます。

EC2（Amazon Linux 2）にSupervisorを導入する

AWSのロードバランサを経由してLaravel（EC2）にアクセスすると、SSL通信にならない場合があります。

Laravel側の設定で解消できるので、対処法をアウトプットしておきます。

- [Amazon CloudFrontを経由したL製のaravelがHTTPSにならないとき](https://liginc.co.jp/490895)

## 原因

クライアントとLaravelのあいだにロードバランサを挟むことにより、元々のクライアントリクエストがSSL通信か否か、Laravelが判断できなくなるからです。

本件において、最終的にLaravelへアクセスするのはロードバランサです。Laravelがロードバランサからのアクセスを信用せず、リクエストヘッダを読み取らない場合、HTTPで通信してしまうようです。

## 対処法

Laravelが信用するプロキシの一覧に、ロードバランサのIPアドレスを追加しましょう。

AWSのロードバランサはIPアドレスが動的なので、ワイルドカードで全て許可するようにしています。

<div className="codeblock-filename">TrustProxies.php</div>

```php
<?php

namespace App\Http\Middleware;

use Fideloper\Proxy\TrustProxies as Middleware;
use Illuminate\Http\Request;

class TrustProxies extends Middleware
{
    // protected $proxies;
    protected $proxies = '*';
}
```

Laravelに対してロードバランサ以外からアクセスがある場合は、別途リクエストヘッダのカスタマイズも実施しておくことをおすすめします。

AWSのロードバランサを経由してLaravelにアクセスすると、SSL通信にならない場合があります。Laravel側の設定で解消できるので、対処法をアウトプットしておきます。

AWS

Amazon SQSを使ったLaravelメールキューを実装する

EC2（Amazon Linux 2）にSupervisorを導入する

ロードバランサを経由してLaravelにアクセスするとSSL通信にならない