# 通知設計書 32-スレッド通知

## 概要

本ドキュメントは、`@babel/register`のワーカースレッドにおける処理完了通知（`Atomics.notify`）に関する設計を記載する。

### 本通知の処理概要

スレッド通知は、`@babel/register`がワーカースレッドで非同期にBabelトランスフォーメーションを実行する際、処理完了をメインスレッドに同期的に通知する低レベルのスレッド間通信メカニズムである。

**業務上の目的・背景**：`@babel/register`は、Node.jsのrequireフック機構を利用してJavaScript/TypeScriptファイルをオンザフライでトランスパイルする。しかし、requireは同期APIであるため、非同期のBabel変換処理を同期的に待機する必要がある。SharedArrayBufferとAtomicsを使用することで、ワーカースレッドでの非同期処理完了をメインスレッドが効率的に待機できる。

**通知の送信タイミング**：ワーカースレッドがメッセージ処理（変換処理、オプション設定、キャッシュ無効化等）を完了した後、レスポンスをメインスレッドに送信した直後に通知が発行される。

**通知の受信者**：メインスレッド（Node.jsのメインプロセス）。`Atomics.wait`で待機しているスレッドが通知を受け取る。

**通知内容の概要**：SharedArrayBuffer上の特定位置（シグナル配列のインデックス0）に値1を設定し、その位置で待機しているスレッドに通知を送る。実際のレスポンスデータはMessagePortを通じて別途送信される。

**期待されるアクション**：メインスレッドは`Atomics.wait`からの復帰後、MessagePortから受け取ったレスポンスを処理し、require処理を継続する。

## 通知種別

内部通知（スレッド間通信 / Atomics.notify）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Atomics.notify） |
| 優先度 | 高（requireの待機を解除するため） |
| リトライ | 無し |

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

通知先は、メッセージ受信時に渡されるシグナル配列（Int32Array）によって決定される。このシグナル配列はSharedArrayBufferをラップしており、メインスレッドとワーカースレッド間で共有されている。

## 通知テンプレート

### Atomics通知の場合

| 項目 | 内容 |
|-----|------|
| シグナル配列型 | Int32Array |
| シグナル位置 | インデックス0 |
| シグナル値 | 1（処理完了を示す） |

### 本文テンプレート

```javascript
Atomics.store(signal, 0, 1);  // シグナル値を1に設定
Atomics.notify(signal, 0);     // インデックス0で待機中のスレッドに通知
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| signal | SharedArrayBufferをラップしたInt32Array | メッセージペイロード | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| メッセージ受信 | GET_DEFAULT_EXTENSIONS処理完了 | 常に | デフォルト拡張子一覧の取得完了 |
| メッセージ受信 | SET_OPTIONS処理完了 | 常に | オプション設定処理の完了 |
| メッセージ受信 | TRANSFORM処理完了 | 常に | コード変換処理の完了 |
| メッセージ受信 | CLOSE処理完了 | 常に | キャッシュ無効化処理の完了 |
| メッセージ受信 | エラー発生 | 常に | 処理中にエラーが発生した場合も通知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | 全てのメッセージ処理の終了時に必ず通知が発行される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[parentPortでメッセージ受信] --> B[handleMessageで処理実行]
    B --> C{処理成功?}
    C -->|Yes| D[result をレスポンスに設定]
    C -->|No| E[error をレスポンスに設定]
    D --> F[port.postMessage でレスポンス送信]
    E --> F
    F --> G{送信成功?}
    G -->|Yes| H[port.close]
    G -->|No| I[シリアライズエラーを送信]
    I --> H
    H --> J[Atomics.store signal 0 1]
    J --> K[Atomics.notify signal 0]
    K --> L[処理完了]
```

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

該当なし

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 処理エラー | handleMessage内で例外発生 | エラーオブジェクトをレスポンスに含めて通知は発行 |
| シリアライズエラー | レスポンスがシリアライズ不可 | 「Cannot serialize worker response」エラーを送信、通知は発行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし（エラー時も通知を発行して処理継続） |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（メッセージ処理完了時に即座に通知）

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

- SharedArrayBufferを使用するため、Cross-Origin Isolation環境での動作が必要（Node.js環境では問題なし）
- シグナル配列は数値のみを扱い、機密データは含まれない
- 実際のレスポンスデータはMessagePortを通じて送信されるため、Atomics通知自体にはペイロードは含まれない

## 備考

- この通知メカニズムは、Node.jsのrequire（同期API）をサポートするために必要
- ワーカースレッドでの非同期処理（async/await）を同期的に待機するためのブロッキング機構
- `finally`ブロックで実行されるため、正常完了・エラー両方のケースで確実に通知される

---

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

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

### 推奨読解順序

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

ワーカーとメインスレッド間で共有されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.cts | `packages/babel-register/src/types.cts` | ACTIONS enumの定義、IClientインターフェースを確認 |

**読解のコツ**: ACTIONSは4種類（GET_DEFAULT_EXTENSIONS, SET_OPTIONS, TRANSFORM, CLOSE）のアクションを定義している。

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

ワーカースレッドのメッセージハンドラを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | index.mts | `packages/babel-register/src/worker/index.mts` | parentPort.addListenerでメッセージを受信（6-42行目） |

**主要処理フロー**:
1. **11-21行目**: メッセージのデストラクチャリング（signal, port, action, payload）
2. **24-28行目**: handleMessageの呼び出しとエラーハンドリング
3. **30-36行目**: port.postMessageでレスポンス送信
4. **37-39行目**: port.close後、Atomics.store/notifyで通知

#### Step 3: メッセージハンドラを理解する

各アクションの処理内容を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | handle-message.mts | `packages/babel-register/src/worker/handle-message.mts` | アクション別の処理分岐（5-18行目） |

**主要処理フロー**:
- **7-8行目**: GET_DEFAULT_EXTENSIONS - デフォルト拡張子を返す
- **9-10行目**: SET_OPTIONS - オプション設定
- **11-12行目**: TRANSFORM - コード変換
- **13-14行目**: CLOSE - キャッシュ無効化

#### Step 4: 変換処理の詳細を理解する

実際のBabel変換処理の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | transform.mts | `packages/babel-register/src/worker/transform.mts` | setOptions, transform, disableCache関数（52-116行目） |

**主要処理フロー**:
- **52-86行目**: setOptions - キャッシュ設定、transformOptsの準備
- **88-110行目**: transform - loadOptionsAsync/transformAsyncによる変換
- **112-114行目**: disableCache - キャッシュの無効化

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

```
parentPort.addListener("message", ...)
    │
    ├─ handleMessage(action, payload)
    │      │
    │      ├─ GET_DEFAULT_EXTENSIONS → DEFAULT_EXTENSIONS
    │      ├─ SET_OPTIONS → setOptions(payload)
    │      ├─ TRANSFORM → transform(code, filename)
    │      │      └─ loadOptionsAsync() / transformAsync()
    │      └─ CLOSE → disableCache()
    │
    ├─ port.postMessage(response)
    │
    ├─ port.close()
    │
    ├─ Atomics.store(signal, 0, 1)
    │
    └─ Atomics.notify(signal, 0)
```

### データフロー図

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

メインスレッド              ワーカースレッド
      │                         │
      │  {signal, port,         │
      │   action, payload}      │
      ├────────────────────────▶│
      │                         │
      │                   handleMessage()
      │                         │
      │                         ▼
      │                   処理実行
      │                         │
      │     {result/error}      │
      │◀────────────────────────┤ port.postMessage
      │                         │
      │                   port.close()
      │                         │
      │                   Atomics.store
      │                         │
      │     notify              │
      │◀────────────────────────┤ Atomics.notify
      │                         │
 Atomics.wait                   │
  からの復帰                    │
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| index.mts | `packages/babel-register/src/worker/index.mts` | ソース | ワーカースレッドのエントリーポイント、Atomics通知を含む |
| handle-message.mts | `packages/babel-register/src/worker/handle-message.mts` | ソース | アクション別のメッセージ処理 |
| transform.mts | `packages/babel-register/src/worker/transform.mts` | ソース | Babel変換処理の実装 |
| types.cts | `packages/babel-register/src/types.cts` | ソース | アクション定義、型定義 |
| cache.mts | `packages/babel-register/src/worker/cache.mts` | ソース | キャッシュ管理 |
