# バッチ設計書 59-ActiveStorage::PreviewImageJob

## 概要

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

**注意：本ジョブは非推奨（deprecated）であり、Rails 9.0で削除予定です。代わりにActiveStorage::CreateVariantsJobを使用してください。**

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

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

**業務上の目的・背景**：PDFや動画ファイルは直接ブラウザに表示できないため、プレビュー画像を生成する必要がある。本ジョブは非同期でプレビュー画像を生成し、ユーザー体験を向上させる。しかし、より柔軟で機能が拡張されたCreateVariantsJobが導入されたため、本ジョブは非推奨となった。

**バッチの実行タイミング**：明示的にエンキューされた場合のみ実行される。新規コードでは使用しないこと。

**主要な処理内容**：
1. Blobオブジェクトとバリアント設定を引数として受け取る
2. blob.preview({}).processedでプレビュー画像を生成
3. 各バリアントに対してTransformJobをエンキュー

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

**影響範囲**：プレビュー画像の生成、TransformJobのエンキュー。

## バッチ種別

データ変換（プレビュー・バリアント生成） - **非推奨**

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベントドリブン） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 明示的なperform_later呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Blobレコード存在 | 対象のBlobレコードがデータベースに存在すること |
| プレビュー可能 | Blobがpreviewable?であること |
| プレビューツール | FFmpeg等のプレビュー生成に必要なツールがインストールされていること |

### 実行可否判定

initializeで非推奨警告を出力する。エンキューされたジョブは実行される。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| blob | ActiveStorage::Blob | Yes | - | 対象のBlobオブジェクト |
| variations | Array | Yes | - | 生成するバリアントの変換パラメータ配列 |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ストレージサービス | バイナリ | プレビュー画像 |
| ActiveJob キュー | ジョブ | TransformJobのエンキュー |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. 非推奨警告出力
   └─ initializeで警告メッセージを出力
2. ジョブ受信
   └─ Blobオブジェクトとvariationsをデシリアライズ
3. プレビュー生成
   └─ blob.preview({}).processedでプレビュー画像生成
4. バリアント生成エンキュー
   └─ 各variationに対してTransformJobをperform_later
```

### フローチャート

```mermaid
flowchart TD
    A[ジョブ開始] --> B[非推奨警告出力]
    B --> C{Blobレコード存在?}
    C -->|No| D[discard_on: RecordNotFound]
    C -->|Yes| E[blob.preview.processed]
    E --> F{UnrepresentableError?}
    F -->|Yes| G[discard_on: ジョブ破棄]
    F -->|No| H[各variationをループ]
    H --> I{blob.representable?}
    I -->|Yes| J[TransformJob.perform_later]
    I -->|No| K[スキップ]
    J --> L{次のvariation?}
    K --> L
    L -->|Yes| H
    L -->|No| M[ジョブ完了]
```

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

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

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

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

#### active_storage_attachments

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

### 障害時対応

1. RecordNotFound発生時：Blobが既に削除されているため、正常な動作としてジョブは破棄される
2. UnrepresentableError発生時：プレビュー生成不可能なファイル形式。正常な動作としてジョブは破棄される
3. IntegrityError発生時：リトライで解消されることが多い

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件/ジョブ |
| 目標処理時間 | ファイルサイズ・種類に依存（通常数秒〜数十秒） |
| メモリ使用量上限 | ファイルサイズに依存 |

## 排他制御

同一Blobに対する複数のPreviewImageJobは並列実行可能。プレビュー画像の作成はfind_or_createで冪等性が保証される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 非推奨警告 | initialize時 | "ActiveStorage::PreviewImageJob is no longer used by Rails..." |
| ジョブログ | ジョブ開始/終了時 | ActiveJob標準のログ出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 非推奨ジョブ使用 | 発生時 | 開発者（マイグレーション促進） |
| リトライ回数 | 10回超過時 | アプリケーションログ監視 |

## 備考

- **非推奨警告**：本ジョブはRails 9.0で削除予定。ActiveStorage::CreateVariantsJobを使用すること
- キュー名: ActiveStorage.queues[:preview_image]（デフォルト: active_storage_preview_image）
- プレビュー可能なファイル形式：PDF、動画等（Previewerが設定されているもの）
- 非推奨警告メッセージ：
  ```
  ActiveStorage::PreviewImageJob is no longer used by Rails.
  It is deprecated and will be removed in Rails 9.0.
  Use the ActiveStorage::CreateVariantsJob instead.
  ```
