# 機能設計書 85-スマートマージ

## 概要

本ドキュメントは、webpackにおけるスマートマージ（cleverMerge）機能の設計を記述する。webpack設定オブジェクトのディープマージを行い、配列の拡張構文（"..."）、条件分岐（byProperty）、動的関数、DELETEシンボルなどの高度なマージセマンティクスを提供する。WeakMapベースのキャッシュにより同一オブジェクト間のマージ結果を効率的に再利用する。

### 本機能の処理概要

スマートマージ機能は、webpackの設定オブジェクトを高度なルールに基づいてマージするユーティリティである。

**業務上の目的・背景**：webpackの設定は多層的に構成される。デフォルト設定、ユーザ設定、プラグインによる設定変更、条件分岐設定（development/production等）など、複数の設定オブジェクトを統合する必要がある。単純なObject.assignやspread演算子ではオブジェクトのディープマージ、配列の拡張、条件分岐設定の統合ができないため、webpackは独自のスマートマージ機構を実装している。

**機能の利用シーン**：
- webpack設定の正規化・デフォルト値適用時（WebpackOptionsApply等）
- モジュールルールのマージ（loaderオプションの統合）
- byProperty構文による条件分岐設定の解決（byModule、byLayer等）
- プラグインが設定を拡張する際のマージ処理

**主要な処理内容**：
1. `cleverMerge(first, second)`: 2つのオブジェクトをスマートマージする。配列内の"..."は元の値の展開を意味する。オブジェクト値は再帰的にマージされる
2. `cachedCleverMerge(first, second)`: WeakMapキャッシュ付きのcleverMerge。同一オブジェクト参照間のマージ結果を再利用
3. `cachedSetProperty(obj, property, value)`: プロパティ設定のキャッシュ付きバージョン。同一オブジェクトの同一プロパティ設定結果を再利用
4. `resolveByProperty(obj, byProperty, ...values)`: byProperty構文（条件分岐設定）を値に基づいて解決する
5. `removeOperations(obj)`: "..."やDELETEシンボルなどの操作子を除去した純粋なオブジェクトを返す
6. 内部で`parseObject`により設定オブジェクトをstaticプロパティとdynamicプロパティに分解して管理する

**関連システム・外部連携**：特になし。webpack内部で完結する。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能に関連する画面はなし |

## 機能種別

ユーティリティ（オブジェクトマージ処理）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| first | object \| null \| undefined | Yes | マージ元オブジェクト | null/undefinedの場合はsecondを返す |
| second | object \| null \| undefined | Yes | マージ先オブジェクト（優先） | null/undefinedの場合はfirstを返す |
| byProperty | string | Yes（resolveByProperty） | 条件分岐プロパティ名（"by"で始まる） | - |
| values | any[] | No（resolveByProperty） | 条件分岐の解決に使用する値 | - |

### 入力データソース

- webpack設定オブジェクト
- プラグイン等から提供される設定パーシャル
- 内部デフォルト設定

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| マージ結果 | T & O | first と second をマージした新しいオブジェクト |
| 解決済み設定 | Omit<T, P> | byPropertyを解決した設定オブジェクト |

### 出力先

呼び出し元に返却。webpack設定パイプラインで使用される。

## 処理フロー

### 処理シーケンス

```
1. cleverMerge(first, second)
   ├─ second === undefined → first を返す
   ├─ first === undefined → second を返す
   ├─ second が非オブジェクト → second を返す
   ├─ first が非オブジェクト → first を返す
   └─ _cleverMerge(first, second, false) を呼び出す

2. _cleverMerge(first, second, internalCaching)
   ├─ parseObject(first) → staticプロパティとdynamicプロパティに分解
   ├─ firstにdynamic部分がある場合
   │   ├─ fn[DYNAMIC_INFO]があれば、secondを蓄積されたsecondとマージ
   │   ├─ 新しいdynamic関数を生成（呼び出し時にsecondとマージ）
   │   └─ serializeObject(static, newDynamic) を返す
   └─ firstがstaticのみの場合
       ├─ parseObject(second) → staticとdynamicに分解
       ├─ firstInfoとsecondInfoの各プロパティをmergeEntries
       ├─ secondにのみあるプロパティはそのまま追加
       └─ serializeObject(mergedInfo, secondDynamic) を返す

3. mergeEntries(firstEntry, secondEntry, internalCaching)
   ├─ VALUE_TYPE_ATOM/DELETE → secondEntryをそのまま返す
   ├─ VALUE_TYPE_UNDEFINED → base/byPropertyの統合
   └─ VALUE_TYPE_OBJECT → base同士のマージ + byValuesの統合

4. mergeSingleValue(a, b, internalCaching)
   ├─ ATOM/DELETE → b を返す
   ├─ OBJECT → a もOBJECTなら再帰マージ、そうでなければ b
   ├─ UNDEFINED → a を返す
   └─ ARRAY_EXTEND → "..."をaの内容で展開した新配列
```

### フローチャート

```mermaid
flowchart TD
    A[cleverMerge first second] --> B{first/second チェック}
    B -->|undefined| C[他方を返す]
    B -->|非オブジェクト| D[型に応じた値を返す]
    B -->|両方オブジェクト| E[_cleverMerge]
    E --> F[parseObject first]
    F --> G{dynamic 部分あり?}
    G -->|Yes| H[新しい dynamic 関数生成]
    H --> I[serializeObject]
    G -->|No| J[parseObject second]
    J --> K[プロパティごとに mergeEntries]
    K --> L{値タイプ判定}
    L -->|ATOM/DELETE| M[second の値を採用]
    L -->|OBJECT| N[再帰的マージ]
    L -->|ARRAY_EXTEND| O[配列展開]
    L -->|UNDEFINED| P[first の値を採用]
    M --> Q[serializeObject]
    N --> Q
    O --> Q
    P --> Q
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-85-1 | 後勝ちルール | アトム値（プリミティブ、関数等）はsecondの値がfirstを上書きする | VALUE_TYPE_ATOM |
| BR-85-2 | 配列拡張 | 配列内の"..."はfirstの配列内容に置換される。"..."がなければsecondの配列で上書き | VALUE_TYPE_ARRAY_EXTEND |
| BR-85-3 | オブジェクト再帰マージ | プレーンオブジェクトは再帰的にcleverMergeされる | VALUE_TYPE_OBJECT |
| BR-85-4 | DELETEシンボル | DELETEシンボルはプロパティの削除を意味する | VALUE_TYPE_DELETE |
| BR-85-5 | byPropertyサポート | "by"で始まるプロパティは条件分岐として解釈され、値に応じた設定を返す | resolveByProperty呼び出し時 |
| BR-85-6 | 動的関数サポート | byPropertyの値が関数の場合、呼び出し結果を再帰的に解決する | resolveByProperty + dynamic function |
| BR-85-7 | キャッシュ活用 | cachedCleverMergeは同一オブジェクト参照間のマージ結果をWeakMapで再利用する | 内部キャッシュモード有効時 |
| BR-85-8 | 同一byProperty制約 | 1つのプロパティに対して異なるbyPropertyキーでの分岐は許可されない（Errorがthrowされる） | parseObject/mergeEntries時 |

### 計算ロジック

- **getValueType(value)**: 値の型を5段階に分類する
  - VALUE_TYPE_UNDEFINED (0): undefined
  - VALUE_TYPE_ATOM (1): プリミティブ値、関数、"..."を含まない配列、コンストラクタ付きオブジェクト
  - VALUE_TYPE_ARRAY_EXTEND (2): "..."を含む配列
  - VALUE_TYPE_OBJECT (3): プレーンオブジェクト（constructor === Object）
  - VALUE_TYPE_DELETE (4): DELETEシンボル
- **parseObject(obj)**: オブジェクトを`{ static: Map<key, {base, byProperty, byValues}>, dynamic: {byProperty, fn} }`形式にパースする。"by"で始まるキーの値がオブジェクトならその内部プロパティをbyValuesに展開する。関数ならdynamic部分として保持する。

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

本機能にデータベース操作は含まれない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | 同一プロパティに異なるbyPropertyキーが指定された場合 | 設定を修正し、1プロパティに対して1つのbyPropertyのみ使用する |
| - | Error | 2つ以上のdynamic関数が指定された場合 | 設定を修正し、1つのdynamic関数のみ使用する |

### リトライ仕様

リトライ処理は不要。

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

トランザクション処理は不要。

## パフォーマンス要件

- WeakMapベースのキャッシュ（mergeCache、parseCache、setPropertyCache）により、同一オブジェクト間のマージ結果を効率的に再利用する
- parseObjectの結果もcachedParseObjectでキャッシュされ、同一オブジェクトの複数回パースを回避する
- DYNAMIC_INFOシンボルにより、動的関数のチェーンを最適化し、深いマージの再計算を防ぐ

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

特になし。

## 備考

- cleverMergeはwebpack-mergeとは異なるwebpack内部専用のマージユーティリティである
- byProperty構文は主にwebpackの正規化処理（lib/config/配下）で使用される
- DYNAMIC_INFO シンボルはdynamic関数のメタデータを保持し、後続のマージでの最適化に利用される

---

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

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

### 推奨読解順序

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

マージ処理の中間表現（ParsedObject）を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | cleverMerge.js | `lib/util/cleverMerge.js` | 13-14行目: DELETE シンボルと DYNAMIC_INFO シンボルの定義 |
| 1-2 | cleverMerge.js | `lib/util/cleverMerge.js` | 93-98行目: ObjectParsedPropertyEntry型定義。base（基本値）、byProperty（分岐キー）、byValues（分岐値Map） |
| 1-3 | cleverMerge.js | `lib/util/cleverMerge.js` | 104-117行目: ParsedObjectStatic/ParsedObjectDynamic/ParsedObject型定義 |
| 1-4 | cleverMerge.js | `lib/util/cleverMerge.js` | 265-269行目: 値タイプ定数（VALUE_TYPE_UNDEFINED〜VALUE_TYPE_DELETE） |

**読解のコツ**: parseObjectの結果は`{ static: Map<key, Entry>, dynamic: {byProperty, fn} | undefined }`という構造。staticのMapの各エントリがbase/byProperty/byValuesを持ち、プロパティごとの条件分岐設定を表現する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | cleverMerge.js | `lib/util/cleverMerge.js` | 304-311行目: cleverMerge関数。undefined/非オブジェクトの早期リターン後、_cleverMergeを呼び出す |
| 2-2 | cleverMerge.js | `lib/util/cleverMerge.js` | 31-51行目: cachedCleverMerge関数。WeakMapキャッシュ付きバージョン |

**主要処理フロー**:
- **31-51行目**: cachedCleverMerge - mergeCache WeakMapで(first, second)ペアの結果をキャッシュ。internalCaching=trueで_cleverMergeを呼び出す
- **304-311行目**: cleverMerge - internalCaching=falseで_cleverMergeを呼び出す

#### Step 3: コアマージロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | cleverMerge.js | `lib/util/cleverMerge.js` | 322-378行目: _cleverMerge関数。parseObject → dynamic処理 or static統合 |
| 3-2 | cleverMerge.js | `lib/util/cleverMerge.js` | 387-510行目: mergeEntries関数。getValueTypeに基づくエントリ単位のマージ |
| 3-3 | cleverMerge.js | `lib/util/cleverMerge.js` | 533-585行目: mergeSingleValue関数。値単位のマージ。配列展開ロジックを含む |

**主要処理フロー**:
- **322-378行目**: _cleverMerge
  - 329-353行目: firstにdynamic部分がある場合、新しいdynamic関数を生成してsecondとの遅延マージを実現
  - 356-378行目: staticのみの場合、各プロパティのmergeEntriesを実行し、serializeObjectで結果を復元
- **533-585行目**: mergeSingleValue
  - ARRAY_EXTEND時（550-581行目）: "..."を見つけたらaの内容で置換する新配列を構築

#### Step 4: parseObject/serializeObjectを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | cleverMerge.js | `lib/util/cleverMerge.js` | 142-221行目: parseObject関数。オブジェクトをstatic/dynamicに分解 |
| 4-2 | cleverMerge.js | `lib/util/cleverMerge.js` | 229-263行目: serializeObject関数。ParsedObjectを通常オブジェクトに復元 |
| 4-3 | cleverMerge.js | `lib/util/cleverMerge.js` | 276-292行目: getValueType関数。値の型分類 |

#### Step 5: resolveByPropertyを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | cleverMerge.js | `lib/util/cleverMerge.js` | 643-669行目: resolveByProperty関数。byPropertyキーを値で解決 |

**主要処理フロー**:
- **652-659行目**: byValueがオブジェクトの場合、指定された値のキーを探し、なければ"default"にフォールバックしてcachedCleverMergeで統合
- **660-666行目**: byValueが関数の場合、関数を呼び出してその結果を再帰的にresolveByProperty

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

```
cleverMerge(first, second) / cachedCleverMerge(first, second)
    |
    +-- _cleverMerge(first, second, internalCaching)
        |
        +-- parseObject(first) / cachedParseObject(first)
        |   +-- getInfo(key) → ObjectParsedPropertyEntry
        |   +-- [byXxx が object] → byValues Map に展開
        |   +-- [byXxx が function] → dynamic 部分として保持
        |
        +-- [dynamic あり]
        |   +-- 新しい dynamic 関数を生成
        |   +-- serializeObject(static, newDynamic)
        |
        +-- [static のみ]
            +-- parseObject(second) / cachedParseObject(second)
            +-- mergeEntries(firstEntry, secondEntry)
            |   +-- getValueType(secondEntry.base)
            |   +-- mergeSingleValue(firstValue, secondValue)
            |       +-- [OBJECT] cleverMerge(a, b) ← 再帰
            |       +-- [ARRAY_EXTEND] "..." 展開
            +-- serializeObject(mergedInfo, secondDynamic)

resolveByProperty(obj, byProperty, ...values)
    +-- [object] cachedCleverMerge(remaining, byValue[key])
    +-- [function] byValue(...values) → resolveByProperty(result) ← 再帰

removeOperations(obj)
    +-- getValueType(value)
    +-- [ARRAY_EXTEND] "..." フィルタ
    +-- [OBJECT] removeOperations(value) ← 再帰

cachedSetProperty(obj, property, value)
    +-- setPropertyCache WeakMap → Map → Map でキャッシュ
```

### データフロー図

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

設定オブジェクト first   -----> parseObject                  --> ParsedObject
設定オブジェクト second  -----> parseObject                  --> ParsedObject

ParsedObject pair       -----> mergeEntries                 --> MergedEntries
                                mergeSingleValue                (プロパティごと)

MergedEntries           -----> serializeObject              --> マージ結果オブジェクト

byProperty設定 + 値     -----> resolveByProperty            --> 解決済み設定
                                cachedCleverMerge
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| cleverMerge.js | `lib/util/cleverMerge.js` | ソース | スマートマージの全ロジックを実装 |
| WebpackOptionsApply.js | `lib/config/WebpackOptionsApply.js` | ソース | webpack設定適用時にcleverMergeを使用（主要消費者） |
| defaults.js | `lib/config/defaults.js` | ソース | デフォルト設定適用時にcachedCleverMergeを使用（主要消費者） |
| normalization.js | `lib/config/normalization.js` | ソース | 設定正規化時にcleverMerge関連関数を使用 |
