# 通知設計書 12-ModuleHashingError

## 概要

本ドキュメントは、Webpackにおけるモジュールハッシュ計算エラー通知（ModuleHashingError）の設計を定義する。ModuleHashingErrorは、モジュールのコンテンツハッシュを計算する際に例外が発生した場合に発行されるエラー通知である。

### 本通知の処理概要

ModuleHashingErrorは、Webpackのコンパイル処理においてモジュールのハッシュダイジェストを計算する際に発生するエラーを開発者に通知する。ハッシュ計算はキャッシュの無効化やファイル名へのハッシュ埋め込みに使用されるため、このエラーはビルド成果物の正確性に影響する。

**業務上の目的・背景**：Webpackはモジュールごとにハッシュ値を計算し、キャッシュバスティングやロングタームキャッシュの管理に活用する。ハッシュ計算が失敗するとキャッシュ戦略が機能しなくなるため、開発者に迅速に問題を通知し、原因調査を促す必要がある。このエラーは、カスタムモジュールやプラグインがハッシュ計算ロジックに不整合を持つ場合に発生しうる。

**通知の送信タイミング**：Compilation.jsのcreateModuleHashes処理内でモジュールのハッシュを計算する際に例外がスローされたとき。具体的にはCompilation.js 4439-4441行目付近のcatchブロックで生成される。

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

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

**期待されるアクション**：開発者は、エラーの原因となっているモジュールやプラグインを特定し、ハッシュ計算の前提条件を満たすようにコードまたは設定を修正することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（ハッシュ計算プロセス内で即座に生成） |
| 優先度 | 高（ビルド成果物の正確性に影響） |
| リトライ | 無（エラー記録後、ハッシュ値は"XXXXXX"で代替） |

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

Compilation.jsのcreateModuleHashes処理中にmodule.hash()がスローした例外をcatchブロックで捕捉し、ModuleHashingErrorインスタンスを生成してerrors配列に追加する。ハッシュ値は"XXXXXX"というフォールバック値が設定され、ビルドは続行される。

## 通知テンプレート

### メール通知の場合

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

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

### 本文テンプレート

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ビルド処理 | Compilation.createModuleHashes内のハッシュ計算 | module.hash()が例外をスロー | try-catchブロックで捕捉（Compilation.js 4439-4441行目付近） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ハッシュ計算が正常に完了した場合 | エラーは発行されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Compilation.createModuleHashes開始] --> B[各モジュールのハッシュ計算]
    B --> C{ハッシュ計算成功？}
    C -->|成功| D[moduleHashDigestにハッシュ値設定]
    C -->|失敗| E[ModuleHashingError生成]
    E --> F[errors配列に追加]
    F --> G[moduleHashDigestに"XXXXXX"設定]
    D --> H[chunkGraph.setModuleHashes呼び出し]
    G --> H
    H --> I[次のモジュールへ]
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| Module | ハッシュ計算対象モジュール | Moduleインスタンス |
| Error | 元のエラー情報 | catchで捕捉されたエラー |

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

#### ModuleHashingErrorインスタンス

| 参照項目（プロパティ名） | 用途 | 取得条件 |
|-------------------|------|---------|
| error.message | エラーメッセージ表示 | Errorオブジェクトから取得 |
| error.stack | 詳細情報（details）表示 | Errorオブジェクトから取得 |
| module | エラー発生モジュールの特定 | ハッシュ計算対象モジュール |

### 更新テーブル一覧

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

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

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ハッシュ計算失敗 | module.hash()が例外をスロー | エラー記録しフォールバックハッシュ"XXXXXX"を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- スタックトレースが含まれるため、ファイルパスなどの内部構造情報が表示される可能性がある
- ビルドログの外部公開時にはスタックトレース情報の取り扱いに注意

## 備考

- ModuleHashingErrorはmakeSerializableによる登録がないため、永続キャッシュ非対応
- ハッシュ計算失敗時のフォールバック値"XXXXXX"は、キャッシュバスティングが正しく機能しない可能性を示唆する
- コンストラクタはsuper()を引数なしで呼び出し、その後messageプロパティを直接設定する

---

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

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

### 推奨読解順序

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

ModuleHashingErrorクラスの構造は非常にシンプルである。

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

**読解のコツ**: コンストラクタでsuper()を引数なしで呼び出し、messageプロパティを後から設定している点に注目。detailsにerror.stack（スタックトレース）が格納される。

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

ModuleHashingErrorが生成されるCompilation.jsのハッシュ計算処理を理解する。

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

**主要処理フロー**:
1. **4435-4438行目**: moduleHash.digest(hashDigest)でハッシュダイジェスト計算
2. **4439行目**: catchブロックでエラー捕捉
3. **4440行目**: new ModuleHashingError(module, err)でエラー生成、errors配列に追加
4. **4441行目**: フォールバック値"XXXXXX"をmoduleHashDigestに設定

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

```
Compilation.createModuleHashes()
    |
    +-- [各モジュールに対して]
    |       |
    |       +-- module.updateHash() (ハッシュ更新)
    |       |
    |       +-- moduleHash.digest() (ダイジェスト計算)
    |       |       |
    |       |       +-- [例外発生時]
    |       |               |
    |       |               +-- new ModuleHashingError(module, err)
    |       |               |
    |       |               +-- errors.push(error)
    |       |               |
    |       |               +-- moduleHashDigest = "XXXXXX"
    |       |
    |       +-- chunkGraph.setModuleHashes()
```

### データフロー図

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

Module                 --> ModuleHashingError             --> エラーメッセージ文字列
Error (hash計算例外)     |  コンストラクタ                  --> errors配列
                        |  - name設定                      --> フォールバックハッシュ"XXXXXX"
                        |  - message=error.message
                        |  - details=error.stack
                        |  - module=対象モジュール
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| WebpackError.js | `lib/WebpackError.js` | ソース | 基底エラークラス |
| ModuleHashingError.js | `lib/ModuleHashingError.js` | ソース | ハッシュエラークラス定義 |
| Compilation.js | `lib/Compilation.js` | ソース | エラー発行元（createModuleHashes） |
