# バッチ設計書 25-Internal::ProcessStaleRedisKeysJob

## 概要

本ドキュメントは、Chatwootシステムにおけるアカウント単位Redisキークリーンアップジョブ（Internal::ProcessStaleRedisKeysJob）の設計仕様を記載したものである。

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

本バッチは、特定のアカウントに関連する古いRedisキー（オンラインプレゼンス情報）を削除し、Redisメモリ使用量を削減する処理を行う。

**業務上の目的・背景**：Chatwootは、コンタクト（顧客）のオンラインプレゼンス情報をRedisのSorted Setで管理している。プレゼンス情報はタイムスタンプをスコアとして保持し、一定期間（デフォルト20秒）を超えた古いエントリは不要となる。しかし、通常のプレゼンス取得操作（get_available_contact_ids）でも古いキーのクリーンアップは行われるものの、アクセス頻度の低いアカウントではRedisメモリにゴミデータが蓄積する可能性がある。本バッチは、全アカウントに対して定期的にクリーンアップを実行することで、Redisのメモリ使用量を最適化し、システム全体のパフォーマンスを維持する。

**バッチの実行タイミング**：Internal::RemoveStaleRedisKeysJob（毎日22:30 UTC実行）から呼び出される。親ジョブがすべてのアカウントを列挙し、各アカウントに対して本ジョブをキューイングする。

**主要な処理内容**：
1. 引数として渡されたアカウントオブジェクトを受け取る
2. Internal::RemoveStaleRedisKeysServiceを呼び出し
3. Redisの zremrangebyscore コマンドでプレゼンス期間を超過した古いキーを削除
4. 削除件数をログに出力

**前後の処理との関連**：本バッチはInternal::RemoveStaleRedisKeysJob（No.6）から呼び出される子ジョブである。親ジョブがすべてのアカウントをバッチサイズ100件で列挙し、各アカウントに対して本ジョブを非同期でキューイングすることで、処理を分散させている。

**影響範囲**：Redis上のオンラインプレゼンスキー（Sorted Set）の古いエントリ削除

## バッチ種別

データクレンジング / Redisメモリ最適化

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次（親ジョブ経由） |
| 実行時刻 | 22:30 UTC前後（親ジョブ実行後） |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | Internal::RemoveStaleRedisKeysJob.perform_later |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| アカウント | 有効なアカウントオブジェクトが渡されること |
| Redis接続 | Redisサーバーへの接続が確立されていること |

### 実行可否判定

本ジョブは呼び出された時点で必ず実行される。親ジョブがすべてのアカウントを列挙するため、特別なフィルタリングは行われない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| account | Account | Yes | - | 処理対象のアカウントオブジェクト |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Redis | Sorted Set | オンラインプレゼンス情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Redis | Sorted Set | 古いエントリの削除 |
| Rails.logger | Log | 削除結果ログ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. performメソッド実行
   └─ アカウントオブジェクトを引数として受け取り

2. RemoveStaleRedisKeysService.perform呼び出し
   └─ サービスを初期化して実行

3. クリーンアップ範囲の計算
   └─ range_start = (現在時刻 - PRESENCE_DURATION).to_i

4. Redis zremrangebyscore実行
   ├─ キー: ONLINE_PRESENCE_CONTACTS:{account_id}
   ├─ 最小スコア: -inf
   └─ 最大スコア: (range_start（排他的）

5. ログ出力
   └─ Successfully cleaned up Redis keys for account {id} (removed {count} keys)
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[RemoveStaleRedisKeysService.perform]
    B --> C[range_start計算]
    C --> D[PRESENCE_DURATION取得]
    D --> E[プレゼンスキー名生成]
    E --> F[zremrangebyscore実行]
    F --> G[削除件数取得]
    G --> H[ログ出力]
    H --> Z[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | RDBへの操作なし |

### Redis操作詳細

#### オンラインプレゼンスキー

| 操作 | キー形式 | コマンド | 備考 |
|-----|---------|---------|------|
| DELETE | ONLINE_PRESENCE_CONTACTS:{account_id} | ZREMRANGEBYSCORE | スコアが閾値未満のメンバーを削除 |

**キー詳細**:
- 形式: Sorted Set
- スコア: Unixタイムスタンプ（秒）
- メンバー: コンタクトID

**削除条件**:
- スコア < (現在時刻 - PRESENCE_DURATION)
- PRESENCE_DURATION: 環境変数で設定（デフォルト20秒）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Redis::ConnectionError | Redis接続失敗 | Sidekiqリトライ |
| - | NoMethodError | アカウントがnilの場合 | Sidekiqリトライ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Sidekiqデフォルト設定に依存 |
| リトライ間隔 | Sidekiqデフォルト設定に依存 |
| リトライ対象エラー | 一時的なエラー全般 |

### 障害時対応

- Redis接続エラーの場合はSidekiqリトライで回復
- 翌日の定期実行で再度クリーンアップされるため、一時的な障害は影響が限定的
- Redisサーバー障害の場合は運用担当へエスカレーション

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | アカウントあたり数百〜数千エントリ |
| 目標処理時間 | 数ミリ秒〜数十ミリ秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- Redisの zremrangebyscore はアトミック操作
- 同一アカウントの同時処理でも競合は発生しない

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 処理開始時 | Removing redis stale keys for account {id} |
| 情報ログ | 処理完了時 | Successfully cleaned up Redis keys for account {id} (removed {count} keys) |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ実行エラー | 発生時 | Sidekiq監視 |
| Redis接続エラー | 連続発生時 | 運用担当 |

## 備考

- キューはlowを使用（低優先度）
- PRESENCE_DURATION は環境変数で設定可能（デフォルト20秒）
- Redisキーの形式: `ONLINE_PRESENCE_CONTACTS:{account_id}`
- zremrangebyscore の排他的最小スコア指定（"(score"形式）により、境界値を含まない削除を実現
- コンタクトのプレゼンス情報のみ対象（ユーザーのプレゼンスは対象外）
- Chatwoot Cloud環境でのRedisメモリ使用量削減（約50%）が期待される
