# バッチ設計書 49-active_storage:update

## 概要

本ドキュメントは、Active Storageのアップグレード用マイグレーションをコピーするRakeタスク `active_storage:update` の設計仕様を定義する。

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

`active_storage:update` タスクは、Active Storageのバージョンアップに伴う追加マイグレーション（新機能対応など）をアプリケーションにコピーするアップグレードタスクである。MIGRATIONS_PATH環境変数を `db/update_migrate` に設定して、通常のマイグレーションとは別のディレクトリにアップグレード用マイグレーションを配置する。

**業務上の目的・背景**：Active Storageは、Railsのバージョンアップに伴い新機能が追加されることがある（例：variant_recordsテーブルの追加など）。既存のアプリケーションをアップグレードする際、これらの新機能に対応するマイグレーションを適用する必要がある。本タスクは、アップグレード用のマイグレーションを特別なディレクトリにコピーすることで、初回インストール用のマイグレーションと区別して管理できるようにする。

**バッチの実行タイミング**：手動実行が主体であり、以下のような場面で使用される。
- Railsのメジャー・マイナーバージョンアップ後
- Active Storageの新機能を利用したい場合

**主要な処理内容**：
1. MIGRATIONS_PATH環境変数を "db/update_migrate" に設定
2. active_storage:install タスクが定義されているか確認
3. 定義されている場合は active_storage:install を実行
4. 定義されていない場合は app:active_storage:install を実行
5. アップグレード用マイグレーションをdb/update_migrateにコピー

**前後の処理との関連**：本タスクは内部で `active_storage:install` を呼び出す。MIGRATIONS_PATHが設定されているため、マイグレーションは通常のdb/migrateではなくdb/update_migrateにコピーされる。適用時はマイグレーションパスを指定する必要がある場合がある。

**影響範囲**：db/update_migrateディレクトリにマイグレーションファイルを追加する。通常のマイグレーションディレクトリ（db/migrate）には影響しない。

## バッチ種別

アップグレード / マイグレーション管理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（アップグレード時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動（bin/rails active_storage:update） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Active Storage導入済み | active_storage:installが実行済みであること |
| Rails環境 | Railsアプリケーションであること |

### 実行可否判定

Active Storageが導入されていれば実行可能。追加のマイグレーションがない場合は、何もコピーされない。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要（MIGRATIONS_PATHは内部設定） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| activestorage gemのアップグレードマイグレーション | Ruby | コピー元のマイグレーションファイル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | コピー結果のメッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | アップグレードマイグレーションファイル |
| 出力先 | db/update_migrate/ |
| 内容 | バージョンアップに伴う追加テーブル・カラムの変更 |

## 処理フロー

### 処理シーケンス

```
1. 環境のロード
   └─ :environment 依存でRails環境をロード
2. MIGRATIONS_PATH の設定
   └─ ENV["MIGRATIONS_PATH"] = "db/update_migrate"
3. タスク存在確認
   └─ Rake::Task.task_defined?("active_storage:install") を確認
4. install タスクの実行
   └─ 該当する install タスクを invoke
5. マイグレーションコピー
   └─ db/update_migrate にマイグレーションファイルをコピー
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[:environment でRails環境ロード]
    B --> C[MIGRATIONS_PATH = db/update_migrate 設定]
    C --> D{active_storage:install 定義あり？}
    D -->|Yes| E[active_storage:install 実行]
    D -->|No| F[app:active_storage:install 実行]
    E --> G[マイグレーションをdb/update_migrateにコピー]
    F --> G
    G --> H{マイグレーションあり？}
    H -->|Yes| I[コピー完了メッセージ出力]
    H -->|No| J[処理なしで終了]
    I --> K[バッチ終了]
    J --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | 本タスク自体はDB操作なし |

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

本タスクはマイグレーションファイルのコピーのみ。マイグレーション適用は別途実行が必要。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル書き込みエラー | 権限不足 | db/update_migrateの権限を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

### 障害時対応

権限エラーの場合は、db/update_migrateディレクトリの書き込み権限を確認するか、手動でディレクトリを作成する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | なし |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 即時（数秒以内） |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行は推奨されない。ただし、同名ファイルはスキップされるため競合は発生しにくい。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | コピー時 | "Copied migration xxx from active_storage" |
| 標準出力 | スキップ時 | "NOTE: Migration xxx has been skipped..." |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクはアップグレード時のみ実行されるため、監視は不要。

## 備考

- アップグレード後は適切なマイグレーションパスを指定して `db:migrate` を実行する必要がある
- db/update_migrateディレクトリは自動作成される場合がある
- 通常のdb/migrateにコピーしたい場合は `active_storage:install` を使用する
- このタスクのdescは定義されていない（内部タスク扱い）
- Rails公式のアップグレードガイドに従って使用することを推奨
