# バッチ設計書 4-queue:retry-batch

## 概要

本ドキュメントは、Laravelフレームワークのバッチ失敗ジョブリトライコマンド `queue:retry-batch` の設計仕様を記載したものです。本バッチはジョブバッチ内で失敗したジョブを一括でリトライする機能を提供します。

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

`queue:retry-batch` コマンドは、Laravelのジョブバッチ機能で処理中に失敗したジョブを、バッチID単位で一括リトライするバッチ処理です。内部的に `queue:retry` コマンドを呼び出して各失敗ジョブを再投入します。

**業務上の目的・背景**：Laravelのジョブバッチ機能を使用すると、複数のジョブをグループ化して進捗管理や完了コールバックを設定できます。バッチ処理中に一部のジョブが失敗した場合、バッチ全体の完了を妨げることがあります。本コマンドにより、特定バッチ内の失敗ジョブのみを効率的にリトライし、バッチ処理を完了に導くことができます。大量データのインポート処理や一括メール送信など、バッチ処理が重要な業務シナリオで活用されます。

**バッチの実行タイミング**：バッチ処理の失敗検知後に手動実行。または監視システムからの自動リトライトリガー。

**主要な処理内容**：
1. BatchRepositoryから指定バッチIDのバッチ情報を取得
2. バッチに紐づく失敗ジョブIDリスト（failedJobIds）を取得
3. 各失敗ジョブに対して `queue:retry` コマンドを呼び出し
4. リトライ結果を表示

**前後の処理との関連**：`queue:retry` コマンドに依存。バッチ情報は `job_batches` テーブルから取得。古いバッチデータは `queue:prune-batches` で削除可能。

**影響範囲**：job_batchesテーブル（参照のみ）、failed_jobsテーブル（queue:retry経由で削除）、jobsテーブル/キュー（ジョブ再投入）に影響を与えます。

## バッチ種別

データ復旧 / バッチジョブリトライ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 / 監視システム連携 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| バッチの存在 | job_batchesテーブルに対象バッチが存在すること |
| 失敗ジョブの存在 | バッチに紐づく失敗ジョブが存在すること |
| BatchRepository | BatchRepositoryがサービスコンテナにバインドされていること |

### 実行可否判定

- 指定バッチIDが存在しない場合はエラーメッセージを表示
- バッチに失敗ジョブが存在しない場合はエラーメッセージを表示
- Isolatableインターフェースを実装しており、同一バッチIDの同時実行を防止

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| id | string/array | No | - | リトライするバッチID（複数指定可） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| job_batches テーブル | DB | バッチ情報と失敗ジョブIDリスト |
| failed_jobs テーブル | DB | 失敗ジョブの詳細情報（queue:retry経由） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | リトライ処理の進捗・結果 |
| jobs テーブル/キュー | DB/Redis等 | 再投入されたジョブ（queue:retry経由） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. バッチID取得
   └─ 引数からリトライ対象バッチIDを取得
2. 各バッチに対してループ処理
   └─ BatchRepositoryから該当バッチを検索
3. バッチ存在確認
   └─ 存在しない場合はエラーメッセージを表示して次へ
4. 失敗ジョブ確認
   └─ failedJobIdsが空の場合はエラーメッセージを表示
5. 処理開始メッセージ
   └─ "Pushing failed queue jobs of the batch [id] back onto the queue"
6. 各失敗ジョブに対してリトライ
   └─ callSilent('queue:retry', ['id' => $failedJobId])
7. 結果表示
   └─ 各ジョブのリトライ結果をタスク形式で表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[バッチID取得]
    B --> C{バッチIDあり?}
    C -->|No| D[終了]
    C -->|Yes| E[次のバッチIDを処理]
    E --> F[BatchRepositoryから検索]
    F --> G{バッチ存在?}
    G -->|No| H[エラー: バッチ未検出]
    H --> I{残りバッチあり?}
    G -->|Yes| J{失敗ジョブあり?}
    J -->|No| K[エラー: 失敗ジョブなし]
    K --> I
    J -->|Yes| L[処理開始メッセージ]
    L --> M[次の失敗ジョブIDを処理]
    M --> N[queue:retry 呼び出し]
    N --> O[結果表示]
    O --> P{残り失敗ジョブあり?}
    P -->|Yes| M
    P -->|No| I
    I -->|Yes| E
    I -->|No| D
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| バッチ検索 | job_batches | SELECT | バッチID指定でバッチ情報を検索 |
| 失敗ジョブリトライ | failed_jobs | DELETE | queue:retry経由で削除 |
| ジョブ投入 | jobs/キュー | INSERT/PUSH | queue:retry経由でキューに再投入 |

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

#### job_batches

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, name, failed_job_ids, ... | id指定 | バッチ情報取得 |

#### failed_jobs（queue:retry経由）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | 全カラム | id指定 | queue:retry経由 |
| DELETE | - | id指定 | queue:retry経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | バッチ未検出 | 指定バッチIDが存在しない | バッチIDを確認して再実行 |
| - | 失敗ジョブなし | バッチに失敗ジョブが存在しない | 対象バッチを確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 本コマンド自体のリトライなし（queue:retryに委譲） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

1. 特定バッチのリトライ失敗時は他のバッチの処理を継続
2. queue:retry の戻り値で成功/失敗を判定
3. Isolatable実装により同一バッチの同時リトライを防止

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ジョブ単位（queue:retryに委譲） |
| コミットタイミング | queue:retry内で管理 |
| ロールバック条件 | queue:retry内で管理 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数件〜数百件（バッチ内の失敗ジョブ数） |
| 目標処理時間 | ジョブ数に依存 |
| メモリ使用量上限 | 標準Artisanコマンドと同等 |

## 排他制御

- Isolatableインターフェースを実装
- isolatableIdメソッドでバッチIDをミューテックスキーとして使用
- 同一バッチIDの同時実行を防止

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチIDあり時 | Pushing failed batch jobs back onto the queue |
| 進捗ログ | 各バッチ処理時 | Pushing failed queue jobs of the batch [id] back onto the queue |
| 結果ログ | 各ジョブ処理時 | 失敗ジョブID（タスク形式） |
| エラーログ | バッチ未検出時 | Unable to find a batch with ID [x] |
| エラーログ | 失敗ジョブなし時 | The given batch does not contain any failed jobs |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| バッチ失敗数 | 運用定義による | 監視システム |
| リトライ失敗 | queue:retry失敗時 | ログ監視 |

## 備考

- 複数のバッチIDを同時に指定可能
- 内部的に `callSilent` で `queue:retry` を呼び出し
- Isolatable実装により競合状態を防止
- バッチのfailedJobIdsプロパティから失敗ジョブIDを取得
- バッチ機能はLaravel 8.0で導入された機能
