# 通知設計書 85-CLI_CHECK_MULTIPLE_WORKERS

## 概要

本ドキュメントは、Lua Language Serverのコマンドライン診断機能における「マルチワーカー開始」通知（CLI_CHECK_MULTIPLE_WORKERS）の設計を記載する。

### 本通知の処理概要

CLI_CHECK_MULTIPLE_WORKERSは、コマンドライン診断（--checkオプション）を複数のワーカープロセスで並列実行する際に、処理開始時に表示される通知メッセージである。

**業務上の目的・背景**：大規模なワークスペースの診断を高速化するため、複数のワーカープロセスを使用して並列診断を行う機能がある。本通知は、ユーザーにマルチワーカーモードで処理が開始されたことを伝え、通常のプログレス出力が無効化されることと、処理に時間がかかる可能性があることを事前に通知する。

**通知の送信タイミング**：`NUM_THREADS`が1より大きい値に設定されており、マルチワーカーモードで診断が開始される直前に表示される。

**通知の受信者**：コマンドラインで`--check`オプションを複数スレッドで実行しているユーザー。標準出力（コンソール）に直接表示される。

**通知内容の概要**：「{ワーカー数} 個のワーカータスクを開始しているため、進行状況の出力が無効になります。完了まで数分かかることがあります。」という形式で、並列処理の開始と所要時間の目安を示す。

**期待されるアクション**：ユーザーは処理が完了するまで待機する。プログレス表示がないため、処理が停止しているわけではないことを理解する。

## 通知種別

コンソール出力（CLI標準出力）

## 送信仕様

### 基本情報

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

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

コマンドラインで診断を実行しているメインプロセスの標準出力に直接出力される。QUIETモードが有効でなく、かつNUM_THREADS > 1の場合に表示される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準出力（stdout） |
| 形式 | プレーンテキスト |

### 本文テンプレート

```
日本語:
{numThreads} 個のワーカータスクを開始しているため、進行状況の出力が無効になります。完了まで数分かかることがあります。

英語:
Starting {numThreads} worker tasks, progress output will be disabled. This may take a few minutes.
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| numThreads | ワーカープロセスの数 | NUM_THREADS環境変数/引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| CLI実行 | マルチワーカー診断開始 | NUM_THREADS > 1 かつ QUIET != true | 並列診断開始直前 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| QUIET=true | 静音モードが有効な場合は表示しない |
| NUM_THREADS == 1 | シングルワーカーモードの場合は表示しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[CLI診断開始] --> B{NUM_THREADS > 1?}
    B -->|No| C[シングルワーカーモード]
    B -->|Yes| D{QUIETモード?}
    D -->|Yes| E[通知スキップ]
    D -->|No| F[CLI_CHECK_MULTIPLE_WORKERS表示]
    F --> G[ワーカープロセス起動]
    E --> G
    C --> H[通常の診断処理]
    G --> I[全ワーカー完了待ち]
```

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

### 参照テーブル一覧

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

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | - |

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | コンソール出力が不可能な場合 | 処理は継続 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1回の診断あたり | 最大1回 |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（CLI実行時のみ）

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

- 機密情報は含まれない（ワーカー数のみ）

## 備考

- マルチワーカーモードでは、各ワーカーにQUIETモードが強制的に適用される
- 各ワーカーのプログレス出力は個別に無効化され、メインプロセスでのみ本通知が表示される
- NUM_THREADS の値はCLI引数またはグローバル変数で設定される

---

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

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

### 推奨読解順序

#### Step 1: マルチワーカー判定を理解する

まず、マルチワーカーモードの判定条件を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | check.lua | `script/cli/check.lua` | NUM_THREADS の取得と判定（51行目、65行目） |

**読解のコツ**: `numThreads` 変数が1より大きい場合にマルチワーカーモードとなる。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | check.lua | `script/cli/check.lua` | `export.runCLI()` 関数（50-118行目） |

**主要処理フロー**:
1. **51行目**: `numThreads = tonumber(NUM_THREADS or 1)` でワーカー数取得
2. **65-67行目**: マルチワーカー通知の表示条件と出力
3. **69-78行目**: ワーカープロセスの起動

#### Step 3: ワーカー引数構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | check.lua | `script/cli/check.lua` | `buildArgs()` 関数（14-48行目） |

**主要処理フロー**:
- **37-40行目**: QUIETオプションの強制追加
- **44-45行目**: 各ワーカー用の出力パス設定

#### Step 4: ローカライゼーションを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/en-us/script.lua` | 682-683行目でメッセージ定義 |
| 4-2 | script.lua | `locale/ja-jp/script.lua` | 683-684行目で日本語メッセージ定義 |

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

```
export.runCLI() [check.lua:50]
    │
    ├─ numThreads取得 [check.lua:51]
    │
    ├─ マルチワーカー条件判定 [check.lua:65]
    │      │
    │      └─ lang.script('CLI_CHECK_MULTIPLE_WORKERS', numThreads) [check.lua:66]
    │
    └─ subprocess.spawn() [check.lua:71]
           └─ buildArgs() [check.lua:71]
                  └─ ワーカー用引数構築（--quiet追加）[check.lua:37-40]
```

### データフロー図

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

NUM_THREADS ─────────▶ numThreads判定 ───────▶ マルチワーカー通知
      │                                              │
      ▼                                              ▼
   buildArgs() ─────────▶ subprocess.spawn() ───▶ ワーカー起動
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| check.lua | `script/cli/check.lua` | ソース | マルチワーカー起動、通知表示 |
| check_worker.lua | `script/cli/check_worker.lua` | ソース | 各ワーカーの診断処理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
