# 通知設計書 29-WINDOW_INITIALIZING

## 概要

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

### 本通知の処理概要

この通知は、LSPサーバーの初期化処理中であることをユーザーに示すプログレスバー表示に使用される。

**業務上の目的・背景**：Lua Language Serverはクライアントからinitialized通知を受信した後、設定の更新、ワークスペースの初期化、動的機能登録などの初期化処理を実行する。これらの処理には時間がかかる場合があり、ユーザーに処理状況を可視化することで、サーバーが準備中であることを示す。

**通知の送信タイミング**：provider.luaのinitializedハンドラで処理を開始する際、progress.createによりプログレスバーが作成される。一定時間（0.5秒）以上処理が継続する場合に表示される。

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

**通知内容の概要**：「Initializing...」というタイトルのプログレスバーが表示される。

**期待されるアクション**：ユーザーは処理完了を待つ。プログレスバーは自動的に消える。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### LSP通知の場合

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

### 本文テンプレート

英語版:
```
Initializing...
```

日本語版:
```
初期化中です...
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 進捗メッセージ | 設定なし | No |
| percentage | 進捗率 | 設定なし | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| サーバー初期化 | initialized通知受信 | 処理時間が0.5秒を超える場合 | LSPサーバーの初期化時 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[initialized通知受信] --> B[progress.create呼び出し]
    B --> C{delay経過?}
    C -->|No| D[プログレス非表示]
    C -->|Yes| E[window/workDoneProgress/create送信]
    E --> F[$/progress begin送信]
    F --> G[初期化処理実行]
    G --> H[設定更新 updateConfig]
    H --> I[動的機能登録]
    I --> J[client.setReady]
    J --> K[workspace.init]
    K --> L[$/progress end送信]
    L --> M[プログレス終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 初期化エラー | 設定読み込み失敗等 | ログに記録、デフォルト設定で継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 初期化状態の表示のみであり、セキュリティリスクは低い

## 備考

- progress.createの第3引数（delay）で表示遅延を設定可能（0.5秒）
- 初期化処理にはワークスペース設定の取得、動的機能登録が含まれる
- 短時間で完了する場合は表示されない設計

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: 「Initializing...」という固定文言として定義されている。

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

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

**主要処理フロー（initialized）**:
1. **143行目**: progress.create呼び出し（WINDOW_INITIALIZING、0.5秒遅延）
2. **145行目**: updateConfigで設定更新
3. **156-160行目**: client/registerCapabilityで動的機能登録
4. **161行目**: client.setReady()でクライアント準備完了
5. **162行目**: workspace.init()でワークスペース初期化

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

```
m.register 'initialized' (script/provider/provider.lua:140)
    │
    └─ progress.create (script/progress.lua:155)
           │
           ├─ [delay後]
           │      │
           │      ├─ proto.request('window/workDoneProgress/create')
           │      │
           │      └─ proto.notify('$/progress', {kind='begin'})
           │
           └─ [完了時 - <close>メタメソッド]
                  │
                  └─ proto.notify('$/progress', {kind='end'})

初期化処理内容:
    ├─ m.updateConfig (設定更新)
    ├─ proto.awaitRequest('client/registerCapability') (動的機能登録)
    ├─ client.setReady() (準備完了マーク)
    └─ workspace.init() (ワークスペース初期化)
```

### データフロー図

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

LSP initialized   ───▶  initializedハンドラ    ───▶  初期化完了
    通知                      │
                             ▼
                    progress.create
                    (WINDOW_INITIALIZING)
                             │
                             ▼
                    [delay経過]
                             │
                             ▼
                    $/progress ────────────▶  LSPクライアント
                    (begin/end)               (プログレスバー表示)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| provider.lua | `script/provider/provider.lua` | ソース | LSPハンドラ、初期化処理 |
| progress.lua | `script/progress.lua` | ソース | プログレスバー管理 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | クライアント状態管理 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
