# 機能設計書 2-コンパイレーション（Compilation）

## 概要

本ドキュメントは、webpackのコアバンドリング機能であるCompilationクラスの機能設計を記述する。Compilationは個別のコンパイルインスタンスを表し、モジュールグラフの構築からアセット生成までの一連の処理パイプラインを管理する。

### 本機能の処理概要

Compilationは、Compilerから生成される個別のビルドインスタンスであり、ソースコードのモジュール解析、依存関係グラフの構築、チャンクの生成、最適化パイプラインの実行、コード生成、ハッシュ計算、アセット出力までを統括する。ウォッチモードでは、ファイル変更のたびに新しいCompilationインスタンスが生成される。

**業務上の目的・背景**：webpackビルドの核心部分として、各コンパイルサイクルにおけるモジュール処理・最適化・コード生成を一元管理する必要がある。Compilationは、これらの処理をフックベースのパイプラインとして構成し、プラグインによる拡張・カスタマイズを可能にする。

**機能の利用シーン**：Compilerのcompile()メソッドから生成され、1回のビルドサイクルにおけるすべてのモジュール処理を管理する。プラグインはCompilationのフックを通じて最適化処理やアセット操作にアクセスする。

**主要な処理内容**：
1. addEntry()によるエントリポイントの追加とモジュールグラフ構築の起動
2. addModule() / buildModule()によるモジュールの追加・ビルド（AsyncQueue使用）
3. finish()によるモジュール処理の完了とエラー集約
4. seal()による最適化パイプラインの実行（依存性最適化、チャンク最適化、Tree Shaking等）
5. codeGeneration()によるモジュールコード生成
6. createHash()によるハッシュ計算
7. createChunkAssets()によるアセットファイルの生成

**関連システム・外部連携**：ModuleGraph（モジュール依存関係グラフ）、ChunkGraph（チャンク−モジュール対応）、buildChunkGraph（チャンクグラフ構築関数）、AsyncQueue（非同期キュー）、CodeGenerationResults（コード生成結果格納）と連携する。

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | Compilationは画面に直接関連しない基盤機能。全画面のモジュール処理と最適化を統括する |

## 機能種別

データ変換 / 最適化パイプライン / オーケストレーション

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| compiler | Compiler | Yes | 親のCompilerインスタンス | Compilerクラスのインスタンスであること |
| params | CompilationParams | Yes | NormalModuleFactoryとContextModuleFactoryを含むパラメータ | normalModuleFactory, contextModuleFactoryが存在すること |

### 入力データソース

- Compilerから受け渡されるNormalModuleFactory / ContextModuleFactory
- エントリポイント設定（EntryPluginのmakeフック経由）
- ファイルシステム上のソースコードモジュール群

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| modules | Set<Module> | 処理されたすべてのモジュール |
| chunks | Set<Chunk> | 生成されたチャンク |
| assets | CompilationAssets | 生成されたアセット（ファイル名→Sourceのマッピング） |
| errors | WebpackError[] | コンパイル中に発生したエラー |
| warnings | WebpackError[] | コンパイル中に発生した警告 |
| hash | string | コンパイル全体のハッシュ値 |
| entrypoints | Map<string, Entrypoint> | エントリポイント名→Entrypointマッピング |

### 出力先

- Compilerに返却され、emitAssets()でファイルシステムに出力される
- Statsオブジェクトを通じてユーザーに統計情報が報告される

## 処理フロー

### 処理シーケンス

```
1. Compilation生成（Compiler.compile()内）
   └─ フック・プロパティ初期化、AsyncQueue群の生成
2. addEntry() 呼び出し（makeフック経由）
   └─ エントリ依存関係の追加、モジュールグラフ構築の起動
3. _addEntryItem() → addModuleTree() → handleModuleCreation()
   ├─ factorize キュー：モジュール生成
   ├─ addModule キュー：モジュール登録
   └─ build キュー：モジュールビルド（ローダー実行・パース）
4. 再帰的な依存関係処理
   └─ processModuleDependencies() で子モジュールを同様に処理
5. finish() 実行
   ├─ buildModule/succeedModule通知
   ├─ エラー・警告の集約
   └─ finishModules フック呼び出し
6. seal() 実行
   ├─ チャンクグラフ構築（buildChunkGraph）
   ├─ 最適化パイプライン（多段フック呼び出し）
   │   ├─ optimizeDependencies
   │   ├─ optimizeModules
   │   ├─ optimizeChunks（SplitChunksPlugin等）
   │   ├─ optimizeTree
   │   └─ optimizeChunkModules
   ├─ モジュール/チャンクID割り当て
   ├─ コード生成（codeGeneration）
   ├─ ランタイム要件処理
   ├─ ハッシュ計算（createHash）
   ├─ アセット生成（createChunkAssets）
   └─ processAssets フック呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[Compilation生成] --> B[addEntry - エントリ追加]
    B --> C[factorize - モジュール生成]
    C --> D[addModule - モジュール登録]
    D --> E[build - モジュールビルド]
    E --> F{子依存関係あり?}
    F -->|Yes| C
    F -->|No| G[finish - モジュール処理完了]
    G --> H[seal - 最適化開始]
    H --> I[buildChunkGraph]
    I --> J[最適化パイプライン]
    J --> K[ID割り当て]
    K --> L[codeGeneration]
    L --> M[createHash]
    M --> N[createChunkAssets]
    N --> O[processAssets]
    O --> P[完了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | モジュール重複排除 | 同一identifierのモジュールは再利用される | addModule()時 |
| BR-02 | AsyncQueueによる並列度制御 | factorize/addModule/buildの各キューで並列度を制御 | モジュール処理全体 |
| BR-03 | processAssetsステージ制御 | processAssetsフックは定義されたステージ順で実行される | seal()内のアセット処理 |
| BR-04 | needAdditionalSeal | フックがtrueを返した場合、seal処理を再実行する | seal()完了時 |

### 計算ロジック

ハッシュ計算は、モジュールハッシュ、チャンクハッシュ、フルハッシュの順に段階的に計算される。各モジュールのコード生成結果とランタイム情報からハッシュが導出される。

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

データベースは使用しない。

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

該当なし。

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

該当なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ModuleNotFoundError | モジュール解決エラー | モジュールパスの解決に失敗 | パス・設定を確認 |
| ModuleBuildError | ビルドエラー | ローダーの実行に失敗 | ローダー設定・ソースコードを確認 |
| ModuleParseError | パースエラー | JavaScriptの構文解析に失敗 | ソースコードの構文を修正 |
| CodeGenerationError | コード生成エラー | コード生成フェーズで例外 | プラグイン・設定を確認 |
| ChunkRenderError | チャンクレンダリングエラー | チャンクのレンダリングに失敗 | テンプレート・設定を確認 |
| ModuleHashingError | ハッシュ計算エラー | モジュールのハッシュ計算に失敗 | モジュールの状態を確認 |
| BuildCycleError | 循環依存エラー | ビルド中の循環依存を検出 | 依存関係を見直す |

### リトライ仕様

リトライ機構は実装されていない。エラーはerrors配列に集約され、ビルド結果として報告される。致命的でないエラーはビルドを中断しない。

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

トランザクション機構はない。seal()処理は逐次的に実行され、途中エラーが発生した場合は即座にコールバックにエラーが渡される。

## パフォーマンス要件

- AsyncQueueによるモジュール処理の並列度制御
- unsafeCacheによるモジュール生成結果のキャッシュ
- ModuleMemCachesによるモジュールレベルのメモリキャッシュ
- processAsyncTreeによる非同期ツリー処理の効率化

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

- ローダーの実行はサンドボックスなしで行われるため、信頼されたローダーのみを使用すること
- executeModule()はモジュールを実際に実行するため、信頼されたコードのみを対象とすること

## 備考

- Compilation.PROCESS_ASSETS_STAGE_* 定数により、processAssetsフックの実行順序が定義されている
- webpack 5ではprocessAssetsフックに一本化され、以前のoptimizeChunkAssets等は非推奨となった

---

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

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

### 推奨読解順序

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

Compilationクラスのプロパティとフック定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Compilation.js | `lib/Compilation.js` | フック定義（758-1044行目）で利用可能なフック群を把握する |
| 1-2 | Compilation.js | `lib/Compilation.js` | プロパティ初期化（1045行目以降）でmodules, chunks, assets等の主要データ構造を理解する |
| 1-3 | Compilation.js | `lib/Compilation.js` | 型定義（200-500行目）でAssetInfo, EntryData, ExecuteModuleResult等のデータ型を理解する |

**読解のコツ**: Compilationのフックは非常に多い（60以上）。最初はseal()内で呼ばれる最適化パイプラインのフック順序に注目すると全体像が把握しやすい。

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

addEntry()からモジュールグラフ構築が始まる流れを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Compilation.js | `lib/Compilation.js` | addEntry()メソッドでエントリポイントの登録処理を理解する |
| 2-2 | Compilation.js | `lib/Compilation.js` | handleModuleCreation()でモジュール生成→追加→ビルドの非同期パイプラインを理解する |

#### Step 3: モジュール処理パイプラインを理解する

AsyncQueueを使った3段階のモジュール処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Compilation.js | `lib/Compilation.js` | factorizeModule(): NormalModuleFactoryを使ったモジュール生成 |
| 3-2 | Compilation.js | `lib/Compilation.js` | addModule(): モジュールの登録と重複チェック |
| 3-3 | Compilation.js | `lib/Compilation.js` | _buildModule(): ローダー実行とソースコード解析 |
| 3-4 | Compilation.js | `lib/Compilation.js` | processModuleDependencies(): 再帰的な依存関係処理 |

#### Step 4: seal処理を理解する

seal()メソッドの最適化パイプラインを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Compilation.js | `lib/Compilation.js` | seal()メソッドでチャンクグラフ構築→最適化→コード生成→ハッシュ→アセット生成の流れを理解する |
| 4-2 | buildChunkGraph.js | `lib/buildChunkGraph.js` | チャンクグラフの構築アルゴリズムを理解する |

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

```
Compilation
    │
    ├─ addEntry(context, dep, options, callback)
    │      └─ _addEntryItem(context, dep, options, callback)
    │             └─ addModuleTree({ context, dependency }, callback)
    │                    └─ handleModuleCreation({ factory, dependencies, ... })
    │                           ├─ factorizeModule() [AsyncQueue]
    │                           │      └─ NormalModuleFactory.create()
    │                           ├─ addModule() [AsyncQueue]
    │                           │      └─ _modules / _modulesCache 管理
    │                           └─ buildModule() [AsyncQueue]
    │                                  ├─ module.needBuild() チェック
    │                                  ├─ module.build() 実行
    │                                  └─ processModuleDependencies()
    │                                         └─ handleModuleCreation() [再帰]
    │
    ├─ finish(callback)
    │      ├─ エラー・警告の集約
    │      └─ hooks.finishModules.callAsync()
    │
    └─ seal(callback)
           ├─ hooks.seal.call()
           ├─ hooks.beforeChunks.call()
           ├─ buildChunkGraph(this, inputEntrypointsAndModules)
           ├─ hooks.afterChunks.call()
           ├─ hooks.optimize.call()
           ├─ hooks.optimizeDependencies -> optimizeModules -> optimizeChunks
           ├─ hooks.optimizeTree -> optimizeChunkModules
           ├─ モジュール/チャンクID割り当て
           ├─ codeGeneration()
           ├─ processRuntimeRequirements()
           ├─ createHash()
           ├─ createChunkAssets()
           └─ hooks.processAssets -> afterProcessAssets -> afterSeal
```

### データフロー図

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

エントリ設定 ─────▶ addEntry() ──────────────────▶ entrypoints Map
                          │
ソースファイル ──▶ factorize → addModule → build
                          │
                   processModuleDependencies ────▶ ModuleGraph
                          │                         （依存関係グラフ）
                          ▼
                   seal()
                   ├─ buildChunkGraph ──────────▶ ChunkGraph
                   ├─ 最適化パイプライン              （チャンク-モジュール対応）
                   ├─ codeGeneration ───────────▶ CodeGenerationResults
                   ├─ createHash ───────────────▶ hash, fullHash
                   └─ createChunkAssets ────────▶ assets Map
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Compilation.js | `lib/Compilation.js` | ソース | Compilationクラス本体 |
| Compiler.js | `lib/Compiler.js` | ソース | Compilationを生成する親クラス |
| ModuleGraph.js | `lib/ModuleGraph.js` | ソース | モジュール間の依存関係グラフ |
| ChunkGraph.js | `lib/ChunkGraph.js` | ソース | チャンクとモジュールの対応管理 |
| buildChunkGraph.js | `lib/buildChunkGraph.js` | ソース | チャンクグラフ構築アルゴリズム |
| NormalModuleFactory.js | `lib/NormalModuleFactory.js` | ソース | モジュール生成ファクトリ |
| AsyncQueue.js | `lib/util/AsyncQueue.js` | ソース | 並列度制御付き非同期キュー |
| CodeGenerationResults.js | `lib/CodeGenerationResults.js` | ソース | コード生成結果の格納 |
| Entrypoint.js | `lib/Entrypoint.js` | ソース | エントリポイント管理 |
| Chunk.js | `lib/Chunk.js` | ソース | チャンクデータ構造 |
| Module.js | `lib/Module.js` | ソース | モジュール基底クラス |
