# バッチ設計書 19-compare

## 概要

本ドキュメントは、Prettierプロジェクトにおける `compare.sh` バッチの設計仕様を定義します。このバッチは、複数のgitコミット間でPrettierのパフォーマンスベンチマーク比較を実行するシェルスクリプトです。

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

このバッチは、指定された複数のgitコミットに対して、それぞれのバージョンのPrettierをビルドし、hyperfineツールを使用してパフォーマンスを比較測定します。シリアル実行とパラレル実行の両方のベンチマークを実行します。

**業務上の目的・背景**：Prettierの開発において、コードの変更がパフォーマンスに与える影響を定量的に評価する必要があります。異なるコミット間でのベンチマーク比較により、パフォーマンスの改善や回帰を検出できます。hyperfineを使用することで、統計的に信頼性の高い測定結果が得られます。

**バッチの実行タイミング**：パフォーマンスの比較が必要な際に手動で実行します。通常はパフォーマンス改善のPRレビュー時や、リリース前の検証で使用されます。

**主要な処理内容**：
1. コマンドライン引数から比較対象のコミットハッシュを取得
2. 各コミットに対してgit archiveでソースを展開
3. 各バージョンでyarnとyarn buildを実行
4. hyperfineで各バージョンのシリアル/パラレル実行を比較
5. 終了時にクリーンアップ（展開したディレクトリを削除）

**前後の処理との関連**：このバッチは内部でbench.jsを呼び出します。hyperfineツールが事前にインストールされている必要があります。

**影響範囲**：一時的にディスク上にコミットのソースを展開しますが、終了時にクリーンアップされます。

## バッチ種別

ベンチマーク / パフォーマンス比較

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（パフォーマンス比較時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| gitリポジトリ | 実行ディレクトリがgitリポジトリ内であること |
| bash環境 | Bashシェルが利用可能であること |
| hyperfine | hyperfineツールがインストール済みであること |
| yarn | yarnが利用可能であること |

### 実行可否判定

gitリポジトリ内で、hyperfineがインストールされている場合に実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| commits | string[] | Yes | なし | 比較対象のgitコミットハッシュ（複数指定可） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| gitリポジトリ | git | 各コミットのソースコード |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力はありません（一時ディレクトリは終了時に削除）。

## 処理フロー

### 処理シーケンス

```
1. 初期化
   └─ コミットリストを引数から取得
   └─ リポジトリルートに移動
   └─ scripts/benchmarkディレクトリに移動

2. クリーンアップ関数の定義
   └─ trapでEXITシグナルにクリーンアップを登録
   └─ 展開したディレクトリを削除

3. 各コミットの準備
   └─ 既存の同名ディレクトリを削除
   └─ git archiveでソースを展開（tests, website, docsを除外）
   └─ 展開ディレクトリ内でyarnを実行
   └─ yarn buildを実行
   └─ hyperfine引数リストにシリアル/パラレルのベンチマークを追加

4. ベンチマーク実行
   └─ hyperfine --warmup 3 で全コマンドを実行

5. クリーンアップ
   └─ trapで登録したクリーンアップ関数が実行
   └─ 全コミットディレクトリを削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[引数からコミット取得]
    B --> C[リポジトリルートに移動]
    C --> D[scripts/benchmarkに移動]
    D --> E[クリーンアップtrap設定]
    E --> F[各コミットをループ]
    F --> G[既存ディレクトリ削除]
    G --> H[git archiveで展開]
    H --> I[yarn install]
    I --> J[yarn build]
    J --> K[ベンチマーク引数追加]
    K --> L{次のコミット?}
    L -->|あり| F
    L -->|なし| M[hyperfine実行]
    M --> N[クリーンアップ実行]
    N --> O[バッチ終了]
```

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

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

データベース操作はありません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | コミット不在エラー | 指定コミットが存在しない | 有効なコミットハッシュを指定 |
| - | hyperfine不在エラー | hyperfineがインストールされていない | hyperfineをインストール |
| - | ビルドエラー | yarn buildが失敗 | 該当コミットのビルド問題を調査 |

### リトライ仕様

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

### 障害時対応

1. コミットが見つからない場合：有効なコミットハッシュを確認
2. hyperfineがない場合：`brew install hyperfine`または同等のコマンドでインストール
3. ビルドエラーの場合：該当コミットのビルド問題を調査

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | コミット数 x 2（serial + parallel） |
| 目標処理時間 | ビルド時間 + ベンチマーク時間（数分〜数十分） |
| メモリ使用量上限 | 制限なし |

## 排他制御

同時実行は推奨されません。同一ディレクトリへの書き込みが発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| クリーンアップログ | 終了時 | "Cleaning up..." "Done!" |
| hyperfine出力 | ベンチマーク時 | 各コマンドの実行時間統計 |

## 監視・アラート

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

## 備考

- Bashスクリプトとして実装されています
- shebang (`#!/usr/bin/env bash`) で実行可能です
- git archiveで展開する際、tests, website, docsディレクトリは除外されます
- hyperfineの`--warmup 3`オプションで3回のウォームアップ実行が行われます
- 各コミットに対してシリアル実行とパラレル実行の両方がベンチマークされます
- クリーンアップはtrapを使用しているため、スクリプトが異常終了しても実行されます
- 比較対象のコミットは任意の数を指定できます
- bench.jsを内部で呼び出してベンチマークを実行します
