# バッチ設計書 3-Card::CleanInaccessibleDataJob

## 概要

本ドキュメントは、カードに関連するアクセス不能データをクリーンアップするバックグラウンドジョブ `Card::CleanInaccessibleDataJob` の設計仕様を記載したものである。

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

このバッチは、ボードへのアクセス権限を失ったユーザーに関連するカードデータ（ピン、ウォッチ）を削除するクリーンアップ処理を行う。アクセス権限の変更に伴うデータ整合性を維持するための重要な機能を担う。

**業務上の目的・背景**：fizzyでは、ユーザーがボードへのアクセス権限を失った場合、そのユーザーが設定したピン（お気に入り）やウォッチ（監視設定）は無効なデータとなる。これらの不要データを適切に削除することで、データベースのクリーンさを維持し、将来的な権限復帰時の混乱を防ぐ。また、プライバシーの観点からも、アクセス権のないユーザーの操作履歴を残さないことが重要である。

**バッチの実行タイミング**：カードに関連するアクセス権限変更が発生した際に非同期で実行される。具体的なトリガーはコールバック`clean_inaccessible_data_later`経由で呼び出される。

**主要な処理内容**：
1. 対象カードを受け取り、クリーンアップ処理を開始
2. ボードへのアクセス権限を持つユーザーIDリストを取得
3. アクセス権限のないユーザーのピンレコードをバッチ削除
4. アクセス権限のないユーザーのウォッチレコードをバッチ削除

**前後の処理との関連**：ボードのアクセス権限変更（revokeなど）により本ジョブがトリガーされる。`Board::CleanInaccessibleDataJob`とは独立して動作し、カード単位でのクリーンアップを担当する。

**影響範囲**：`pins`テーブル、`watches`テーブル

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（アクセス権限変更時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | アクセス権限変更時のコールバック |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| カードの存在 | 有効なCardレコードが存在すること |
| ボードの存在 | カードが属するBoardレコードが存在すること |

### 実行可否判定

`ActiveJob::DeserializationError`が発生した場合（Cardレコードが削除済みの場合など）はジョブを破棄する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| card | Card | Yes | - | クリーンアップ対象のCardオブジェクト |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| cards | DB | 対象カード情報 |
| boards | DB | カードが属するボード情報 |
| accesses | DB | ボードへのアクセス権限情報 |
| pins | DB | カードに対するピン情報 |
| watches | DB | カードに対するウォッチ情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| pins | DB | アクセス不能ユーザーのピンを削除 |
| watches | DB | アクセス不能ユーザーのウォッチを削除 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. ジョブ開始
   └─ card.clean_inaccessible_dataメソッドを呼び出し
2. アクセス可能ユーザーID取得
   └─ board.accesses.pluck(:user_id)
3. 不要ピン削除
   └─ pins.where.not(user_id: accessible_user_ids).in_batches.destroy_all
4. 不要ウォッチ削除
   └─ watches.where.not(user_id: accessible_user_ids).in_batches.destroy_all
5. ジョブ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[アクセス可能ユーザーID取得]
    B --> C[不要ピン検索]
    C --> D{不要ピンあり?}
    D -->|Yes| E[バッチ削除]
    D -->|No| F[スキップ]
    E --> G[不要ウォッチ検索]
    F --> G
    G --> H{不要ウォッチあり?}
    H -->|Yes| I[バッチ削除]
    H -->|No| J[スキップ]
    I --> K[バッチ終了]
    J --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 参照 | accesses | SELECT | アクセス可能ユーザーIDの取得 |
| 削除 | pins | DELETE | アクセス不能ユーザーのピン削除 |
| 削除 | watches | DELETE | アクセス不能ユーザーのウォッチ削除 |

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

#### pins

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | user_id NOT IN (accessible_user_ids) AND card_id = target_card | バッチ処理 |

#### watches

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | user_id NOT IN (accessible_user_ids) AND card_id = target_card | バッチ処理 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| DeserializationError | シリアライズエラー | カードが削除済み | ジョブを破棄 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

クリーンアップ失敗時は、不要データが残存する可能性があるが、機能的な影響は限定的。次回のアクセス権限変更時に再度クリーンアップが試行される。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | バッチ単位（in_batches） |
| コミットタイミング | 各バッチ完了時 |
| ロールバック条件 | バッチ内での例外発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | カードあたり最大数百件 |
| 目標処理時間 | バッチサイズに依存 |
| メモリ使用量上限 | in_batchesにより制御 |

## 排他制御

同時実行の制限なし。in_batchesによる分割処理でロック競合を軽減。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | ActiveJob標準ログ |
| 終了ログ | ジョブ終了時 | ActiveJob標準ログ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗率 | 異常な増加 | ジョブ監視システム |

## 備考

- `in_batches`を使用してメモリ効率の良いバッチ削除を実行
- `destroy_all`により関連するコールバックが実行される
- カード単位の処理であり、ボード全体のクリーンアップは`Board::CleanInaccessibleDataJob`が担当
