# 通知設計書 4-textDocument/didClose

## 概要

本ドキュメントは、LSP(Language Server Protocol)におけるtextDocument/didClose通知の設計仕様を記載する。クライアントからサーバーへ送信される通知であり、テキストドキュメントが閉じられたことをサーバーに通知する。

### 本通知の処理概要

textDocument/didClose通知は、エディタ上でClojure/ClojureScriptファイルが閉じられた際に、クライアントからclojure-lspサーバーへ送信される通知である。この通知により、サーバーはドキュメントの同期状態を終了し、必要に応じてリソースをクリーンアップする。

**業務上の目的・背景**：ファイルが閉じられた際、サーバーはそのドキュメントの「ライブ」状態の追跡を終了する必要がある。外部ファイル（プロジェクト外のファイル）の場合は診断情報をクリアし、ディスク上に存在しないファイル（一時ファイルや削除されたファイル）の場合は解析データを完全に削除する。これにより、メモリの効率的な使用と不要な診断情報の除去を実現する。

**通知の送信タイミング**：ユーザーがエディタでファイルを閉じた直後に、エディタ(LSPクライアント)がこの通知を送信する。タブを閉じる、ウィンドウを閉じる、プロジェクトを閉じるなどのアクションがトリガーとなる。

**通知の受信者**：clojure-lspサーバープロセスがこの通知を受信する。

**通知内容の概要**：通知には、閉じられたドキュメントのURIが含まれる。

**期待されるアクション**：サーバーは受信後、ドキュメントの状態に応じた処理を行う。外部ファイルの場合は空の診断情報を公開してクライアントの診断表示をクリアする。ディスク上に存在しないファイルの場合は、解析データ、ドキュメント情報、診断情報をDBから削除し、関連ファイルへの参照通知を実行する。

## 通知種別

LSP通知 (クライアント → サーバー)

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即座に処理） |
| 優先度 | 中（リソースクリーンアップ） |
| リトライ | なし（通知のため応答なし） |

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

クライアントからサーバーへの一方向通知のため、送信先決定ロジックは不要。

## 通知テンプレート

### パラメータ構造

| 項目 | 内容 |
|-----|------|
| メソッド名 | textDocument/didClose |
| パラメータ型 | DidCloseTextDocumentParams |
| プロトコル | JSON-RPC 2.0 over stdio |

### パラメータ定義

```json
{
  "textDocument": {
    "uri": "file:///path/to/file.clj"
  }
}
```

### 添付ファイル

該当なし（LSP通知にファイル添付機能なし）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| textDocument.uri | ドキュメントのURI | クライアント（エディタ） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | タブを閉じる | ドキュメントがオープン中 | ユーザーがファイルタブを閉じた時 |
| 画面操作 | エディタを閉じる | ドキュメントがオープン中 | ユーザーがエディタウィンドウを閉じた時 |
| 画面操作 | プロジェクトを閉じる | ドキュメントがオープン中 | ユーザーがプロジェクトを閉じた時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ドキュメント未オープン | didOpenが送信されていない場合 |
| サーバー未接続 | LSPサーバーが起動していない/接続されていない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイルを閉じる] --> B[textDocument/didClose通知送信]
    B --> C[サーバーで受信]
    C --> D[URIを正規化]
    D --> E[handler/did-closeを呼び出し]
    E --> F{外部ファイルか?}
    F -->|Yes| G[空の診断情報を公開]
    F -->|No| H{ディスク上に存在するか?}
    H -->|Yes| I[終了]
    H -->|No| J[files-deleted処理]
    J --> K[DBからドキュメント削除]
    K --> L[空の診断情報を公開]
    L --> M[関連ファイルへ通知]
    G --> I
    M --> I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| db/settings | source-pathsの参照 | 外部ファイル判定 |
| db/analysis | 解析結果の参照 | 削除時の参照通知 |

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

#### db/settings

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| [:settings :source-paths] | 外部ファイル判定 | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| db/documents | DELETE | ドキュメント情報の削除 |
| db/analysis | DELETE | 解析結果の削除 |
| db/diagnostics | DELETE | 診断情報の削除 |
| db/dep-graph | UPDATE | 依存グラフの更新 |

#### 削除処理詳細（db-without-uri関数）

| 操作 | 項目（カラム名） | 備考 |
|-----|-----------------|------|
| DISSOC | [:documents uri] | ドキュメント情報削除 |
| DISSOC | [:analysis uri] | 解析結果削除 |
| DISSOC | [:diagnostics :clj-kondo uri] | 診断情報削除 |
| UPDATE | dep-graph | 依存グラフから削除 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| URI解決エラー | 無効なファイルパス | ログ出力して処理継続 |
| ファイル存在チェックエラー | ファイルシステムアクセス失敗 | 例外処理で対応 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（常時処理可能）

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

- ファイルパス(URI)はユーザーのローカルファイルシステム上のパスを含む
- ファイルの存在チェックのためにファイルシステムへのアクセスが発生する

## 備考

- LSP仕様: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_didClose
- この通知は応答を返さない(notification)
- didCloseとdidDeleteは異なる概念（didCloseはエディタ上での閉じる操作、didDeleteはファイルシステム上の削除）

---

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

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

### 推奨読解順序

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

まず、プログラム間で受け渡されるデータ構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | db.clj | `lib/src/clojure_lsp/db.clj` | :documents, :analysis, :diagnostics構造 |

**読解のコツ**: どのデータがクリーンアップ対象になるかを理解すること。

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

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | server.clj | `cli/src/clojure_lsp/server.clj` | receive-notification multimethod定義 |

**主要処理フロー**:
1. **268-269行目**: `textDocument/didClose`メソッドのdefmethod定義
2. **269行目**: `handler/did-close`への委譲、URI正規化処理

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | handlers.clj | `lib/src/clojure_lsp/handlers.clj` | did-close関数の定義 |

**主要処理フロー**:
- **246-249行目**: did-close関数本体
- **249行目**: f.file-management/did-closeへの委譲

#### Step 4: ファイル管理機能層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | file_management.clj | `lib/src/clojure_lsp/feature/file_management.clj` | did-close関数の実装 |
| 4-2 | file_management.clj | `lib/src/clojure_lsp/feature/file_management.clj` | files-deleted関数 |
| 4-3 | file_management.clj | `lib/src/clojure_lsp/feature/file_management.clj` | db-without-uri関数 |

**主要処理フロー**:
- **360-368行目**: did-close関数本体
- **363-364行目**: 外部ファイル判定
- **365-366行目**: 外部ファイルの場合、空の診断情報を公開
- **367-368行目**: ディスク上に存在しない場合、files-deleted呼び出し
- **319-323行目**: files-deleted関数
- **312-317行目**: db-without-uri関数

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

```
jsonrpc.server/receive-notification "textDocument/didClose"
    |
    +-- server.clj (268-269行目)
           |
           +-- handler/did-close (handlers.clj 246-249行目)
                  |
                  +-- f.file-management/did-close (file_management.clj 360-368行目)
                         |
                         +-- external-filename? 判定 (363-364行目)
                         |      |
                         |      +-- [外部] publish-empty-diagnostics! (366行目)
                         |
                         +-- file-exists? 判定 (367行目)
                                |
                                +-- [存在しない] files-deleted (368行目)
                                       |
                                       +-- db-without-uri (312-317行目)
                                       +-- publish-empty-diagnostics! (321行目)
                                       +-- notify-references (322-323行目)
```

### データフロー図

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

DidCloseTextDocumentParams
    |
    +-- uri --------+
                    |
                    +---> normalize-doc-uri
                    |            |
                    |            v
                    +---> external-filename? 判定
                    |            |
                    |            +---> [外部] publish-empty-diagnostics!
                    |            |            |
                    |            |            v
                    |            |     textDocument/publishDiagnostics (空)
                    |            |
                    |            +---> [内部] file-exists? 判定
                    |                         |
                    |                         +---> [存在しない] files-deleted
                    |                                      |
                    |                                      v
                    |                               db-without-uri
                    |                                      |
                    |                                      +-- dissoc [:documents uri]
                    |                                      +-- dissoc [:analysis uri]
                    |                                      +-- dissoc [:diagnostics :clj-kondo uri]
                    |                                      +-- dep-graph/remove-doc
                    |                                      |
                    |                                      v
                    |                               publish-empty-diagnostics!
                    |                                      |
                    |                                      v
                    |                               notify-references
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| server.clj | `cli/src/clojure_lsp/server.clj` | ソース | LSPサーバーのエントリーポイント、通知受信 |
| handlers.clj | `lib/src/clojure_lsp/handlers.clj` | ソース | 各種LSPメッセージのハンドラー |
| file_management.clj | `lib/src/clojure_lsp/feature/file_management.clj` | ソース | ファイル管理機能の実装 |
| shared.clj | `lib/src/clojure_lsp/shared.clj` | ソース | external-filename?、file-exists?関数 |
| diagnostics.clj | `lib/src/clojure_lsp/feature/diagnostics.clj` | ソース | 診断情報の公開 |
| dep_graph.clj | `lib/src/clojure_lsp/dep_graph.clj` | ソース | 依存グラフの管理 |
