# バッチ設計書 9-db:migrate:scripts

## 概要

本ドキュメントはMedusa CLIのdb:migrate:scriptsコマンドについて、その設計内容を記述したバッチ設計書です。本コマンドはmigration-scriptsディレクトリに配置されたマイグレーションスクリプトを実行します。

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

db:migrate:scriptsは、データベースマイグレーション後に実行が必要なカスタムスクリプトを管理・実行するCLIコマンドです。スキーマ変更だけでは対応できないデータ移行や初期化処理を実行します。

**業務上の目的・背景**：データベースマイグレーション（db:migrate）はテーブルスキーマの変更を行いますが、既存データの変換、デフォルト値の設定、モジュール間のリンク作成など、スキーマ変更だけでは対応できない処理があります。db:migrate:scriptsは、これらの追加処理を管理し、一度だけ実行されることを保証します。Medusa本体のマイグレーションスクリプト（migrate-product-shipping-profile、migrate-tax-region-provider、create-super-admin-roleなど）に加え、プラグイン固有のスクリプトも実行できます。

**バッチの実行タイミング**：通常はdb:migrateコマンドから自動的に呼び出されますが、単独でCLI実行することも可能です。

**主要な処理内容**：
1. データベースの存在確認
2. プラグイン設定のマージ
3. リンク定義のロード
4. アプリケーションリソースの開始
5. 未実行スクリプトの特定
6. スクリプトの順次実行
7. リソースのシャットダウン

**前後の処理との関連**：db:migrateコマンドから呼び出される場合が多いです。MedusaModule.clearInstances()でキャッシュをクリアし、新鮮な状態でモジュールをロードします。

**影響範囲**：マイグレーションスクリプトの内容に依存します。データベースの各種テーブル、モジュール間リンクなどが影響を受ける可能性があります。

## バッチ種別

CLIコマンド / マイグレーションスクリプト実行

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（デプロイ・アップデート時） |
| 実行時刻 | 手動実行またはdb:migrateから呼び出し |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `npx medusa db:migrate:scripts`コマンド |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続設定 | 有効なデータベース接続設定が存在すること |
| db:migrateの実行 | データベースマイグレーションが完了していること（推奨） |
| Node.js環境 | Node.jsランタイムが利用可能であること |

### 実行可否判定

- 未実行のスクリプトがない場合は早期終了（正常）
- 各スクリプトのdefineFileConfig設定によりスキップ可能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| directory | string | Yes | カレントディレクトリ | プロジェクトのルートディレクトリ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| @medusajs/medusa/migration-scripts | TypeScript/JavaScript | Medusa本体のスクリプト |
| プラグイン/migration-scripts | TypeScript/JavaScript | プラグインのスクリプト |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| migration_scripts_migrations | DB | 実行済みスクリプトの記録 |
| 各スクリプトの出力先 | DB等 | スクリプト依存 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 環境設定
   └─ MEDUSA_WORKER_MODE = "server"
2. コンテナ初期化
   └─ initializeContainer(directory)
3. データベース確認
   └─ ensureDbExists(container)
4. プラグインロード
   └─ getResolvedPlugins → mergePluginModules
5. モジュールキャッシュクリア
   └─ MedusaModule.clearInstances()
6. リンク定義ロード
   └─ LinkLoader(linksSourcePaths).load()
7. アプリケーションリソース開始
   └─ MedusaAppLoader().load() → onApplicationStart()
8. スクリプトパス収集
   └─ @medusajs/medusa + プラグインのmigration-scripts
9. マイグレーションテーブル確保
   └─ MigrationScriptsMigrator.ensureMigrationsTable()
10. 未実行スクリプト取得
    └─ migrator.getPendingMigrations(scriptsSourcePaths)
11. スクリプト実行
    └─ migrator.run(scriptsSourcePaths)
12. リソースシャットダウン
    └─ onApplicationPrepareShutdown → onApplicationShutdown
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド開始] --> B[コンテナ初期化]
    B --> C[ensureDbExists]
    C --> D[プラグインロード]
    D --> E[MedusaModule.clearInstances]
    E --> F[リンク定義ロード]
    F --> G[アプリケーション開始]
    G --> H[スクリプトパス収集]
    H --> I[マイグレーションテーブル確保]
    I --> J[未実行スクリプト取得]
    J --> K{未実行あり?}
    K -->|No| L[No pending scripts]
    K -->|Yes| M[スクリプト一覧表示]
    M --> N[スクリプト実行]
    N --> O[完了ログ]
    L --> P[リソースシャットダウン]
    O --> P
    P --> Q[終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| テーブル確保 | migration_scripts_migrations | CREATE TABLE | 履歴テーブル作成 |
| 未実行取得 | migration_scripts_migrations | SELECT | 実行済みスクリプト確認 |
| 実行記録 | migration_scripts_migrations | INSERT | 実行完了記録 |
| スクリプト実行 | 各種 | 依存 | スクリプト内容による |

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

#### migration_scripts_migrations

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name | 全件取得 | 実行済み確認 |
| INSERT | name, executed_at | スクリプト名, 現在時刻 | 実行完了時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗 | 接続設定を確認 |
| - | スクリプト実行エラー | スクリプト内エラー | スクリプト内容を確認 |

### リトライ仕様

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

### 障害時対応

- スクリプト実行失敗時はlogger.errorでエラー出力
- process.exit(1)で異常終了
- 失敗したスクリプトは次回実行時に再試行される

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | スクリプト単位 |
| コミットタイミング | 各スクリプト完了時 |
| ロールバック条件 | スクリプト失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | スクリプト数に依存 |
| 目標処理時間 | スクリプト内容に依存 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- MigrationScriptsMigratorによる実行済み管理で重複実行を防止
- 同一スクリプトは一度だけ実行される

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 未実行なし | `No pending migration scripts to execute` |
| 区切り線 | 未実行あり時 | ターミナル幅のダッシュ |
| 情報ログ | スクリプト一覧 | `Pending migration scripts to execute` + スクリプト名 |
| 区切り線 | 実行開始前 | ターミナル幅のダッシュ |
| 情報ログ | 実行開始時 | `Running migration scripts...` |
| 区切り線 | 実行完了後 | ターミナル幅のダッシュ |
| 情報ログ | 実行完了時 | `Migration scripts completed` |
| エラーログ | エラー発生時 | エラー内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 終了コード | 非0 | 呼び出し元 |

## 備考

- MigrationScriptsMigratorクラスでスクリプト実行を管理
- スクリプトパス:
  1. `@medusajs/medusa`パッケージのmigration-scriptsディレクトリ
  2. 各プラグインのmigration-scriptsディレクトリ
- MedusaModule.clearInstances()でモジュールキャッシュをクリア（新鮮な状態でロード）
- onApplicationStart()でモジュールを初期化してからスクリプト実行
- finallyブロックでリソースシャットダウンを保証
- 終了コード: 成功時0、失敗時1
- 実装箇所: `packages/medusa/src/commands/db/run-scripts.ts`
