# バッチ設計書 20-bench

## 概要

本ドキュメントは、CoffeeScriptプロジェクトにおける`bench`タスクの設計書です。このバッチは、CoffeeScriptコンパイラのコンパイル時間を計測する簡易ベンチマークツールです。

### 本バッチの処理概要

このバッチは、CoffeeScriptコンパイラの各処理フェーズ（Lex、Rewrite、Parse、Compile）の実行時間を計測し、パフォーマンスの概要を把握するためのツールです。複数のソースファイルを読み込み、連結した状態でコンパイル処理を実行し、各フェーズにかかった時間をミリ秒単位で表示します。

**業務上の目的・背景**：CoffeeScriptコンパイラの開発において、パフォーマンスの改善や劣化を検出することは重要です。このベンチマークを使用することで、コード変更がコンパイル速度に与える影響を定量的に把握できます。新機能の追加やリファクタリング後に実行することで、パフォーマンスの変化を確認できます。

**バッチの実行タイミング**：パフォーマンス測定が必要な場合に手動で実行します。コンパイラの最適化作業時やパフォーマンス問題の調査時に使用します。

**主要な処理内容**：
1. コンパイラソースファイル（coffeescript、grammar、helpers、lexer、nodes、rewriter）を読み込み
2. scope.litcoffee（文芸的CoffeeScript）を読み込み
3. 全ソースを連結
4. Lexフェーズ：トークン化処理の時間を計測
5. Rewriteフェーズ：トークンの書き換え処理の時間を計測
6. Parseフェーズ：AST生成処理の時間を計測
7. Compileフェーズ：JavaScript生成処理の時間を計測
8. 各フェーズの時間と合計時間を表示

**前後の処理との関連**：独立したベンチマークタスクのため、他のタスクとの依存関係はありません。ただし、コンパイラがビルドされている（`lib/coffeescript/`配下にファイルが存在する）必要があります。

**影響範囲**：標準出力へのログ出力のみで、ファイルやデータへの変更はありません。

## バッチ種別

パフォーマンス計測 / ベンチマーク

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（パフォーマンス測定時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Node.js環境 | Node.jsがインストールされていること |
| ビルド済みコンパイラ | lib/coffeescript/配下にコンパイル済みファイルが存在すること |
| ソースファイル | src/配下にソースファイルが存在すること |

### 実行可否判定

- `lib/coffeescript/rewriter.js`が存在すること
- `src/`ディレクトリ配下にソースファイルが存在すること

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | コマンドライン引数なし |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| src/coffeescript.coffee | CoffeeScript | メインコンパイラソース |
| src/grammar.coffee | CoffeeScript | 文法定義ソース |
| src/helpers.coffee | CoffeeScript | ヘルパー関数ソース |
| src/lexer.coffee | CoffeeScript | レキサーソース |
| src/nodes.coffee | CoffeeScript | ASTノードソース |
| src/rewriter.coffee | CoffeeScript | リライターソース |
| src/scope.litcoffee | Literate CoffeeScript | スコープ管理ソース |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | ベンチマーク結果 |

### 出力ファイル仕様

該当なし（ファイル出力なし）

## 処理フロー

### 処理シーケンス

```
1. Rewriterモジュール読み込み
   └─ lib/coffeescript/rewriterを require
2. ソースファイル読み込み
   └─ 6つのCoffeeScriptファイルを読み込み、連結
3. Litcoffeeファイル読み込み
   └─ scope.litcoffeeを読み込み
4. 計測準備
   └─ 時間計測用の変数を初期化
5. Lexフェーズ計測
   └─ CoffeeScript.tokens()を実行、トークン数と時間を記録
6. Rewriteフェーズ計測
   └─ Rewriter.rewrite()を実行、トークン数と時間を記録
7. Parseフェーズ計測
   └─ CoffeeScript.nodes()を実行、時間を記録
8. Compileフェーズ計測
   └─ nodes.compile()を実行、生成文字数と時間を記録
9. 結果出力
   └─ 各フェーズの時間と合計時間を表示
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Rewriterモジュール読み込み]
    B --> C[ソースファイル読み込み・連結]
    C --> D[scope.litcoffee読み込み]
    D --> E[Lexフェーズ実行・計測]
    E --> F[トークン数と時間を表示]
    F --> G[Rewriteフェーズ実行・計測]
    G --> H[トークン数と時間を表示]
    H --> I[Parseフェーズ実行・計測]
    I --> J[時間を表示]
    J --> K[Compileフェーズ実行・計測]
    K --> L[生成文字数と時間を表示]
    L --> M[合計時間を表示]
    M --> N[バッチ終了]
```

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

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

該当なし（ファイルシステム操作のみ、読み込みのみ）

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル読み込みエラー | ソースファイルが存在しない | src/配下のファイルを確認 |
| - | コンパイルエラー | ソースコードに構文エラー | ソースコードを修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

### 障害時対応

- ファイル読み込みエラー時は例外がスローされる
- コンパイラがビルドされていない場合は`cake build`を先に実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし |
| コミットタイミング | 該当なし |
| ロールバック条件 | 該当なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ソースファイル7個 |
| 目標処理時間 | 数百ミリ秒〜数秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行：可能
- ロック仕様：なし

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| Lexログ | Lex完了時 | "Lex    XXX ms (N tokens)" |
| Rewriteログ | Rewrite完了時 | "Rewrite XXX ms (N tokens)" |
| Parseログ | Parse完了時 | "Parse  XXX ms" |
| Compileログ | Compile完了時 | "Compile XXX ms (N chars)" |
| 合計ログ | 全完了時 | "total  XXX ms" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 該当なし | - | - |

## 備考

- 出力フォーマットは4文字右詰めで統一されている
- 時間はミリ秒単位で表示
- ANSIカラー（bold）で時間を強調表示
- 実際の計測対象は以下のソースファイル：
  - coffeescript.coffee
  - grammar.coffee
  - helpers.coffee
  - lexer.coffee
  - nodes.coffee
  - rewriter.coffee
  - scope.litcoffee（文芸的CoffeeScript）
- `rewrite: no`オプションでLexフェーズを単独計測
- `literate: yes`オプションで.litcoffeeファイルを処理
- `bare: yes`オプションでIIFEなしでコンパイル
