# 通知設計書 46-WINDOW_DELAY_WS_DIAGNOSTIC

## 概要

本ドキュメントは、lua-language-serverにおける「アイドル時診断」ボタン通知（WINDOW_DELAY_WS_DIAGNOSTIC）の設計仕様を定義する。この通知は、ワークスペース診断をアイドル時に遅延実行するオプションをユーザーに提示するボタンラベルを提供する。

### 本通知の処理概要

この通知は、ワークスペース診断設定案内ダイアログ（WINDOW_SETTING_WS_DIAGNOSTIC）内のアクションボタンとして使用される。ユーザーがこのボタンを選択すると、診断処理がアイドル時間まで遅延されるように設定が変更される。

**業務上の目的・背景**：大規模なLuaプロジェクトでは、ワークスペース全体の診断処理に時間がかかり、編集作業中にCPUリソースを消費する可能性がある。この設定により、ユーザーがアクティブに編集している間は診断を実行せず、アイドル時間（デフォルト30秒後）に診断を実行することで、編集時のパフォーマンスと診断機能を両立させる。

**通知の送信タイミング**：WINDOW_SETTING_WS_DIAGNOSTICダイアログの一部として表示される。askForDisable関数内で、他の選択肢（再度表示しない、診断無効化）と共に提示される。

**通知の受信者**：VSCode等のIDEを使用してLuaプロジェクトを編集している開発者。特に大規模プロジェクトで診断処理のパフォーマンス影響を軽減したい場合に関連する。

**通知内容の概要**：「Idle time diagnosis (delay {} seconds)」（日本語：「アイドル時に診断（{}秒遅延）」）というボタンラベル。`{}`にはデフォルトで30秒が挿入される。

**期待されるアクション**：ユーザーがこのボタンをクリックすると、`Lua.diagnostics.workspaceDelay`設定が30000ms（30秒）に設定され、以降の診断処理はアイドル時間後に実行されるようになる。

## 通知種別

LSPメッセージリクエスト（`window/showMessageRequest`）のアクションボタンラベル

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期 |
| 優先度 | 中（Info） |
| リトライ | なし |

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

WINDOW_SETTING_WS_DIAGNOSTICダイアログの送信先決定ロジックに従う。

## 通知テンプレート

### ボタンラベルの場合

| 項目 | 内容 |
|-----|------|
| 用途 | 遅延診断設定ボタン |
| 親メッセージ | WINDOW_SETTING_WS_DIAGNOSTIC |
| 形式 | テキスト（パラメータ付き） |

### 本文テンプレート

```
英語: Idle time diagnosis (delay {} seconds)
日本語: アイドル時に診断（{}秒遅延）
中国語(簡体): 空闲时诊断（延迟{}秒）
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} | 遅延秒数 | delay変数（デフォルト30） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ダイアログ表示 | askForDisable | dontAskedForDisable = false | 診断設定案内ダイアログの一部 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| dontAskedForDisable = true | 親ダイアログが抑止されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[askForDisable呼び出し] --> B[delay = 30を設定]
    B --> C[lang.script WINDOW_DELAY_WS_DIAGNOSTIC, delay で展開]
    C --> D[delayTitleにラベル格納]
    D --> E[ダイアログ表示]
    E --> F{ユーザー選択}
    F -->|delayTitle| G[client.setConfig呼び出し]
    G --> H[workspaceDelay = delay * 1000 設定]
    H --> I[終了]
    F -->|他のアクション| J[他の処理]
    J --> I
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | N/A | データベース不使用 |

### 設定更新

| 設定キー | 操作 | 値 | 説明 |
|---------|------|-----|------|
| Lua.diagnostics.workspaceDelay | SET | 30000 | 30秒遅延（ms単位） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 設定更新失敗 | client.setConfigが失敗した場合 | ログ記録、処理継続 |
| テンプレート展開失敗 | lang.script関数が失敗した場合 | デフォルト言語にフォールバック |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | 親ダイアログに依存 |

### 配信時間帯

制限なし

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

- 設定変更はローカルの設定ファイルのみに影響
- ユーザーの明示的な選択が必要
- 機密情報は含まれない

## 備考

- delay変数は現在ハードコードで30秒に設定されている（diagnostic.lua 471行目）
- workspaceDelayの単位はミリ秒（ms）であるため、delay * 1000で変換
- 関連する通知：WINDOW_SETTING_WS_DIAGNOSTIC、WINDOW_DONT_SHOW_AGAIN、WINDOW_DISABLE_DIAGNOSTIC

---

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

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

### 推奨読解順序

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

askForDisable関数でのボタンラベル生成を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | diagnostic.lua | `script/provider/diagnostic.lua` | 471-472行目：delay変数とdelayTitle生成 |

**主要処理フロー**:
1. **471行目**: `local delay = 30` - 遅延秒数の定義
2. **472行目**: `local delayTitle = lang.script('WINDOW_DELAY_WS_DIAGNOSTIC', delay)` - ラベル生成

#### Step 2: ボタン表示を理解する

ダイアログのアクション定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | diagnostic.lua | `script/provider/diagnostic.lua` | 480-482行目：アクションボタン定義 |

**主要処理フロー**:
- **481行目**: `title = delayTitle` - ボタンラベルとしてdelayTitleを設定

#### Step 3: クリック時の処理を理解する

設定変更処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | diagnostic.lua | `script/provider/diagnostic.lua` | 493-501行目：選択処理 |

**主要処理フロー**:
- **493行目**: `item.title == delayTitle` - 選択判定
- **494-500行目**: `client.setConfig`で`workspaceDelay = delay * 1000`を設定

#### Step 4: 言語リソースを理解する

テンプレート変数の展開を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/en-us/script.lua` | 560-561行目：英語メッセージ |
| 4-2 | script.lua | `locale/ja-jp/script.lua` | 560-561行目：日本語メッセージ |

**読解のコツ**: `{}`はテンプレート変数のプレースホルダー。`lang.script('WINDOW_DELAY_WS_DIAGNOSTIC', delay)`の第2引数がこの位置に挿入される。

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

```
askForDisable (diagnostic.lua:467)
    |
    +-- delay = 30 (471行目)
    |
    +-- lang.script('WINDOW_DELAY_WS_DIAGNOSTIC', delay) (472行目)
    |       |
    |       +-- テンプレート展開: "Idle time diagnosis (delay 30 seconds)"
    |
    +-- proto.awaitRequest (473行目)
    |       |
    |       +-- actions: [{title: delayTitle}, ...]
    |
    +-- [選択処理] (493-501行目)
            |
            +-- item.title == delayTitle
                    |
                    +-- client.setConfig
                            |
                            +-- key: 'Lua.diagnostics.workspaceDelay'
                            +-- value: delay * 1000 (= 30000)
```

### データフロー図

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

delay = 30       ───▶  lang.script展開        ───▶  delayTitle
                       "Idle time diagnosis           (ボタンラベル)
                        (delay 30 seconds)"
                            |
                            ▼
                       proto.awaitRequest     ───▶  ダイアログ表示
                            |
                            ▼
                       [ユーザークリック]
                            |
                            ▼
                       client.setConfig       ───▶  設定更新
                       workspaceDelay = 30000        .luarc.json等
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| diagnostic.lua | `script/provider/diagnostic.lua` | ソース | 診断プロバイダー（メイン処理） |
| client.lua | `script/client.lua` | ソース | 設定変更API |
| language.lua | `script/language.lua` | ソース | テンプレート展開 |
| script.lua | `locale/en-us/script.lua` | 言語リソース | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
