# 機能設計書 42-サービスゾーン管理

## 概要

本ドキュメントは、Medusaコマースプラットフォームにおけるサービスゾーン管理機能の設計を記述する。サービスゾーンはフルフィルメントセットの配下に位置し、地理ゾーン（GeoZone）を通じて配送可能な地域を定義し、配送オプションを紐付ける中間エンティティである。

### 本機能の処理概要

**業務上の目的・背景**：ECサイトにおいて、配送サービスは地域によって利用可否が異なる。サービスゾーンは、特定の地理的範囲（国、州、都市、郵便番号）を定義し、その範囲内で利用可能な配送オプションを管理するための機能を提供する。これにより、地域ごとに異なる配送料金や配送方法を柔軟に設定できる。

**機能の利用シーン**：
- 新規配送エリアを追加する場合（例：北海道エリア、関東エリア）
- 特定地域限定の配送オプションを設定する場合
- 国際配送のゾーン分けを行う場合
- 配送可能エリアの変更・拡大を行う場合

**主要な処理内容**：
1. サービスゾーンの作成（名前、フルフィルメントセット紐付け、地理ゾーン設定）
2. サービスゾーンの更新（地理ゾーンの追加・削除を含む）
3. サービスゾーンのUpsert（存在すれば更新、なければ作成）
4. サービスゾーンの取得・一覧表示
5. サービスゾーンの削除（カスケードで地理ゾーン・配送オプションも削除）

**関連システム・外部連携**：
- フルフィルメントセットとの親子関係（belongsTo）
- 地理ゾーンとの1対多関係（hasMany）
- 配送オプションとの1対多関係（hasMany）

**権限による制御**：管理画面からの操作は管理者権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 132 | ロケーション詳細画面 | 参照画面 | サービスゾーンの表示 |
| 136 | サービスゾーン作成画面 | 主機能 | サービスゾーンの作成、地理的範囲の設定 |
| 137 | サービスゾーン編集画面 | 主機能 | サービスゾーンの編集 |

## 機能種別

CRUD操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| name | string | Yes | サービスゾーンの名前 | ユニーク制約あり |
| fulfillment_set_id | string | Yes | 親フルフィルメントセットのID | 存在チェック |
| metadata | object | No | カスタムメタデータ | JSON形式 |
| geo_zones | array | No | 地理ゾーンの配列 | 後述の地理ゾーン構造 |
| geo_zones[].type | string | Yes | ゾーンタイプ（country/province/city/zip） | 必須 |
| geo_zones[].country_code | string | Yes | 国コード | 必須 |
| geo_zones[].province_code | string | Conditional | 州/県コード | type=province/city/zip時に必須 |
| geo_zones[].city | string | Conditional | 都市名 | type=city/zip時に必須 |
| geo_zones[].postal_expression | object | Conditional | 郵便番号パターン | type=zip時に必須 |

### 入力データソース

- 管理画面からのフォーム入力
- Admin API（POST /admin/service-zones）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | string | サービスゾーンID（serzo_xxx形式） |
| name | string | ゾーン名 |
| fulfillment_set_id | string | 親フルフィルメントセットID |
| fulfillment_set | object | 親フルフィルメントセット（リレーション展開時） |
| geo_zones | array | 関連地理ゾーンの配列 |
| shipping_options | array | 関連配送オプションの配列 |
| metadata | object | メタデータ |
| created_at | datetime | 作成日時 |
| updated_at | datetime | 更新日時 |
| deleted_at | datetime | 削除日時 |

### 出力先

- API Response（JSON形式）
- DBテーブル：service_zone

## 処理フロー

### 処理シーケンス

```
1. 入力データの受信
   └─ APIまたはサービスメソッド経由でデータを受信

2. バリデーション処理
   └─ 地理ゾーンの整合性チェック（タイプ別必須プロパティ）
   └─ 名前のユニーク性確認

3. サービスゾーンの作成/更新
   └─ serviceZoneService_.create/update()を呼び出し
   └─ 地理ゾーンもORMにより同時に処理される

4. 更新時の差分処理
   └─ 削除対象の地理ゾーンを特定
   └─ geoZoneService_.delete()で削除

5. レスポンスの生成
   └─ 作成/更新されたエンティティをシリアライズ
   └─ DTOに変換して返却

6. イベント発行
   └─ @EmitEvents()デコレータによりドメインイベント発行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[入力データ受信]
    B --> C{geo_zones あり?}
    C -->|Yes| D[geo_zones検証]
    C -->|No| E{IDあり?}
    D --> F{検証OK?}
    F -->|Yes| E
    F -->|No| G[エラー返却]
    E -->|Yes| H[更新処理]
    E -->|No| I[作成処理]
    H --> J[差分検出・削除]
    J --> K[serviceZoneService_.update]
    I --> L[serviceZoneService_.create]
    K --> M[シリアライズ]
    L --> M
    M --> N[イベント発行]
    N --> O[レスポンス返却]
    G --> P[終了]
    O --> P
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-42-01 | 名前ユニーク制約 | サービスゾーン名は一意でなければならない | 作成・更新時 |
| BR-42-02 | カスケード削除 | サービスゾーン削除時、配下の地理ゾーンと配送オプションも削除 | 削除時 |
| BR-42-03 | 地理ゾーン必須プロパティ | 地理ゾーンタイプに応じた必須項目チェック | 地理ゾーン作成・更新時 |
| BR-42-04 | フルフィルメントセット存在チェック | 親セットが存在しなければエラー | 作成時 |
| BR-42-05 | 更新時地理ゾーン整合性 | 更新時に指定された地理ゾーンIDが存在するかチェック | 更新時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| createServiceZones | service_zone | INSERT | 新規サービスゾーン作成 |
| createServiceZones | geo_zone | INSERT | 同時に地理ゾーン作成 |
| updateServiceZones | service_zone | UPDATE | ゾーン情報更新 |
| updateServiceZones | geo_zone | DELETE | 削除対象の地理ゾーン削除 |
| updateServiceZones | geo_zone | INSERT/UPDATE | 新規/既存地理ゾーン処理 |
| deleteServiceZones | service_zone | UPDATE | deleted_atを設定 |
| deleteServiceZones | geo_zone | DELETE | カスケード削除 |
| deleteServiceZones | shipping_option | DELETE | カスケード削除 |

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

#### service_zone

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | 自動生成（serzo_xxx形式） | プライマリキー |
| INSERT | name | 入力値 | ユニークインデックス |
| INSERT | fulfillment_set_id | 親セットのID | 外部キー |
| INSERT | metadata | 入力値（nullable） | JSON |
| UPDATE | name | 入力値 | - |
| UPDATE | deleted_at | 現在時刻 | ソフトデリート時 |

#### geo_zone

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | 自動生成（fgz_xxx形式） | プライマリキー |
| INSERT | type | 入力値（country/province/city/zip） | Enum |
| INSERT | country_code | 入力値 | 必須 |
| INSERT | province_code | 入力値 | 条件付き必須 |
| INSERT | city | 入力値 | 条件付き必須 |
| INSERT | postal_expression | 入力値 | 条件付き必須、JSON |
| INSERT | service_zone_id | 親ゾーンのID | 外部キー |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NOT_FOUND | MedusaError | 指定されたサービスゾーンIDが存在しない | 正しいIDを指定 |
| NOT_FOUND | MedusaError | 指定された地理ゾーンIDが存在しない | 正しい地理ゾーンIDを指定 |
| INVALID_DATA | MedusaError | 地理ゾーンの必須プロパティが不足 | タイプに応じた必須項目を入力 |
| INVALID_DATA | MedusaError | 無効な地理ゾーンタイプ | country/province/city/zipのいずれかを指定 |
| UNIQUE_VIOLATION | DBError | サービスゾーン名が重複 | 別の名前を使用 |

### リトライ仕様

トランザクションレベルでのリトライ対応。

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

- `@InjectTransactionManager()`デコレータによりトランザクション内で実行
- 地理ゾーンの削除と更新は同一トランザクション
- エラー発生時は全体がロールバック

## パフォーマンス要件

- リスト取得時はページネーション対応
- 関連テーブル（geo_zones, shipping_options）のリレーション取得は必要に応じて

## セキュリティ考慮事項

- 管理者認証必須
- 入力値のサニタイズはORMが担当

## 備考

- サービスゾーンはフルフィルメントセットとStock Locationの橋渡しとして機能
- IDプレフィックスは「serzo」

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | service-zone.ts | `packages/modules/fulfillment/src/models/service-zone.ts` | エンティティ定義、リレーション |
| 1-2 | geo-zone.ts | `packages/modules/fulfillment/src/models/geo-zone.ts` | 地理ゾーンの構造とタイプ |
| 1-3 | fulfillment-set.ts | `packages/modules/fulfillment/src/models/fulfillment-set.ts` | 親エンティティとの関係 |

**読解のコツ**: サービスゾーンは`belongsTo`で親（FulfillmentSet）と、`hasMany`で子（GeoZone, ShippingOption）と接続。カスケード削除設定（55-57行目）に注目。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | サービスゾーン関連メソッド |

**主要処理フロー**:
1. **336-365行目**: `createServiceZones()`パブリックメソッド - 単一/複数作成対応
2. **367-394行目**: `createServiceZones_()`内部メソッド - 地理ゾーンバリデーション、作成実行
3. **922-977行目**: `updateServiceZones()`パブリックメソッド - ID/セレクター両対応
4. **979-1119行目**: `updateServiceZones_()`内部メソッド - 差分検出、削除、更新
5. **1121-1201行目**: `upsertServiceZones()`/`upsertServiceZones_()`- Upsert処理

#### Step 3: 更新処理の差分検出を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | updateServiceZones_メソッド |

**主要処理フロー**:
- **1034-1055行目**: 地理ゾーンの差分検出 - 既存と更新データの比較
- **1070-1082行目**: 存在しない地理ゾーンIDのチェック - エラースロー
- **1084-1100行目**: 地理ゾーンデータのマージ処理
- **1104-1111行目**: 削除対象地理ゾーンの削除実行

### プログラム呼び出し階層図

```
FulfillmentModuleService
    │
    ├─ createServiceZones() [public]
    │      └─ createServiceZones_() [protected]
    │             ├─ validateGeoZones() [static]
    │             └─ serviceZoneService_.create()
    │
    ├─ updateServiceZones() [public]
    │      └─ updateServiceZones_() [protected]
    │             ├─ serviceZoneService_.list() - 既存データ取得
    │             ├─ getSetDifference() - 削除対象検出
    │             ├─ validateGeoZones() - 新規地理ゾーン検証
    │             ├─ geoZoneService_.delete() - 不要ゾーン削除
    │             └─ serviceZoneService_.update() - 更新実行
    │
    └─ upsertServiceZones() [public]
           └─ upsertServiceZones_() [protected]
                  ├─ createServiceZones_() - 新規作成
                  └─ updateServiceZones_() - 既存更新
```

### データフロー図

```
[入力]                     [処理]                            [出力]

CreateServiceZoneDTO       FulfillmentModuleService         ServiceZoneDTO
         │                          │                              │
         ▼                          ▼                              ▼
    ┌──────────┐           ┌────────────────┐              ┌──────────────┐
    │ API      │ ────────▶ │ createService  │ ───────────▶ │ JSON Response│
    │ Request  │           │ Zones          │              │ (serialized) │
    └──────────┘           └────────────────┘              └──────────────┘
                                   │
                    ┌──────────────┼──────────────┐
                    ▼              ▼              ▼
             ┌───────────┐  ┌───────────┐  ┌───────────┐
             │ service_  │  │ geo_zone  │  │fulfillment│
             │ zone      │  │           │  │ _set      │
             └───────────┘  └───────────┘  └───────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| fulfillment-module-service.ts | `packages/modules/fulfillment/src/services/fulfillment-module-service.ts` | ソース | モジュールサービス本体 |
| service-zone.ts | `packages/modules/fulfillment/src/models/service-zone.ts` | ソース | サービスゾーンエンティティ |
| geo-zone.ts | `packages/modules/fulfillment/src/models/geo-zone.ts` | ソース | 地理ゾーンエンティティ |
| fulfillment-set.ts | `packages/modules/fulfillment/src/models/fulfillment-set.ts` | ソース | 親エンティティ |
| shipping-option.ts | `packages/modules/fulfillment/src/models/shipping-option.ts` | ソース | 子エンティティ（配送オプション） |
