# 通知設計書 15-CONFIG_LOAD_FAILED

## 概要

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

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverは、ワークスペースごとの設定をローカル設定ファイル（.luarc.json等）から読み込むことができる。設定ファイルが存在するにもかかわらず読み込めない場合（アクセス権限の問題、ファイルシステムエラー等）、ユーザーに問題を通知し、設定ファイルの確認を促す必要がある。本通知はそのような状況で使用される。

**通知の送信タイミング**：設定ファイルの読み込み処理（`config/loader.lua`の`loadLocalConfig`関数または設定編集処理）で、ファイルの読み込みに失敗した場合に送信される。

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

**通知内容の概要**：「設定ファイルを読み込めませんでした：{path}」というメッセージが表示され、どの設定ファイルで問題が発生したかを明示する。

**期待されるアクション**：ユーザーは設定ファイルのパス、アクセス権限、ファイルの存在を確認し、必要に応じてファイルを修正または作成することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessage |
| メッセージタイプ | Error（エラー） |

### 本文テンプレート

```
設定ファイルを読み込めませんでした：{path}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| path | 読み込みに失敗した設定ファイルのパス | 関数引数 | Yes |
| lang.script.CONFIG_LOAD_FAILED | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 設定編集 | editConfigJson呼び出し | util.loadFile(path)がnil | 設定ファイル編集時の読み込み失敗 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ファイルが正常に読み込めた場合 | 通知不要 |
| loadLocalConfigでの読み込み失敗 | コメントアウトにより現在は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[editConfigJson呼び出し] --> B[util.loadFile実行]
    B --> C{text == nil?}
    C -->|No| D[設定ファイル編集処理]
    C -->|Yes| E[m.showMessage - Error]
    E --> F[CONFIG_LOAD_FAILED通知]
    F --> G[return nil]
    D --> H[JSON編集完了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| util.loadFile | ファイル読み込み | ファイルシステムアクセス |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 読み込み失敗のため更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ファイル読み込み失敗 | ファイルが存在しない or アクセス権限なし | エラー表示、処理中止 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 設定ファイルのフルパスがメッセージに含まれるが、ローカル表示のみ
- ファイルアクセス権限の問題をユーザーに通知

## 備考

- loadLocalConfig関数内のCONFIG_LOAD_FAILED通知はコメントアウトされている（行57）
- 主にeditConfigJson関数（client.lua行337-359）で使用される
- 設定ファイル編集時の読み込み失敗を検出

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | loader.lua | `script/config/loader.lua` | 設定読み込みの基本処理 |

**読解のコツ**: loadLocalConfig、loadRCConfig関数の処理フローを把握する。

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

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

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

**主要処理フロー**:
1. **行337**: `local function editConfigJson(uri, path, changes)` - 関数定義
2. **行338**: `local text = util.loadFile(path)` - ファイル読み込み
3. **行339-341**: 読み込み失敗時のエラー処理
4. **行340**: `m.showMessage('Error', lang.script('CONFIG_LOAD_FAILED', path))` - 通知送信

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/ja-jp/script.lua` | CONFIG_LOAD_FAILED定義（行618-619） |

**主要処理フロー**:
- **行618-619**: `CONFIG_LOAD_FAILED = '設定ファイルを読み込めませんでした：{}'`

#### Step 4: 設定ローダーでの使用箇所を理解する

loader.luaでの参照（コメントアウト）を確認。

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

**主要処理フロー**:
- **行55-59**: ファイル読み込み失敗時の処理（行57はコメントアウト）

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

```
client.lua
    │
    └─ editConfigJson(uri, path, changes)
           │
           ├─ util.loadFile(path)
           │      │
           │      └─ 失敗時: nil返却
           │
           └─ text == nil の場合
                  │
                  └─ m.showMessage('Error', lang.script('CONFIG_LOAD_FAILED', path))
                         │
                         └─ proto.notify('window/showMessage', ...)
```

### データフロー図

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

設定ファイルパス ───▶ util.loadFile()
                            │
                            ▼
                   ファイル読み込み試行
                            │
                            ▼ (読み込み失敗時)
                   lang.script('CONFIG_LOAD_FAILED', path)
                            │
                            ▼
                   m.showMessage() ───▶ window/showMessage通知
                            │
                            ▼
                   return nil ───▶ 処理中止
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| client.lua | `script/client.lua` | ソース | editConfigJson関数 |
| loader.lua | `script/config/loader.lua` | ソース | 設定ローダー |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| utility.lua | `script/utility.lua` | ソース | loadFile関数 |
| proto.lua | `script/proto/proto.lua` | ソース | LSPプロトコル通信 |
