# 通知設計書 16-CONFIG_LOAD_ERROR

## 概要

本ドキュメントは、Lua Language Serverにおける「設定ファイル読み込みエラー」通知（CONFIG_LOAD_ERROR）の設計仕様を定義する。この通知は、設定ファイルのパース（JSON/Lua解析）中にエラーが発生した場合にユーザーに警告するエラーメッセージである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、設定ファイル（.luarc.json、.luarc.jsonc、config.lua等）を読み込んで動作をカスタマイズする。設定ファイルに構文エラー（JSON/Luaの文法エラー）がある場合、パースに失敗する。ユーザーに具体的なエラー内容を通知し、設定ファイルの修正を促すために本通知が必要である。

**通知の送信タイミング**：設定ファイルのパース処理（`config/loader.lua`の`loadRCConfig`または`loadLocalConfig`関数）で、JSONまたはLuaのデコードに失敗した場合に送信される。

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

**通知内容の概要**：「設定ファイルの読み込み中にエラーが発生しました：{error}」というメッセージが表示され、具体的なパースエラーの内容を明示する。

**期待されるアクション**：ユーザーは設定ファイルを開き、表示されたエラー情報に基づいて構文エラーを修正することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
設定ファイルの読み込み中にエラーが発生しました：{error}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| error | パースエラーの詳細メッセージ | pcall結果のエラー文字列 | Yes |
| lang.script.CONFIG_LOAD_ERROR | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| RC設定読み込み | loadRCConfig呼び出し | jsonc.decode_jsonc失敗 | .luarc.json/.luarc.jsoncのパースエラー |
| ローカル設定読み込み | loadLocalConfig呼び出し | jsonc.decode_jsoncまたはload失敗 | ローカル設定ファイルのパースエラー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| パース成功 | 通知不要 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[設定ファイル読み込み] --> B[util.loadFile実行]
    B --> C{text取得成功?}
    C -->|No| Z[lastConfig返却]
    C -->|Yes| D{JSON形式?}
    D -->|Yes| E[jsonc.decode_jsonc実行]
    D -->|No| F[load実行 - Lua形式]
    E --> G{パース成功?}
    F --> G
    G -->|Yes| H[設定適用]
    G -->|No| I[errorMessage - Warning]
    I --> J[CONFIG_LOAD_ERROR通知]
    J --> K[lastConfig返却]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| scp:get('lastRCConfig') | 前回の有効な設定 | フォールバック用 |
| scp:get('lastLocalConfig') | 前回の有効なローカル設定 | フォールバック用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| scp | SET | エラー時は前回の設定を維持 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| JSONパースエラー | JSON構文エラー | 警告表示、前回設定を使用 |
| Luaパースエラー | Lua構文エラー | 警告表示、前回設定を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（設定ファイルアクセス時）

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

- パースエラーの詳細がメッセージに含まれるが、ローカル表示のみ
- Lua形式の設定ファイルは実行されるため、信頼できるファイルのみ使用すべき

## 備考

- エラー発生時は前回の有効な設定（lastRCConfig/lastLocalConfig）にフォールバック
- JSONとLua両方の形式に対応
- jsonc（JSON with Comments）形式もサポート
- errorMessage関数でproto.notifyを使用（window/showMessage type=3）

---

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

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

### 推奨読解順序

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

設定ローダーの基本構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | loader.lua | `script/config/loader.lua` | 設定読み込みの全体構造 |

**読解のコツ**: loadRCConfig、loadLocalConfig関数の処理フローと、lastConfigへのフォールバック機構を把握する。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | loader.lua | `script/config/loader.lua` | loadRCConfig関数（行21-41）とloadLocalConfig関数（行44-85） |

**主要処理フロー（loadRCConfig）**:
1. **行21**: `function m.loadRCConfig(uri, filename)` - 関数定義
2. **行28-31**: ファイル読み込み
3. **行33**: `local suc, res = pcall(jsonc.decode_jsonc, buf)` - JSONパース
4. **行34-36**: パース失敗時のエラー処理
5. **行35**: `errorMessage(lang.script('CONFIG_LOAD_ERROR', res))` - 通知送信
6. **行36**: `return scp:get('lastRCConfig')` - フォールバック

**主要処理フロー（loadLocalConfig）**:
1. **行63-72**: JSON形式のパース処理
2. **行64**: `local suc, res = pcall(jsonc.decode_jsonc, buf)` - JSONパース
3. **行65-67**: パース失敗時のエラー処理
4. **行66**: `errorMessage(lang.script('CONFIG_LOAD_ERROR', res))` - 通知送信
5. **行74-84**: Lua形式のパース処理
6. **行77-79**: パース失敗時のエラー処理
7. **行78**: `errorMessage(lang.script('CONFIG_LOAD_ERROR', res))` - 通知送信

#### Step 3: エラー通知関数を理解する

errorMessage関数の実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | loader.lua | `script/config/loader.lua` | errorMessage関数（行9-15） |

**主要処理フロー**:
- **行9-15**: proto.notifyでwindow/showMessage（type=3）を送信

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

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

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

**主要処理フロー**:
- **行620-621**: `CONFIG_LOAD_ERROR = '設定ファイルの読み込み中にエラーが発生しました：{}'`

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

```
loader.lua
    │
    ├─ m.loadRCConfig(uri, filename)
    │      │
    │      ├─ util.loadFile(path)
    │      │
    │      └─ pcall(jsonc.decode_jsonc, buf)
    │             │
    │             └─ 失敗時: errorMessage(lang.script('CONFIG_LOAD_ERROR', res))
    │                    │
    │                    └─ proto.notify('window/showMessage', {type=3, ...})
    │
    └─ m.loadLocalConfig(uri, filename)
           │
           ├─ util.loadFile(path)
           │
           ├─ JSON形式: pcall(jsonc.decode_jsonc, buf)
           │      │
           │      └─ 失敗時: errorMessage(...)
           │
           └─ Lua形式: pcall(load, buf)
                  │
                  └─ 失敗時: errorMessage(...)
```

### データフロー図

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

設定ファイル内容 ───▶ jsonc.decode_jsonc() or load()
                            │
                            ▼
                   パース処理
                            │
                            ▼ (パース失敗時)
                   lang.script('CONFIG_LOAD_ERROR', res)
                            │
                            ▼
                   errorMessage() ───▶ window/showMessage通知
                            │
                            ▼
                   return lastConfig ───▶ 前回設定へフォールバック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| loader.lua | `script/config/loader.lua` | ソース | 設定ローダー |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| jsonc.lua | `script/jsonc.lua` | ソース | JSON with Comments パーサー |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信 |
| scope.lua | `script/workspace/scope.lua` | ソース | スコープ管理（lastConfig保存） |
