# 通知設計書 5-Async\ConditionNode::fail

## 概要

本ドキュメントは、HH\Lib\Async\ConditionNode クラスの fail メソッドによるリンクリストノードへの失敗通知機能について記載する。

### 本通知の処理概要

Async\ConditionNode::fail メソッドは、リンクリスト構造を持つ条件変数ノードに対して失敗通知を行う機能である。ConditionNode は Condition クラスを継承しており、fail メソッドは親クラスから継承される。主に BasePoll クラスで非同期イテレーション中に発生した例外の通知に使用される。

**業務上の目的・背景**：Poll パターンにおいて、監視対象の Awaitable のいずれかが例外で失敗した場合、その例外を foreach ループの利用者に伝播する必要がある。ConditionNode::fail は、Awaitable の失敗時に例外を待機側に通知し、適切なエラーハンドリングを可能にする。これにより、非同期イテレーション中のエラーを漏れなく捕捉できる。

**通知の送信タイミング**：BasePoll 内の waitForThenNotify メソッドの catch ブロックから、Awaitable の失敗時に自動的に呼び出される。Awaitable が例外をスローした場合に対応するノードに対して fail が呼び出される。

**通知の受信者**：同一 ConditionNode に対して waitForNotificationAsync を呼び出している BasePoll::next メソッドが受信者となる。

**通知内容の概要**：\Exception オブジェクトが通知される。この例外は Awaitable が発生させた元の例外である。

**期待されるアクション**：受信者（BasePoll::next）から例外がスローされ、foreach ループの利用者の try-catch ブロックでキャッチされる。

## 通知種別

プログラム内非同期通知（リンクリスト型条件変数・Poll パターン・例外通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（メソッド呼び出し時に即座に状態変更） |
| 優先度 | N/A（プログラム内通知のため） |
| リトライ | 無（各ノードへの通知は1回のみ） |

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

送信先は BasePoll 内で管理されるリンクリストの次のノード（lastNotified の次のノード）である。ノードの順序は Awaitable が追加された順序に従うが、完了順に通知される。

## 通知テンプレート

### プログラム通知の場合

| 項目 | 内容 |
|-----|------|
| 通知形式 | Awaitable の例外完了 |
| データ型 | \Exception |
| 通知方法 | 継承した Condition::fail メソッド経由 |

### 通知データ構造

```hack
// 失敗通知時のデータ
\Exception $exception  // Awaitable から発生した例外
```

### 添付ファイル

該当なし（プログラム内通知のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $exception | Awaitable から発生した例外 | catch ブロックで捕捉された例外 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| Awaitable 例外 | await $awaitable で例外発生 | なし | waitForThenNotify の catch ブロックから呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 二重通知 | 同一ノードに対して既に succeed または fail が呼び出されている場合、invariant 違反 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Awaitable 失敗] --> B[waitForThenNotify 内で例外捕捉]
    B --> C[lastNotified を次のノードに進める]
    C --> D[lastNotified->fail を呼び出し]
    D --> E[待機中の next メソッドに例外を通知]
    E --> F[foreach ループで例外スロー]
    F --> G[利用者の catch ブロックで処理]
    G --> H[終了]
```

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

該当なし（メモリ内での状態管理のみ）

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| invariant 違反 | 同一ノードに2回以上 succeed/fail を呼び出した場合 | 通常使用では発生しない（BasePoll が管理） |
| 例外の伝播 | Awaitable が例外をスローした場合 | foreach ループで try-catch を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（プログラム内通知のため）

### 配信時間帯

制限なし

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

- 例外メッセージやスタックトレースに機密情報が含まれる可能性がある場合は、ログ出力時に適切なマスキングを検討
- 例外の種類によっては、攻撃者に内部実装の詳細が漏洩する可能性があることに注意

## 備考

- ConditionNode は Condition クラスを継承し、リンクリスト機能を追加したクラス
- fail メソッドは親クラス Condition から継承される
- PollTest の testInputs でエラーケースのテストが行われている

---

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

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

### 推奨読解順序

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

ConditionNode のリンクリスト構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ConditionNode.php | `src/async/ConditionNode.php` | クラス定義と継承関係（16行目） |
| 1-2 | ConditionNode.php | `src/async/ConditionNode.php` | $next プロパティとリンクリスト構造（17行目） |

**読解のコツ**: ConditionNode は Condition を継承し、fail メソッドはそのまま継承される。

#### Step 2: 継承元のメソッドを理解する

fail メソッドは Condition クラスから継承される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Condition.php | `src/async/Condition.php` | fail メソッドの実装（41-52行目） |

**主要処理フロー**:
- ConditionNode::fail は Condition::fail をそのまま継承
- 処理内容は Condition::fail と同一

#### Step 3: BasePoll での使用パターンを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | BasePoll.php | `src/async/BasePoll.php` | waitForThenNotify メソッド（132-146行目） |
| 3-2 | BasePoll.php | `src/async/BasePoll.php` | catch ブロックでの fail 呼び出し（141-145行目） |

**主要処理フロー**:
- **行132-135**: async メソッドの定義
- **行141**: catch ブロックで例外を捕捉
- **行142-143**: lastNotified を次のノードに進める
- **行144**: lastNotified->fail($exception) を呼び出し

#### Step 4: テストコードで動作を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | PollTest.php | `tests/async/PollTest.php` | testInputs メソッドのエラーケース（54-64行目、66-78行目） |

**主要処理フロー**:
- **行54-64**: 単一の eager failure テストケース
- **行60-64**: 単一の resumed failure テストケース
- **行66-78**: 複合テストケース（成功と失敗の混在）

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

```
BasePoll::addImpl($key, $awaitable)
    |
    +-- ConditionNode::addNext()  // 新しいノードを追加
    |
    +-- waitForThenNotify($key, $awaitable)
            |
            +-- try: await $awaitable
            |
            +-- catch (\Exception $exception)
                    |
                    +-- lastNotified = lastNotified->getNext()
                    |
                    +-- lastNotified->fail($exception)
                            |
                            +-- [継承] Condition::fail()
                                    |
                                    +-- 待機中の next() で例外スロー
```

### データフロー図

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

Awaitable<Tv>
    │
    v
await ────────▶ [例外発生] ────▶ waitForThenNotify()
                    │                    │
                    │                    v
                    │           catch (\Exception)
                    │                    │
                    │                    v
                    │           ConditionNode::fail()
                    │                    │
                    │                    v
                    └──────────▶ BasePoll::next()
                                         │
                                         v
                                 foreach ループで
                                 例外がスロー
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ConditionNode.php | `src/async/ConditionNode.php` | ソース | ConditionNode クラスの実装 |
| Condition.php | `src/async/Condition.php` | ソース | 親クラス Condition の実装 |
| BasePoll.php | `src/async/BasePoll.php` | ソース | ConditionNode を使用する Poll 基底クラス |
| Poll.php | `src/async/Poll.php` | ソース | BasePoll を継承した具象クラス |
| KeyedPoll.php | `src/async/KeyedPoll.php` | ソース | BasePoll を継承したキー付き Poll クラス |
| PollTest.php | `tests/async/PollTest.php` | テスト | Poll/KeyedPoll のユニットテスト（エラーケース含む） |
