# 通知設計書 7-ModuleError

## 概要

本ドキュメントは、Webpackにおけるモジュール処理時の一般的なエラーメッセージを表す `ModuleError` クラスの設計仕様を記述する。ローダーやプラグインが `emitError` を通じて発行するエラーを、統一されたフォーマットでラップする役割を持つ。

### 本通知の処理概要

ModuleError は、ローダーの実行中に発生するエラーを表現するクラスである。ローダーが `loaderContext.emitError()` を呼び出した際に生成され、NormalModuleのエラーリストに追加される。ModuleWarningのエラー版に相当する。

**業務上の目的・背景**：Webpackのビルドプロセスでは、ローダーやプラグインがモジュール処理中に致命的な問題を検出することがある。ModuleBuildError（ビルド自体の失敗）とは異なり、ModuleErrorはローダーが自発的に報告するエラーであり、ビルドプロセス自体は継続される。開発者に問題の存在を確実に伝え、修正を促すことが目的である。

**通知の送信タイミング**：ローダーの `emitError` コールバックが呼ばれた時（NormalModule.js 行764-772）。モジュールのビルドフェーズで発生する。

**通知の受信者**：Webpackビルドを実行した開発者。Stats出力を通じてコンソールやJSON形式でエラーとして表示される。

**通知内容の概要**：「Module Error (from {ローダー名}): {元のエラーメッセージ}」の形式で表示される。元のエラーがErrorオブジェクトの場合は、そのスタックトレースをcleanUp処理した上でdetailsプロパティに保持する。

**期待されるアクション**：開発者はエラーメッセージの内容に従い、ソースコードの修正、ローダー設定の見直し、依存パッケージの更新などを行う。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Module.addError経由でCompilation.errorsに追加） |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

NormalModuleの `addError` メソッド経由でモジュールのエラーリストに追加される。その後、Compilationがモジュールのエラーを収集し、Stats出力時にビルド実行者にエラーとして表示する。

## 通知テンプレート

### メール通知の場合

該当なし（ビルド出力として表示される）。

### 本文テンプレート

fromパラメータがある場合:
```
Module Error (from {from}):
{err.message}
```

fromパラメータがない場合:
```
Module Error: {err.message}
```

### 添付ファイル

該当なし。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| err | 元のErrorオブジェクト | ローダー/プラグインからのemitError引数 | Yes |
| from | エラー発生元のローダー名 | getCurrentLoaderName()の戻り値 | No |
| name | エラー名称（固定値 "ModuleError"） | クラス内で設定 | Yes |
| error | 元のErrorオブジェクト参照 | コンストラクタ引数のerr | Yes |
| details | スタックトレースのクリーンアップ結果 | ErrorHelpers.cleanUp() | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ローダー実行 | loaderContext.emitError()呼び出し | 常に（emitError呼び出し時） | NormalModule.js 行764-772 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| stats.errors=false | webpack設定でerrors表示を無効にしている場合、Stats出力に含まれない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ローダー内でemitError呼び出し] --> B{errorがError型か?}
    B -->|No| C[NonErrorEmittedErrorでラップ]
    B -->|Yes| D[ModuleErrorインスタンス生成]
    C --> D
    D --> E[from パラメータ付きメッセージ構築]
    E --> F[err.stackをcleanUpしてdetailsに設定]
    F --> G[Module.addError でエラー追加]
    G --> H[Compilation.errors に収集]
    H --> I[Stats出力]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| NonErrorEmittedError | emitErrorに非Errorオブジェクトが渡された場合 | NonErrorEmittedErrorでラップしてから処理する |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

エラーメッセージにローダーのファイルパスが含まれる場合がある（from パラメータ）。CI/CD環境のログ公開時には、内部ファイルパスの漏洩に注意する。

## 備考

- ModuleError は `makeSerializable` によりキャッシュのシリアライズ/デシリアライズに対応している。
- serialize/deserialize メソッドでは `error` プロパティも保存・復元される。
- ModuleWarning（No.2）とほぼ同じ構造だが、エラーとして扱われる点が異なる（Compilation.errorsに追加される）。
- `ErrorHelpers.cleanUp` により、スタックトレースからローダー実行フラグ以降の行とメッセージ行が除去される。

---

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

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

### 推奨読解順序

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

ModuleErrorクラスの構造と、ModuleWarningとの共通点・相違点を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ModuleError.js | `lib/ModuleError.js` | コンストラクタでのメッセージ構築ロジック、errorプロパティ、cleanUpによるdetails生成 |
| 1-2 | ModuleWarning.js | `lib/ModuleWarning.js` | 比較対象: 同じ構造でwarningプロパティ名が異なる |

**読解のコツ**: ModuleError（行20-42）のコンストラクタは ModuleWarning とほぼ同一構造。主な違いはメッセージプレフィックス（"Module Error" vs "Module Warning"）と、プロパティ名（`this.error` vs `this.warning`）のみ。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NormalModule.js | `lib/NormalModule.js` | _createLoaderContextメソッド内のemitError定義（行764-772） |

**主要処理フロー**:
1. **行764**: `emitError` コールバック定義
2. **行765-766**: 引数がError型でない場合、NonErrorEmittedErrorでラップ
3. **行768-772**: `new ModuleError(error, { from: getCurrentLoaderName() })` でインスタンス生成
4. **行768**: `this.addError()` でモジュールのエラーリストに追加

#### Step 3: スタックトレース整形を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ErrorHelpers.js | `lib/ErrorHelpers.js` | cleanUp関数（行77-81）: ModuleWarningと同じヘルパーを使用 |

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

```
NormalModule._createLoaderContext()
    │
    └─ emitError(error)               [行764]
           ├─ new NonErrorEmittedError()  [行766] (非Error時)
           └─ new ModuleError(error, {from})  [行769]
                  ├─ super(message)        [行31]
                  └─ cleanUp(err.stack)    [行39-41]
                         ├─ cutOffLoaderExecution() [ErrorHelpers.js 行31]
                         └─ cutOffMessage()         [ErrorHelpers.js 行63-70]
```

### データフロー図

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

ローダーからの      ───> NonErrorEmittedError        ───> ModuleError
Errorオブジェクト        (非Error時ラップ)                  │
                                                          │ addError()
from: ローダー名    ───> メッセージ構築               ───> Module.errors[]
                         "Module Error (from X): Y"        │
                                                          │ Compilation収集
err.stack           ───> cleanUp()                   ───> Compilation.errors[]
                         スタックトレース整形               │
                                                          v
                                                     Stats出力(エラー)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ModuleError.js | `lib/ModuleError.js` | ソース | モジュールエラークラス定義 |
| WebpackError.js | `lib/WebpackError.js` | ソース | 基底エラー/警告クラス |
| ErrorHelpers.js | `lib/ErrorHelpers.js` | ソース | スタックトレース整形ヘルパー |
| NormalModule.js | `lib/NormalModule.js` | ソース | ローダー実行コンテキスト、emitError定義 |
| makeSerializable.js | `lib/util/makeSerializable.js` | ソース | シリアライズ登録ユーティリティ |
| Compilation.js | `lib/Compilation.js` | ソース | errors配列の管理 |
