# 通知設計書 15-CodeGenerationError

## 概要

本ドキュメントは、Webpackにおけるモジュールコード生成エラー通知（CodeGenerationError）の設計を定義する。CodeGenerationErrorは、モジュールのソースコードからバンドル用のコードを生成する際に例外が発生した場合に発行されるエラー通知である。

### 本通知の処理概要

CodeGenerationErrorは、Webpackのコンパイル処理においてモジュールのコード生成（code generation）フェーズで発生する例外を開発者に通知する。コード生成フェーズはモジュールのビルドが完了した後、最終的なバンドルコードを生成する段階で実行される。

**業務上の目的・背景**：Webpackのビルドパイプラインでは、モジュールの解析・ビルド後にコード生成フェーズが実行される。このフェーズでは、モジュールの依存関係テンプレートの適用やランタイムコードの生成などが行われる。コード生成が失敗するとバンドル出力が不完全になるため、開発者に原因を通知し、プラグインやローダーの修正を促す必要がある。

**通知の送信タイミング**：Compilation.jsのcodeGeneration処理内で各モジュールのcodeGeneration()メソッドが例外をスローしたとき。具体的にはCompilation.js 3782-3785行目付近のcatchブロックで生成される。

**通知の受信者**：Webpackのビルドを実行した開発者。コンソール出力またはWebpack Stats APIを通じてエラー情報が伝達される。

**通知内容の概要**：元のエラーメッセージ（error.message）とスタックトレース（error.stack）が含まれ、どのモジュールでコード生成が失敗したかを特定できる。

**期待されるアクション**：開発者は、エラーの原因となっているモジュールやプラグインを特定し、依存関係テンプレートやカスタムコード生成ロジックの修正を行うことが期待される。

## 通知種別

コンソールエラー出力 / Webpack Stats APIエラーレポート / ビルドエラー（errors配列への追加）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コード生成プロセス内で即座に生成） |
| 優先度 | 高（バンドル出力に影響するエラー） |
| リトライ | 無（エラー記録後、空のsourcesとnullのruntimeRequirementsで代替） |

### 送信先決定ロジック

Compilation.jsのcodeGeneration処理中にmodule.codeGeneration()がスローした例外をcatchブロックで捕捉し、CodeGenerationErrorインスタンスを生成してerrors配列に追加する。フォールバックとして空のMap(sources)とnullのruntimeRequirementsが設定される。

## 通知テンプレート

### メール通知の場合

本通知はメール送信ではなく、Webpackビルドコンソール出力として表示される。

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | N/A（コンソール出力） |
| 送信元名称 | webpack |
| 件名 | N/A |
| 形式 | テキスト |

### 本文テンプレート

```
CodeGenerationError: {元のエラーメッセージ}
{元のエラースタックトレース}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| error.message | 元のエラーメッセージ | catchブロックで捕捉されたErrorオブジェクト | Yes |
| error.stack | 元のスタックトレース | catchブロックで捕捉されたErrorオブジェクト | Yes |
| module | コード生成対象のモジュール | Compilation.codeGenerationの処理対象 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ビルド処理 | Compilation.codeGeneration内のmodule.codeGeneration()呼び出し | module.codeGeneration()が例外をスロー | try-catchブロックで捕捉（Compilation.js 3782-3785行目付近） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| コード生成が正常に完了した場合 | エラーは発行されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Compilation.codeGeneration開始] --> B[各モジュールのcodeGeneration呼び出し]
    B --> C{コード生成成功？}
    C -->|成功| D[コード生成結果を保存]
    C -->|失敗| E[CodeGenerationError生成]
    E --> F[errors配列に追加]
    F --> G[フォールバック結果を設定]
    G --> H["sources: new Map(), runtimeRequirements: null"]
    D --> I[次のモジュールへ]
    H --> I
```

## データベース参照・更新仕様

### 参照テーブル一覧

本通知はデータベースを使用しない。Webpackのインメモリデータ構造を参照する。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| Module | コード生成対象モジュール | Moduleインスタンス |
| Error | 元のエラー情報 | catchで捕捉されたエラー |

### テーブル別参照項目詳細

#### CodeGenerationErrorインスタンス

| 参照項目（プロパティ名） | 用途 | 取得条件 |
|-------------------|------|---------|
| name | エラー名表示 | 固定値 "CodeGenerationError" |
| module | エラー発生モジュール | コンストラクタ引数 |
| error | 元のエラーオブジェクト | コンストラクタ引数 |
| message | エラーメッセージ | error.messageから取得 |
| details | 詳細情報 | error.stackから取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| errors配列 | INSERT | CodeGenerationErrorインスタンスの追加 |

#### 送信ログテーブル

| 操作 | 項目（プロパティ名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | errors[] | CodeGenerationErrorインスタンス | codeGeneration処理内のローカルerrors配列 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コード生成失敗 | module.codeGeneration()が例外をスロー | プラグインや依存関係テンプレートの修正 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし。Webpackビルド実行時に即座に通知される。

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

- スタックトレースが含まれるため、ファイルパスやモジュール構造の内部情報が表示される可能性がある

## 備考

- ModuleHashingError（No.12）と類似した構造を持つシンプルなエラークラス
- コンストラクタはsuper()を引数なしで呼び出し、プロパティを個別に設定する
- makeSerializableによる登録がないため、永続キャッシュ非対応
- エラー発生後はフォールバック結果（空のsources、nullのruntimeRequirements）が使用される

---

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

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

### 推奨読解順序

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

CodeGenerationErrorクラスの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | WebpackError.js | `lib/WebpackError.js` | 基底クラスのプロパティ定義（17-38行目） |
| 1-2 | CodeGenerationError.js | `lib/CodeGenerationError.js` | エラークラス定義。name, module, error, message, detailsの5プロパティ（12-32行目） |

**読解のコツ**: super()を引数なしで呼び出し、message=error.message、details=error.stackと個別にプロパティを設定している。ModuleHashingErrorと同一のパターン。

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

CodeGenerationErrorが生成されるCompilation.jsのコード生成処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Compilation.js | `lib/Compilation.js` | codeGeneration内のtry-catchブロック（3779-3789行目付近） |

**主要処理フロー**:
1. **3779-3781行目**: module.codeGeneration()呼び出し（コード生成実行）
2. **3782行目**: catchブロックでエラー捕捉
3. **3783-3784行目**: new CodeGenerationError(module, err)でエラー生成、errors配列に追加
4. **3786-3788行目**: フォールバック結果設定（sources: new Map(), runtimeRequirements: null）

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

```
Compilation.codeGeneration()
    |
    +-- [各モジュールに対して]
            |
            +-- module.codeGeneration({...})
            |       |
            |       +-- [例外発生時]
            |               |
            |               +-- new CodeGenerationError(module, err)
            |               |
            |               +-- errors.push(error)
            |               |
            |               +-- フォールバック結果設定
            |
            +-- codeGenerationResults.set(module, runtime, result)
```

### データフロー図

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

Module                 --> CodeGenerationError             --> エラーメッセージ文字列
Error (codeGen例外)     |  コンストラクタ                  --> errors配列
                        |  - name="CodeGenerationError"    --> フォールバック結果
                        |  - message=error.message             (空Map, null)
                        |  - details=error.stack
                        |  - module=対象モジュール
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| WebpackError.js | `lib/WebpackError.js` | ソース | 基底エラークラス |
| CodeGenerationError.js | `lib/CodeGenerationError.js` | ソース | コード生成エラークラス定義 |
| Compilation.js | `lib/Compilation.js` | ソース | エラー発行元（codeGeneration） |
