# 機能設計書 77-プラグインシステム

## 概要

本ドキュメントは、Lua Language Serverにおけるプラグインシステムの設計を記述する。この機能は、カスタムプラグインの読み込みと実行を管理し、サーバーの動作を拡張・カスタマイズする仕組みを提供する。

### 本機能の処理概要

**業務上の目的・背景**：Lua Language Serverの標準機能では対応できない特殊な要件（カスタムrequire解決、独自のAST変換、テキスト前処理など）に対応するため、プラグインによる拡張が必要となる場合がある。本機能はLuaで記述されたプラグインを読み込み、特定のイベントで呼び出すことで、サーバーの動作を柔軟にカスタマイズできるようにする。

**機能の利用シーン**：
- カスタムrequireパス解決の実装
- ソースコードの前処理（テンプレート展開など）
- AST変換による構文拡張
- プロジェクト固有のルール適用

**主要な処理内容**：
1. プラグインファイルの読み込みと検証
2. 信頼性確認（ユーザー承認）
3. プラグインインターフェースの登録
4. イベントディスパッチ（OnSetText, OnTransformAst, ResolveRequire）
5. エラーハンドリングとログ記録

**関連システム・外部連携**：
- 設定管理システム（Lua.runtime.plugin設定）
- ワークスペース管理システム
- ファイルシステム（プラグインファイル読み込み）
- クライアント通知（信頼性確認ダイアログ）

**権限による制御**：プラグインの読み込みにはユーザーの明示的な承認が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は画面関連なし |

## 機能種別

プラグイン管理 / 拡張機能

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Lua.runtime.plugin | string/string[] | No | プラグインファイルのパス | 有効なファイルパス |
| Lua.runtime.pluginArgs | table | No | プラグインへ渡す引数 | - |

### 入力データソース

- 設定ファイル（.luarc.json）
- プラグインLuaファイル

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| success | boolean | イベント実行の成否 |
| result1, result2 | any | プラグインからの戻り値 |

### 出力先

- イベント呼び出し元への戻り値
- エラー時はクライアントへの通知

## 処理フロー

### 処理シーケンス

```
1. ワークスペース開始時にinitPlugin実行
   └─ startReloadイベントで発火
2. プラグインパスの解決
   └─ Lua.runtime.plugin設定から取得
3. プラグインファイルの読み込み
   └─ util.loadFileで読み込み
4. 信頼性確認
   └─ ユーザー承認またはtrustedファイル確認
5. プラグインの実行と登録
   └─ load()でLuaコード実行
6. イベントディスパッチ
   └─ dispatch()で各イベントを呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[ワークスペース開始] --> B[initPlugin呼び出し]
    B --> C[プラグインパス取得]
    C --> D{パス設定あり?}
    D -->|No| E[終了]
    D -->|Yes| F[プラグインファイル読み込み]
    F --> G{読み込み成功?}
    G -->|No| H[警告ログ出力]
    H --> E
    G -->|Yes| I{信頼済み?}
    I -->|No| J[ユーザー承認要求]
    J --> K{承認?}
    K -->|No| E
    K -->|Yes| L[trustedファイルに記録]
    I -->|Yes| M[プラグイン実行]
    L --> M
    M --> N{実行成功?}
    N -->|No| O[エラー表示]
    N -->|Yes| P[インターフェース登録]
    P --> Q[ワークスペースリセット]
    Q --> E
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-77-01 | 信頼性確認 | 初回読み込み時はユーザー承認が必要 | trustByClient未設定時 |
| BR-77-02 | 信頼記録 | 承認済みプラグインはtrustedファイルに記録 | 承認時 |
| BR-77-03 | TRUST_ALL_PLUGINS | この環境変数設定時は承認スキップ | 環境変数設定時 |
| BR-77-04 | 性能監視 | 0.1秒以上かかるイベント呼び出しは警告ログ | 常時 |

### 計算ロジック

**イベントディスパッチロジック**:
```lua
function m.dispatch(event, uri, ...)
    local scp = scope.getScope(uri)
    local interfaces = scp:get('pluginInterfaces')
    for _, interface in ipairs(interfaces) do
        local method = interface[event]
        if type(method) == 'function' then
            local clock = os.clock()
            local suc, res1, res2 = xpcall(method, log.error, uri, ...)
            local passed = os.clock() - clock
            if passed > 0.1 then
                log.warn(('Call plugin event [%s] takes [%.3f] sec'):format(event, passed))
            end
        end
    end
end
```

## データベース操作仕様

### 操作別データベース影響一覧

本機能はデータベース操作を行わない。ファイルシステムへのtrusted記録のみ。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| PLUGIN_RUNTIME_ERROR | 実行時エラー | プラグイン内でエラー発生 | エラーメッセージ表示 |
| - | ファイル読込失敗 | プラグインファイルが見つからない | 警告ログ出力 |
| - | ロードエラー | Lua構文エラー | エラーメッセージ表示 |

### リトライ仕様

リトライは行わない。エラー発生時はそのイベント呼び出しは失敗として扱う。

## トランザクション仕様

トランザクション管理は不要。

## パフォーマンス要件

- 各イベント呼び出しは0.1秒以内を推奨
- 0.1秒を超える場合は警告ログを出力

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

- プラグインはLuaコードとして実行されるため、信頼できるソースのみ使用
- 初回読み込み時はユーザーの明示的な承認が必要
- 承認済みプラグインはLOGPATH/trustedファイルに記録
- package.pathにプラグインディレクトリを追加してrequireを許可

## 備考

- プラグインイベント: OnSetText, OnTransformAst, ResolveRequire
- 複数プラグインの同時読み込みをサポート
- プラグインごとに異なるpluginArgsを設定可能

---

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

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

### 推奨読解順序

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

プラグインモジュールの構造を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | plugin.lua | `script/plugin.lua` | 10-11行目: pluginモジュール定義 |
| 1-2 | plugin.lua | `script/plugin.lua` | 21行目: plugin.eventエイリアス定義 |

**読解のコツ**: `@alias plugin.event`でサポートされるイベント（OnSetText, OnTransformAst, ResolveRequire）が定義されている。

#### Step 2: イベントディスパッチを理解する

プラグインイベントの呼び出し処理。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | plugin.lua | `script/plugin.lua` | 23-52行目: dispatch関数 |

**主要処理フロー**:
1. **25-26行目**: スコープからインターフェース取得
2. **32-34行目**: イベントメソッドの存在確認
3. **37-41行目**: xpcallで安全に呼び出し
4. **42-44行目**: 性能監視（0.1秒超で警告）

#### Step 3: プラグイン初期化を理解する

プラグインの読み込みと登録処理。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | plugin.lua | `script/plugin.lua` | 94-167行目: initPlugin関数 |

**主要処理フロー**:
- **104-107行目**: Lua.runtime.plugin設定取得
- **124-128行目**: プラグインファイル読み込み
- **132-136行目**: package.pathへのパス追加
- **147-148行目**: load()でプラグイン実行
- **154-156行目**: checkTrustLoadで信頼性確認
- **157-162行目**: プラグイン実行とインターフェース登録

#### Step 4: 信頼性確認を理解する

プラグイン読み込み時のユーザー承認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | plugin.lua | `script/plugin.lua` | 63-91行目: checkTrustLoad関数 |

**主要処理フロー**:
- **66-68行目**: TRUST_ALL_PLUGINSチェック
- **70-79行目**: trustedファイルからの確認
- **81-90行目**: ユーザー承認ダイアログ

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

```
ws.watch('startReload') (イベント)
    │
    └─ initPlugin(uri)
           │
           ├─ config.get('Lua.runtime.plugin')
           │      └─ プラグインパス取得
           │
           ├─ ws.getAbsolutePath()
           │      └─ 絶対パス解決
           │
           ├─ util.loadFile(pluginPath)
           │      └─ プラグイン読み込み
           │
           ├─ checkTrustLoad(scp)
           │      │
           │      ├─ util.loadFile(trustedPath)
           │      │      └─ 信頼済みリスト確認
           │      │
           │      └─ client.awaitRequestMessage()
           │             └─ ユーザー承認
           │
           ├─ load(pluginLua)()
           │      └─ プラグイン実行
           │
           └─ ws.resetFiles(scp)
                  └─ ワークスペースリセット

m.dispatch(event, uri, ...) (公開API)
    │
    └─ interface[event](uri, ...)
           └─ 各プラグインのイベントハンドラ呼び出し
```

### データフロー図

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

.luarc.json ─────────▶ initPlugin() ─────────────▶ pluginInterfaces
(Lua.runtime.plugin)         │                        (スコープに登録)
                             │
                             ▼
                      プラグインファイル
                             │
                             ▼
                      checkTrustLoad() ──────────▶ trusted ファイル更新
                             │
                             ▼
                      load()実行
                             │
                             ▼
m.dispatch() ─────────▶ interface[event]() ──────▶ 処理結果
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| plugin.lua | `script/plugin.lua` | ソース | プラグインシステムのメインモジュール |
| plugins.lua | `script/plugins.lua` | ソース | 組み込みプラグイン |
| scope.lua | `script/workspace/scope.lua` | ソース | スコープ管理（プラグインインターフェース保持） |
| config.lua | `script/config/config.lua` | ソース | プラグイン設定取得 |
| client.lua | `script/client.lua` | ソース | ユーザー承認ダイアログ |
| workspace/init.lua | `script/workspace/init.lua` | ソース | ワークスペース管理、startReloadイベント |
