# 通知設計書 6-MWS_UCONFIG_FAILED

## 概要

本ドキュメントは、Lua Language Server におけるユーザー設定保存失敗通知（MWS_UCONFIG_FAILED）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ユーザー設定ファイル（settings.json等）への書き込みに失敗した場合に表示されるエラーメッセージである。言語サーバーがクライアント経由で設定を変更しようとした際に、ファイルシステムエラーや権限エラーなどで保存できなかった場合に使用される。

**業務上の目的・背景**：Lua Language Server は、ユーザーの操作に応じて設定を自動的に更新する機能を持つ（例：ライブラリの追加、診断の無効化など）。この設定更新がファイルシステムレベルで失敗した場合、ユーザーに明示的に通知し、手動での設定変更を促す必要がある。

**通知の送信タイミング**：ユーザー設定の保存処理が失敗した時点で送信される。具体的には、client.setConfig でユーザー設定（グローバル設定）の書き込みに失敗した場合。

**通知の受信者**：エディタを使用している開発者（ユーザー）。Warning レベルのメッセージとして表示される。

**通知内容の概要**：「ユーザー設定の保存に失敗しました。」というシンプルなエラーメッセージが表示される。

**期待されるアクション**：ユーザーは手動で設定ファイルを編集するか、ファイルの権限やディスク空き容量を確認する。

## 通知種別

アプリ内通知（LSP window/showMessage）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無 |

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

LSP クライアントに対して直接送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Warning |
| ボタン | なし |

### 本文テンプレート

```
Saving user setting failed.
```

日本語:
```
ユーザー設定の保存に失敗しました。
```

中国語（簡体）:
```
用户配置保存失败。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージ | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ユーザー設定保存失敗 | ファイル書き込みエラー | 設定ファイルの保存に失敗した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 保存成功 | 設定が正常に保存された場合は送信しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定変更要求] --> B[ユーザー設定ファイル書き込み]
    B --> C{書き込み成功?}
    C -->|Yes| D[MWS_UCONFIG_UPDATED通知]
    C -->|No| E[MWS_UCONFIG_FAILED通知]
    D --> F[終了]
    E --> F
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない（インメモリ処理）。

### 更新テーブル一覧

なし（設定ファイルへの書き込みは失敗している状態）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル権限エラー | 書き込み権限なし | ユーザーに通知し、手動設定を促す |
| ディスク容量不足 | ディスクフル | ユーザーに通知 |
| ファイルロック | 他プロセスがファイルを使用中 | ユーザーに通知 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし |

### 配信時間帯

制限なし

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

- 固定メッセージのため機密情報は含まれない
- 詳細なエラー情報（ファイルパス等）は含まれない

## 備考

- MWS_UCONFIG_UPDATED（No.7）と対になる通知
- 詳細なエラー情報はログに記録される

---

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

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

### 推奨読解順序

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

メッセージ定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 199-200行目: MWS_UCONFIG_FAILED 定義 |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | 199-200行目: 日本語訳 |

**読解のコツ**: 固定メッセージで変数プレースホルダーなし。

#### Step 2: 設定保存処理を理解する

client.setConfig の実装を理解する。

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

**主要処理フロー**:
1. **524-541行**: 設定変更をfinalChangesに集約
2. **549-571行**: 各種保存方法を試行
3. **557行**: tryModifySpecifiedConfig
4. **567行**: 失敗時のエラーメッセージ表示

#### Step 3: 設定ファイル編集を理解する

JSON設定ファイルの編集処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | 337-359行目: editConfigJson 関数 |

**主要処理フロー**:
- **338-342行**: ファイル読み込みと失敗時のエラー表示
- **343-348行**: JSON パースとエラー処理

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

```
client.setConfig (client.lua:520)
    │
    ├─ config.add/set/prop (524-541行)
    │
    ├─ tryModifyClientGlobal (551行)
    │
    ├─ tryModifySpecifiedConfig (553, 561行)
    │      │
    │      └─ editConfigJson (337行)
    │             │
    │             ├─ util.loadFile (338行)
    │             │      └─ [失敗] → showMessage('Error', CONFIG_LOAD_FAILED)
    │             │
    │             └─ jsonc.decode_jsonc (343行)
    │                    └─ [失敗] → showMessage('Error', CONFIG_MODIFY_FAIL_SYNTAX_ERROR)
    │
    └─ [全て失敗] → showMessage('Warning', CONFIG_MODIFY_FAIL...)
```

### データフロー図

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

設定変更要求        ───▶  setConfig()              ───▶  成功通知 or 失敗通知
                         │
                         ├─ tryModifySpecifiedConfig
                         │      └─ editConfigJson
                         │             └─ [失敗] → エラー通知
                         │
                         └─ [全方法失敗]
                                └─ CONFIG_MODIFY_FAIL通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | メッセージ定義（199-200行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | setConfig, editConfigJson 実装 |
