# 通知設計書 11-clojure/serverInfo/log

## 概要

本ドキュメントは、clojure-lspにおける`clojure/serverInfo/log`通知の設計仕様を記載したものです。この通知はクライアントからサーバーへ送信される通知であり、サーバー情報をログとして出力することを要求します。

### 本通知の処理概要

`clojure/serverInfo/log`通知は、clojure-lspサーバーの現在の状態や設定情報をデバッグ目的でログ出力するための機能です。開発者やユーザーがLSPサーバーの内部状態を把握し、問題のトラブルシューティングを行うために使用されます。

**業務上の目的・背景**：この通知はclojure-lsp独自の拡張機能であり、LSPサーバーの動作状況を診断する必要がある場合に使用されます。プロジェクトのセットアップ問題、クラスパスの設定問題、またはサーバー設定の不整合などを特定する際に、サーバー内部の詳細情報へのアクセスが必要となります。

**通知の送信タイミング**：クライアント（エディタ）からユーザーの明示的なアクション（コマンド実行など）によって送信されます。通常、デバッグメニューやコマンドパレットから「Server Info Log」などのコマンドを実行した際にトリガーされます。

**通知の受信者**：clojure-lspサーバーがこの通知を受信します。サーバーは受信後、収集したサーバー情報を`window/showMessage`通知を使用してクライアントに返送します。

**通知内容の概要**：通知自体にはパラメータは含まれません。サーバーはこの通知を受信すると、プロジェクトルートURI、サーバーバージョン、clj-kondoバージョン、ログパス、各種設定（プロジェクト設定、クラスパス設定、クライアント設定）、最終設定、クラスパス、cljfmt設定、分析サマリー、nREPLポートなどの情報を収集します。

**期待されるアクション**：ユーザーは表示されたサーバー情報を確認し、問題の診断やサポートへの情報提供に利用することが期待されます。

## 通知種別

LSP通知（クライアント→サーバー）+ ユーザーへのメッセージ表示（サーバー→クライアント）

## 送信仕様

### 基本情報

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

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

クライアントからサーバーへの一方向通知のため、送信先はclojure-lspサーバーに固定されます。サーバーからの応答は`window/showMessage`通知を通じてクライアントへ返送されます。

## 通知テンプレート

### LSP通知の場合

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

### 本文テンプレート

サーバー情報はpretty-print形式でフォーマットされ、`window/showMessage`経由で表示されます。

```clojure
{:project-root-uri "file:///path/to/project"
 :server-version "2024.01.01-00.00.00"
 :clj-kondo-version "2024.01.01"
 :log-path "/tmp/clojure-lsp.xxxxx.out"
 :project-settings {...}
 :classpath-settings {...}
 :client-settings {...}
 :final-settings {...}
 :classpath [...]
 :cljfmt-raw "..."
 :analysis-summary {...}
 :port "NREPL only available on :debug profile"}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| project-root-uri | プロジェクトルートのURI | db :project-root-uri | Yes |
| server-version | サーバーバージョン | shared/clojure-lsp-version | Yes |
| clj-kondo-version | clj-kondoバージョン | lsp.kondo/clj-kondo-version | Yes |
| log-path | ログファイルパス | db :log-path | Yes |
| project-settings | プロジェクト設定 | db :project-settings | No |
| classpath-settings | クラスパス設定 | db :classpath-settings | No |
| client-settings | クライアント設定 | db :client-settings | No |
| final-settings | 最終マージ設定 | settings/all db | Yes |
| classpath | クラスパス一覧 | db :classpath | No |
| cljfmt-raw | cljfmtの生設定 | f.format/resolve-user-cljfmt-config | No |
| analysis-summary | 分析サマリー | q/analysis-summary | Yes |
| port | nREPLポート | db :port | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザーコマンド | clojure/serverInfo/logコマンド実行 | なし | ユーザーがエディタからコマンドを実行 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[クライアントからclojure/serverInfo/log通知受信] --> B[future内で処理開始]
    B --> C[handler/server-info-log呼び出し]
    C --> D[f.development-info/server-info-log呼び出し]
    D --> E[サーバー情報収集]
    E --> F[pprint形式でフォーマット]
    F --> G[producer/show-message呼び出し]
    G --> H[window/showMessage通知をクライアントへ送信]
    H --> I[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| db（アトム） | サーバー状態全般の参照 | インメモリ状態管理 |

### テーブル別参照項目詳細

#### db（アトム）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| :project-root-uri | プロジェクトルート表示 | 直接参照 |
| :log-path | ログファイルパス表示 | 直接参照 |
| :project-settings | プロジェクト設定表示 | 直接参照 |
| :classpath-settings | クラスパス設定表示 | 直接参照 |
| :client-settings | クライアント設定表示 | 直接参照 |
| :classpath | クラスパス一覧表示 | 直接参照 |
| :port | nREPLポート表示 | 直接参照 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 例外発生 | サーバー情報収集中にエラー | logger/errorでログ出力後、例外を再スロー |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

サーバー情報にはファイルパスやプロジェクト設定が含まれる可能性があるため、ログの共有時には機密情報の有無を確認することが推奨されます。

## 備考

- この機能はclojure-lsp独自の拡張であり、標準LSP仕様には含まれません
- デバッグプロファイル（`bb debug-cli`）でのみnREPLポートが利用可能です

---

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

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

### 推奨読解順序

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

サーバー情報として収集されるデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | server-info関数（14-28行目）でサーバー情報のマップ構造を確認 |

**読解のコツ**: Clojureのマップリテラル`{:key value}`形式で返却される構造を確認します。

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

通知受信からハンドラー呼び出しまでの流れを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | server.clj | `cli/src/clojure_lsp/server.clj` | receive-notification "clojure/serverInfo/log"（216-222行目）でエントリーポイントを確認 |

**主要処理フロー**:
1. **216行目**: defmethod jsonrpc.server/receive-notificationでメソッド定義
2. **217行目**: future内で非同期処理開始
3. **219行目**: handler/server-info-log呼び出し

#### Step 3: ハンドラー層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | handlers.clj | `lib/src/clojure_lsp/handlers.clj` | server-info-log関数（347-350行目）でハンドラー実装を確認 |

**主要処理フロー**:
- **348行目**: shared/logging-taskでタスクロギング
- **350行目**: f.development-info/server-info-log呼び出し

#### Step 4: 機能実装層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | server-info-log関数（30-36行目）で実際のメッセージ送信を確認 |

**主要処理フロー**:
- **30行目**: server-info-log関数定義
- **31-34行目**: producer/show-message呼び出しでpprint形式のサーバー情報を送信
- **36行目**: {:no-op? true}を返却

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

```
jsonrpc.server/receive-notification "clojure/serverInfo/log"
    │
    └─ handler/server-info-log
           │
           └─ f.development-info/server-info-log
                  │
                  ├─ server-info (内部関数)
                  │      │
                  │      ├─ shared/clojure-lsp-version
                  │      ├─ lsp.kondo/clj-kondo-version
                  │      ├─ settings/all
                  │      ├─ f.format/resolve-user-cljfmt-config
                  │      └─ q/analysis-summary
                  │
                  └─ producer/show-message
                         │
                         └─ jsonrpc.server/send-notification "window/showMessage"
```

### データフロー図

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

通知受信               サーバー情報収集                 メッセージ表示
(パラメータなし) ───▶ db参照・各種情報取得 ───▶ window/showMessage通知
                          │
                          ├─ project-root-uri
                          ├─ server-version
                          ├─ clj-kondo-version
                          ├─ log-path
                          ├─ settings (3種)
                          ├─ classpath
                          ├─ cljfmt-raw
                          ├─ analysis-summary
                          └─ port
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| server.clj | `cli/src/clojure_lsp/server.clj` | ソース | LSP通知のエントリーポイント |
| handlers.clj | `lib/src/clojure_lsp/handlers.clj` | ソース | ハンドラー関数の定義 |
| development_info.clj | `lib/src/clojure_lsp/feature/development_info.clj` | ソース | サーバー情報収集・表示の実装 |
| producer.clj | `lib/src/clojure_lsp/producer.clj` | ソース | IProducerプロトコル定義 |
| shared.clj | `lib/src/clojure_lsp/shared.clj` | ソース | バージョン取得等のユーティリティ |
