# バッチ設計書 5-Board::CleanInaccessibleDataJob

## 概要

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

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

このバッチは、特定のユーザーがボードへのアクセス権限を失った際に、そのユーザーに関連するボード上の全データ（メンション、通知、ウォッチ、ピン）を一括削除するクリーンアップ処理を行う。ユーザー単位での包括的なデータクリーンアップを担当する。

**業務上の目的・背景**：fizzyでは、ユーザーがボードへのアクセス権限を失った場合（アクセス権の取り消し、チームからの離脱など）、そのユーザーに関連する全てのボードデータは不要となる。これらのデータを適切に削除することで、データベースのクリーンさを維持し、プライバシーを保護する。特に、メンション履歴や通知履歴など、アクセス権のないコンテンツに関する情報を保持しないことが重要である。

**バッチの実行タイミング**：ユーザーのボードアクセス権限が取り消された際に非同期で実行される。

**主要な処理内容**：
1. 対象ユーザーとボードを受け取り、クリーンアップ処理を開始
2. ユーザーがまだボードにアクセス可能な場合は処理をスキップ
3. ユーザーのボード関連メンションを全削除
4. ユーザーのボード関連通知を全削除
5. ユーザーのボード関連ウォッチを全削除
6. ユーザーのボード関連ピンを全削除

**前後の処理との関連**：`Card::CleanInaccessibleDataJob`や`Card::RemoveInaccessibleNotificationsJob`がカード単位での処理を担当するのに対し、本ジョブはボード・ユーザー単位での包括的なクリーンアップを担当する。アクセス権限取り消し時に実行される。

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

## バッチ種別

データクレンジング

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ユーザーの存在 | 有効なUserレコードが存在すること |
| ボードの存在 | 有効なBoardレコードが存在すること |

### 実行可否判定

- `ActiveJob::DeserializationError`が発生した場合（User/Boardレコードが削除済みの場合など）はジョブを破棄する
- ユーザーがまだボードにアクセス可能な場合（`accessible_to?(user)`がtrueの場合）は処理をスキップ

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| users | DB | 対象ユーザー情報 |
| boards | DB | 対象ボード情報 |
| accesses | DB | ボードへのアクセス権限情報 |
| cards | DB | ボードに属するカード情報 |
| comments | DB | カードに属するコメント情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| mentions | DB | ユーザーのボード関連メンションを削除 |
| notifications | DB | ユーザーのボード関連通知を削除 |
| watches | DB | ユーザーのボード関連ウォッチを削除 |
| pins | DB | ユーザーのボード関連ピンを削除 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. ジョブ開始
   └─ board.clean_inaccessible_data_for(user)メソッドを呼び出し
2. アクセス可否チェック
   └─ accessible_to?(user)で確認、アクセス可能ならreturn
3. メンション削除
   └─ mentions_for_user(user).destroy_all
4. 通知削除
   └─ notifications_for_user(user).destroy_all
5. ウォッチ削除
   └─ watches_for(user).destroy_all
6. ピン削除
   └─ pins_for(user).destroy_all
7. ジョブ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{ユーザーはボードにアクセス可能?}
    B -->|Yes| C[処理スキップ]
    B -->|No| D[メンション削除]
    D --> E[通知削除]
    E --> F[ウォッチ削除]
    F --> G[ピン削除]
    C --> H[バッチ終了]
    G --> H
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 参照 | accesses | SELECT | アクセス権限の確認 |
| 削除 | mentions | DELETE | ユーザーのボード関連メンション削除 |
| 削除 | notifications | DELETE | ユーザーのボード関連通知削除 |
| 削除 | watches | DELETE | ユーザーのボード関連ウォッチ削除 |
| 削除 | pins | DELETE | ユーザーのボード関連ピン削除 |

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

#### mentions

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | Card→Mentionパスまたは Comment→Card→Mentionパスでボードに関連 | 複雑なJOINクエリ |

#### notifications

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | Event→Card または Event→Comment→Card でボードに関連 | 複雑なJOINクエリ |

#### watches

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | card_id IN (board.cards) AND user_id = user.id | - |

#### pins

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | card_id IN (board.cards) AND user_id = user.id | - |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

クリーンアップ失敗時は、不要データが残存する可能性がある。手動でのデータクリーンアップが必要となる場合がある。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各削除操作は個別 |
| コミットタイミング | 各destroy_all完了時 |
| ロールバック条件 | 例外発生時（部分的な削除は維持される） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ボードのサイズに依存（数百〜数千件） |
| 目標処理時間 | データ量に依存 |
| メモリ使用量上限 | destroy_allの実装に依存 |

## 排他制御

同時実行の制限なし。同一ユーザー・ボードの組み合わせで複数回実行されても、冪等性は担保される（既に削除済みのデータは再度削除されない）。

## ログ出力

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

## 監視・アラート

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

## 備考

- メンションクエリは複雑なJOINを使用：
  1. Mention→Card パス（直接カードへのメンション）
  2. Mention→Comment→Card パス（コメント内のメンション）
- 通知クエリは複雑なJOINを使用：
  1. Notification→Event→Card パス
  2. Notification→Event→Comment→Card パス
- UUIDはバイナリ形式でシリアライズされてクエリに使用される
- メンション削除が通知削除の前に行われる（Notification→Mentionの依存関係のため）
