# バッチ設計書 15-buildGenerateMigrationScript

## 概要

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

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

buildGenerateMigrationScriptは、MikroORMベースのMedusaモジュールに対してマイグレーションファイルを自動生成するためのスクリプトを生成するユーティリティ関数である。モデル定義の変更を検出し、対応するマイグレーションファイルを作成する。

**業務上の目的・背景**：Medusaの各モジュールはDML（Data Modeling Language）でモデルを定義しており、モデルの変更をデータベーススキーマに反映するためにはマイグレーションファイルが必要である。手動でマイグレーションを作成するのは手間がかかり、エラーが発生しやすい。このユーティリティは現在のモデル定義とデータベーススキーマのスナップショットを比較し、差分を検出して自動的にマイグレーションファイルを生成する。

**バッチの実行タイミング**：開発者がモデル定義を変更した後、マイグレーションファイルを生成する必要がある際に手動で実行される。通常は開発フェーズで使用される。

**主要な処理内容**：
1. モジュール名、モデル、マイグレーションパスを受け取りスクリプト関数を生成
2. データベース設定の読み込み（loadDatabaseConfig）
3. モデルをMikroORMエンティティに変換（toMikroOrmEntities）
4. MikroORM接続の作成（スナップショット名付き）
5. Migrationsクラスによるマイグレーション生成

**前後の処理との関連**：buildMigrationScriptの前段階として使用される。生成されたマイグレーションファイルは、buildMigrationScriptで実行される。

**影響範囲**：マイグレーションファイルの生成（ファイルシステム）、スナップショットファイルの更新。

## バッチ種別

マイグレーション生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（開発時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| PostgreSQL接続可能 | データベースサーバーに接続できること（スキーマ比較用） |
| モデル定義存在 | modelsパラメータにモジュールのモデル定義が渡されること |
| MikroORMベースモジュール | このユーティリティはMikroORMを使用するモジュールでのみ有効 |

### 実行可否判定

1. loadDatabaseConfigでデータベース設定を取得
2. 設定が取得できない場合は処理を中断
3. モデル定義が存在することを確認

## 入力仕様

### 入力パラメータ

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

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

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| モデル定義 | TypeScript/DML | モジュールのエンティティモデル |
| スナップショット | JSONファイル | 前回のスキーマ状態 |
| データベース設定 | 設定オブジェクト | loadDatabaseConfigから取得 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| マイグレーションファイル | TypeScript | pathToMigrationsディレクトリに出力 |
| スナップショットファイル | JSON | 現在のスキーマ状態を保存 |
| 標準出力 | コンソール | 実行ログ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | Migration{timestamp}_{random}.ts |
| 出力先 | pathToMigrationsで指定されたディレクトリ |
| 文字コード | UTF-8 |
| スナップショット名 | .snapshot-{kebabCase(moduleName)} |

## 処理フロー

### 処理シーケンス

```
1. buildGenerateMigrationScript呼び出し
   └─ moduleName、models、pathToMigrationsを受け取り関数を生成
2. 生成された関数の実行
   └─ options、loggerを受け取る
3. ログヘッダー出力
   └─ ターミナル幅分の区切り線とモジュール名を出力
4. データベース設定読み込み
   └─ loadDatabaseConfig(moduleName, options)
5. モデル変換
   └─ toMikroOrmEntities(models)でMikroORMエンティティに変換
6. スナップショット名生成
   └─ .snapshot-{kebabCase(moduleName.replace("Service", ""))}
7. MikroORM接続作成
   └─ mikroOrmCreateConnection(dbData, normalizedModels, pathToMigrations)
8. Migrationsインスタンス生成
   └─ new Migrations(orm)
9. マイグレーション生成
   └─ migrations.generate()
10. 結果判定・ログ出力
    └─ 生成あり: "Generated successfully ({fileName})."
    └─ 生成なし: "Skipped. No changes detected in your models."
```

### フローチャート

```mermaid
flowchart TD
    A[buildGenerateMigrationScript呼び出し] --> B[関数を生成して返却]
    B --> C[生成関数の実行]
    C --> D[ログヘッダー出力]
    D --> E[loadDatabaseConfig]
    E --> F[toMikroOrmEntitiesでモデル変換]
    F --> G[スナップショット名生成]
    G --> H[mikroOrmCreateConnection]
    H --> I[Migrationsインスタンス生成]
    I --> J[migrations.generate実行]
    J --> K{マイグレーション生成?}
    K -->|Yes| L[Generated successfully ログ]
    K -->|No| M[Skipped - No changes ログ]
    L --> N[処理終了]
    M --> N
    J --> O{エラー発生?}
    O -->|Yes| P[エラーログ出力]
    P --> N
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スキーマ情報取得 | information_schema | SELECT | 現在のスキーマ構造を取得 |

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

このスクリプトはデータベースに対して読み取り専用の操作のみを行う。テーブルの変更はマイグレーション実行時に行われる。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 接続エラー | データベースに接続できない | 接続設定を確認 |
| - | モデル変換エラー | モデル定義が不正 | モデル定義を確認 |
| - | ファイル書き込みエラー | 出力先に書き込めない | ディレクトリの権限を確認 |

### リトライ仕様

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

### 障害時対応

1. エラーログを確認し、失敗箇所を特定
2. モデル定義の問題の場合はDML構文を確認
3. 接続の問題の場合はデータベース設定を確認
4. ファイル出力の問題の場合はディレクトリの存在と権限を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 読み取りのみ（トランザクション不要） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行で1つのマイグレーションファイル |
| 目標処理時間 | 数秒 |
| メモリ使用量上限 | Node.jsデフォルト制限 |

## 排他制御

同一モジュールに対する同時実行は想定していない。ファイル競合を避けるため、シングルプロセスで実行すること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 関数実行開始時 | MODULE: {moduleName} |
| 終了ログ | 生成完了時 | Generated successfully ({fileName}). / Skipped. No changes detected |
| エラーログ | エラー発生時 | Failed with error {error.message} |

## 監視・アラート

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

## 備考

- このユーティリティはMikroORMベースのモジュール専用
- スナップショット名はモジュール名からkebabCaseで生成される（例: ProductService -> .snapshot-product）
- toMikroOrmEntitiesはMedusaのDMLモデルをMikroORMのエンティティスキーマに変換する
- 変更が検出されなかった場合はファイルは生成されない
- 生成されるマイグレーションファイルにはupメソッドとdownメソッドが含まれる
