# 通知設計書 4-MWS_COMPLETE

## 概要

本ドキュメントは、Lua Language Server におけるワークスペース準備完了通知（MWS_COMPLETE）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ワークスペースの読み込み・解析が完了し、言語サーバーの全機能が利用可能になったことをユーザーに伝えるメッセージである。

**業務上の目的・背景**：Lua Language Server は起動時にワークスペース内のファイルをスキャン・プリロード・解析する。この処理が完了すると、コード補完、定義ジャンプ、参照検索などの言語サーバー機能が完全に利用可能になる。以前に MWS_NOT_COMPLETE で「準備中」と伝えていた場合、この通知により「準備完了」を伝え、ユーザーに再試行を促す。

**通知の送信タイミング**：ワークスペースの読み込み・解析処理が完了した際に送信される。特に、以前に MWS_NOT_COMPLETE が表示されていた場合の状態遷移として使用される。

**通知の受信者**：エディタを使用している開発者（ユーザー）。

**通知内容の概要**：「ワークスペースの準備が完了しました。再度お試しいただけます。」というメッセージが表示される。

**期待されるアクション**：ユーザーは以前失敗した操作（補完、定義ジャンプ等）を再度実行する。

## 通知種別

アプリ内通知（LSP window/showMessage）

## 送信仕様

### 基本情報

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

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

LSP クライアントに対して直接送信される。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| ボタン | なし |

### 本文テンプレート

```
Workspace is complete now. You may try again...
```

日本語:
```
ワークスペースの準備が完了しました。再度お試しいただけます。
```

中国語（簡体）:
```
工作目录准备好了，你可以再试一下了...
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ワークスペース読み込み完了 | scope:set('ready', true) 実行時 | プリロード・解析が完了した時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 初回起動で直接完了 | MWS_NOT_COMPLETE が先に表示されていない場合は不要 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ワークスペースプリロード開始] --> B[ファイルスキャン]
    B --> C[ファイル解析]
    C --> D[scope:set ready=true]
    D --> E{MWS_NOT_COMPLETE表示済み?}
    E -->|Yes| F[MWS_COMPLETE通知送信]
    E -->|No| G[通知なしで完了]
    F --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

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

### 更新データ

| データ | 更新元 | 用途 |
|--------|--------|------|
| ready状態 | scope:set('ready', true) | ワークスペース準備完了を記録 |

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | ワークスペースあたり1回 |

### 配信時間帯

制限なし

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

- 固定メッセージのため機密情報は含まれない

## 備考

- MWS_NOT_COMPLETE（No.3）と対になる通知
- 状態遷移: NOT_COMPLETE → COMPLETE

---

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

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

### 推奨読解順序

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

メッセージ定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 195-196行目: MWS_COMPLETE 定義 |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | 195-196行目: 日本語訳 |

**読解のコツ**: 固定メッセージで変数プレースホルダーなし。

#### Step 2: ready状態の設定を理解する

ワークスペース準備完了の設定機構を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | workspace.lua | `script/workspace/workspace.lua` | 501-521行目: awaitReload 関数 |

**主要処理フロー**:
1. **504行**: scp:set('ready', false) - リロード開始時に false
2. **510行**: awaitPreload(scp) - プリロード実行
3. **511行**: scp:set('ready', true) - 完了時に true
4. **512-517行**: waitingReady のコールバック実行

#### Step 3: waitingReady機構を理解する

準備完了待ちの機構を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | workspace.lua | `script/workspace/workspace.lua` | 530-540行目: awaitReady 関数 |

**主要処理フロー**:
- **535-536行**: waitingReady配列にwakerを追加
- **537-539行**: await.waitで待機

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

```
workspace.awaitReload (workspace.lua:501)
    │
    ├─ scp:set('ready', false) (504行)
    │
    ├─ m.flushFiles(scp) (508行)
    │
    ├─ m.awaitPreload(scp) (510行)
    │      └─ loading.create → ファイル読み込み
    │
    ├─ scp:set('ready', true) (511行)
    │
    └─ waitingReady callbacks (512-517行)
           └─ 待機中の処理を再開
```

### データフロー図

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

ワークスペース     ───▶  awaitReload()            ───▶  ready = true
リロード要求              │
                         ├─ flushFiles()
                         │
                         ├─ awaitPreload()
                         │
                         └─ scp:set('ready', true)
                                │
                                └─ MWS_COMPLETE通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義（195-196行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義（195-196行） |
| workspace.lua | `script/workspace/workspace.lua` | ソース | awaitReload, awaitReady 実装 |
| loading.lua | `script/workspace/loading.lua` | ソース | ファイル読み込み処理 |
