# 通知設計書 75-HOVER_WS_LOADING

## 概要

本ドキュメントは、Lua Language Serverにおける `HOVER_WS_LOADING` 通知の設計を記述する。この通知は、ワークスペースの読み込み中にホバー機能を使用した際に、読み込み状況を表示するために使用される。

### 本通知の処理概要

この通知は、ワークスペースの初期化やファイル読み込みが完了していない状態でユーザーがホバー機能を使用した際に、現在の読み込み進捗状況を表示するためのメッセージとして使用される。

**業務上の目的・背景**：大規模なLuaプロジェクトでは、ワークスペースの初期化に時間がかかることがある。ユーザーがホバー機能（マウスオーバーでの型情報表示など）を使用した際に、まだワークスペースが準備完了していない場合、エラーを返すのではなく、現在の読み込み進捗を表示することで、ユーザーに状況を伝えて適切に待機を促す。

**通知の送信タイミング**：ユーザーがコード上でホバー操作を行い、かつワークスペースがまだ準備完了状態でない場合に表示される。

**通知の受信者**：VSCode等のLSPクライアントを使用している開発者。ホバーポップアップとして表示される。

**通知内容の概要**：「ワークスペースをロード中：{現在のファイル数} / {最大ファイル数}」という進捗情報を含むメッセージ。

**期待されるアクション**：ユーザーはワークスペースの読み込みが完了するまで待機する。読み込み完了後、再度ホバー操作を行うことで正常な型情報が表示される。

## 通知種別

アプリ内通知（ホバーポップアップ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（LSPレスポンス） |
| 優先度 | 低 |
| リトライ | なし |

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

LSPプロトコルの`textDocument/hover`リクエストに対するレスポンスとして送信される。

## 通知テンプレート

### ホバーポップアップの場合

| 項目 | 内容 |
|-----|------|
| 形式 | Markdown |
| 本文 | HOVER_WS_LOADING |

### 本文テンプレート

```
日本語: ワークスペースをロード中：{count} / {max}
英語: Loading workspace: {count} / {max}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| count | 現在読み込み済みのファイル数 | workspace.getLoadingProcess(uri) | Yes |
| max | 読み込み対象の総ファイル数 | workspace.getLoadingProcess(uri) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| LSPリクエスト | textDocument/hover | workspace.isReady(uri) == false | ホバー要求時にワークスペース未準備 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ワークスペース準備完了 | workspace.isReady(uri)がtrueの場合、通常のホバー情報を返す |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[textDocument/hover発生] --> B{workspace.isReady?}
    B -->|Yes| C[通常のホバー処理]
    B -->|No| D[getLoadingProcess呼び出し]
    D --> E[HOVER_WS_LOADINGメッセージ生成]
    E --> F[ホバーレスポンス返却]
    C --> G[通常ホバー情報返却]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。インメモリでワークスペース状態を管理する。

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 進捗情報取得失敗 | getLoadingProcessが失敗 | デフォルトの進捗表示 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（ホバー操作頻度依存） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（エディタ操作時のみ）

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

- 進捗情報のみを表示するため、セキュリティリスクは低い
- ファイル数情報はプロジェクトの規模を示すが、機密性は低い

## 備考

- この通知はワークスペース初期化中のみ表示される
- 読み込み完了後は自動的に通常のホバー機能が有効になる

---

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

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

### 推奨読解順序

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

まず、通知で使用されるローカライズ文字列の定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/ja-jp/script.lua` | HOVER_WS_LOADINGの日本語定義（419-420行目）を確認 |
| 1-2 | script.lua | `locale/en-us/script.lua` | HOVER_WS_LOADINGの英語定義を確認 |

**読解のコツ**: `{}` はテンプレート変数のプレースホルダーとして使用される。

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

処理の起点となるホバーハンドラを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | provider.lua | `script/provider/provider.lua` | textDocument/hoverハンドラ（340-385行目） |

**主要処理フロー**:
1. **348-350行目**: hover.enable設定のチェック
2. **352-359行目**: workspace.isReady()チェックとHOVER_WS_LOADINGの使用箇所
3. **353行目**: getLoadingProcess()の呼び出し
4. **354-358行目**: HOVER_WS_LOADINGメッセージの生成と返却

#### Step 3: ワークスペース状態管理を理解する

ワークスペースの準備状態と進捗取得を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | workspace.lua | `script/workspace/workspace.lua` | isReady関数とgetLoadingProcess関数 |

**主要処理フロー**:
- ワークスペースの初期化状態管理
- ファイル読み込み進捗のトラッキング

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

```
textDocument/hover (provider.lua:340)
    │
    ├─ config.get(uri, 'Lua.hover.enable')
    │
    ├─ workspace.isReady(uri)
    │      │
    │      └─ false の場合
    │             │
    │             ├─ workspace.getLoadingProcess(uri)
    │             │      └─ (count, max) を返却
    │             │
    │             └─ lang.script('HOVER_WS_LOADING', count, max)
    │                    │
    │                    └─ ホバーレスポンス生成
    │
    └─ true の場合
           └─ core.hover.byUri() - 通常処理
```

### データフロー図

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

ホバー操作 ───▶ textDocument/hover ───▶ isReady判定
                       │                      │
                       │                      ├─ 未準備
                       │                      │    │
                       │                      │    └─▶ getLoadingProcess
                       │                      │              │
                       │                      │              └─▶ (count, max)
                       │                      │                      │
                       │                      │                      └─▶ HOVER_WS_LOADING
                       │                      │
                       │                      └─ 準備完了 ───▶ 通常ホバー情報
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSPホバーハンドラ |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース状態管理 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| hover.lua | `script/core/hover.lua` | ソース | ホバー情報取得 |
