# 通知設計書 1-WebpackError

## 概要

本ドキュメントは、Webpackにおけるすべてのエラー・警告通知の基底クラスである `WebpackError` の設計仕様を記述する。WebpackError はJavaScriptの標準 `Error` クラスを拡張し、Webpack固有のプロパティ（モジュール情報、位置情報、チャンク情報など）を付加した共通基盤を提供する。

### 本通知の処理概要

WebpackError は、Webpackのビルドプロセス全体で発生するすべてのエラーおよび警告メッセージの共通基底クラスである。直接インスタンス化されることもあるが、主に他の具体的なエラー・警告クラスがこのクラスを継承して使用する。

**業務上の目的・背景**：Webpackのビルドプロセスでは、モジュール解決、依存関係解析、コード生成、チャンクレンダリングなど多岐にわたるフェーズでエラーや警告が発生しうる。これらの通知を統一的に管理・表示するため、共通のプロパティ（module, loc, chunk, hideStack, details, file）を持つ基底クラスが必要となる。WebpackError はこの役割を担い、Stats出力やCLI表示における一貫したエラー/警告レポートを実現する。

**通知の送信タイミング**：WebpackError 自体は基底クラスであるため、直接的な「送信タイミング」は定義されない。派生クラスがビルドの各フェーズ（ローダー実行、モジュール解析、依存関係解決、コード生成など）でインスタンス化され、Compilationオブジェクトの `errors` または `warnings` 配列に追加されることでユーザーに通知される。

**通知の受信者**：Webpackビルドを実行した開発者が受信者となる。Stats出力（コンソール、JSON、HTML）を通じてエラー・警告情報が表示される。

**通知内容の概要**：エラーメッセージ（message）、詳細情報（details）、発生元モジュール（module）、ソースコード上の位置情報（loc）、関連チャンク（chunk）、関連ファイル（file）、スタックトレースの表示制御（hideStack）を含む。

**期待されるアクション**：開発者はエラー/警告メッセージと位置情報を確認し、ソースコードの修正、設定の変更、依存関係の見直しなど、通知内容に応じた対応を行う。

## 通知種別

ビルドプロセス内通知（コンソール出力 / Stats JSON / Stats HTML）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Compilation.errors/warnings配列への追加） |
| 優先度 | エラー: 高 / 警告: 中 |
| リトライ | なし（ビルド結果として一括出力） |

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

Compilationオブジェクトの `errors` 配列（エラーの場合）または `warnings` 配列（警告の場合）に追加される。Stats生成時にこれらの配列から情報が収集され、設定された出力形式（コンソール、JSON等）でビルド実行者に表示される。

## 通知テンプレート

### メール通知の場合

該当なし（メール通知ではなく、ビルド出力として表示される）。

### 本文テンプレート

```
{name}: {message}
{details}
{stack}
```

inspectカスタム出力:
```
{stack}
{details（存在する場合）}
{cause（存在する場合）}
```

### 添付ファイル

該当なし。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | エラー/警告メッセージ | コンストラクタ引数 | Yes |
| name | エラー名称 | 派生クラスで設定 | Yes |
| details | 詳細情報（スタックトレース等） | 派生クラスで設定 | No |
| module | 関連モジュール | 派生クラスで設定 | No |
| loc | ソースコード位置情報 | 派生クラスで設定 | No |
| hideStack | スタックトレース非表示フラグ | 派生クラスで設定 | No |
| chunk | 関連チャンク | 外部から設定 | No |
| file | 関連ファイル | 外部から設定 | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ビルドプロセス | 各派生クラスのインスタンス化 | エラー/警告発生時 | Compilation.errors/warningsへの追加 |
| Stats出力 | compilation.getStats() | ビルド完了時 | Stats出力時にerrors/warningsが表示される |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| stats設定による抑止 | webpack設定のstats.warnings=false, stats.errors=false等で表示を抑制可能 |
| hideStackフラグ | trueの場合、スタックトレースが非表示になる |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[派生クラスでエラー/警告が発生] --> B[WebpackErrorインスタンス生成]
    B --> C[プロパティ設定 message/details/module/loc等]
    C --> D[Compilation.errors または warnings に追加]
    D --> E[Stats生成時に収集]
    E --> F[Stats出力形式に整形]
    F --> G[コンソール/JSON/HTML出力]
```

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

### 参照テーブル一覧

該当なし（データベースは使用しない）。

### 更新テーブル一覧

該当なし（データベースは使用しない）。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| シリアライズエラー | キャッシュ保存時にserialize/deserializeが失敗 | makeSerializableによる登録が正しいか確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ビルド実行時に即座に出力される）。

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

エラーメッセージにファイルパスやスタックトレースが含まれるため、本番環境のログ出力時にはパス情報が外部に漏洩しないよう注意が必要。

## 備考

- WebpackError は `makeSerializable` によりキャッシュのシリアライズ/デシリアライズに対応している。
- `util.inspect.custom` シンボルを実装し、Node.jsのinspect出力をカスタマイズしている。
- Webpack内のすべてのエラー・警告クラス（ModuleWarning, ModuleError, ModuleBuildError等）がこのクラスを継承している。

---

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

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

### 推奨読解順序

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

まず、WebpackErrorクラスが持つプロパティとその型定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | WebpackError.js | `lib/WebpackError.js` | クラス定義、プロパティ（message, details, module, loc, hideStack, chunk, file）の型と初期値 |

**読解のコツ**: JSDocの `@typedef` によるインポート型定義に注目する。`Chunk`, `DependencyLocation`, `Module` の型がインポートされており、これらがWebpackErrorが関連付けられるオブジェクトの型を示している。

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

WebpackErrorは基底クラスであるため、直接のエントリーポイントはない。代わりに、派生クラスがCompilation内で生成・登録される仕組みを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Compilation.js | `lib/Compilation.js` | `errors` 配列と `warnings` 配列の定義、`reportDependencyErrorsAndWarnings` メソッド |

**主要処理フロー**:
1. **17行目**: コンストラクタでError基底クラスを呼び出し、message と options(cause) を渡す
2. **27-37行目**: Webpack固有プロパティ（details, module, loc, hideStack, chunk, file）をundefinedで初期化
3. **43-49行目**: `util.inspect.custom` シンボルで inspect出力をカスタマイズ
4. **54-62行目**: serialize メソッドでキャッシュ永続化用のシリアライズ処理
5. **67-75行目**: deserialize メソッドでキャッシュからの復元処理
6. **78行目**: makeSerializable でシリアライズ登録

#### Step 3: シリアライズ基盤を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | makeSerializable.js | `lib/util/makeSerializable.js` | ClassSerializerによるserialize/deserializeのラッパー、register関数への登録 |

**主要処理フロー**:
- **58-60行目**: register関数にConstructor, request, name, ClassSerializerインスタンスを渡してシリアライズ可能にする

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

```
Error (JavaScript標準)
    │
    └─ WebpackError (lib/WebpackError.js)
           │
           ├─ ModuleWarning (lib/ModuleWarning.js)
           ├─ ModuleError (lib/ModuleError.js)
           ├─ ModuleBuildError (lib/ModuleBuildError.js)
           ├─ ModuleDependencyWarning (lib/ModuleDependencyWarning.js)
           ├─ ModuleDependencyError (lib/ModuleDependencyError.js)
           ├─ ModuleNotFoundError (lib/ModuleNotFoundError.js)
           ├─ CommentCompilationWarning (lib/CommentCompilationWarning.js)
           ├─ InvalidDependenciesModuleWarning (lib/InvalidDependenciesModuleWarning.js)
           ├─ CriticalDependencyWarning (lib/dependencies/CriticalDependencyWarning.js)
           └─ ... (その他多数の派生クラス)
```

### データフロー図

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

エラーメッセージ ───> WebpackError             ───> Compilation.errors[]
(string)             コンストラクタ                  または
                     プロパティ設定                   Compilation.warnings[]
                                                     │
                                                     v
                                               Stats出力
                                               (コンソール/JSON)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| WebpackError.js | `lib/WebpackError.js` | ソース | 基底エラー/警告クラス定義 |
| makeSerializable.js | `lib/util/makeSerializable.js` | ソース | シリアライズ登録ユーティリティ |
| ErrorHelpers.js | `lib/ErrorHelpers.js` | ソース | スタックトレースのクリーンアップヘルパー |
| Compilation.js | `lib/Compilation.js` | ソース | errors/warnings配列の管理、通知の収集 |
| NormalModule.js | `lib/NormalModule.js` | ソース | ローダー実行時のエラー/警告生成 |
