# バッチ設計書 6-migrate-tax-region-provider

## 概要

本ドキュメントはMedusaフレームワークのmigrate-tax-region-providerマイグレーションスクリプトについて、その設計内容を記述したバッチ設計書です。本スクリプトは税地域（Tax Region）にシステムプロバイダーを割り当てるマイグレーション処理を実行します。

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

migrate-tax-region-providerは、プロバイダーが設定されていない親税地域（province_codeを持たない税地域）に対して、システムデフォルトの税プロバイダー（`tp_system`）を割り当てるマイグレーションスクリプトです。

**業務上の目的・背景**：Medusaの税計算機能では、各税地域に税プロバイダーを割り当てる必要があります。税プロバイダーは税率の計算や税金の適用ロジックを担当します。新規にTaxモジュールを導入した場合や、システムアップグレード時に、既存の税地域にプロバイダーが設定されていない可能性があります。このスクリプトは、プロバイダー未設定の親税地域（国レベルの税地域）にシステムデフォルトプロバイダーを割り当てることで、税計算機能が正しく動作することを保証します。

**バッチの実行タイミング**：`db:migrate:scripts`コマンドの実行時に、他のマイグレーションスクリプトと共に実行されます。手動でのCLI実行が必要です。

**主要な処理内容**：
1. Taxモジュールのインストール確認
2. 全税地域を取得（id, provider_id, province_code）
3. プロバイダー未設定かつ親地域（province_codeなし）をフィルタリング
4. 対象の税地域にシステムプロバイダー（`tp_system`）を設定

**前後の処理との関連**：`db:migrate`コマンドの後に`db:migrate:scripts`経由で実行されます。Taxモジュールがインストールされている必要があります。

**影響範囲**：tax_regionテーブルのprovider_idカラムが更新されます。親税地域（国レベル）のみが対象であり、子税地域（州/県レベル）は影響を受けません。

## バッチ種別

マイグレーションスクリプト / データ更新

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（マイグレーション時） |
| 実行時刻 | 手動実行 |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `db:migrate:scripts`コマンド |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Taxモジュールインストール | `MedusaModule.isInstalled(Modules.TAX)`がtrue |
| データベース接続 | 有効なデータベース接続が確立されていること |

### 実行可否判定

- Taxモジュールが未インストールの場合はスキップ（エラーなし）
- マイグレーションスクリプトテーブルで実行済みとして記録されている場合はスキップ

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| container | MedusaContainer | Yes | - | Medusaの依存性注入コンテナ（ExecArgs経由） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tax_region | DB | 全税地域データ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| tax_region | DB | 税地域のprovider_id更新 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. モジュールインストール確認
   └─ Taxモジュールの存在チェック
2. 税地域取得
   └─ useQueryGraphStepで全税地域を取得
3. 対象フィルタリング
   └─ transformで条件に合致する税地域を抽出
      └─ province_codeがnull/undefined（親地域）
      └─ provider_idがnull/undefined（未設定）
4. 更新データ作成
   └─ 各税地域にtp_systemを設定
5. 税地域更新
   └─ updateTaxRegionsStepで一括更新
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B{Taxモジュール存在?}
    B -->|No| C[スキップ]
    B -->|Yes| D[税地域取得]
    D --> E[フィルタリング]
    E --> F{対象あり?}
    F -->|No| G[処理なし]
    F -->|Yes| H[更新データ作成]
    H --> I[updateTaxRegionsStep実行]
    I --> J[完了ログ出力]
    J --> K[終了]
    G --> K
    C --> K
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 税地域取得 | tax_region | SELECT | 全税地域を取得 |
| 税地域更新 | tax_region | UPDATE | provider_idを更新 |

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

#### tax_region

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id, provider_id, province_code | 全件取得 | - |
| UPDATE | provider_id | "tp_system" | 親地域かつ未設定の場合のみ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 一般エラー | ワークフロー実行失敗 | エラーログ出力後throw |

### リトライ仕様

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

### 障害時対応

- エラー発生時はlogger.errorでエラー内容を出力
- エラーを上位に再throw
- ワークフロー内のトランザクションはロールバック

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ワークフロー全体 |
| コミットタイミング | ワークフロー正常完了時 |
| ロールバック条件 | ワークフロー内でエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 税地域数に依存（通常は国数程度） |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 最小 |

## 排他制御

マイグレーションスクリプトテーブルにより、同一スクリプトの重複実行を防止します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | 処理開始時 | `Assigning tax system provider to tax regions` |
| 情報ログ | 処理完了時 | `System provider assigned to tax regions` |
| エラーログ | エラー発生時 | エラー内容 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理失敗 | 発生時 | コンソールログ |

## 備考

- ワークフロー名: `assign-system-provider-to-tax-regions`
- システムプロバイダーID: `tp_system`
- フィルタリング条件:
  - `province_code`がnull/undefined: 親地域（国レベル）を意味する
  - `provider_id`がnull/undefined: プロバイダー未設定を意味する
- 子税地域（州/県レベル）は親地域のプロバイダーを継承するため、更新対象外
- エラー発生時はthrowして上位に伝播（他のスクリプトとは異なる動作）
- 実装箇所: `packages/medusa/src/migration-scripts/migrate-tax-region-provider.ts`
