# 機能設計書 44-リゾルバキャッシュ

## 概要

本ドキュメントは、webpackのリゾルバキャッシュ機能について、ResolverCachePluginを中心に設計内容を記述する。

### 本機能の処理概要

本機能は、enhanced-resolveによるモジュールパス解決の結果をキャッシュし、同一のモジュール解決リクエストに対する重複解決を防止する。FileSystemInfoのスナップショット機構を用いてキャッシュの有効性を検証する。

**業務上の目的・背景**：大規模プロジェクトでは数千のモジュールが存在し、各モジュールの依存関係解決がビルド時間の大きな割合を占める。同一のrequestに対するresolver呼び出しを重複して実行することはリソースの無駄であるため、キャッシュにより高速化する。

**機能の利用シーン**：すべてのwebpackビルドで自動的に有効化される。特に多数のモジュールを持つプロジェクトで効果が大きい。

**主要な処理内容**：
1. resolverFactory.hooks.resolverのinterceptで各リゾルバにキャッシュフックを注入
2. resolver.hooks.resolveにstage -100で早期介入し、キャッシュヒットを判定
3. キャッシュミス時は実際のresolveを実行し、結果をFileSystemInfoスナップショットと共に保存
4. 同一identifierの並行リクエストをactiveRequestsで集約

**関連システム・外部連携**：Compiler.cache(CacheFacade)、FileSystemInfo(スナップショット検証)、ResolverFactory(リゾルバ生成)

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面との直接的な関連なし（内部キャッシュ機構） |

## 機能種別

キャッシュ管理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| request | ResolveRequest | Yes | モジュール解決リクエスト | - |
| resolveContext | ResolveContext | Yes | 解決コンテキスト(依存関係追跡用) | - |

### 入力データソース

- NormalModuleFactoryおよびContextModuleFactoryからのresolve呼び出し

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| result | ResolveRequest | 解決結果(キャッシュヒット時) |
| null | null | 解決失敗(キャッシュヒット時) |

### 出力先

- Compiler.cacheを通じてメモリ/ファイルキャッシュに保存

## 処理フロー

### 処理シーケンス

```
1. resolver.hooks.resolve (stage -100) にフックを登録
   └─ _ResolverCachePluginCacheMissフラグがあればスキップ

2. identifierを生成(type + optionsIdent + requestToString)
   └─ cacheWithContext設定によりcontextを含める/除外する

3. activeRequestsで並行リクエストを集約
   └─ 同一identifierの実行中リクエストがあれば、コールバック配列に追加

4. itemCache.get()でキャッシュ検索
   └─ CacheEntry(result + snapshot)を取得

5. FileSystemInfo.checkSnapshotValid()でスナップショット検証
   └─ 有効: キャッシュ結果を返却、依存関係を伝播
   └─ 無効: doRealResolve()で実際の解決を実行

6. doRealResolve()完了後
   └─ FileSystemInfo.createSnapshot()でスナップショット作成
   └─ CacheEntryとしてitemCacheに保存
```

### フローチャート

```mermaid
flowchart TD
    A[resolve呼び出し] --> B{CacheMissフラグ?}
    B -->|Yes| C[通常のresolve処理]
    B -->|No| D[identifier生成]
    D --> E{並行リクエスト?}
    E -->|Yes| F[コールバック追加]
    E -->|No| G[itemCache.get]
    G --> H{キャッシュヒット?}
    H -->|Yes| I{スナップショット有効?}
    I -->|Yes| J[キャッシュ結果返却]
    I -->|No| K[doRealResolve]
    H -->|No| K
    K --> L[createSnapshot]
    L --> M[itemCache.store]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-44-01 | 並行リクエスト集約 | 同一identifierの解決リクエストは一つに集約される | 常時 |
| BR-44-02 | スナップショット検証 | キャッシュ結果はファイルシステムスナップショットで有効性を検証 | キャッシュヒット時 |
| BR-44-03 | 依存関係伝播 | キャッシュヒット時もfile/context/missing依存関係を呼び出し元に伝播 | キャッシュヒット時 |
| BR-44-04 | yieldサポート | yield関数が指定された場合、複数結果を配列で返却 | yield使用時 |

### 計算ロジック

- identifier生成: `${type}${withYield ? "|yield" : "|default"}${optionsIdent}${objectToString(request, !cacheWithContext)}`

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Error | resolve処理中のエラー | コールバックにエラーを伝播 |
| - | Error | スナップショット作成失敗 | コールバックにエラーを伝播 |

### リトライ仕様

リトライは行わない。

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

該当なし

## パフォーマンス要件

- stage -100で他のフックより先に実行され、キャッシュヒット時は後段処理をスキップ
- finishModulesフックでキャッシュヒット率をログ出力

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

特になし

## 備考

- CacheEntryはシリアライズ可能であり、ファイルキャッシュにも永続化される
- cacheWithContextオプションにより、contextを含めた/含めないキャッシュキーの使い分けが可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **31-56行目**: CacheEntry - result(解決結果)とsnapshot(有効性検証用)の組 |

**読解のコツ**: CacheEntryはmakeSerializableでシリアライズ可能に設定されており、ファイルキャッシュにも永続化される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **99-447行目**: apply()メソッド全体 |
| 2-2 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **253-446行目**: resolverFactory.hooks.resolver.intercept - リゾルバへのフック注入 |

**主要処理フロー**:
1. **115-132行目**: thisCompilationフックでfileSystemInfoとsnapshotOptionsを取得
2. **145-252行目**: doRealResolve関数 - 実際のresolve実行とスナップショット作成
3. **275-441行目**: resolver.hooks.resolve.tapAsync(stage: -100) - キャッシュ検索と判定

#### Step 3: キャッシュ検索と並行リクエスト処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **289-292行目**: identifier生成ロジック |
| 3-2 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **294-309行目**: activeRequests/activeRequestsWithYieldによる並行リクエスト集約 |
| 3-3 | ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | **382-431行目**: processCacheResult - スナップショット検証とキャッシュヒット処理 |

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

```
ResolverCachePlugin.apply(compiler)
    |
    +-- compiler.resolverFactory.hooks.resolver.intercept
            |
            +-- hook.tap(PLUGIN_NAME)
                    |
                    +-- resolver.hooks.resolve.tapAsync (stage: -100)
                            |
                            +-- identifier生成
                            +-- activeRequests集約チェック
                            +-- itemCache.get(processCacheResult)
                            |       |
                            |       +-- checkSnapshotValid
                            |       |       +-- 有効: done(null, result)
                            |       |       +-- 無効: doRealResolve()
                            |       |
                            |       +-- キャッシュなし: doRealResolve()
                            |
                            +-- doRealResolve()
                                    +-- resolver.doResolve()
                                    +-- createSnapshot()
                                    +-- itemCache.store(CacheEntry)
```

### データフロー図

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

ResolveRequest    ───▶  ResolverCachePlugin          ───▶  ResolveRequest (結果)
ResolveContext    ───▶  ├─ identifier生成
                        ├─ activeRequests集約
                        ├─ itemCache.get()
                        │     └─ CacheEntry {result, snapshot}
                        ├─ checkSnapshotValid()
                        └─ doRealResolve() [ミス時]
                              ├─ resolver.doResolve()
                              ├─ createSnapshot()
                              └─ itemCache.store()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ResolverCachePlugin.js | `lib/cache/ResolverCachePlugin.js` | ソース | リゾルバキャッシュプラグイン本体 |
| ResolverFactory.js | `lib/ResolverFactory.js` | ソース | リゾルバ生成・管理 |
| FileSystemInfo.js | `lib/FileSystemInfo.js` | ソース | スナップショット作成・検証 |
| CacheFacade.js | `lib/CacheFacade.js` | ソース | キャッシュアクセスファサード |
| Cache.js | `lib/Cache.js` | ソース | キャッシュ基盤クラス |
