# バッチ設計書 12-exec

## 概要

本ドキュメントは、Medusaフレームワークにおける任意スクリプト実行用CLIコマンド「exec」の設計仕様を定義する。

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

execコマンドは、Medusaコンテナ環境内で任意のJavaScript/TypeScriptスクリプトを実行するためのCLIコマンドである。開発者が独自のスクリプトを作成し、Medusaの依存性注入コンテナにアクセスしながら処理を実行できる。

**業務上の目的・背景**：日常的なデータ操作、バッチ処理、カスタムマイグレーション、デバッグ作業など、Medusa環境へのアクセスが必要な任意の処理を実行する需要がある。専用のCLIコマンドを毎回作成するのではなく、スクリプトファイルを指定して即座に実行できる柔軟性を提供する。

**バッチの実行タイミング**：開発者が手動で任意のタイミングで実行。データ修正、一括更新処理、検証スクリプトなど多様な用途に使用される。

**主要な処理内容**：
1. Medusaコンテナの初期化（DB接続なし）
2. 指定されたスクリプトファイルの存在確認
3. スクリプトのdynamic import
4. スキップフラグおよびdefault export関数の検証
5. Medusaローダーによる完全なコンテナ初期化
6. スクリプト関数の実行（container、argsを渡す）

**前後の処理との関連**：独立したユーティリティコマンドであり、特定の前後関係はない。ただし、スクリプト内から他のワークフローやサービスを呼び出すことが可能。

**影響範囲**：実行するスクリプトの内容に依存。データベースへの書き込み、外部APIの呼び出し、ファイル操作など、スクリプトで定義された任意の処理が実行される。

## バッチ種別

汎用スクリプト実行

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| スクリプトファイル存在 | 指定されたパスにスクリプトファイルが存在すること |
| default export | スクリプトがdefault exportで関数をエクスポートしていること |
| Node.js環境 | Node.jsがインストールされていること |
| medusa-config.js存在 | プロジェクトルートにmedusa-config.jsが存在すること |

### 実行可否判定

1. 指定されたファイルパスが存在するか確認（existsSync）
2. ファイルがスキップ対象でないか確認（isFileSkipped）
3. default exportが関数であるか確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| file | string | Yes | - | 実行するスクリプトファイルのパス |
| args | string[] | No | [] | スクリプトに渡す引数の配列 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| スクリプトファイル | JavaScript/TypeScript | 実行対象のスクリプト |
| medusa-config.js | JavaScript設定ファイル | モジュール設定の読み込み |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | コンソール | スクリプトからの出力 |
| スクリプト依存 | 各種 | スクリプトの処理に応じた出力 |

### 出力ファイル仕様

スクリプトの実装に依存するため、本コマンド自体は特定のファイル出力仕様を持たない。

## 処理フロー

### 処理シーケンス

```
1. 環境変数設定
   └─ MEDUSA_WORKER_MODE = "server" を設定
2. コンテナ初期化（DB接続なし）
   └─ initializeContainerでMedusaコンテナを初期化（skipDbConnection: true）
3. ロガー取得
   └─ ContainerRegistrationKeys.LOGGERを解決
4. 開始ログ出力
   └─ "Executing script at {file}..." を出力
5. ファイル存在確認
   └─ path.resolveで絶対パスを取得し、existsSyncで確認
6. スクリプトのdynamic import
   └─ dynamicImportでスクリプトをロード
7. スキップチェック
   └─ isFileSkippedでスキップ対象か確認
8. 関数チェック
   └─ default exportが関数であることを確認
9. Medusaローダー実行
   └─ loadersでコンテナを完全初期化（skipLoadingEntryPoints: true）
10. スクリプト実行
    └─ スクリプト関数を実行（container、argsを引数として渡す）
11. 完了ログ出力
    └─ "Finished executing script." を出力
12. プロセス終了
    └─ process.exit()で正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[MEDUSA_WORKER_MODE設定]
    B --> C[コンテナ初期化 DB接続なし]
    C --> D[ロガー取得]
    D --> E{ファイル存在?}
    E -->|No| F[エラー: ファイルが存在しない]
    E -->|Yes| G[dynamic importでスクリプトロード]
    G --> H{スキップ対象?}
    H -->|Yes| I[エラー: ファイルが無効]
    H -->|No| J{default exportは関数?}
    J -->|No| K[エラー: 関数がexportされていない]
    J -->|Yes| L[Medusaローダー実行]
    L --> M[スクリプト実行]
    M --> N[完了ログ出力]
    N --> O[process.exit]
    F --> P[exit 1]
    I --> P
    K --> P
    O --> Q[バッチ終了]
    P --> Q
```

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

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

本コマンド自体はデータベース操作を行わない。実行されるスクリプトの内容に依存する。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スクリプト依存 | スクリプト依存 | スクリプト依存 | 実行スクリプトの実装による |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル不存在エラー | 指定されたファイルパスにファイルが存在しない | 正しいファイルパスを指定 |
| - | ファイル無効エラー | ファイルがスキップ対象（disabled） | ファイルのskip設定を確認 |
| - | 関数未定義エラー | default exportが関数でない | スクリプトを修正してdefault export関数を定義 |
| - | 実行時エラー | スクリプト実行中のエラー | スクリプトの内容をデバッグ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（単発実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. エラーログを確認し、失敗箇所を特定
2. ファイルパスの問題の場合は相対パス/絶対パスを確認
3. スクリプトの問題の場合はdefault export関数を確認
4. 実行時エラーの場合はスクリプト内のロジックをデバッグ

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | スクリプト依存 |
| コミットタイミング | スクリプト依存 |
| ロールバック条件 | スクリプト依存 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | スクリプト依存 |
| 目標処理時間 | スクリプト依存 |
| メモリ使用量上限 | Node.jsデフォルト制限 |

## 排他制御

本コマンド自体は排他制御を行わない。必要な場合はスクリプト内で実装すること。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | スクリプト実行開始時 | Executing script at {file}... |
| 終了ログ | スクリプト実行完了時 | Finished executing script. |
| エラーログ | エラー発生時 | Error running script + エラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | スクリプト依存 | 標準出力 |
| エラー件数 | 1件以上 | 標準エラー出力 |

## 備考

- スクリプトには以下の形式でExecArgsが渡される：
  ```typescript
  interface ExecArgs {
    container: MedusaContainer
    args: string[]
  }
  ```
- スクリプトはdefault exportで関数をエクスポートする必要がある
- skipLoadingEntryPoints: trueでローダーを実行するため、APIエンドポイントはロードされない
- MEDUSA_WORKER_MODEは"server"に設定され、ワーカーモードでなくサーバーモードで実行される
- スクリプト内からcontainerを通じてすべてのMedusaモジュールにアクセス可能
