# バッチ設計書 10-Inboxes::BulkAutoAssignmentJob

## 概要

本ドキュメントは、Chatwootアプリケーションにおける`Inboxes::BulkAutoAssignmentJob`バッチの設計仕様を記載したものである。

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

このバッチは、未アサインの会話を利用可能なエージェントに一括自動アサインするジョブである。Assignment V2機能が有効なアカウントの自動アサイン対応インボックスを対象に、定期的に未アサイン会話をエージェントに割り当てる。

**業務上の目的・背景**：Chatwootでは、顧客からの問い合わせ（会話）をエージェントに自動的に割り当てる機能を提供している。しかし、会話作成時にオンラインのエージェントがいない場合や、割り当て処理が失敗した場合は未アサイン状態となる。このバッチは、定期的に未アサイン会話をスキャンし、利用可能なエージェントに割り当てることで、顧客対応の遅延を最小化し、カスタマーサポートの効率を向上させる。

**バッチの実行タイミング**：15分ごとに実行される。

**主要な処理内容**：
1. Assignment V2機能が有効なアカウントを取得
2. Chatwoot Cloud環境ではデフォルトプランをスキップ
3. 各アカウントの自動アサイン有効インボックスを処理
4. 利用可能なエージェント（容量考慮）を取得
5. 未アサインかつオープンな会話（最大100件）を取得
6. AgentAssignmentServiceで各会話にエージェントをアサイン

**前後の処理との関連**：独立したバッチとして動作。AgentAssignmentServiceとInboxRoundRobinServiceを使用して、ラウンドロビン方式でエージェントをアサインする。

**影響範囲**：conversationsテーブルのassignee_idカラム更新

## バッチ種別

自動アサイン / 会話管理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 15分毎 |
| 実行時刻 | 毎時0, 15, 30, 45分 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（sidekiq-cron） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Assignment V2有効 | アカウントでAssignment V2機能が有効であること |
| 自動アサイン有効 | インボックスで自動アサインが有効であること |

### 実行可否判定

- アカウントレベル: `Account.feature_assignment_v2`スコープで対象アカウントを絞り込み
- Chatwoot Cloud環境: デフォルトプランのアカウントはスキップ
- インボックスレベル: `enable_auto_assignment: true`のインボックスのみ対象

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチは引数を取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| accounts | DB | feature_assignment_v2スコープで取得 |
| inboxes | DB | enable_auto_assignment: trueのインボックス |
| conversations | DB | unassigned.openな会話 |
| inbox_members | DB | 利用可能なエージェント（容量考慮） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| conversations | DB | assignee_idの更新 |
| ログ | テキスト | アサイン結果の出力 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 対象アカウントの取得
   └─ Account.feature_assignment_v2.find_each
2. アカウント単位のスキップ判定
   └─ Chatwoot Cloudかつデフォルトプランならスキップ
   └─ ログ出力: "Skipping auto assignment for account {id}"
3. インボックス単位の処理
   └─ account.inboxes.where(enable_auto_assignment: true).find_each
4. 利用可能エージェントの取得
   └─ inbox.member_ids_with_assignment_capacity
   └─ 空の場合はログ出力してスキップ
5. 未アサイン会話の取得
   └─ inbox.conversations.unassigned.open.limit(100)
6. 会話単位のアサイン処理
   └─ AgentAssignmentService.new(conversation:, allowed_agent_ids:).perform
   └─ ログ出力: "Assigned conversation {id} to agent {agent_id}"
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[feature_assignment_v2アカウント取得]
    B --> C{アカウントあり?}
    C -->|No| D[バッチ終了]
    C -->|Yes| E{Chatwoot Cloud かつ デフォルトプラン?}
    E -->|Yes| F[スキップログ出力]
    E -->|No| G[自動アサイン有効インボックス取得]
    F --> H{次のアカウントあり?}
    G --> I{インボックスあり?}
    I -->|No| H
    I -->|Yes| J[member_ids_with_assignment_capacity取得]
    J --> K{エージェントあり?}
    K -->|No| L[エージェントなしログ出力]
    K -->|Yes| M[未アサインオープン会話取得]
    L --> N{次のインボックスあり?}
    M --> O[AgentAssignmentServiceでアサイン]
    O --> P[アサイン結果ログ出力]
    P --> N
    N -->|Yes| J
    N -->|No| H
    H -->|Yes| E
    H -->|No| D
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| アカウント取得 | accounts | SELECT | feature_assignment_v2スコープ |
| インボックス取得 | inboxes | SELECT | enable_auto_assignment: true |
| エージェント取得 | inbox_members, users | SELECT | 容量考慮の利用可能エージェント |
| 会話取得 | conversations | SELECT | unassigned.open.limit(100) |
| アサイン更新 | conversations | UPDATE | assignee_idの更新 |

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

#### conversations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, assignee_id, status, inbox_id | assignee_id IS NULL AND status = 'open' | limit(100) |
| UPDATE | assignee_id | 選択されたエージェントのID | AgentAssignmentService経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | StandardError | 予期しないエラー | Sidekiqリトライ機構に委譲 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Sidekiqのデフォルト設定に依存 |
| リトライ間隔 | Sidekiqのデフォルト設定に依存 |
| リトライ対象エラー | ジョブ実行時の例外全般 |

### 障害時対応

本ジョブが失敗した場合、15分後の次回実行で再度処理される。未アサイン会話は次回実行時にも処理対象となるため、一時的な失敗は問題にならない。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | AgentAssignmentService内の個別更新 |
| コミットタイミング | 各conversation.update時 |
| ロールバック条件 | 個別更新失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | インボックスあたり最大100会話 |
| 目標処理時間 | 15分以内（次回実行前に完了） |
| メモリ使用量上限 | 最小限（find_eachで分割処理） |

## 排他制御

同時実行の制御は特になし。15分間隔での実行のため、通常は前回実行が完了してから次回実行が開始される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | アカウントスキップ時 | `Skipping auto assignment for account {id}` |
| 情報ログ | エージェントなし時 | `No agents available to assign conversation to inbox {id}` |
| 情報ログ | アサイン成功時 | `Assigned conversation {id} to agent {agent_id}` |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗 | 連続失敗 | Sidekiq監視 |
| 未アサイン会話増加 | 閾値超過 | 運用監視（任意） |

## 備考

- BillingHelperをincludeしており、Chatwoot Cloud環境でのプラン判定に使用される
- Chatwoot Cloud環境では、デフォルトプランのアカウントは自動アサインがスキップされる（有料機能の可能性）
- `member_ids_with_assignment_capacity`はEnterprise版で容量ベースの判定を行う（OSS版では全メンバーを返す）
- `Limits::AUTO_ASSIGNMENT_BULK_LIMIT = 100`で1回の処理での会話数を制限
- AgentAssignmentServiceはラウンドロビン方式でオンラインエージェントから選択
- Assignment V2は新しい自動割り当て機能であり、従来の方式とは異なるロジックを使用
