# 通知設計書 14-window/showMessage

## 概要

本ドキュメントは、clojure-lspにおける`window/showMessage`通知の設計仕様を記載したものです。この通知はサーバーからクライアントへ送信される通知であり、ユーザーにメッセージを表示することを要求します。

### 本通知の処理概要

`window/showMessage`通知は、LSPサーバーからエディタへメッセージを送信し、ユーザーに情報、警告、エラーを表示するための標準LSP機能です。clojure-lspでは、サーバー情報の表示、カーソル情報の表示、エラー通知、処理状況の報告などに使用されます。

**業務上の目的・背景**：この通知はLSP標準仕様の一部であり、サーバーからユーザーへの直接的なコミュニケーション手段を提供します。clojure-lspでは、デバッグ情報の表示（serverInfo/log、cursorInfo/log）、プロジェクト設定の問題通知、マクロ解決時のユーザー確認などに活用されます。

**通知の送信タイミング**：以下のシナリオで送信されます：
- サーバー情報ログ要求時（clojure/serverInfo/log）
- カーソル情報ログ要求時（clojure/cursorInfo/log）
- プロジェクトルートURIが未指定の場合の警告
- マクロ解決やテスト作成などの機能で確認が必要な場合

**通知の受信者**：エディタ（クライアント）がこの通知を受信し、メッセージタイプに応じた方法でユーザーにメッセージを表示します（情報ダイアログ、警告ポップアップ、エラーメッセージなど）。

**通知内容の概要**：通知にはメッセージテキストとメッセージタイプ（Error=1、Warning=2、Info=3、Log=4）が含まれます。clojure-lspの拡張として、追加のコンテキスト情報を含む`extra`フィールドも使用されます。

**期待されるアクション**：ユーザーはメッセージの内容を確認します。情報メッセージの場合は特にアクションは必要ありませんが、警告やエラーの場合は設定の修正や問題の対処が期待されます。

## 通知種別

LSP通知（サーバー→クライアント）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中〜高（メッセージタイプによる） |
| リトライ | なし |

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

サーバーからクライアントへの一方向通知のため、送信先は接続されているエディタクライアントに固定されます。

## 通知テンプレート

### LSP通知の場合

| 項目 | 内容 |
|-----|------|
| メソッド名 | `window/showMessage` |
| パラメータ | ShowMessageParams |
| レスポンス | なし（通知のため） |

### 本文テンプレート

```json
{
  "type": 3,
  "message": "Server info:\n{:project-root-uri \"file:///path/to/project\"...}"
}
```

メッセージタイプの値：
- 1: Error
- 2: Warning
- 3: Info
- 4: Log

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| type | メッセージタイプ（1-4） | 呼び出し元指定 | Yes |
| message | メッセージ本文 | 呼び出し元指定 | Yes |
| extra | 追加コンテキスト情報 | 呼び出し元指定（clojure-lsp拡張） | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザーコマンド | clojure/serverInfo/log | 常に | サーバー情報をInfo表示 |
| ユーザーコマンド | clojure/cursorInfo/log | 常に | カーソル情報をInfo表示 |
| 初期化 | initialize完了 | project-root-uriが未指定 | 警告メッセージ表示 |
| 機能実行 | マクロ解決・テスト作成等 | 確認が必要な場合 | 確認/エラーメッセージ表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | この通知に特別な抑止条件はありません |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[トリガー発生] --> B[producer/show-message呼び出し]
    B --> C[ShowMessageParams構築]
    C --> D[conform-or-log検証]
    D -->|検証OK| E[send-notification実行]
    D -->|検証NG| F[ログ出力して終了]
    E --> G[クライアントへ通知送信]
    G --> H[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | この通知自体ではDB参照なし（呼び出し元で必要に応じて参照） |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | この通知では状態更新は行いません |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| conform失敗 | メッセージデータの形式不正 | ログ出力して処理スキップ |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし

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

メッセージにはサーバー設定やファイルパス情報が含まれる場合があります。serverInfo/logで表示される情報をサポート目的で共有する際は、機密情報の有無を確認することが推奨されます。

## 備考

- LSP標準仕様に準拠
- clojure-lspでは`extra`フィールドを拡張として使用（現在は主にnilで使用）
- window/showMessageRequestとは異なり、ユーザーの選択を待たない単方向通知

---

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

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

### 推奨読解順序

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

メッセージパラメータの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | server.clj | `cli/src/clojure_lsp/server.clj` | show-message実装（180-189行目）でパラメータ構造を確認 |

**読解のコツ**: `:message`、`:type`、`:extra`の3フィールドがあり、`:extra`はclojure-lsp独自の拡張です。

#### Step 2: プロトコル定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | producer.clj | `lib/src/clojure_lsp/producer.clj` | IProducerプロトコルのshow-message定義（12行目）を確認 |

**主要処理フロー**:
- **12行目**: `(show-message [this message type extra])`の3引数シグネチャ

#### Step 3: 実装層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | server.clj | `cli/src/clojure_lsp/server.clj` | ClojureLspProducerのshow-message実装（180-189行目）を確認 |

**主要処理フロー**:
- **180行目**: show-message関数定義
- **181-184行目**: message-contentマップ構築
- **185-188行目**: shared/logging-task内でconform-or-log検証とsend-notification実行

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | server-info-log（30-36行目）での使用例を確認 |
| 4-2 | development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | cursor-info-log（58-65行目）での使用例を確認 |
| 4-3 | handlers.clj | `lib/src/clojure_lsp/handlers.clj` | initialize（163-201行目）での警告メッセージ使用を確認 |

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

```
トリガー（serverInfo/log, cursorInfo/log, initialize等）
    │
    └─ producer/show-message
           │
           ├─ message-content構築
           │      │
           │      ├─ :message (メッセージ本文)
           │      ├─ :type (メッセージタイプ)
           │      └─ :extra (追加情報)
           │
           ├─ conform-or-log ::coercer/show-message
           │
           └─ jsonrpc.server/send-notification "window/showMessage"
```

### データフロー図

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

message (文字列)    ──▶ message-content構築 ──▶ conform検証
type (キーワード)         │                         │
extra (任意)              ▼                         ▼
                    {:message ...        send-notification
                     :type ...     ──▶   "window/showMessage"
                     :extra ...}              │
                                              ▼
                                      クライアントへ通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| server.clj | `cli/src/clojure_lsp/server.clj` | ソース | ClojureLspProducerでのshow-message実装 |
| producer.clj | `lib/src/clojure_lsp/producer.clj` | ソース | IProducerプロトコル定義 |
| development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | ソース | serverInfo/log, cursorInfo/logでの使用 |
| handlers.clj | `lib/src/clojure_lsp/handlers.clj` | ソース | initialize時の警告メッセージ使用 |
| resolve_macro.clj | `lib/src/clojure_lsp/feature/resolve_macro.clj` | ソース | マクロ解決時のメッセージ使用 |
| refactor/transform.clj | `lib/src/clojure_lsp/refactor/transform.clj` | ソース | リファクタリング時のメッセージ使用 |
