# 通知設計書 10-WORKSPACE_LOADING

## 概要

本ドキュメントは、Lua Language Server におけるワークスペース読み込み中通知（WORKSPACE_LOADING）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ワークスペースのファイルを読み込み・解析している最中であることをユーザーに表示するプログレスバーのタイトルテキストである。LSP の progress 機能を使用して、読み込み進捗をリアルタイムで表示する。

**業務上の目的・背景**：大規模なワークスペースでは、全ファイルのスキャン・プリロード・解析に時間がかかる場合がある。この間、ユーザーは言語サーバーの状態を把握できないと、動作していないと誤解する可能性がある。プログレスバーを表示することで、処理が進行中であることと、その進捗状況をリアルタイムで確認できる。

**通知の送信タイミング**：ワークスペースの読み込み処理が開始された時点でプログレスバーが表示され、完了するまで継続的に更新される。

**通知の受信者**：エディタを使用している開発者（ユーザー）。エディタのステータスバーまたはプログレス通知として表示される。

**通知内容の概要**：「Loading workspace」（日本語：「ワークスペースを読み込み中」）というタイトルと共に、読み込み済み/全体のファイル数が表示される。

**期待されるアクション**：ユーザーは読み込み完了を待つ。プログレスバーの進捗を確認しながら、処理が進んでいることを認識できる。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（継続的更新） |
| 優先度 | 低 |
| リトライ | 無 |

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

LSP クライアントに対して window/workDoneProgress/create でプログレス作成後、$/progress で更新を送信。

## 通知テンプレート

### プログレスバーの場合

| 項目 | 内容 |
|-----|------|
| タイトル | Loading workspace |
| メッセージ | {読み込み済み}/{全体} |
| 百分率 | (読み込み済み / 全体) * 100 |

### 本文テンプレート

タイトル:
```
Loading workspace
```

日本語:
```
ワークスペースを読み込み中
```

中国語（簡体）:
```
正在加载工作目录
```

メッセージ形式:
```
{read}/{max}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| read | 読み込み済みファイル数 | loading.read | Yes |
| max | 全ファイル数 | loading.max | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ワークスペース読み込み開始 | loading.create() | プリロード処理開始時 |
| システムイベント | ファイル読み込み完了 | loading:update() | 各ファイル読み込み完了時 |
| システムイベント | 全ファイル読み込み完了 | loading:remove() | プリロード処理完了時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Lua.window.progressBar == false | プログレスバーが無効化されている場合 |
| delay未経過 | 指定された遅延時間が経過していない場合（0.5秒） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ワークスペース読み込み開始] --> B[loading.create]
    B --> C[progress.create with delay]
    C --> D{delay経過?}
    D -->|No| E[プログレス非表示]
    D -->|Yes| F[window/workDoneProgress/create]
    F --> G[$/progress begin]
    E --> H[ファイル読み込み]
    G --> H
    H --> I[loading:update]
    I --> J[$/progress report]
    J --> K{全ファイル完了?}
    K -->|No| H
    K -->|Yes| L[$/progress end]
    L --> M[loading:remove]
    M --> N[終了]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない（インメモリ処理）。

### 管理データ

| データ | 型 | 用途 |
|--------|-----|------|
| loading.read | integer | 読み込み済みファイル数 |
| loading.max | integer | 全ファイル数 |
| loading.preload | integer | プリロード対象ファイル数 |
| _bar._token | integer | プログレストークン |
| _bar._showed | boolean | プログレス表示状態 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| プログレス作成失敗 | クライアント非対応 | 処理は継続、プログレス表示なし |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | 50ms以上 |
| 初期遅延 | 0.5秒（設定可能） |

### 配信時間帯

制限なし

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

- ファイル数のみを表示、ファイル名や内容は含まれない

## 備考

- progress.lua モジュールで汎用的に実装されている
- WORKSPACE_DIAGNOSTIC（No.11）は診断時のプログレス

---

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

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

### 推奨読解順序

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

メッセージ定義とプログレス構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 208-209行目: WORKSPACE_LOADING 定義 |
| 1-2 | loading.lua | `script/workspace/loading.lua` | 10-25行目: loading クラス構造 |

**読解のコツ**: WORKSPACE_LOADING は単純な文字列で、プログレスバーのタイトルとして使用される。

#### Step 2: プログレスバー機構を理解する

progress.lua の実装を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | progress.lua | `script/progress.lua` | 13-27行目: progress クラス構造 |
| 2-2 | progress.lua | `script/progress.lua` | 151-168行目: create 関数 |
| 2-3 | progress.lua | `script/progress.lua` | 81-133行目: update 関数 |

**主要処理フロー**:
1. **155-163行**: progress.create - プログレス作成
2. **88-111行**: update - delay経過後に window/workDoneProgress/create
3. **119-132行**: update - $/progress report 送信

#### Step 3: loading との連携を理解する

loading.lua での progress 使用を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | loading.lua | `script/workspace/loading.lua` | 204-214行目: m.create 関数 |
| 3-2 | loading.lua | `script/workspace/loading.lua` | 30-33行目: mt:update 関数 |
| 3-3 | loading.lua | `script/workspace/loading.lua` | 158-183行目: mt:loadAll 関数 |

**主要処理フロー**:
- **207行**: progress.create で WORKSPACE_LOADING プログレス作成
- **31-32行**: _bar:setMessage と _bar:setPercentage で更新
- **173行**: _bar:remove でプログレス終了

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

```
workspace.awaitPreload (workspace.lua:318)
    │
    └─ loading.create(scp) (loading.lua:204)
           │
           ├─ progress.create(WORKSPACE_LOADING) (207行)
           │      │
           │      ├─ [delay経過後]
           │      │      ├─ window/workDoneProgress/create (95行)
           │      │      └─ $/progress begin (98行)
           │      │
           │      └─ [更新時]
           │             └─ $/progress report (124行)
           │
           ├─ loading:loadFile() × N回
           │      └─ loading:update() (31行)
           │             └─ _bar:setMessage/setPercentage
           │
           └─ loading:loadAll() (158行)
                  │
                  ├─ _bar:remove() (173行)
                  │      └─ $/progress end (39行)
                  │
                  └─ 新しいprogress作成 (174行)
```

### データフロー図

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

ワークスペース     ───▶  loading.create()         ───▶  プログレスバー表示
プリロード開始           │
                        ├─ progress.create()
                        │      └─ WORKSPACE_LOADING タイトル
                        │
                        ├─ loadFile() × N
                        │      └─ update()
                        │             └─ {read}/{max} メッセージ
                        │
                        └─ loadAll() 完了
                               └─ $/progress end
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | メッセージ定義（208-209行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| loading.lua | `script/workspace/loading.lua` | ソース | ローディング管理 |
| progress.lua | `script/progress.lua` | ソース | プログレスバー実装 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | awaitPreload 呼び出し |
