# バッチ設計書 14-buildRevertMigrationScript

## 概要

本ドキュメントは、Medusaフレームワークにおけるモジュール用マイグレーションロールバックスクリプトビルダー「buildRevertMigrationScript」の設計仕様を定義する。

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

buildRevertMigrationScriptは、MikroORMベースのMedusaモジュールに対してマイグレーションをロールバック（巻き戻し）するためのスクリプトを生成するユーティリティ関数である。各モジュールが独自のロールバックスクリプトを持つことを可能にし、データベーススキーマ変更の取り消しを標準化する。

**業務上の目的・背景**：マイグレーションによるスキーマ変更を適用した後、問題が発見された場合や開発中にスキーマを変更する必要がある場合に、安全にロールバックする仕組みが必要である。このユーティリティはbuildMigrationScriptと対になり、マイグレーションのライフサイクル管理を完結させる。本番環境でのデプロイ失敗時の緊急対応や、開発環境でのスキーマ実験にも活用される。

**バッチの実行タイミング**：db:rollbackコマンド実行時に各モジュールのロールバックスクリプトが呼び出される。また、開発中にモジュール単体でロールバックを実行する際にも使用される。

**主要な処理内容**：
1. モジュール名とマイグレーションパスを受け取りスクリプト関数を生成
2. データベース設定の読み込み（loadDatabaseConfig）
3. MikroORM接続の作成（mikroOrmCreateConnection）
4. Migrationsクラスによるマイグレーションのロールバック実行
5. 進捗イベント（reverting、reverted、revert:skipped）のハンドリング

**前後の処理との関連**：db:rollbackコマンドの内部で使用される。buildMigrationScriptと対になる関数で、マイグレーションの適用とロールバックを対称的に管理する。

**影響範囲**：指定されたモジュールのデータベーステーブル、mikro_orm_migrationsテーブル（マイグレーション履歴）。

## バッチ種別

マイグレーションロールバック

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（db:rollback実行時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | CLIコマンド / プログラム呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PostgreSQL接続可能 | データベースサーバーに接続できること |
| マイグレーション実行済み | ロールバック対象のマイグレーションが適用済みであること |
| MikroORMベースモジュール | このユーティリティはMikroORMを使用するモジュールでのみ有効 |

### 実行可否判定

1. loadDatabaseConfigでデータベース設定を取得
2. 設定が取得できない場合は処理を中断
3. mikro_orm_migrationsテーブルでロールバック対象のマイグレーションを確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| moduleName | string | Yes | - | モジュール名（ログ出力に使用） |
| pathToMigrations | string | Yes | - | マイグレーションファイルのディレクトリパス |

### 生成される関数のパラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| options | ModuleServiceInitializeOptions | No | {} | モジュール初期化オプション |
| logger | Logger | No | console | ログ出力用Logger |
| migrationNames | string[] | No | undefined | ロールバック対象のマイグレーション名の配列 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| マイグレーションファイル | TypeScript | pathToMigrationsディレクトリ内のマイグレーションファイル |
| データベース設定 | 設定オブジェクト | loadDatabaseConfigから取得 |
| マイグレーション履歴 | DBテーブル | mikro_orm_migrationsテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| mikro_orm_migrations | DBテーブル | ロールバック済みマイグレーションの削除 |
| 対象テーブル | DBテーブル | マイグレーションで定義された変更の取り消し |
| 標準出力 | コンソール | 実行ログ |

### 出力ファイル仕様

ファイル出力はなし。

## 処理フロー

### 処理シーケンス

```
1. buildRevertMigrationScript呼び出し
   └─ moduleName、pathToMigrationsを受け取り関数を生成
2. 生成された関数の実行
   └─ options、logger、migrationNamesを受け取る
3. ログヘッダー出力
   └─ ターミナル幅分の区切り線とモジュール名を出力
4. データベース設定読み込み
   └─ loadDatabaseConfig(moduleName, options)
5. MikroORM接続作成
   └─ mikroOrmCreateConnection(dbData, [], pathToMigrations)
6. Migrationsインスタンス生成
   └─ new Migrations(orm)
7. イベントハンドラ登録
   └─ "reverting": ロールバック開始時のログ
   └─ "reverted": ロールバック完了時のログ
   └─ "revert:skipped": スキップ時のログ
8. ロールバックオプション設定
   └─ migrationNames指定時: { step: migrationNames.length }
   └─ 未指定時: undefined
9. ロールバック実行
   └─ migrations.revert(revertOptions)
10. 結果判定・ログ出力
    └─ 実行あり: "Reverted successfully"
    └─ 実行なし: "Skipped. Nothing to revert"
```

### フローチャート

```mermaid
flowchart TD
    A[buildRevertMigrationScript呼び出し] --> B[関数を生成して返却]
    B --> C[生成関数の実行]
    C --> D[ログヘッダー出力]
    D --> E[loadDatabaseConfig]
    E --> F[mikroOrmCreateConnection]
    F --> G[Migrationsインスタンス生成]
    G --> H[イベントハンドラ登録]
    H --> I{migrationNames指定?}
    I -->|Yes| J[step: migrationNames.length]
    I -->|No| K[オプションなし]
    J --> L[migrations.revert実行]
    K --> L
    L --> M{ロールバック実行あり?}
    M -->|Yes| N[Reverted successfully]
    M -->|No| O[Skipped - Nothing to revert]
    N --> P[処理終了]
    O --> P
    L --> Q{エラー発生?}
    Q -->|Yes| R[エラーログ出力]
    R --> S[MedusaError throw]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ロールバック実行 | mikro_orm_migrations | DELETE | ロールバック済みマイグレーション履歴を削除 |
| ロールバック実行 | モジュールテーブル | DROP/ALTER | スキーマ変更の取り消し |

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

#### mikro_orm_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | name | ロールバック対象のマイグレーション名 | 履歴から削除 |
| SELECT | name | - | ロールバック対象の特定 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| DB_ERROR | MedusaError | ロールバック実行中のエラー | エラーメッセージを確認し原因を特定 |
| - | 接続エラー | データベースに接続できない | 接続設定を確認 |
| - | ロールバック不可 | downメソッドが実装されていない | マイグレーションファイルを確認 |

### リトライ仕様

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

### 障害時対応

1. エラーログを確認し、失敗箇所を特定
2. マイグレーションファイルのdownメソッドを確認
3. 部分的にロールバックされた場合は手動で対処
4. データ整合性を確認し、必要に応じてバックアップから復元

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ロールバック単位 |
| コミットタイミング | 各ロールバック完了時 |
| ロールバック条件 | ロールバック内でエラー発生時（自動ロールバック） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ロールバック対象のマイグレーション数による |
| 目標処理時間 | マイグレーション内容による |
| メモリ使用量上限 | Node.jsデフォルト制限 |

## 排他制御

ロールバック実行時はPostgreSQLのトランザクションロックにより他の操作との競合を防止。同一モジュールに対する同時実行は想定していない。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 関数実行開始時 | MODULE: {moduleName} |
| 進捗ログ | 各ロールバック開始時 | Reverting {migration.name} |
| 進捗ログ | 各ロールバック完了時 | Reverted {migration.name} |
| 進捗ログ | スキップ時 | Skipped {migration.name}. {reason} |
| 終了ログ | 全ロールバック完了時 | Reverted successfully / Skipped |
| エラーログ | エラー発生時 | Failed with error {error.message} |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| エラー発生 | 1件以上 | 標準エラー出力 |

## 備考

- このユーティリティはMikroORMベースのモジュール専用。カスタムマネージャーを使用する場合は、開発者自身でロールバック処理を実装する必要がある
- migrationNamesが指定された場合、その配列の長さ分だけロールバックを実行（step オプション）
- migrationNamesが未指定の場合、直近1件のマイグレーションをロールバック
- revert:skippedイベントはマイグレーションがスキップされた理由も含めてログ出力
- MedusaError.Types.DB_ERRORとしてエラーをラップして再throw。エラーコードも保持される
