# 通知設計書 11-ModuleParseError

## 概要

本ドキュメントは、Webpackにおけるモジュール解析エラー通知（ModuleParseError）の設計を定義する。ModuleParseErrorは、JavaScriptやその他のモジュールのパース処理に失敗した場合に発行されるエラー通知であり、ビルド失敗の主要な原因の一つである。

### 本通知の処理概要

ModuleParseErrorは、Webpackがモジュールのソースコードを解析（パース）する際に発生するエラーを開発者に通知するための仕組みである。適切なローダーが設定されていない場合や、構文エラーがある場合、WebAssemblyモジュールの誤認など、多様なパースエラーをカバーする。

**業務上の目的・背景**：モジュールバンドラーであるWebpackは、様々な形式のファイルを処理する。開発者がファイルに適切なローダーを設定していない場合や、ソースコードに構文エラーが含まれる場合、ビルドが失敗する。ModuleParseErrorは、失敗の原因を開発者に明確に伝え、問題の解決を支援する目的で設計されている。特にWebAssemblyモジュールがWebAssemblyとして認識されていない場合のガイダンスや、ローダー設定の提案など、具体的な修正アクションを提示する。

**通知の送信タイミング**：NormalModuleのビルド処理中、JavaScriptParserなどのパーサーがモジュールのソースコードを解析する際にエラーが発生したとき。具体的にはNormalModule.jsのhandleParseErrorコールバック内（1290-1299行目付近）で生成される。

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

**通知内容の概要**：パースエラーのメッセージ、使用中のローダー一覧、エラー発生位置（行番号）周辺のソースコード抜粋、WebAssemblyモジュール誤認時の設定ガイダンスが含まれる。

**期待されるアクション**：開発者は、エラーメッセージに基づいて適切なローダーの追加・設定変更、ソースコードの構文修正、またはWebAssembly実験機能の有効化を行うことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（ビルドプロセス内で即座に生成） |
| 優先度 | 高（ビルド失敗に直結するエラー） |
| リトライ | 無（エラー記録後、ビルドは継続するがモジュールはエラー状態） |

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

NormalModuleのビルド処理中にパースエラーが発生した場合、handleParseErrorが呼ばれ、ModuleParseErrorインスタンスが生成される。生成されたエラーはmodule.markModuleAsErroredを通じてmodule.errorsに追加され、最終的にcompilation.errorsに集約される。Webpack Stats APIまたはコンソール出力を通じて開発者に表示される。

## 通知テンプレート

### メール通知の場合

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

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

### 本文テンプレート

```
Module parse failed: {パーサーエラーメッセージ}

[WebAssemblyモジュール誤認時]
The module seem to be a WebAssembly module, but module is not flagged as WebAssembly module for webpack.
BREAKING CHANGE: Since webpack 5 WebAssembly is not enabled by default and flagged as experimental feature.
You need to enable one of the WebAssembly experiments via 'experiments.asyncWebAssembly: true' (based on async modules) or 'experiments.syncWebAssembly: true' (like webpack 4, deprecated).
For files that transpile to WebAssembly, make sure to set the module type in the 'module.rules' section of the config (e. g. 'type: "webassembly/async"').

[ローダー未設定時]
You may need an appropriate loader to handle this file type. See https://webpack.js.org/concepts/loaders

[ローダー設定済みだが処理失敗時]
File was processed with these loaders:
 * {ローダー1パス}
 * {ローダー2パス}
You may need an additional loader to handle the result of these loaders.

[エラー位置情報がある場合のソースコード抜粋]
| {前の行1}
| {前の行2}
> {エラー行}
| {後の行1}
| {後の行2}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| err.message | パーサーから返されるエラーメッセージ | パーサー例外オブジェクト | Yes |
| source | モジュールのソースコード | NormalModule._source.source() | Yes |
| loaders | 適用されたローダーのパス一覧 | NormalModule.loaders配列 | No |
| type | モジュールタイプ | NormalModule.type | Yes |
| err.loc | エラー発生位置（行・列） | パーサー例外オブジェクト | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ビルド処理 | NormalModule.doBuild完了後のparse処理 | パーサーが例外をスローした場合 | handleParseErrorコールバックで捕捉 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| パーサーが正常終了した場合 | エラーは発行されない |
| モジュールがビルドスキップされた場合 | パース処理自体が実行されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[NormalModule.doBuild完了] --> B[パーサーによるソースコード解析]
    B -->|パース成功| C[ビルド正常完了]
    B -->|パース失敗| D[handleParseError発火]
    D --> E[ソースコード取得]
    E --> F[ローダーパス一覧をcontextify]
    F --> G[ModuleParseError生成]
    G --> H{ソース判定}
    H -->|WASMヘッダー検出 & 非WebAssembly型| I[WASM設定ガイダンス追加]
    H -->|ローダー未設定| J[ローダー追加推奨メッセージ追加]
    H -->|ローダー設定済み| K[追加ローダー推奨メッセージ追加]
    I --> L[エラー位置情報チェック]
    J --> L
    K --> L
    L -->|位置情報あり & テキストファイル| M[ソースコード抜粋追加]
    L -->|位置情報あり & バイナリファイル| N[バイナリファイル表示省略メッセージ追加]
    L -->|位置情報なし & スタックあり| O[スタックトレース追加]
    M --> P[markModuleAsErrored呼び出し]
    N --> P
    O --> P
    P --> Q[compilation.errorsに追加]
    Q --> R[終了]
    C --> R
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| NormalModule._source | パース対象ソースコード取得 | Sourceオブジェクト |
| NormalModule.loaders | ローダー一覧取得 | ローダー設定配列 |
| NormalModule.type | モジュールタイプ判定 | 文字列 |

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

#### NormalModuleインスタンス

| 参照項目（プロパティ名） | 用途 | 取得条件 |
|-------------------|------|---------|
| _source | ソースコードのバッファ/文字列取得 | doBuild完了後に利用可能 |
| loaders | 適用ローダーのパス一覧 | モジュール設定から取得 |
| type | モジュールタイプ文字列 | モジュール設定から取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| module.errors | INSERT | ModuleParseErrorインスタンスの追加 |
| compilation.errors | INSERT | 最終的なエラー集約 |

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

| 操作 | 項目（プロパティ名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | module.errors[] | ModuleParseErrorインスタンス | markModuleAsErrored経由 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| WebAssembly誤認 | WASMヘッダー(\0asm)検出かつmodule.typeがwebassembly以外 | experiments.asyncWebAssemblyまたはsyncWebAssemblyの有効化を推奨 |
| ローダー未設定 | loadersがnull/undefined | 適切なローダーの追加を推奨 |
| ローダー設定済み解析失敗 | loaders.length >= 1だが解析失敗 | 追加ローダーの設定を推奨 |
| ローダー空配列 | loaders.length === 0 | 適切なローダーの設定を推奨 |
| バイナリファイル解析 | ソースがバッファまたは制御文字を含む | ソースコード省略メッセージを表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A（パースエラーはリトライで解決しない） |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（ビルド中に発生した全エラーを報告） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

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

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

- ソースコードの一部がエラーメッセージに含まれるため、ビルドログの取り扱いに注意が必要
- エラー位置周辺のソースコード（最大5行程度）が表示される
- バイナリファイルの場合はソースコード表示が省略される安全措置がある

## 備考

- ModuleParseErrorはmakeSerializableにより永続キャッシュ対応（シリアライズ/デシリアライズ可能）
- WASM_HEADERはBuffer.from([0x00, 0x61, 0x73, 0x6d])で定義されている
- エラー発生後もビルドプロセスは継続し、他のモジュールの処理を試みる

---

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

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

### 推奨読解順序

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

まず、ModuleParseErrorクラスの継承関係とプロパティ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | WebpackError.js | `lib/WebpackError.js` | 基底クラス。message, details, module, loc, hideStack, chunkプロパティの定義（17-38行目） |
| 1-2 | ModuleParseError.js | `lib/ModuleParseError.js` | エラークラス本体。コンストラクタでの条件分岐ロジックとメッセージ生成（18-98行目） |

**読解のコツ**: ModuleParseErrorのコンストラクタには4つの条件分岐（WASM誤認、ローダー未設定、ローダー設定済み、ローダー空）があり、それぞれ異なるメッセージを生成する。WASM_HEADER定数（16行目）はWebAssemblyバイナリのマジックバイトである。

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

ModuleParseErrorが生成される起点となるNormalModuleのビルド処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NormalModule.js | `lib/NormalModule.js` | handleParseError関数でModuleParseErrorが生成される（1290-1299行目） |

**主要処理フロー**:
1. **1290行目**: handleParseError関数定義 - パースエラー時のコールバック
2. **1291行目**: this._source.source()でソースコードを取得
3. **1292-1294行目**: loaders配列をcontextify関数で相対パスに変換
4. **1295行目**: new ModuleParseError(source, e, loaders, this.type)でエラー生成
5. **1296行目**: this.markModuleAsErrored(error)でモジュールをエラー状態にマーク

#### Step 3: エラーメッセージ生成ロジックを理解する

ModuleParseErrorコンストラクタ内の条件分岐を詳しく読み解く。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ModuleParseError.js | `lib/ModuleParseError.js` | WASM判定（30-42行目）、ローダー判定（43-56行目）、ソース抜粋生成（58-90行目） |

**主要処理フロー**:
- **16行目**: WASM_HEADER定数定義
- **30-33行目**: WASMヘッダー判定（Bufferの先頭4バイトまたは文字列の\0asm一致）
- **43-46行目**: ローダー未設定時のメッセージ
- **47-52行目**: ローダー設定済み時のメッセージ（ローダーパス一覧を表示）
- **58-87行目**: エラー位置情報があれば周辺ソースコードを抜粋
- **88-90行目**: 位置情報がなければスタックトレースを追加

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

```
NormalModule.build()
    |
    +-- NormalModule.doBuild() (ローダー実行)
    |       |
    |       +-- doBuild完了コールバック
    |               |
    |               +-- Parser.parse() (ソースコード解析)
    |               |       |
    |               |       +-- [例外発生時] handleParseError()
    |               |               |
    |               |               +-- new ModuleParseError(source, err, loaders, type)
    |               |               |       |
    |               |               |       +-- WebpackError.constructor(message)
    |               |               |
    |               |               +-- this.markModuleAsErrored(error)
    |               |                       |
    |               |                       +-- module.errors.push(error)
    |               |
    |               +-- [正常時] ビルド継続
    |
    +-- compilation.errors に集約
```

### データフロー図

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

ソースコード(Buffer/string) --> ModuleParseError             --> エラーメッセージ文字列
パーサーエラー(Error)         |  コンストラクタ                |
ローダー配列(string[])        |  - WASM判定                  --> module.errors[]
モジュールタイプ(string)       |  - ローダー有無判定           --> compilation.errors[]
                              |  - ソース抜粋生成             --> コンソール/Stats出力
                              |  - locプロパティ設定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| WebpackError.js | `lib/WebpackError.js` | ソース | 基底エラークラス |
| ModuleParseError.js | `lib/ModuleParseError.js` | ソース | パースエラークラス定義 |
| NormalModule.js | `lib/NormalModule.js` | ソース | エラー発行元（handleParseError） |
| makeSerializable.js | `lib/util/makeSerializable.js` | ソース | シリアライズ登録ユーティリティ |
| internalSerializables.js | `lib/util/internalSerializables.js` | ソース | シリアライズ可能クラスの登録簿 |
