# バッチ設計書 13-buildMigrationScript

## 概要

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

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

buildMigrationScriptは、MikroORMベースのMedusaモジュールに対してマイグレーションを実行するためのスクリプトを生成するユーティリティ関数である。各モジュールが独自のマイグレーションスクリプトを持つことを可能にし、データベーススキーマの管理を標準化する。

**業務上の目的・背景**：Medusaは30以上のモジュラーコマースパッケージで構成されており、各モジュールが独自のデータベーススキーマを持つ。モジュールごとにマイグレーションを管理・実行する仕組みが必要であり、このユーティリティはその標準的なパターンを提供する。開発者は各モジュールでこの関数を使用してマイグレーションスクリプトをビルドし、一貫した方法でスキーマ変更を適用できる。

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

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

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

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

## バッチ種別

マイグレーション実行

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PostgreSQL接続可能 | データベースサーバーに接続できること |
| マイグレーションファイル存在 | pathToMigrationsで指定されたディレクトリにマイグレーションファイルが存在すること |
| MikroORMベースモジュール | このユーティリティはMikroORMを使用するモジュールでのみ有効 |

### 実行可否判定

1. loadDatabaseConfigでデータベース設定を取得
2. 設定が取得できない場合は処理を中断
3. mikro_orm_migrationsテーブルで実行済みマイグレーションを確認

## 入力仕様

### 入力パラメータ

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

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

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| options | ModuleServiceInitializeOptions | No | {} | モジュール初期化オプション |
| logger | Logger | No | console | ログ出力用Logger |

### 入力データソース

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

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| mikro_orm_migrations | DBテーブル | 実行済みマイグレーションの履歴 |
| 対象テーブル | DBテーブル | マイグレーションで定義された変更 |
| 標準出力 | コンソール | 実行ログ |

### 出力ファイル仕様

ファイル出力はなし。

## 処理フロー

### 処理シーケンス

```
1. buildMigrationScript呼び出し
   └─ moduleName、pathToMigrationsを受け取り関数を生成
2. 生成された関数の実行
   └─ options、loggerを受け取る
3. ログヘッダー出力
   └─ ターミナル幅分の区切り線とモジュール名を出力
4. データベース設定読み込み
   └─ loadDatabaseConfig(moduleName, options)
5. MikroORM接続作成
   └─ mikroOrmCreateConnection(dbData, [], pathToMigrations)
6. Migrationsインスタンス生成
   └─ new Migrations(orm)
7. イベントハンドラ登録
   └─ "migrating": マイグレーション開始時のログ
   └─ "migrated": マイグレーション完了時のログ
8. マイグレーション実行
   └─ migrations.run()
9. 結果判定・ログ出力
   └─ 実行あり: "Completed successfully"
   └─ 実行なし: "Skipped. Database is up-to-date for module."
10. 結果を返却
```

### フローチャート

```mermaid
flowchart TD
    A[buildMigrationScript呼び出し] --> B[関数を生成して返却]
    B --> C[生成関数の実行]
    C --> D[ログヘッダー出力]
    D --> E[loadDatabaseConfig]
    E --> F[mikroOrmCreateConnection]
    F --> G[Migrationsインスタンス生成]
    G --> H[イベントハンドラ登録]
    H --> I[migrations.run実行]
    I --> J{マイグレーション実行あり?}
    J -->|Yes| K[Completed successfully]
    J -->|No| L[Skipped - up-to-date]
    K --> M[結果を返却]
    L --> M
    I --> N{エラー発生?}
    N -->|Yes| O[エラーログ出力]
    O --> P[MedusaError throw]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション実行 | mikro_orm_migrations | INSERT | 実行済みマイグレーションを記録 |
| マイグレーション実行 | モジュールテーブル | CREATE/ALTER/DROP | スキーマ変更の適用 |

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

#### mikro_orm_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | name | マイグレーションファイル名 | 実行完了時に記録 |
| INSERT | executed_at | 実行日時 | 自動設定 |
| SELECT | name | - | 実行済み判定用 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| DB_ERROR | MedusaError | マイグレーション実行中のエラー | エラーメッセージを確認し原因を特定 |
| - | 接続エラー | データベースに接続できない | 接続設定を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーログを確認し、失敗箇所を特定
2. マイグレーションファイルの問題の場合はSQL構文を確認
3. 部分的に適用された場合は手動でロールバックするか、db:rollbackを使用
4. 依存関係の問題の場合はマイグレーション順序を確認

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

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

## パフォーマンス要件

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

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 関数実行開始時 | MODULE: {moduleName} |
| 進捗ログ | 各マイグレーション開始時 | Migrating {migration.name} |
| 進捗ログ | 各マイグレーション完了時 | Migrated {migration.name} |
| 終了ログ | 全マイグレーション完了時 | Completed successfully / Skipped |
| エラーログ | エラー発生時 | Failed with error {error.message} |

## 監視・アラート

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

## 備考

- このユーティリティはMikroORMベースのモジュール専用。カスタムマネージャーを使用する場合は、開発者自身でマイグレーション処理を実装する必要がある
- TERMINAL_SIZEはprocess.stdout.columnsから取得し、区切り線の長さを調整
- イベント駆動で進捗をログ出力するため、長時間のマイグレーションでも進捗が確認可能
- MedusaError.Types.DB_ERRORとしてエラーをラップして再throw
