# 通知設計書 5-MWS_MAX_PRELOAD

## 概要

本ドキュメントは、Lua Language Server におけるプリロード上限到達通知（MWS_MAX_PRELOAD）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ワークスペース内でプリロードされるファイル数が設定された上限に達した場合に表示される警告メッセージである。ユーザーに上限到達を通知し、追加のファイルを解析するには手動で開く必要があることを伝える。

**業務上の目的・背景**：大規模なプロジェクトでは、ワークスペース内のLuaファイル数が非常に多くなる場合がある。全ファイルを自動的にプリロードするとメモリ使用量が増大し、パフォーマンスが低下する可能性がある。そのため、`Lua.workspace.maxPreload` 設定で上限が設けられている。この通知により、ユーザーは上限に達したことを認識し、必要に応じて設定を調整できる。

**通知の送信タイミング**：ワークスペースのファイルスキャン中に、プリロード対象ファイル数が `Lua.workspace.maxPreload` で設定された上限に達した時点で送信される。

**通知の受信者**：エディタを使用している開発者（ユーザー）。Info レベルのメッセージダイアログとして表示される。

**通知内容の概要**：「プリロードファイルの数が上限（{上限値}）に達しました。読み込む必要のあるファイルを手動で開く必要があります。」というメッセージと、「上限を増やす」ボタンが表示される。

**期待されるアクション**：ユーザーは「上限を増やす」ボタンをクリックして maxPreload 設定値を増加させるか、必要なファイルを手動で開いて解析対象に含める。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（LSP request） |
| 優先度 | 中 |
| リトライ | 無 |

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| ボタン | 上限を増やす（WINDOW_INCREASE_UPPER_LIMIT） |

### 本文テンプレート

```
Preloaded files has reached the upper limit ({}), you need to manually open the files that need to be loaded.
```

日本語:
```
プリロードファイルの数が上限（{}）に達しました。読み込む必要のあるファイルを手動で開く必要があります。
```

中国語（簡体）:
```
预加载文件数已达上限（{}），你需要手动打开需要加载的文件。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} (位置1) | プリロード上限値 | config.get('Lua.workspace.maxPreload') | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ファイルプリロード処理中 | self.preload > maxPreload | プリロードファイル数が上限を超えた場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| hasHintedMaxPreload == true | 同一スコープで既に通知済みの場合 |
| preload <= maxPreload | 上限に達していない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイルプリロード処理] --> B[preloadカウント増加]
    B --> C{preload > maxPreload?}
    C -->|No| D[通常処理継続]
    C -->|Yes| E{hasHintedMaxPreload?}
    E -->|Yes| F[プリロードスキップ]
    E -->|No| G[MWS_MAX_PRELOAD通知生成]
    G --> H[hasHintedMaxPreload = true]
    H --> I[requestMessage送信]
    I --> J{ユーザー選択}
    J -->|上限増加| K[maxPreload設定更新]
    J -->|キャンセル| L[プリロードスキップ]
    K --> M[終了]
    L --> M
    D --> M
    F --> M
```

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

### 参照テーブル一覧

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

### 参照データ

| データ | 取得元 | 用途 |
|--------|--------|------|
| maxPreload | config.get('Lua.workspace.maxPreload') | 上限値取得 |
| hasHintedMaxPreload | scope:get('hasHintedMaxPreload') | 重複通知防止 |

### 更新データ

| データ | 更新先 | 用途 |
|--------|--------|------|
| hasHintedMaxPreload | scope:set('hasHintedMaxPreload', true) | 通知済みフラグ |
| maxPreload | client.setConfig | 上限値更新（ユーザー選択時） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 設定更新失敗 | クライアントが設定変更非対応 | ログに記録、ユーザーに手動設定を促す |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| スコープあたり上限 | 1回（hasHintedMaxPreloadで制御） |

### 配信時間帯

制限なし

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

- 上限値のみを表示、機密情報は含まれない

## 備考

- WINDOW_INCREASE_UPPER_LIMIT（No.42）ボタンと組み合わせて使用
- 上限増加時は現在の値の2倍（最低でも1000増加）に設定

---

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

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

### 推奨読解順序

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

メッセージ定義とボタンラベルを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 197-198行目: MWS_MAX_PRELOAD 定義 |
| 1-2 | script.lua | `locale/en-us/script.lua` | 552-553行目: WINDOW_INCREASE_UPPER_LIMIT 定義 |

**読解のコツ**: {} がプレースホルダーで、maxPreload値が挿入される。

#### Step 2: 通知送信処理を理解する

checkMaxPreload関数の実装を理解する。

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

**主要処理フロー**:
1. **37行**: maxPreload 設定値を取得
2. **38-40行**: preload <= max なら true を返す
3. **41-44行**: hasHintedMaxPreload 確認と設定
4. **45-62行**: requestMessage で通知送信
5. **51-58行**: ボタン押下時のコールバック（設定更新）

#### Step 3: loadFile処理を理解する

プリロードカウントの増加処理を理解する。

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

**主要処理フロー**:
- **72行**: self.preload = self.preload + 1
- **73-75行**: checkMaxPreload の呼び出し

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

```
loading:loadFile (loading.lua:69)
    │
    ├─ self.preload++ (72行)
    │
    ├─ self:checkMaxPreload(uri) (73行)
    │      │
    │      ├─ config.get('Lua.workspace.maxPreload') (37行)
    │      │
    │      ├─ [preload > max]
    │      │      │
    │      │      ├─ scp:get('hasHintedMaxPreload') (41行)
    │      │      │
    │      │      └─ client.requestMessage (45行)
    │      │             │
    │      │             ├─ lang.script('MWS_MAX_PRELOAD', max)
    │      │             │
    │      │             └─ [ボタン押下]
    │      │                    └─ client.setConfig (52-58行)
    │      │
    │      └─ [preload <= max] → return true
    │
    └─ [checkMaxPreload == false] → return (プリロードスキップ)
```

### データフロー図

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

ファイルスキャン    ───▶  loadFile()               ───▶  プリロード or スキップ
                         │
                         ├─ preloadカウント増加
                         │
                         └─ checkMaxPreload()
                                │
                                ├─ [上限超過]
                                │      └─ MWS_MAX_PRELOAD通知
                                │             │
                                │             └─ [上限増加ボタン]
                                │                    └─ 設定更新
                                │
                                └─ [上限以下] → 継続
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | メッセージ定義（197-198行、552-553行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| loading.lua | `script/workspace/loading.lua` | ソース | checkMaxPreload, loadFile 実装 |
| client.lua | `script/client.lua` | ソース | requestMessage, setConfig 実装 |
