# 通知設計書 27-served/updateDependency

## 概要

本ドキュメントは、serve-d LSPサーバーにおけるカスタム通知「served/updateDependency」の設計仕様を定義する。本通知はクライアント(エディタ)からサーバーに送信され、DUBの既存依存パッケージのバージョンを更新する。

### 本通知の処理概要

本通知は、DUBプロジェクトの既存依存パッケージのバージョン指定を変更し、必要に応じてパッケージを再ダウンロードしてインポートパスを更新するものである。

**業務上の目的・背景**：プロジェクト開発の過程で、依存パッケージを新しいバージョンにアップグレードする必要がある。本通知によりエディタUI上から直接パッケージバージョンの更新が可能となり、レシピファイルの手動編集を不要にする。

**通知の送信タイミング**：ユーザーがエディタの依存関係管理UI（DUBツリービュー等）から「Update Dependency」を実行し、新しいバージョンを指定したときに送信される。

**通知の受信者**：serve-d LSPサーバープロセスが受信者である。

**通知内容の概要**：UpdateRequest（name, version）をパラメータとして受け取る。更新対象のパッケージ名と新しいバージョン文字列を含む。

**期待されるアクション**：サーバーはdub.json/dub.sdl内の該当パッケージのバージョン指定を書き換え、不足パッケージのダウンロードとインポートパスの更新を行う。

## 通知種別

LSPカスタム通知（JSON-RPC Notification）。クライアントからサーバーへの方向（C->S）。

## 送信仕様

### 基本情報

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

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

クライアントがserve-d LSPサーバーに直接送信する。処理はactiveInstanceに対して行われる。

## 通知テンプレート

### メール通知の場合

該当なし。

### 本文テンプレート

```json
{
  "jsonrpc": "2.0",
  "method": "served/updateDependency",
  "params": {
    "name": "vibe-d",
    "version": "0.9.6"
  }
}
```

### 添付ファイル

該当なし。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| name | 更新対象のパッケージ名 | ユーザー入力 | Yes |
| version | 新しいバージョン指定 | ユーザー入力 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ユーザーが「Update Dependency」コマンドを実行 | アクティブインスタンスがDUBプロジェクト | 依存パッケージのバージョン更新 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| アクティブインスタンスなし | activeInstanceが未設定の場合は処理不可 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[served/updateDependency通知受信] --> B[activeInstance取得]
    B --> C[reportProgress: importUpgrades 0/10]
    C --> D[changeDependency: バージョン書き換え]
    D --> E{書き換え成功?}
    E -->|Yes| F{DubComponentあり?}
    E -->|No| G[reportProgress: 10/10で終了]
    F -->|Yes| H[selectAndDownloadMissing]
    F -->|No| I[reportProgress: dubReload 7/10]
    H --> I
    I --> J[updateImports]
    J --> K[reportProgress: dubReload 10/10]
    K --> L[終了]
    G --> L
```

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

### 参照テーブル一覧

該当なし。

### 更新テーブル一覧

該当なし。ファイルシステム上のdub.json/dub.sdlが更新される。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| パッケージ未発見 | 指定パッケージがレシピファイルに存在しない | changeDependencyがfalseを返し、更新をスキップ |
| バージョン文字列解析失敗 | version属性の解析に失敗 | changeDependencyがfalseを返す |
| レシピファイル未発見 | dub.json/dub.sdlが存在しない | changeDependencyがfalseを返す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし。

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

- ファイルシステム上のレシピファイルが直接編集される
- DUBパッケージレジストリからパッケージがダウンロードされる可能性がある

## 備考

- changeDependency関数はSDL形式とJSON形式の両方に対応
- SDL形式ではversion属性の引用符内を書き換え
- JSON形式では正規表現を使用してバージョン値を置換
- TODOコメントにdub.selections.jsonの更新が未実装であることが記載されている（L591）
- 書き換えに失敗した場合（パッケージが見つからない等）はダウンロードもスキップされる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.d | `source/served/types.d` | UpdateRequest（name, version）の定義 |

**読解のコツ**: UpdateRequestはInstallRequestと同じ構造（name, version_）を持つ。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | dub.d | `source/served/commands/dub.d` | updateDependency関数（L588-604） |

**主要処理フロー**:
1. **L588**: `@protocolNotification("served/updateDependency")` アノテーション
2. **L589**: `void updateDependency(UpdateRequest req)` シグネチャ
3. **L593**: activeInstance取得
4. **L596**: changeDependency呼び出し
5. **L598-599**: 成功時にselectAndDownloadMissing
6. **L601**: updateImports呼び出し

#### Step 3: バージョン書き換え処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | dub.d | `source/served/commands/dub.d` | changeDependency関数（L727-776） |

**主要処理フロー**:
- **L729-760**: SDL形式での書き換え（dependency行のversion属性を検索して置換）
- **L761-776**: JSON形式での書き換え（正規表現で置換）

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

```
[クライアント] served/updateDependency通知
    |
    +-- RPCProcessor
          |
          +-- updateDependency() [dub.d L589]
                |
                +-- changeDependency() [L727]
                |     |
                |     +-- dub.sdlバージョン書き換え / dub.jsonバージョン書き換え
                |
                +-- DubComponent.selectAndDownloadMissing()
                |
                +-- updateImports() [L212]
```

### データフロー図

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

UpdateRequest             updateDependency()               レシピファイル更新
(name, version) -------> changeDependency()             --> パッケージダウンロード
                         selectAndDownloadMissing()      --> インポートパス更新
                         updateImports()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| dub.d | `source/served/commands/dub.d` | ソース | updateDependency通知ハンドラ（L588-604）、changeDependency（L727-776） |
| types.d | `source/served/types.d` | ソース | UpdateRequestの型定義 |
| progress.d | `source/served/utils/progress.d` | ソース | reportProgress関数 |
| extension.d | `source/served/extension.d` | ソース | モジュール登録 |
