# 通知設計書 29-window/showMessageRequest

## 概要

本ドキュメントは、serve-d LSPサーバーにおけるLSP標準リクエスト「window/showMessageRequest」の設計仕様を定義する。本リクエストはサーバーからクライアント(エディタ)に送信され、メッセージとアクションボタンを表示してユーザーの選択結果を返す。

### 本通知の処理概要

本リクエストは、サーバーがクライアントに対してメッセージダイアログを表示し、ユーザーに選択肢を提示して応答を取得するものである。

**業務上の目的・背景**：serve-dのさまざまな処理フローにおいて、ユーザーの確認や選択が必要な場面がある。DCDの更新確認、DUB依存関係のダウンロード確認、サブプロジェクトの読み込み確認など、ユーザーの判断を必要とする操作に本リクエストが使用される。LSP標準のwindow/showMessage（通知）と異なり、ユーザーの応答を取得できる点が特徴である。

**通知の送信タイミング**：以下の場面で送信される。(1) DCD更新確認（doGlobalStartup内、DCDが古い場合）。(2) DUB依存関係ダウンロード確認（delayedProjectActivation内、missingDeps検出時）。(3) サブプロジェクト読み込み確認（delayedProjectActivation内、manyProjectsThreshold超過時）。

**通知の受信者**：LSPクライアント（エディタ）が受信者である。エディタはメッセージダイアログをユーザーに表示する。

**通知内容の概要**：ShowMessageRequestParams（type, message, actions）をパラメータとして送信する。MessageType（error/warning/info/log）、メッセージ本文、選択可能なアクションボタンのリストを含む。

**期待されるアクション**：クライアントはユーザーにメッセージダイアログを表示し、ユーザーが選択したアクション（MessageActionItem）をサーバーに返す。ダイアログが閉じられた場合はnullが返される。

## 通知種別

LSP標準リクエスト（JSON-RPC Request）。サーバーからクライアントへの方向（S->C）。応答を伴うリクエストであり、通知（Notification）ではない。

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（JSON-RPC request、応答待ち） |
| 優先度 | 高 |
| リトライ | なし |

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

サーバーからLSPクライアントに直接送信される。WindowFunctions.requestMessage()メソッド経由で呼び出される。

## 通知テンプレート

### メール通知の場合

該当なし。本リクエストはLSPプロトコル上のJSON-RPCメッセージである。

### 本文テンプレート

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "window/showMessageRequest",
  "params": {
    "type": 1,
    "message": "DCD is outdated. Expected: v0.15.2, got none. Download DCD?",
    "actions": [
      { "title": "Download DCD" },
      { "title": "Ignore" }
    ]
  }
}
```

### 添付ファイル

該当なし。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| type | メッセージ種別（1:Error, 2:Warning, 3:Info, 4:Log） | サーバー側ロジック | Yes |
| message | 表示するメッセージ本文 | 翻訳リソース（translate関数） | Yes |
| actions | 選択可能なアクションボタンの配列 | サーバー側ロジック | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 自動 | DCD更新確認 | DCDが古い && aggressiveUpdate == false | DCD更新/無視の選択 |
| 自動 | DUB依存関係ダウンロード確認 | missingDeps.length > 0 && forceDownloadDependencies == "ask" | ダウンロード/常に/しないの選択 |
| 自動 | サブプロジェクト読み込み確認 | manyProjectsAction == "ask" && numLoaded > threshold | 読み込み/スキップの選択 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| d.aggressiveUpdate == true | DCD更新時は確認なしに自動更新 |
| forceDownloadDependencies == "always" / "never" | 依存関係ダウンロード時は確認なし |
| manyProjectsAction != "ask" | サブプロジェクト読み込み時は確認なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[サーバー処理でユーザー確認が必要] --> B[rpc.window.requestMessage呼び出し]
    B --> C[window/showMessageRequestリクエスト送信]
    C --> D[クライアント: ダイアログ表示]
    D --> E{ユーザーの選択}
    E -->|アクション選択| F[MessageActionItem返却]
    E -->|ダイアログ閉じる| G[null返却]
    F --> H[サーバー: 選択に基づく処理分岐]
    G --> H
```

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

### 参照テーブル一覧

該当なし。

### 更新テーブル一覧

該当なし。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ダイアログ閉じ | ユーザーがアクションを選択せずに閉じた | title == nullのMessageActionItemが返る。呼び出し元で適切に処理 |
| RPC通信エラー | クライアントとの通信が切断 | 例外がスローされる |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（ただしユーザー操作をブロックするため乱用注意） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし。

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

ユーザーの明示的な操作（ボタンクリック）を必要とするため、意図しない処理が実行されるリスクは低い。メッセージ内容は翻訳リソースから取得されるため、外部入力によるインジェクションのリスクはない。

## 備考

- WindowFunctions構造体（jsonrpc.d L939）でrequestMessageメソッドとして実装
- 2つのオーバーロードがある：MessageActionItem[]版とstring[]版
- string[]版はMessageActionItem[]に変換後、内部でMessageActionItem[]版を呼び出す
- 応答がnullまたは空の場合、title == nullのMessageActionItemが返される
- resultJsonのデシリアライズにはdeserializeJson!MessageActionItemが使用される

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protocol.d | `protocol/source/served/lsp/protocol.d` | ShowMessageRequestParams、MessageActionItem、MessageTypeの定義 |

**読解のコツ**: MessageTypeはenum（1:Error, 2:Warning, 3:Info, 4:Log）。MessageActionItemはtitleフィールドのみを持つ。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | jsonrpc.d | `lsp/source/served/lsp/jsonrpc.d` | WindowFunctions.requestMessage（L955-972） |

**主要処理フロー**:
1. **L955**: コメント「Runs window/showMessageRequest which typically shows a message box...」
2. **L956**: `MessageActionItem requestMessage(MessageType type, string message, MessageActionItem[] actions)` シグネチャ
3. **L958**: `rpc.sendRequest("window/showMessageRequest", ShowMessageRequestParams(type, message, actions.opt))` リクエスト送信
4. **L960-961**: 応答がnull/空の場合にtitle == nullのMessageActionItemを返す
5. **L962**: 正常応答をdeserializeしてMessageActionItemとして返す
6. **L966-971**: string[]オーバーロード（MessageActionItem[]に変換して呼び出し）

#### Step 3: 呼び出し元を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | extension.d | `source/served/extension.d` | doGlobalStartup（L454: DCD更新確認） |
| 3-2 | extension.d | `source/served/extension.d` | delayedProjectActivation（L758, L825: サブプロジェクト・DUB依存関係確認） |

**主要処理フロー**:
- **L454**: `rpc.window.requestMessage(MessageType.error, outdatedMessage, actions)` DCD更新確認
- **L758-761**: `rpc.window.requestMessage(MessageType.warning, ..., [loadButton, skipButton])` サブプロジェクト確認
- **L825-829**: `rpc.window.requestMessage(MessageType.info, ..., [upgrade, always, never])` DUB依存関係確認

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

```
[サーバー処理]
    |
    +-- doGlobalStartup() [extension.d]
    |     |
    |     +-- rpc.window.requestMessage() [DCD更新確認]
    |
    +-- delayedProjectActivation() [extension.d]
          |
          +-- rpc.window.requestMessage() [サブプロジェクト確認]
          +-- rpc.window.requestMessage() [DUB依存関係確認]
                |
                +-- WindowFunctions.requestMessage() [jsonrpc.d L956]
                      |
                      +-- rpc.sendRequest("window/showMessageRequest", ...)
                            |
                            +-- [クライアント] ダイアログ表示・ユーザー応答
```

### データフロー図

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

サーバー処理での            requestMessage()            ダイアログ表示
確認要求             -----> sendRequest()          --> ユーザー選択
(type, message,             応答待ち                    MessageActionItem
 actions)                   デシリアライズ              (選択結果)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| jsonrpc.d | `lsp/source/served/lsp/jsonrpc.d` | ソース | WindowFunctions.requestMessage（L955-972）、sendRequest |
| extension.d | `source/served/extension.d` | ソース | DCD更新確認（L454）、サブプロジェクト確認（L758）、DUB依存関係確認（L825） |
| protocol.d | `protocol/source/served/lsp/protocol.d` | ソース | ShowMessageRequestParams、MessageActionItem型定義 |
| translate.d | `source/served/utils/translate.d` | ソース | メッセージの翻訳リソース |
| dcd_update.d | `source/served/commands/dcd_update.d` | ソース | DCD更新処理（requestMessageの結果に基づく） |
