# 通知設計書 20-CONFIG_MODIFY_FAIL

## 概要

本ドキュメントは、Lua Language Serverにおける「設定変更失敗」通知（CONFIG_MODIFY_FAIL）の設計仕様を定義する。この通知は、ワークスペースモードで設定変更を試みたが、何らかの理由で変更を完了できなかった場合にユーザーに警告するメッセージである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、ユーザーの操作（コードアクション等）に応じて設定ファイルを自動的に変更する機能を持つ。ワークスペースモードでは、.luarc.json、指定された設定ファイル、またはクライアント設定への変更を試みる。しかし、すべての変更方法が失敗した場合（ファイルへの書き込み権限がない、クライアントが設定変更をサポートしていない等）、ユーザーに通知して手動での設定変更方法を案内する必要がある。

**通知の送信タイミング**：設定変更処理（`client.lua`の`setConfig`関数）で、ワークスペースモード（#ws.folders > 0）において、すべての設定変更方法を試みた後、まだ変更が残っている場合に送信される。

**通知の受信者**：LSPクライアント（VSCode等のエディタ）を通じてユーザーに表示される。警告メッセージとしてエディタのUI上にポップアップ表示される。

**通知内容の概要**：「設定の変更に失敗しました。以下の設定を手動で変更してください：{manualConfigMessage}」というメッセージが表示され、手動で変更すべき設定内容が併せて表示される。

**期待されるアクション**：ユーザーは表示された設定内容を確認し、手動でユーザー設定またはワークスペース設定に追加することが期待される。

## 通知種別

アプリ内通知（LSP Window Message - Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | なし |

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

LSPプロトコルに従い、接続中のLSPクライアントに対してwindow/showMessage通知を送信する。受信者の決定は不要（接続中のクライアントすべてに送信）。

## 通知テンプレート

### メッセージ通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessage |
| メッセージタイプ | Warning（警告） |

### 本文テンプレート

```
設定の変更に失敗しました。

以下の設定を手動で変更してください：
{manualConfigMessage}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| manualConfigMessage | 手動で変更すべき設定内容 | buildMaunuallyMessage関数 | Yes |
| lang.script.CONFIG_MODIFY_FAIL | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定変更 | setConfig呼び出し | #ws.folders > 0 かつ全変更方法失敗後 #finalChanges > 0 | ワークスペースモードで設定変更残り |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| #ws.folders == 0 | 単一ファイルモード（CONFIG_MODIFY_FAIL_NO_WORKSPACEを使用） |
| #finalChanges == 0 | 設定変更がすべて完了した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[setConfig呼び出し] --> B[設定変更試行]
    B --> C[tryModifyClientGlobal]
    C --> D{#ws.folders > 0?}
    D -->|No| E[CONFIG_MODIFY_FAIL_NO_WORKSPACEへ]
    D -->|Yes| F[各ワークスペースをループ]
    F --> G[tryModifySpecifiedConfig]
    G --> H[tryModifyRC - 既存ファイル]
    H --> I[tryModifyClient]
    I --> J[tryModifyRC - 新規作成]
    J --> K{#finalChanges > 0?}
    K -->|No| L[処理完了]
    K -->|Yes| M[m.showMessage - Warning]
    M --> N[CONFIG_MODIFY_FAIL通知]
    N --> O[手動設定案内]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ws.folders | ワークスペースフォルダ一覧 | ループ処理 |
| config | 現在の設定値 | 変更前の値取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 失敗時は更新なし（部分的に成功している場合あり） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル書き込み失敗 | 権限なし等 | 次の方法を試行、最終的に警告表示 |
| クライアント非対応 | 設定変更機能なし | 次の方法を試行、最終的に警告表示 |
| すべて失敗 | 上記すべて | 警告表示、手動設定案内 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（フォールバック方式） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（設定変更操作時）

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

- 設定変更内容がメッセージに含まれるが、ローカル表示のみ
- 手動設定案内により、ユーザーが意図しない設定を行うリスクを軽減

## 備考

- tryModifySpecifiedConfig → tryModifyRC(既存) → tryModifyClient → tryModifyRC(新規) の順で試行
- 各ワークスペースで個別に試行される
- log.warnでログにも出力される
- buildMaunuallyMessage関数でWINDOW_MANUAL_CONFIG_ADD/SET/PROPメッセージを使用

---

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

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

### 推奨読解順序

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

設定変更の基本構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | client.lua | `script/client.lua` | config.change型の構造（行202-208） |

**読解のコツ**: config.changeのkey、action、value、prop、uri、globalフィールドを把握する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | client.lua | `script/client.lua` | setConfig関数（行522-572） |

**主要処理フロー**:
1. **行522**: `function m.setConfig(changes, onlyMemory)` - 関数定義
2. **行551**: `tryModifyClientGlobal(finalChanges)` - グローバル設定変更試行
3. **行559-565**: 各ワークスペースでの変更試行ループ
4. **行560**: `tryModifySpecifiedConfig(scp.uri, finalChanges)` - 指定設定ファイル
5. **行561**: `tryModifyRC(scp.uri, finalChanges, false)` - .luarc.json（既存）
6. **行562**: `tryModifyClient(scp.uri, finalChanges)` - クライアント設定
7. **行563**: `tryModifyRC(scp.uri, finalChanges, true)` - .luarc.json（新規作成）
8. **行565-568**: finalChanges残りがある場合の警告
9. **行566**: `m.showMessage('Warning', lang.script('CONFIG_MODIFY_FAIL', buildMaunuallyMessage(finalChanges)))` - 通知送信

#### Step 3: 各変更方法を理解する

tryModify*関数の実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | tryModifySpecifiedConfig（行375-405）、tryModifyRC（行407-445）、tryModifyClient（行447-474） |

#### Step 4: 言語リソースを理解する

通知メッセージの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | script.lua | `locale/ja-jp/script.lua` | CONFIG_MODIFY_FAIL定義（行635-641） |

**主要処理フロー**:
- **行635-641**: 複数行のメッセージテンプレート

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

```
client.lua
    │
    └─ m.setConfig(changes, onlyMemory)
           │
           ├─ config.add/set/propで適用
           │
           ├─ tryModifyClientGlobal(finalChanges)
           │      └─ globalフラグのある変更をクライアントへ
           │
           └─ for _, scp in ipairs(ws.folders) do
                  │
                  ├─ tryModifySpecifiedConfig(scp.uri, finalChanges)
                  │      └─ 指定された設定ファイル(CONFIGPATH)を編集
                  │
                  ├─ tryModifyRC(scp.uri, finalChanges, false)
                  │      └─ 既存の.luarc.jsonを編集
                  │
                  ├─ tryModifyClient(scp.uri, finalChanges)
                  │      └─ クライアントの$/commandでlua.config送信
                  │
                  └─ tryModifyRC(scp.uri, finalChanges, true)
                         └─ .luarc.jsonを新規作成して編集

           └─ #finalChanges > 0 の場合
                  │
                  ├─ buildMaunuallyMessage(finalChanges)
                  │
                  ├─ m.showMessage('Warning', ...)
                  │
                  └─ log.warn('Config modify fail', ...)
```

### データフロー図

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

設定変更リスト ───▶ setConfig()
                         │
                         ▼
                  各ワークスペースでループ
                         │
        ┌────────────────┼────────────────┐
        │                │                │
        ▼                ▼                ▼
   Specified        .luarc.json       Client
   Config           (既存/新規)        設定
        │                │                │
        └────────────────┼────────────────┘
                         │
                         ▼ (変更残りあり)
                  buildMaunuallyMessage(finalChanges)
                         │
                         ▼
                  lang.script('CONFIG_MODIFY_FAIL', ...)
                         │
                         ▼
                  m.showMessage() ───▶ window/showMessage通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| client.lua | `script/client.lua` | ソース | 設定変更処理・setConfig関数 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理 |
| config.lua | `script/config.lua` | ソース | 設定管理 |
| json-edit.lua | `script/json-edit.lua` | ソース | JSON編集機能 |
| utility.lua | `script/utility.lua` | ソース | ファイル読み書き |
