# 通知設計書 12-カバレッジ収集状況通知

## 概要

本ドキュメントは、Jestテストフレームワークにおけるカバレッジ収集状況通知機能の設計について記載する。CoverageReporterクラスの`_addUntestedFiles`メソッドによって実装され、テストされていないファイルに対するカバレッジ収集処理の状況をコンソールに出力する。

### 本通知の処理概要

**業務上の目的・背景**：カバレッジ収集では、実際にテストが実行されたファイルだけでなく、`collectCoverageFrom`で指定されたがテストされていないファイルも収集対象となる。このプロセスは時間がかかる場合があるため、ユーザーに処理状況を通知することで、実行中であることを明示し、ユーザーの不安を解消する。

**通知の送信タイミング**：テスト実行完了後、`onRunComplete`メソッドから`_addUntestedFiles`が呼び出された際に、未テストファイルのカバレッジ収集を開始するタイミングで出力される。対話的な環境（ターミナル）でのみ表示される。

**通知の受信者**：コンソールを監視している開発者。ターミナルでJestを実行しているユーザーが対象。

**通知内容の概要**：「Running coverage on untested files...」というメッセージが薄暗い（dim）スタイルで標準エラー出力に表示される。処理完了後はこの行がクリアされる。

**期待されるアクション**：ユーザーは処理が進行中であることを理解し、完了を待つ。処理が異常に長い場合は、`collectCoverageFrom`の設定を見直すきっかけとなる。

## 通知種別

コンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低 |
| リトライ | なし |

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

標準エラー出力（process.stderr）に直接出力される。対話的環境（isInteractive が true）でのみ表示される。

## 通知テンプレート

### コンソール出力形式

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力（stderr） |
| 形式 | テキスト（ANSIカラーコード付き） |

### 本文テンプレート

```
Running coverage on untested files...
```

スタイル: `chalk.bold.dim` (太字・薄暗い)

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| N/A | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| テスト完了後 | onRunComplete → _addUntestedFiles | isInteractive=true & 未テストファイルあり | CoverageReporter._addUntestedFiles()で実行 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 非対話的環境 | isInteractive が false の場合（CI環境など） |
| 未テストファイルなし | collectCoverageFromで指定されたファイルがない場合 |
| collectCoverageFrom未設定 | グローバル設定でcollectCoverageFromが空の場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[onRunComplete呼び出し] --> B[_addUntestedFiles]
    B --> C{collectCoverageFrom設定?}
    C -->|No| Z[終了]
    C -->|Yes| D[ファイル収集]
    D --> E{files.length > 0?}
    E -->|No| Z
    E -->|Yes| F{isInteractive?}
    F -->|No| G[Worker処理開始]
    F -->|Yes| H[stderr: Running coverage...]
    H --> G
    G --> I[各ファイルのカバレッジ収集]
    I --> J{isInteractive?}
    J -->|No| K[Worker終了]
    J -->|Yes| L[clearLine]
    L --> K
    K --> Z
```

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

### 参照テーブル一覧

本機能はデータベースを使用しない。

### テーブル別参照項目詳細

該当なし（ファイルシステムとメモリ内のデータを参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル収集失敗 | カバレッジ収集対象ファイルの処理でエラー | console.errorで赤色出力、処理継続 |
| Worker終了エラー | Workerプロセスの終了に失敗 | エラーを無視（コメント: errors were reported earlier） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Worker: 2（maxRetries設定） |
| リトライ間隔 | 自動（jest-worker管理） |
| リトライ対象エラー | Workerプロセスのクラッシュ |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 出力されるメッセージは固定文字列のため、機密情報漏洩のリスクなし
- ファイルパスはこの通知では表示されない（エラー時のみ表示）

## 備考

- jest-utilの`isInteractive`はprocess.stdout.isTTYとCI環境変数から判定
- clearLine関数はstderrの現在行をクリアする
- maxWorkersが1以下の場合はWorkerを使用せず、同期的に処理

---

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

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

### 推奨読解順序

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

カバレッジ収集で扱うデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L36-46: CoverageWorker型、メンバー変数の定義 |
| 1-2 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L112: files配列の構造（config, path） |

**読解のコツ**: `_v8CoverageResults`と`_coverageMap`の2種類のカバレッジデータ格納先があることに注意。

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

処理の起点となるonRunCompleteメソッドを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L70-107: onRunCompleteメソッド |

**主要処理フロー**:
1. **L74**: `_addUntestedFiles`を最初に呼び出し
2. **L75**: `_getCoverageResult`でカバレッジ結果を取得
3. **L77-104**: レポート生成処理
4. **L106**: `_checkThreshold`でカバレッジ閾値チェック

#### Step 3: 未テストファイル処理の詳細

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L109-222: _addUntestedFilesメソッド全体 |

**主要処理フロー**:
- **L114-129**: collectCoverageFromに基づきファイルを収集
- **L131-133**: ファイルがない場合は早期リターン
- **L135-139**: isInteractiveの場合のみメッセージ出力
- **L141-155**: Workerの初期化（maxWorkers > 1 でマルチプロセス）
- **L157-207**: 各ファイルのカバレッジ収集（非同期）
- **L209-213**: Promise.allで全処理を待機
- **L215-217**: isInteractiveの場合、行をクリア
- **L219-221**: Worker終了

#### Step 4: 出力処理の詳細

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L38-39: 色定義 |
| 4-2 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L135-139: メッセージ出力 |
| 4-3 | CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | L215-217: 行クリア |

**主要処理フロー**:
- **L39**: `RUNNING_TEST_COLOR = chalk.bold.dim`
- **L136-138**: `process.stderr.write(RUNNING_TEST_COLOR('Running coverage on untested files...'))`
- **L216**: `clearLine(process.stderr)`

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

```
CoverageReporter.onRunComplete (L70)
    │
    └─ _addUntestedFiles (L109)
           │
           ├─ context.hasteFS.matchFilesWithGlob (L120-123)
           │
           ├─ process.stderr.write (L136-138) ← 通知出力
           │
           ├─ Worker初期化 (L141-155)
           │      │
           │      └─ CoverageWorker.worker (L171)
           │
           ├─ Promise.all (L210) [非同期]
           │
           ├─ clearLine (L216) ← 通知クリア
           │
           └─ worker.end (L220)
```

### データフロー図

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

testContexts ─────────────▶ collectCoverageFrom設定参照
                                   │
                                   ▼
                            ファイル収集
                                   │
                                   ▼
                            isInteractive判定
                                   │
                            ┌──────┴──────┐
                            │             │
                            ▼             ▼
                         stderr出力    (出力なし)
                            │
                            ▼
                      Worker処理
                            │
                            ▼
                    カバレッジ収集
                            │
                            ▼
                      clearLine
                            │
                            ▼
_coverageMap/           Worker終了
_v8CoverageResults
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| CoverageReporter.ts | `packages/jest-reporters/src/CoverageReporter.ts` | ソース | メイン実装ファイル |
| CoverageWorker.ts | `packages/jest-reporters/src/CoverageWorker.ts` | ソース | カバレッジ収集のワーカー処理 |
| BaseReporter.ts | `packages/jest-reporters/src/BaseReporter.ts` | ソース | Reporterインターフェースの基底実装 |
| jest-util/index.ts | `packages/jest-util/src/index.ts` | ソース | isInteractive, clearLine関数 |
| jest-worker | `packages/jest-worker/` | パッケージ | 並列処理のためのWorkerプール |
