# 通知設計書 11-WORKSPACE_DIAGNOSTIC

## 概要

本ドキュメントは、Lua Language Serverにおける「ワークスペース診断実行中」通知（WORKSPACE_DIAGNOSTIC）の設計仕様を定義する。この通知はワークスペース全体の診断処理を実行中であることをユーザーに表示するためのプログレス通知である。

### 本通知の処理概要

**業務上の目的・背景**：ワークスペース全体のLuaファイルに対して診断（構文エラー、型チェック、スタイル警告など）を実行する際、処理に時間がかかる場合がある。ユーザーに処理状況を可視化し、システムが正常に動作していることを示すために本通知が必要である。また、ユーザーが必要に応じて診断をキャンセルできるようにする。

**通知の送信タイミング**：ワークスペース診断が開始されたタイミングで送信される。具体的には、以下のイベント発生時に診断がトリガーされる：
- ワークスペースの初期読み込み完了後
- ファイルの保存時（設定による）
- ファイル変更時（設定による）
- 設定変更時（診断関連設定の変更）

**通知の受信者**：LSPクライアント（VSCode等のエディタ）を通じてユーザーに表示される。プログレスバー形式でエディタのUI上に表示される。

**通知内容の概要**：「ワークスペースの診断を実行しています。」というメッセージと共に、診断の進捗状況（処理済みファイル数/全ファイル数）がパーセンテージで表示される。

**期待されるアクション**：ユーザーは診断の進行状況を確認し、必要に応じてキャンセルボタンで診断を中断できる。診断完了後は自動的にプログレスバーが消える。

## 通知種別

アプリ内通知（LSP Progress Notification）

## 送信仕様

### 基本情報

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

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

LSPプロトコルに従い、接続中のLSPクライアントに対してプログレス通知を送信する。受信者の決定は不要（接続中のクライアントすべてに送信）。

## 通知テンプレート

### プログレス通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | Progress（$/progress） |
| トークン | 自動生成（UUID形式） |

### 本文テンプレート

```
ワークスペースの診断を実行しています。
{処理済みファイル数}/{全ファイル数}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| lang.script.WORKSPACE_DIAGNOSTIC | 診断実行中メッセージ | locale/ja-jp/script.lua | Yes |
| 処理済みファイル数 | 診断完了したファイル数 | diagnostic.lua内のカウンター | Yes |
| 全ファイル数 | 診断対象の全ファイル数 | files.getAllUris() | Yes |
| パーセンテージ | 進捗率（%） | (処理済み/全体)*100 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ワークスペース読み込み | reload イベント | ワークスペース準備完了時 | 初期読み込み後の診断 |
| ファイル保存 | OnSave イベント | workspaceEvent='OnSave'設定時 | 保存トリガーの診断 |
| ファイル変更 | OnChange イベント | workspaceEvent='OnChange'設定時 | 変更トリガーの診断 |
| 設定変更 | config.watch | 診断関連設定変更時 | 設定変更後の再診断 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| diagnostics.enable = false | 診断機能が無効化されている場合 |
| workspaceDelay < 0 | ワークスペース診断が無効化されている場合 |
| fallbackスコープ | 単一ファイルモードの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[診断トリガー発生] --> B{diagnostics.enable?}
    B -->|false| Z[処理終了]
    B -->|true| C{workspaceDelay >= 0?}
    C -->|false| Z
    C -->|true| D[ワークスペース準備完了待機]
    D --> E[プログレスバー作成]
    E --> F[WORKSPACE_DIAGNOSTIC表示]
    F --> G[ファイルリスト取得]
    G --> H[ファイル診断ループ]
    H --> I{キャンセル?}
    I -->|Yes| J[キャンセルダイアログ表示]
    I -->|No| K[進捗更新]
    K --> L{全ファイル完了?}
    L -->|No| H
    L -->|Yes| M[プログレスバー削除]
    J --> M
    M --> Z
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| files.fileMap | 診断対象ファイル一覧 | メモリ上のファイルキャッシュ |
| config | 診断設定取得 | 設定情報 |
| scope | ワークスペーススコープ情報 | スコープ管理 |

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

#### files.fileMap

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| uri | ファイル識別子 | スコープ内のファイル |
| text | ファイル内容 | 診断実行用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| m.cache | UPDATE | 診断結果のキャッシュ更新 |

#### 診断キャッシュ

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | m.cache[uri] | 診断結果配列 | ファイルごとの診断結果 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| キャンセル | ユーザーによる中断 | ログ出力後、正常終了 |
| ファイル読み込みエラー | ファイルアクセス失敗 | 該当ファイルをスキップ |
| メモリ不足 | 大規模ワークスペース | ガベージコレクション実行 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（エディタ起動中いつでも）

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

- ローカルファイルシステムへのアクセスはエディタが許可したワークスペース内に限定
- 診断結果にはファイルパスが含まれるが、外部送信は行わない

## 備考

- 大規模ワークスペースでは診断に時間がかかるため、キャンセル機能が重要
- 診断遅延設定（workspaceDelay）により、頻繁な診断実行を抑制可能
- 設定「Lua.diagnostics.workspaceEvent」でトリガータイミングを制御可能

---

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

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

### 推奨読解順序

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

まず、プログレス通知で使用されるデータ構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | progress.lua | `script/progress.lua` | プログレス通知のクラス定義とメソッド |

**読解のコツ**: progress.createで生成されるプログレスオブジェクトの構造を把握する。

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

処理の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | diagnostic.lua | `script/provider/diagnostic.lua` | diagnosticsScope関数が主要エントリーポイント |

**主要処理フロー**:
1. **行581**: `m.diagnosticsScope(uri, force, ignoreFileOpenState)` - スコープ診断の開始
2. **行541**: `progress.create(suri, lang.script.WORKSPACE_DIAGNOSTIC, 1)` - プログレスバー作成
3. **行551-559**: ファイルリストの取得とソート
4. **行562-575**: ファイル診断ループ

#### Step 3: 言語リソースを理解する

通知メッセージの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/ja-jp/script.lua` | WORKSPACE_DIAGNOSTIC定義（行210-211） |

**主要処理フロー**:
- **行210-211**: `WORKSPACE_DIAGNOSTIC = 'ワークスペースの診断を実行しています。'`

#### Step 4: トリガー処理を理解する

診断がトリガーされる条件を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | diagnostic.lua | `script/provider/diagnostic.lua` | ws.watch、files.watch、config.watchコールバック |

**主要処理フロー**:
- **行671-676**: ws.watchでreloadイベント時に診断開始
- **行707-716**: config.watchで設定変更時に診断開始

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

```
workspace.lua (ワークスペース管理)
    │
    ├─ m.onWatch('reload', scp.uri)
    │      └─ diagnostic.lua
    │             └─ m.diagnosticsScope(uri)
    │                    ├─ progress.create() -- プログレス作成
    │                    ├─ m.awaitDiagnosticsScope()
    │                    │      ├─ files.getAllUris() -- ファイル取得
    │                    │      └─ m.doDiagnostic() -- 各ファイル診断
    │                    └─ bar:remove() -- プログレス削除
    │
    └─ files.watch('save'/'update')
           └─ m.refreshScopeDiag()
                  └─ m.diagnosticsScope()
```

### データフロー図

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

ワークスペースURI ───▶ scope.getScope() ───▶ スコープ情報
                              │
                              ▼
                      files.getAllUris() ───▶ ファイルリスト
                              │
                              ▼
                      progress.create() ───▶ LSP $/progress 通知
                              │
                              ▼
                      m.doDiagnostic() ───▶ 診断結果キャッシュ
                              │
                              ▼
                      proto.notify() ───▶ textDocument/publishDiagnostics
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| diagnostic.lua | `script/provider/diagnostic.lua` | ソース | 診断処理の中核実装 |
| progress.lua | `script/progress.lua` | ソース | プログレス通知管理 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
| files.lua | `script/files.lua` | ソース | ファイル管理 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| config.lua | `script/config.lua` | ソース | 設定管理 |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信 |
