# 通知設計書 28-WINDOW_DIAGNOSING

## 概要

本ドキュメントは、Lua Language Serverにおける診断中通知（WINDOW_DIAGNOSING）の設計について記述する。

### 本通知の処理概要

この通知は、ファイルまたはワークスペースの診断（静的解析）処理中であることをユーザーに示すプログレスバー表示に使用される。

**業務上の目的・背景**：Lua Language Serverはファイルに対して様々な静的解析（型チェック、未使用変数検出、構文エラー検出など）を実行する。特にワークスペース全体の診断は時間がかかる可能性があり、ユーザーに処理状況を可視化することで、サーバーが応答していることを示し、待機中の不安を軽減する。

**通知の送信タイミング**：diagnostic.doDiagnostic関数でファイルの診断処理を開始する際、progress.createによりプログレスバーが作成される。一定時間（0.5秒）以上処理が継続する場合に表示される。

**通知の受信者**：エディタを使用しているユーザー（開発者）。LSPクライアント経由で$/progress通知として受信する。

**通知内容の概要**：「Diagnosing」というタイトルのプログレスバーと、処理中のファイルパスがメッセージとして表示される。

**期待されるアクション**：ユーザーは処理完了を待つ。プログレスバーは自動的に消える。キャンセル可能な場合もある。

## 通知種別

LSP $/progress通知（プログレスバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（LSP notification） |
| 優先度 | 低（情報表示） |
| リトライ | なし |

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

LSPクライアント（エディタ）に対して$/progress通知を送信する。受信者はエディタを操作しているユーザー。

## 通知テンプレート

### LSP通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | $/progress |
| プログレスKind | begin / report / end |

### 本文テンプレート

英語版:
```
Diagnosing
```

日本語版:
```
診断中です
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 処理中のファイルパス | ws.getRelativePath(uri) | No |
| percentage | 進捗率 | 計算値（i / #uris * 100） | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ファイル診断 | doDiagnostic呼び出し | 処理時間が0.5秒を超える場合 | 単一ファイルの診断時 |
| ワークスペース診断 | awaitDiagnosticsScope呼び出し | 常に表示 | ワークスペース全体の診断時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Lua.window.progressBar == false | 設定でプログレスバーが無効の場合 |
| 処理時間が0.5秒未満（単一ファイル） | 短時間で完了する場合は表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[doDiagnostic呼び出し] --> B[progress.create呼び出し]
    B --> C{delay経過?}
    C -->|No| D[プログレス非表示]
    C -->|Yes| E[window/workDoneProgress/create送信]
    E --> F[$/progress begin送信]
    F --> G[診断処理実行]
    G --> H{処理完了?}
    H -->|No| I[$/progress report送信]
    I --> G
    H -->|Yes| J[$/progress end送信]
    J --> K[プログレス終了]
```

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

### 参照テーブル一覧

該当なし（インメモリ処理のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 診断エラー | 内部エラー | ログに記録、診断スキップ |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | 50ms以上 |

### 配信時間帯

制限なし

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

- ファイルパスが表示されるが、ユーザー本人の作業ファイルのためセキュリティリスクは低い

## 備考

- ワークスペース診断時はキャンセル可能
- progress.createの第3引数（delay）で表示遅延を設定可能

---

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

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

### 推奨読解順序

#### Step 1: メッセージ定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | WINDOW_DIAGNOSING定義（524-525行目） |

**読解のコツ**: シンプルな固定文言として定義されている。

#### Step 2: プログレスの使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | diagnostic.lua | `script/provider/diagnostic.lua` | doDiagnostic関数（281-358行目） |
| 2-2 | diagnostic.lua | `script/provider/diagnostic.lua` | awaitDiagnosticsScope関数（526-579行目） |

**主要処理フロー（doDiagnostic）**:
1. **296行目**: progress.create呼び出し（WINDOW_DIAGNOSING）
2. **297行目**: setMessageでファイルパス設定

**主要処理フロー（awaitDiagnosticsScope）**:
1. **541行目**: progress.create呼び出し（WORKSPACE_DIAGNOSTIC）
2. **567-568行目**: setMessage/setPercentageで進捗更新

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

```
diagnostic.doDiagnostic (script/provider/diagnostic.lua:281)
    │
    └─ progress.create (script/progress.lua:155)
           │
           ├─ [delay後]
           │      │
           │      ├─ proto.request('window/workDoneProgress/create')
           │      │
           │      └─ proto.notify('$/progress', {kind='begin'})
           │
           ├─ [進捗更新時]
           │      │
           │      └─ proto.notify('$/progress', {kind='report'})
           │
           └─ [完了時]
                  │
                  └─ proto.notify('$/progress', {kind='end'})

diagnostic.awaitDiagnosticsScope (script/provider/diagnostic.lua:526)
    │
    └─ progress.create (script/progress.lua:155)
           │
           ├─ onCancel コールバック設定
           │
           └─ [同上のフロー]
```

### データフロー図

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

ファイルURI      ───▶  doDiagnostic           ───▶  診断結果
                           │                         (publishDiagnostics)
                           ▼
                    progress.create
                    (WINDOW_DIAGNOSING)
                           │
                           ▼
                    [delay経過]
                           │
                           ▼
                    $/progress ────────────▶  LSPクライアント
                    (begin/report/end)         (プログレスバー表示)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| diagnostic.lua | `script/provider/diagnostic.lua` | ソース | 診断処理の中核 |
| progress.lua | `script/progress.lua` | ソース | プログレスバー管理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
