# 通知設計書 7-MWS_UCONFIG_UPDATED

## 概要

本ドキュメントは、Lua Language Server におけるユーザー設定更新完了通知（MWS_UCONFIG_UPDATED）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ユーザー設定（グローバル設定）の更新が正常に完了したことをユーザーに通知するメッセージである。言語サーバーがクライアント経由で設定を変更し、ファイルへの保存が成功した場合に表示される。

**業務上の目的・背景**：Lua Language Server は、診断の無効化、ライブラリの追加、グローバル変数の定義など、ユーザーの操作に応じて設定を自動的に更新する機能を持つ。設定更新が成功した場合、ユーザーにフィードバックを提供し、変更が適用されたことを確認できるようにする。

**通知の送信タイミング**：ユーザー設定の保存処理が成功した時点で送信される。

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

**通知内容の概要**：「ユーザー設定が更新されました。」というシンプルな確認メッセージが表示される。

**期待されるアクション**：特別なアクションは不要。ユーザーは設定が正常に更新されたことを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
User setting updated.
```

日本語:
```
ユーザー設定が更新されました。
```

中国語（簡体）:
```
用户配置已更新。
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ユーザー設定保存成功 | ファイル書き込み成功 | 設定ファイルの保存が正常に完了した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 保存失敗 | 設定の保存に失敗した場合は MWS_UCONFIG_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_FAILED（No.6）と対になる通知
- MWS_WCONFIG_UPDATED（No.8）はワークスペース設定用

---

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

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

### 推奨読解順序

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

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

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

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

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

setConfig成功時の処理を理解する。

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

**主要処理フロー**:
1. **549行**: xpcallで保存処理を試行
2. **553-564行**: 各保存方法を順次試行
3. **成功時**: finalChanges から適用済み変更が削除される

#### Step 3: 設定変更の流れを理解する

どのような設定変更がトリガーになるかを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | loading.lua | `script/workspace/loading.lua` | 52-58行目: maxPreload変更時のsetConfig呼び出し |

**主要処理フロー**:
- **52-58行**: client.setConfig で設定を更新

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

```
ユーザー操作 (例: 上限増加ボタン)
    │
    └─ client.setConfig (client.lua:520)
           │
           ├─ config.add/set/prop (524-541行)
           │
           ├─ tryModifyClientGlobal (551行)
           │      └─ [成功] → 設定更新
           │
           ├─ tryModifySpecifiedConfig (553行)
           │      └─ [成功] → 設定更新
           │
           └─ [全て成功後]
                  └─ MWS_UCONFIG_UPDATED通知
```

### データフロー図

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

設定変更要求        ───▶  setConfig()              ───▶  更新完了通知
(診断無効化等)            │
                         ├─ tryModifyClientGlobal
                         │
                         ├─ tryModifySpecifiedConfig
                         │
                         └─ [成功]
                                └─ MWS_UCONFIG_UPDATED
```

### 関連ファイル一覧

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