# バッチ設計書 8-Storage::MaterializeJob

## 概要

本ドキュメントは、ストレージ使用量の実体化（マテリアライズ）処理を実行するバックグラウンドジョブ `Storage::MaterializeJob` の設計仕様を記載したものである。

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

このバッチは、ストレージ使用量の差分エントリを集約し、スナップショット（Storage::Total）に反映させる実体化処理を行う。ファイル添付などによるストレージ使用量の変動を効率的に追跡するための重要な機能を担う。

**業務上の目的・背景**：fizzyでは、ファイル添付機能によりストレージを使用する。使用量を正確に追跡するために、各操作（アップロード/削除）をエントリとして記録し、定期的にスナップショットに集約する「レジャー方式」を採用している。本ジョブは、蓄積されたエントリをスナップショットにマテリアライズすることで、ストレージ使用量の高速な参照を可能にする。

**バッチの実行タイミング**：ストレージエントリが追加された際に`materialize_storage_later`メソッドを通じて非同期でキューイングされる。

**主要な処理内容**：
1. オーナー（AccountまたはBoard）を受け取り、マテリアライズ処理を開始
2. Storage::Totalレコードを取得または作成
3. 排他ロックを取得してスナップショットを更新
4. 前回のスナップショット以降のエントリの合計を計算
5. bytes_storedとlast_entry_idを更新

**前後の処理との関連**：ファイルの添付/削除時にStorage::Entryが作成され、本ジョブがトリガーされる。`Storage::ReconcileJob`は実際のファイルサイズとレジャーの整合性を確認する補完的な役割を持つ。

**影響範囲**：`storage_totals`テーブル（スナップショット更新）

## バッチ種別

集計処理 / データマテリアライズ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（ストレージ操作時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | Storage::Entry作成時のコールバック |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| オーナーの存在 | 有効なAccount/Boardレコードが存在すること |

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| owner | Account/Board | Yes | - | ストレージオーナーオブジェクト |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| storage_totals | DB | 現在のスナップショット情報 |
| storage_entries | DB | マテリアライズ対象のエントリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| storage_totals | DB | bytes_stored, last_entry_idの更新 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. ジョブ開始
   └─ owner.materialize_storageメソッドを呼び出し
2. Storage::Total取得/作成
   └─ create_or_find_storage_total
3. 排他ロック取得
   └─ total.with_lock
4. 最新エントリID取得
   └─ storage_entries.maximum(:id)
5. 更新要否判定
   └─ latest_entry_id存在 AND last_entry_idと異なる
6. 差分計算
   └─ 前回スナップショット以降のエントリの合計
7. スナップショット更新
   └─ bytes_stored += delta_sum, last_entry_id = latest_entry_id
8. ジョブ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Storage::Total取得/作成]
    B --> C[排他ロック取得]
    C --> D[最新エントリID取得]
    D --> E{更新が必要?}
    E -->|No| F[スキップ]
    E -->|Yes| G[差分エントリ取得]
    G --> H[delta_sum計算]
    H --> I[スナップショット更新]
    I --> J[ロック解放]
    F --> J
    J --> K[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 参照/作成 | storage_totals | SELECT/INSERT | スナップショットの取得または作成 |
| 参照 | storage_entries | SELECT | エントリの取得と集計 |
| 更新 | storage_totals | UPDATE | bytes_stored, last_entry_idの更新 |

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

#### storage_totals

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT/INSERT | - | owner_type, owner_id | create_or_find_by! |
| UPDATE | bytes_stored | 現在値 + delta_sum | 累積加算 |
| UPDATE | last_entry_id | 最新エントリID | ウォーターマーク |

#### storage_entries

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | delta | id > last_entry_id AND id <= latest_entry_id | SUM集計 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

マテリアライズ失敗時は、次回のストレージ操作時に再度マテリアライズが試行される。スナップショットが古い場合でも、`bytes_used_exact`メソッドで正確な使用量を計算可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | with_lockによる排他ロック内 |
| コミットタイミング | update!完了時 |
| ロールバック条件 | 例外発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | エントリ数に依存 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | SUMクエリのため最小限 |

## 排他制御

- 同時実行制限: オーナーごとに1
- `limits_concurrency to: 1, key: ->(owner) { owner }`によりオーナー単位で同時実行を制限
- `with_lock`によりStorage::Totalレコードに排他ロックを取得

## ログ出力

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

## 監視・アラート

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

## 備考

- キュー名: `backend`
- 同時実行制限: オーナーごとに1（`limits_concurrency`）
- レジャー方式によるストレージ追跡：
  - Storage::Entry: 各操作（アップロード/削除）の差分を記録
  - Storage::Total: エントリを集約したスナップショット
- `bytes_used`: 高速参照用のマテリアライズ済みスナップショット
- `bytes_used_exact`: スナップショット + 未マテリアライズエントリの正確な使用量
- last_entry_idはウォーターマークとして機能し、重複処理を防止
