# 機能設計書 66-async/await

## 概要

本ドキュメントは、CoffeeScriptのasync/await機能の設計を記述する。async/awaitは、非同期処理をPromiseベースで同期的なスタイルで記述するための言語機能である。

### 本機能の処理概要

CoffeeScriptのasync/awaitは、ES2017で導入された非同期関数構文をサポートする機能である。関数内で`await`キーワードを使用することで、その関数は自動的に非同期関数（`async function`）となり、Promiseを返す。`await`式はPromiseの解決を待機し、その値を取得する。REPLではトップレベルawaitもサポートされる。

**業務上の目的・背景**：
従来のコールバックベースやPromiseチェーンベースの非同期処理は、コードが複雑化しやすく、エラーハンドリングも煩雑になりがちであった。async/awaitにより、非同期処理を同期的なコードのように記述でき、try/catchでのエラーハンドリングも可能になる。これにより、非同期処理の可読性と保守性が大幅に向上する。

**機能の利用シーン**：
- APIリクエストの待機（例：`response = await fetch(url)`）
- ファイルI/O操作（例：`data = await readFile(path)`）
- データベースクエリの待機
- 複数の非同期操作の順次実行
- Promise.allとの組み合わせによる並列処理
- `for await...from`による非同期イテレータの処理

**主要な処理内容**：
1. `await`キーワードの解析とOpノード生成
2. 関数内での`await`使用の検出
3. 関数を`async function`形式に変換
4. `await return`の処理（AwaitReturnノード）
5. `for await...from`構文のサポート
6. REPLでのトップレベルawaitサポート

**関連システム・外部連携**：
async/awaitはgrammar.coffeeのOperation規則で解析され、Opノード（operator: 'await'）として表現される。コンパイル時に、awaitを含む関数は`async function`形式に変換される。

**権限による制御**：
本機能はコンパイル時の言語機能であり、権限による制御は適用されない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 画面関連なし（言語機能） |

## 機能種別

言語構文変換 / 非同期処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| expression | Expression | Yes | await対象の式（通常はPromise） | 有効な式 |
| operator | String | Yes | 演算子（`await`） | - |

### 入力データソース

CoffeeScriptソースコード内の`await`式

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| JavaScript | String | `await`式と`async function`宣言 |
| value | Any | Promiseの解決値（実行時） |

### 出力先

JavaScriptコード（標準出力またはファイル）

## 処理フロー

### 処理シーケンス

```
1. await式の解析
   └─ grammar.coffeeのOperation規則でトークン列を解析
2. Opノード生成
   └─ operator: 'await'を設定
3. 関数のasync判定
   └─ Codeノードで、body内にawaitが含まれるか確認
4. コンパイル処理
   └─ 4.1 compileContinuation()でawait式を生成
   └─ 4.2 関数ヘッダーに`async`を追加
   └─ 4.3 式として使用時は`await`でラップ
5. 特殊ケースの処理
   └─ 5.1 await return の処理
   └─ 5.2 for await...from の処理
```

### フローチャート

```mermaid
flowchart TD
    A[await式の開始] --> B[Opノード生成]
    B --> C{関数内?}
    C -->|No - REPLモード| D[トップレベルawait許可]
    C -->|Yes| E[関数をisAsync = trueに設定]
    D --> F[await式をコンパイル]
    E --> F
    F --> G{式として使用?}
    G -->|Yes| H[awaitでラップ]
    G -->|No| I[そのままawait出力]
    H --> J[async function 形式で出力]
    I --> J
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-66-1 | 自動async化 | awaitを含む関数は自動的にasync関数になる | - |
| BR-66-2 | トップレベルawait | REPLモードではトップレベルでawaitが使用可能 | REPLモード時 |
| BR-66-3 | await return | `await return`でPromise解決後に値を返す | AwaitReturnノード |
| BR-66-4 | for await | `for await...from`で非同期イテレータを反復 | For構文でawait: true |
| BR-66-5 | 式としての評価 | async関数を式として評価する場合、`await`でラップ | compileClosure時 |

### 計算ロジック

- async検出: 関数bodyを走査し、`operator === 'await'`のOpノードを検出
- isAsync設定: Codeノードの`isAsync`プロパティをtrueに設定

## データベース操作仕様

### 操作別データベース影響一覧

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ランタイムエラー | awaitしたPromiseがrejectされた | try/catchでエラーをハンドリング |

### リトライ仕様

コンパイル時エラーは発生しない。実行時のPromise rejectはアプリケーション側で処理。

## トランザクション仕様

本機能はデータベーストランザクションを使用しない。

## パフォーマンス要件

- コンパイル時間: 通常の関数と同等
- 実行時: Promiseの解決時間に依存

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

- 非同期処理のタイムアウト設定を推奨
- 信頼できないソースからのPromiseには注意

## 備考

- ES2017 async/awaitの完全サポート
- yieldとawaitは同じ関数内で共存不可
- async関数は常にPromiseを返す

---

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

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

### 推奨読解順序

#### Step 1: 文法定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | grammar.coffee | `src/grammar.coffee` | Operation規則内のAWAIT（902-903行目） |

**読解のコツ**:
- 902行目: `AWAIT Expression` - 式をawait
- 903行目: `AWAIT INDENT Object OUTDENT` - オブジェクトリテラルをawait

**主要処理フロー**:
1. **902行目**: `AWAIT Expression` → `new Op $1, $2`
2. **323-326行目**: `AwaitReturn`規則

#### Step 2: Opノードのawait処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | nodes.coffee | `src/nodes.coffee` | Opクラスのawait関連メソッド |

**主要処理フロー**:
- **4752行目**: `@isYield() or @isAwait()` でcompileContinuation呼び出し
- **4809行目**: `@checkContinuation o unless @isAwait()` - awaitはスコープチェック不要
- **4849行目**: `'AwaitExpression'` - AST型

#### Step 3: Codeノードのasync判定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | nodes.coffee | `src/nodes.coffee` | Codeクラスのawait検出（3905-3914行目） |

**主要処理フロー**:
- **3905行目**: `@isAsync = no` - デフォルトはfalse
- **3912-3914行目**: await検出でisAsync = true
- **4089行目**: `modifiers.push 'async' if @isAsync`
- **517行目**: Rootノードでもトップレベルawait検出

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

```
CoffeeScript.compile()
    │
    ├─ Lexer.tokenize()
    │      └─ AWAITトークン生成
    │
    ├─ parser.parse()
    │      └─ Operation規則でOpノード生成
    │             └─ new Op('await', expression)
    │
    └─ Code.compileNode()
           ├─ isAsync判定
           │      └─ body.contains (node) -> node.operator is 'await'
           └─ async function 形式で出力
                  └─ Op.compileContinuation()
```

### データフロー図

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

CoffeeScript           Lexer           Parser              Compiler
await式            →  トークン列  →   Opノード       →    JavaScript
                                    (operator:await)   await式/async fn

例:
fetchData = ->
  result = await fetch(url)
  result.json()
    ↓
Code {
  body: Block([
    Assign { variable: 'result', value: Op { operator: 'await', ... } },
    ...
  ]),
  isAsync: true
}
    ↓
var fetchData = async function() {
  var result;
  result = await fetch(url);
  return result.json();
};
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| grammar.coffee | `src/grammar.coffee` | ソース | Operation内AWAIT（902-903行目）、AwaitReturn（323-326行目） |
| nodes.coffee | `src/nodes.coffee` | ソース | Opクラス、CodeクラスのisAsync判定 |
| lexer.coffee | `src/lexer.coffee` | ソース | AWAITトークンの生成 |
| repl.coffee | `src/repl.coffee` | ソース | トップレベルawaitのサポート |
