# 機能設計書 77-計測

## 概要

本ドキュメントは、Nushellの計測機能の設計仕様を定義する。timeitコマンドは、クロージャの実行時間を計測する機能を提供する。

### 本機能の処理概要

計測機能は、指定されたクロージャの実行にかかる時間を正確に測定し、Duration型で返却する機能である。パイプライン入力をクロージャに渡すことも可能で、オプションでクロージャの出力も取得できる。

**業務上の目的・背景**：スクリプトやコマンドのパフォーマンス測定は、最適化作業において不可欠である。本機能により、特定の処理がどの程度の時間を要するかを正確に把握でき、ボトルネックの特定や改善効果の検証に活用できる。

**機能の利用シーン**：
- コマンドやスクリプトの実行時間を測定したい場合
- 処理のボトルネックを特定したい場合
- 最適化前後のパフォーマンス比較を行いたい場合
- ベンチマークテストを実施したい場合

**主要な処理内容**：
1. パイプライン入力をクロージャに渡す
2. クロージャの実行開始時刻を記録
3. クロージャを実行し、出力を収集
4. 実行終了時刻を記録し、経過時間を計算
5. Duration型で結果を返却（--output時はレコードで返却）

**関連システム・外部連携**：
- web_time::Instant：時間計測
- nu-engine::ClosureEvalOnce：クロージャ実行

**権限による制御**：特になし。全ユーザーが使用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインREPL | 主画面 | timeitコマンドの実行と結果表示 |

## 機能種別

パフォーマンス計測機能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| command | Closure | Yes | 時間を計測するクロージャ | - |
| --output (-o) | switch | No | クロージャの出力も含める | - |

### 入力データソース

- パイプライン入力（クロージャに渡される）
- クロージャ引数

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 通常出力 | Duration | 実行時間（ナノ秒精度） |
| --output時 | Record | {time: Duration, output: Any} |

### 出力先

標準出力（パイプライン出力）

## 処理フロー

### 処理シーケンス

```
1. timeit コマンド
   └─ リダイレクションをリセット（標準出力/エラー出力を許可）
   └─ --outputフラグの確認
   └─ クロージャを取得
   └─ ClosureEvalOnceを作成（出力先を保持）
   └─ 開始時刻を記録（Instant::now()）
   └─ クロージャを実行（入力をパイプライン渡し）
   └─ 出力を値として収集
   └─ 経過時間を計算（elapsed().as_nanos()）
   └─ 結果を返却（Duration or Record）
```

### フローチャート

```mermaid
flowchart TD
    A[timeit コマンド] --> B[リダイレクションをリセット]
    B --> C[--outputフラグ確認]
    C --> D[クロージャ取得]
    D --> E[ClosureEvalOnce作成]
    E --> F[開始時刻記録: Instant::now]
    F --> G[クロージャ実行]
    G --> H[出力を値として収集]
    H --> I[経過時間計算: elapsed]
    I --> J{--output?}
    J -->|Yes| K[Record{time, output}を返却]
    J -->|No| L[Durationを返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-77-1 | 精度 | ナノ秒精度で計測（as_nanos()） | 常時 |
| BR-77-2 | 出力収集 | クロージャ出力は値として収集される | 常時 |
| BR-77-3 | ストリーム注意 | ストリーム入力は計測に影響する可能性がある | ストリーム入力時 |
| BR-77-4 | エラー伝播 | クロージャ内のエラーはそのまま伝播 | エラー発生時 |

### 計算ロジック

```
経過時間（ナノ秒）= Instant::now() - 開始時刻
出力 = Value::duration(経過時間 as i64, span)
```

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

該当なし（本機能はデータベースを使用しない）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ShellError | クロージャ実行中にエラーが発生 | エラーがそのまま伝播される |

### リトライ仕様

リトライは行わない。

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

該当なし

## パフォーマンス要件

- 計測のオーバーヘッドは最小限に抑える
- 開始時刻の記録は他の計算完了後に行う

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

- リダイレクションがリセットされるため、クロージャは標準出力/エラー出力に書き込み可能
- クロージャ内で任意のコマンドが実行される

## 備考

- ストリーム入力の場合は、計測前にcollectを使用することを推奨
- search_termsにtiming, timer, benchmark, measureが含まれる
- web_timeクレートを使用し、クロスプラットフォーム対応

---

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

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

### 推奨読解順序

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

timeitコマンドの入出力型を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | timeit.rs | `crates/nu-command/src/debug/timeit.rs` | input_output_typesの定義（27-44行目） |

**読解のコツ**: 入出力は4パターン存在し、--outputフラグの有無で戻り値の型が変わる。

#### Step 2: 実行フローを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | timeit.rs | `crates/nu-command/src/debug/timeit.rs` | run関数の実装（57-89行目） |

**主要処理フロー** (timeit.rs):
- **65行目**: リダイレクションのリセット（push_redirection）
- **67行目**: --outputフラグの取得
- **68行目**: クロージャの取得
- **69行目**: ClosureEvalOnce::new_preserve_out_destの作成
- **72行目**: 開始時刻の記録（Instant::now()）
- **73行目**: クロージャ実行と出力収集
- **74行目**: 経過時間をDuration型に変換
- **76-86行目**: --outputフラグに応じた戻り値の構築

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

```
TimeIt::run (timeit.rs)
    ├─ stack.push_redirection(None, None)
    │
    ├─ call.has_flag("output")
    │
    ├─ call.req::<Closure>()
    │
    ├─ ClosureEvalOnce::new_preserve_out_dest()
    │
    ├─ Instant::now()  [開始時刻]
    │
    ├─ closure.run_with_input(input)
    │      └─ .into_value()  [出力収集]
    │
    ├─ start_time.elapsed().as_nanos()  [経過時間]
    │
    └─ 結果構築
           ├─ --output: Record{time, output}
           └─ 通常: Duration
```

### データフロー図

```
[timeit 通常]
PipelineData ───▶ クロージャ ───▶ (出力破棄) ───▶ Duration

[timeit --output]
PipelineData ───▶ クロージャ ───▶ 出力収集 ───▶ Record{time, output}

時間計測:
開始時刻 ───────────────────────────────────────▶ 終了時刻
    │                                               │
    └───────────── elapsed() ─────────────────────▶─┘
                        │
                        ▼
                 Duration (ナノ秒)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| timeit.rs | `crates/nu-command/src/debug/timeit.rs` | ソース | timeitコマンド |
| mod.rs | `crates/nu-command/src/debug/mod.rs` | ソース | debugモジュール定義 |
