# 通知設計書 14-coded/updateSetting

## 概要

本ドキュメントは、カスタム通知 `coded/updateSetting` の設計仕様を定義する。この通知はサーバー（serve-d）からクライアント（エディタ）に送信され、クライアント側の設定値を更新するよう要求する。

### 本通知の処理概要

`coded/updateSetting` 通知は、serve-dサーバーがクライアント側の設定を変更する必要がある場合に送信する通知である。`UpdateSettingParams` 構造体により、変更対象の設定セクション、新しい値、およびグローバル設定かどうかを指定する。

**業務上の目的・背景**：サーバー側でDCDの自動インストールやダウンロードが行われた場合、DCDの実行ファイルパスが変更される。この新しいパスをクライアント側の設定に反映させるため、サーバーからクライアントへ設定更新を要求する必要がある。また、ユーザーが依存パッケージのダウンロード設定を変更した場合にも使用される。

**通知の送信タイミング**：(1) DCD更新処理（updateDCD）完了後にdcdClientPath/dcdServerPathの設定を更新する際、(2) 依存パッケージの自動ダウンロード設定（forceDownloadDependencies）をユーザーが「always」または「never」に変更した際に送信される。

**通知の受信者**：LSPクライアント（エディタ拡張機能）が受信する。クライアントは受信した設定変更をユーザー設定またはワークスペース設定に反映する。

**通知内容の概要**：`UpdateSettingParams` 構造体が送信され、(1) 設定セクション名（section）、(2) 新しい値（value）、(3) グローバル設定フラグ（global）が含まれる。

**期待されるアクション**：クライアントは指定された設定セクションの値を更新する。グローバルフラグがtrueの場合はユーザー設定（全ワークスペース共通）に、falseの場合はワークスペース固有設定に反映する。

## 通知種別

LSPカスタム通知（JSON-RPC notification）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（処理完了後に送信） |
| 優先度 | 中 |
| リトライ | 無し |

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

サーバーからクライアントへの一方向通知。LSP接続で確立されたクライアントプロセスに固定。

## 通知テンプレート

### JSON-RPC通知メッセージ

| 項目 | 内容 |
|-----|------|
| メソッド名 | `coded/updateSetting` |
| パラメータ型 | `UpdateSettingParams` |
| レスポンス | なし（通知） |

### メッセージ構造

```json
{
  "jsonrpc": "2.0",
  "method": "coded/updateSetting",
  "params": {
    "section": "dcdClientPath",
    "value": "/home/user/.local/share/code-d/bin/dcd-client",
    "global": true
  }
}
```

### 本文テンプレート

送信される設定更新パターン：

| section | value例 | global | 送信元 |
|---------|---------|--------|--------|
| `dcdClientPath` | DCDクライアント実行ファイルパス | true | dcd_update.d |
| `dcdServerPath` | DCDサーバー実行ファイルパス | true | dcd_update.d |
| `forceDownloadDependencies` | `"always"` / `"never"` | true | extension.d |

### 添付ファイル

該当なし。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| section | 設定セクション名 | 送信元コードで固定値指定 | Yes |
| value | 設定値（JsonValue型） | 処理結果に応じた動的値 | Yes |
| global | グローバル設定フラグ | 送信元コードで固定値指定 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 内部処理 | DCD更新完了 | updateDCD処理の最終段階 | dcdClientPath/dcdServerPathを更新（dcd_update.d L270-273） |
| 画面操作 | 依存パッケージダウンロード設定変更 | ユーザーが「always」/「never」を選択 | forceDownloadDependenciesを更新（extension.d L832-839） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | トリガー条件を満たした場合は常に送信される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[トリガー発生] --> B{送信元}
    B -->|DCD更新| C[updateDCD完了]
    B -->|依存DL設定| D[ユーザー選択]
    C --> E[coded/updateSetting送信: dcdClientPath]
    C --> F[coded/updateSetting送信: dcdServerPath]
    D -->|always| G[coded/updateSetting送信: forceDownloadDependencies = always]
    D -->|never| H[coded/updateSetting送信: forceDownloadDependencies = never]
    E --> I[終了]
    F --> I
    G --> I
    H --> I
```

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

### 参照テーブル一覧

該当なし（データベースを使用しない）。

### 更新テーブル一覧

該当なし（データベースを使用しない）。クライアント側の設定ストアが更新される。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| クライアント未対応 | クライアントがcoded/updateSettingをハンドリングしない | 通知は無視される。ユーザーが手動で設定変更する必要がある |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし。

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

- ファイルパス情報が含まれる場合がある（DCDの実行ファイルパス）
- 設定値の変更はクライアント側で検証されることが前提

## 備考

- DCD更新時は成否に関わらず常にdcdClientPath/dcdServerPathの設定更新が送信される（dcd_update.d L264-268でデフォルト値にフォールバック）
- `UpdateSettingParams` 構造体は `served/lsp/protoext.d` で定義されている

---

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

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

### 推奨読解順序

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

通知パラメータの構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | protoext.d | `source/served/lsp/protoext.d` | `UpdateSettingParams` 構造体（L42-50）の定義 |

**読解のコツ**: `section` は設定セクション名（d.dcdClientPathの「dcdClientPath」部分）、`value` はJsonValue型で任意の型を格納可能、`global` はユーザー設定かワークスペース設定かを判別する。

#### Step 2: DCD更新時の送信を理解する

DCD更新処理での設定更新送信を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | dcd_update.d | `source/served/commands/dcd_update.d` | updateDCD関数のL270-273での設定更新送信 |

**主要処理フロー**:
1. **L270-271**: `dcdClientPath` の設定更新を送信（global=true）
2. **L272-273**: `dcdServerPath` の設定更新を送信（global=true）

#### Step 3: 依存パッケージ設定変更時の送信を理解する

extension.dでのforceDownloadDependencies設定更新を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | extension.d | `source/served/extension.d` | delayedProjectActivation内のL832-839でのcoded/updateSetting送信 |

**主要処理フロー**:
- **L830-833**: ユーザーが「always」を選択した場合、`forceDownloadDependencies` を `"always"` で更新送信
- **L836-839**: ユーザーが「never」を選択した場合、`forceDownloadDependencies` を `"never"` で更新送信

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

```
[DCD更新フロー]
updateDCD (dcd_update.d:83)
    |
    +-- rpc.notifyMethod("coded/updateSetting",
    |       UpdateSettingParams("dcdClientPath", ..., true)) (L270-271)
    |
    +-- rpc.notifyMethod("coded/updateSetting",
            UpdateSettingParams("dcdServerPath", ..., true)) (L272-273)

[依存パッケージ設定フロー]
delayedProjectActivation (extension.d:727)
    |
    +-- [ユーザーが "always" 選択]
    |       +-- rpc.notifyMethod("coded/updateSetting",
    |               UpdateSettingParams("forceDownloadDependencies", "always", true)) (L832-833)
    |
    +-- [ユーザーが "never" 選択]
            +-- rpc.notifyMethod("coded/updateSetting",
                    UpdateSettingParams("forceDownloadDependencies", "never", true)) (L838-839)
```

### データフロー図

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

DCD更新完了            updateDCD()                    coded/updateSetting
                  --> (dcd_update.d:270-273) -------> section: "dcdClientPath"
                                                      section: "dcdServerPath"

ユーザー選択           delayedProjectActivation()     coded/updateSetting
(always/never)    --> (extension.d:832-839) --------> section: "forceDownloadDependencies"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| protoext.d | `source/served/lsp/protoext.d` | ソース | UpdateSettingParams構造体の定義 |
| dcd_update.d | `source/served/commands/dcd_update.d` | ソース | DCD更新時のdcdClientPath/dcdServerPath設定送信 |
| extension.d | `source/served/extension.d` | ソース | forceDownloadDependencies設定送信 |
