# バッチ設計書 60-ActiveStorage::CreateVariantsJob

## 概要

本ドキュメントは、プレビュー画像とバリアントを作成するActiveJobクラスについて記載する。

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

このジョブは、プレビュー可能なファイル（PDF、動画等）のプレビュー画像を生成し、さらに指定されたバリアント（サムネイル等）を生成するためのActiveJobクラスである。非推奨のPreviewImageJobの後継として導入された。

**業務上の目的・背景**：PDFや動画ファイルは直接ブラウザに表示できないため、プレビュー画像を生成する必要がある。また、画像ファイルは表示場所に応じて様々なサイズのバリアントが必要になる。本ジョブにより、これらの処理を非同期で一括して行うことができ、ユーザー体験を向上させる。同期実行と非同期実行の両方に対応しており、用途に応じて柔軟に使用できる。

**バッチの実行タイミング**：Attachmentの作成時にprocess_variants_laterメソッドから呼び出される場合、または明示的にエンキューされた場合。

**主要な処理内容**：
1. Blobオブジェクト、バリアント設定、処理モードを引数として受け取る
2. プレビュー画像が必要な場合は生成
3. 各バリアントに対してTransformJobを呼び出し（同期/非同期は処理モードに依存）

**前後の処理との関連**：Attachmentのafter_create_commitで呼び出される。TransformJobを呼び出してバリアントを生成する。

**影響範囲**：プレビュー画像の生成、バリアントファイルの生成、TransformJobのエンキュー。

## バッチ種別

データ変換（プレビュー・バリアント生成）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベントドリブン） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | Attachment作成時、または明示的なperform_later |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Blobレコード存在 | 対象のBlobレコードがデータベースに存在すること |
| ファイル存在 | Blobに紐づくファイルがストレージサービス上に存在すること |
| プレビューツール | FFmpeg等のプレビュー生成に必要なツールがインストールされていること（プレビュー生成時） |
| 変換ツール | ImageMagick等の変換処理に必要なツールがインストールされていること |

### 実行可否判定

特別な実行可否判定なし。エンキューされたジョブは実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| blob | ActiveStorage::Blob | Yes | - | 対象のBlobオブジェクト |
| variants | Array | Yes | - | 生成するバリアントの変換パラメータ配列（キーワード引数） |
| process | Symbol | Yes | - | 処理モード（:immediately または :later）（キーワード引数） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| active_storage_blobs | DB | Blobレコード |
| ストレージサービス | バイナリ | 元のファイル実体 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| active_storage_attachments | DB | プレビュー画像のattachment |
| active_storage_variant_records | DB | バリアントレコード |
| ストレージサービス | バイナリ | プレビュー画像・バリアントファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | プレビュー画像・バリアントのキー |
| 出力先 | ストレージサービス |
| 文字コード | - |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. ジョブ受信
   └─ Blobオブジェクト、variants、processをデシリアライズ
2. プレビュー画像チェック
   └─ preview_image_needed?でプレビュー画像の必要性を判定
3. プレビュー画像生成（必要な場合）
   └─ create_preview_imageでblob.preview({}).processed実行
4. バリアント生成
   └─ 各variantに対してTransformJobを呼び出し
   └─ processが:immediatelyならperform_now、:laterならperform_later
```

### フローチャート

```mermaid
flowchart TD
    A[ジョブ開始] --> B{Blobレコード存在?}
    B -->|No| C[discard_on: RecordNotFound]
    B -->|Yes| D{preview_image_needed?}
    D -->|Yes| E[create_preview_image]
    D -->|No| F[各variantをループ]
    E --> F
    F --> G{process == :immediately?}
    G -->|Yes| H[TransformJob.perform_now]
    G -->|No| I[TransformJob.perform_later]
    H --> J{次のvariant?}
    I --> J
    J -->|Yes| F
    J -->|No| K[ジョブ完了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| プレビュー画像記録 | active_storage_attachments | INSERT | プレビュー画像のattachment作成 |
| プレビュー画像Blob | active_storage_blobs | INSERT | プレビュー画像のBlob作成 |

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

#### active_storage_attachments

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | record_type, record_id, name | preview_image関連情報 | プレビュー画像として関連付け |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ActiveRecord::RecordNotFound | Blobレコードが削除されている | discard_on: ジョブを破棄 |
| - | ActiveStorage::IntegrityError | ファイルのチェックサム不一致 | retry_on: 最大10回リトライ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 最大10回 |
| リトライ間隔 | polynomially_longer（多項式的に増加） |
| リトライ対象エラー | ActiveStorage::IntegrityError |

### 障害時対応

1. RecordNotFound発生時：Blobが既に削除されているため、正常な動作としてジョブは破棄される
2. IntegrityError発生時：ファイルが破損または不完全にアップロードされている可能性あり。リトライで解消されることが多い

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | プレビュー画像の作成（processed内部） |
| コミットタイミング | processed完了時 |
| ロールバック条件 | 作成エラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件/ジョブ（バリアント数分のTransformJobが派生） |
| 目標処理時間 | ファイルサイズ・バリアント数に依存 |
| メモリ使用量上限 | ファイルサイズに依存 |

## 排他制御

同一Blobに対する複数のCreateVariantsJobは並列実行可能。プレビュー画像・バリアントの作成は冪等性が保証される。

## ログ出力

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

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| リトライ回数 | 10回超過時 | アプリケーションログ監視 |
| キュー滞留 | 運用ポリシーに依存 | キュー監視システム |

## 備考

- キュー名: ActiveStorage.queues[:transform]（デフォルト: active_storage_transform）
- PreviewImageJobの後継として導入された
- process引数で同期/非同期を制御：
  - `:immediately` - TransformJob.perform_nowで同期実行
  - `:later` - TransformJob.perform_laterで非同期実行
- preview_image_needed?の条件：
  - blob.previewable? がtrue
  - かつ blob.preview_image.attached? がfalse
- Attachmentの設定（has_one_attached等）でprocessオプションを指定することで、バリアント生成のタイミングを制御可能
