# 通知設計書 6-Async\BasePoll::waitForThenNotify

## 概要

本ドキュメントは、HH\Lib\Async\BasePoll クラスの waitForThenNotify メソッドによる Awaitable 完了後の通知機能について記載する。

### 本通知の処理概要

Async\BasePoll::waitForThenNotify メソッドは、Poll パターンにおいて個々の Awaitable の完了を監視し、完了時に次の待機中の ConditionNode に結果を通知する内部メソッドである。このメソッドは private であり、addImpl や addMultiImpl から呼び出される。

**業務上の目的・背景**：Poll パターンは epoll()/poll()/select() のような非同期I/O多重化メカニズムを Hack で実現するために使用される。waitForThenNotify は、複数の Awaitable を監視し、どれか1つが完了するたびにその結果を順次通知する役割を担う。これにより、完了順に結果を処理できる非同期イテレーションが実現される。主な用途として、投機的なバックエンドリクエスト（異なるDCへの memcache リクエストなど）や、ページレット/GraphQL クエリの完了順処理がある。

**通知の送信タイミング**：監視対象の Awaitable が完了（成功または失敗）した時点で自動的に呼び出される。await $awaitable の完了を契機に、try または catch ブロックで ConditionNode への通知が行われる。

**通知の受信者**：リンクリスト内の次の ConditionNode が受信者となる。lastNotified ポインタが指す次のノードに対して succeed または fail が呼び出される。

**通知内容の概要**：成功時はタプル (Tk, Tv) が通知される。失敗時は \Exception が通知される。

**期待されるアクション**：通知を受けた ConditionNode は、待機中の BasePoll::next メソッドを解除し、foreach ループの次のイテレーションで結果を処理する。

## 通知種別

プログラム内非同期通知（内部メソッド・Poll パターン）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（await 完了後に自動送信） |
| 優先度 | N/A（プログラム内通知のため） |
| リトライ | 無（各 Awaitable につき1回のみ） |
| アクセス修飾子 | private（内部メソッド） |

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

送信先は lastNotified ポインタの次のノード（getNext() で取得）である。通知後に lastNotified が次のノードに進められる。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知形式 | ConditionNode::succeed または fail の呼び出し |
| 成功時データ型 | タプル (Tk, Tv) |
| 失敗時データ型 | \Exception |

### 通知データ構造

```hack
// 成功通知時
tuple($key, $result)  // Tk: キー, Tv: 結果値

// 失敗通知時
\Exception $exception  // 捕捉された例外
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $key | Awaitable に関連付けられたキー | addImpl の第1引数 | Yes |
| $awaitable | 監視対象の Awaitable | addImpl の第2引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| Awaitable 成功 | await $awaitable の正常完了 | なし | succeed で結果を通知 |
| Awaitable 失敗 | await $awaitable で例外発生 | なし | fail で例外を通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | Awaitable の完了時に必ず通知される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[addImpl からの呼び出し] --> B[waitForThenNotify 開始]
    B --> C[try: await $awaitable]
    C --> D{完了結果}
    D -->|成功| E[lastNotified を次のノードに進める]
    D -->|例外| F[catch ブロックに移行]
    E --> G[succeed tuple key, result を呼び出し]
    F --> H[lastNotified を次のノードに進める]
    H --> I[fail exception を呼び出し]
    G --> J[終了]
    I --> J
```

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

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| Awaitable 例外 | await $awaitable で例外発生 | catch ブロックで捕捉し fail で通知 |
| invariant 違反 | lastNotified->getNext() が null | 通常発生しない（Poll が正しく管理） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- private メソッドのため、外部から直接呼び出されることはない
- 通知される結果や例外に機密情報が含まれる可能性がある場合は、利用側で適切に取り扱う必要がある

## 備考

- このメソッドは CPU 負荷が高い処理である（クラスコメントの警告参照）
- 大量の Awaitable を処理する場合や、低レイテンシーが要求される場合は使用を避けるべき
- 主な用途：高レイテンシーの投機的リクエスト、ページレット処理、ストリーマブル GraphQL

---

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

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

### 推奨読解順序

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

BasePoll クラスの内部状態を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | BasePoll.php | `src/async/BasePoll.php` | クラスプロパティ（70-73行目） |

**読解のコツ**: lastAdded, lastNotified, lastAwaited の3つのポインタがリンクリストを管理していることに注目する。

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

waitForThenNotify メソッドの実装を詳細に理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | BasePoll.php | `src/async/BasePoll.php` | waitForThenNotify メソッド（132-146行目） |

**主要処理フロー**:
1. **行132-135**: async private メソッドの定義
2. **行136-140**: try ブロック - await で結果を取得し succeed を呼び出し
3. **行137**: await $awaitable で Awaitable の完了を待機
4. **行138-139**: lastNotified を次のノードに進める
5. **行140**: succeed でタプル (key, result) を通知
6. **行141-145**: catch ブロック - 例外を捕捉し fail を呼び出し

#### Step 3: 呼び出し元を理解する

addImpl と addMultiImpl からの呼び出しパターンを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | BasePoll.php | `src/async/BasePoll.php` | addImpl メソッド（84-102行目） |
| 3-2 | BasePoll.php | `src/async/BasePoll.php` | addMultiImpl メソッド（104-130行目） |

**主要処理フロー**:
- **行94**: waitForThenNotify を呼び出して Awaitable をラップ
- **行96-101**: notifiers に追加して concurrent 実行

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | PollTest.php | `tests/async/PollTest.php` | testInputs メソッド（83-103行目） |
| 4-2 | PollTest.php | `tests/async/PollTest.php` | testLongChain メソッド（150-180行目） |

**主要処理フロー**:
- **行83-103**: 様々な入力パターンでの動作検証
- **行150-180**: 大量の Awaitable 追加時の動作検証

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

```
Poll/KeyedPoll::add($key, $awaitable)
    |
    +-- BasePoll::addImpl($key, $awaitable)
            |
            +-- ConditionNode::addNext()
            |
            +-- waitForThenNotify($key, $awaitable)
                    |
                    +-- await $awaitable
                    |
                    +-- [成功時] lastNotified->succeed(tuple($key, $result))
                    |
                    +-- [失敗時] lastNotified->fail($exception)
                            |
                            +-- BasePoll::next() が結果を受け取る
```

### データフロー図

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

Tk $key ─────────┐
                 │
Awaitable<Tv>    │
$awaitable ──────┼─────▶ waitForThenNotify()
                 │              │
                 │              v
                 │      ┌───────────────┐
                 │      │ await         │
                 │      │ $awaitable    │
                 │      └───────┬───────┘
                 │              │
                 │       ┌──────┴──────┐
                 │       │             │
                 │       v             v
                 │   [成功]        [失敗]
                 │       │             │
                 │       v             v
                 └──▶ succeed()    fail()
                          │             │
                          v             v
                    tuple(Tk,Tv)   Exception
                          │             │
                          └──────┬──────┘
                                 │
                                 v
                          BasePoll::next()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| BasePoll.php | `src/async/BasePoll.php` | ソース | waitForThenNotify の実装 |
| ConditionNode.php | `src/async/ConditionNode.php` | ソース | 通知先のノードクラス |
| Condition.php | `src/async/Condition.php` | ソース | ConditionNode の親クラス |
| Poll.php | `src/async/Poll.php` | ソース | BasePoll を継承した具象クラス |
| KeyedPoll.php | `src/async/KeyedPoll.php` | ソース | BasePoll を継承したキー付きクラス |
| PollTest.php | `tests/async/PollTest.php` | テスト | Poll のユニットテスト |
