# バッチ設計書 5-queue:restart

## 概要

本ドキュメントは、Laravelフレームワークのキューワーカー再起動コマンド `queue:restart` の設計仕様を記載したものです。本バッチはキューワーカーデーモンに再起動シグナルを送信する機能を提供します。

### 本バッチの処理概要

`queue:restart` コマンドは、キャッシュに再起動タイムスタンプを書き込むことで、稼働中の全てのキューワーカーに再起動シグナルを送信するバッチ処理です。ワーカーは現在処理中のジョブを完了した後にグレースフルに終了し、Supervisor等のプロセス管理ツールにより再起動されます。

**業務上の目的・背景**：本番環境でキューワーカーがデーモンとして常駐稼働している場合、コードの変更やアプリケーションの設定変更を反映するためにワーカーの再起動が必要です。しかし、処理中のジョブを中断すると、データの不整合や重複処理のリスクがあります。本コマンドにより、現在のジョブを安全に完了させてから再起動するグレースフル再起動を実現できます。デプロイ時の必須手順として使用されます。

**バッチの実行タイミング**：アプリケーションのデプロイ時、設定変更時、コード更新時に手動またはCI/CDパイプラインから実行。

**主要な処理内容**：
1. 現在のタイムスタンプを取得
2. キャッシュに再起動シグナル（illuminate:queue:restart キー）を永続的に保存
3. 完了メッセージを表示

**前後の処理との関連**：`queue:work` コマンドで稼働中のワーカーがこのシグナルを検知して終了します。Supervisor等のプロセス管理ツールがワーカーを再起動します。

**影響範囲**：キャッシュストレージ（再起動シグナル書き込み）、全ての稼働中キューワーカー（グレースフル終了）に影響を与えます。

## バッチ種別

運用管理 / ワーカー再起動

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（デプロイ時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / CI/CD パイプライン |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| キャッシュ設定 | キャッシュドライバが設定され利用可能であること |
| ワーカー稼働 | 再起動対象のキューワーカーが稼働していること |
| プロセス管理 | Supervisor等のプロセス管理ツールが設定されていること（推奨） |

### 実行可否判定

- 特別な実行条件なし
- キャッシュへの書き込みが成功すれば処理完了

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | このコマンドはパラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| なし | - | 入力データソースなし |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| キャッシュ | illuminate:queue:restart キー | 再起動タイムスタンプ |
| 標準出力 | テキスト | 処理完了メッセージ |

### 出力ファイル仕様

該当なし（ファイル出力は行わない）

## 処理フロー

### 処理シーケンス

```
1. タイムスタンプ取得
   └─ InteractsWithTimeトレイトのcurrentTimeメソッドで現在時刻を取得
2. キャッシュ書き込み
   └─ illuminate:queue:restart キーにタイムスタンプを永続保存
3. 完了メッセージ表示
   └─ "Broadcasting queue restart signal."
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[現在タイムスタンプ取得]
    B --> C[キャッシュに再起動シグナル書き込み]
    C --> D[完了メッセージ表示]
    D --> E[バッチ終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

### テーブル別操作詳細

該当なし（データベース操作は行わない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | キャッシュ書き込み失敗 | キャッシュドライバが利用不可 | キャッシュ設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. キャッシュ書き込み失敗時は手動でワーカーを再起動
2. ワーカーが再起動シグナルを検知しない場合はプロセスを直接終了

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件（シグナル1回） |
| 目標処理時間 | 即座（数ミリ秒） |
| メモリ使用量上限 | 最小限 |

## 排他制御

- 排他制御なし
- 複数回実行しても最新のタイムスタンプで上書きされるため問題なし
- ワーカー側で再起動タイミングを制御

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | なし | なし |
| 進捗ログ | なし | なし |
| 終了ログ | 処理完了時 | Broadcasting queue restart signal. |
| エラーログ | エラー発生時 | キャッシュ書き込み失敗エラー |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワーカー再起動完了 | プロセス監視 | Supervisor / 監視ツール |
| キャッシュ書き込み | 失敗時 | アプリケーションログ |

## 備考

- キャッシュキーは `illuminate:queue:restart`
- `forever` メソッドで永続的に保存（TTLなし）
- ワーカーは各ジョブ処理後にこのキーをチェック
- タイムスタンプがワーカー起動時より新しい場合に終了
- Supervisor等での自動再起動を前提とした設計
- InteractsWithTimeトレイトを使用
- デプロイスクリプトに組み込むことを推奨
