# 通知設計書 2-MWS_RESTART

## 概要

本ドキュメントは、Lua Language Server における再起動ボタン（MWS_RESTART）の設計仕様を定義する。

### 本通知の処理概要

この通知は、マルチワークスペース非対応通知（MWS_NOT_SUPPORT）のダイアログに表示される「再起動」ボタンのラベルテキストである。ユーザーがこのボタンをクリックすると、言語サーバーが再起動され、新しいワークスペースが適切に認識される。

**業務上の目的・背景**：マルチワークスペース機能がサポートされていない場合、言語サーバーを再起動することで新しいワークスペースを正しく読み込むことができる。このボタンは、ユーザーに明確なアクション選択肢を提供し、問題解決への導線を確立する役割を持つ。

**通知の送信タイミング**：MWS_NOT_SUPPORT 通知と同時に、ダイアログボタンのラベルとして表示される。単独では送信されない。

**通知の受信者**：エディタを使用している開発者（ユーザー）。MWS_NOT_SUPPORT ダイアログ内のボタンとして表示される。

**通知内容の概要**：「Restart」（日本語：「再起動」）というボタンラベルが表示される。

**期待されるアクション**：ユーザーがボタンをクリックすると、言語サーバーの再起動処理が実行される。これにより、新しく追加されたワークスペースが適切に初期化・認識される。

## 通知種別

アプリ内通知（LSP window/showMessageRequest のアクションボタン）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（親メッセージに包含） |
| 優先度 | 中 |
| リトライ | 無（親メッセージに依存） |

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

MWS_NOT_SUPPORT と共に LSP クライアントに送信される。単独での送信ロジックは存在しない。

## 通知テンプレート

### ボタンラベル

| 言語 | ラベル |
|-----|------|
| 英語 | Restart |
| 日本語 | 再起動 |
| 中国語（簡体） | 重启 |
| 中国語（繁体） | 重新啟動 |
| ポルトガル語 | Reiniciar |
| スペイン語 | Reiniciar |

### 本文テンプレート

```
Restart
```

日本語:
```
再起動
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | ボタンラベルは固定文字列 | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 親通知依存 | MWS_NOT_SUPPORT送信時 | MWS_NOT_SUPPORT が送信される場合 | 親通知のアクションボタンとして含まれる |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| MWS_NOT_SUPPORT が送信されない | 親通知が送信されない場合は表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[MWS_NOT_SUPPORT 通知生成] --> B[MWS_RESTART ボタン追加]
    B --> C[window/showMessageRequest 送信]
    C --> D{ユーザー選択}
    D -->|Restart| E[再起動コールバック実行]
    D -->|キャンセル/閉じる| F[処理終了]
    E --> G[言語サーバー再起動]
    G --> H[ワークスペース再読み込み]
    H --> I[終了]
    F --> I
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コールバック失敗 | 再起動処理が失敗 | ログに記録、ユーザーに手動再起動を促す |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | MWS_NOT_SUPPORT に依存 |

### 配信時間帯

制限なし

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

- ボタンラベルのみで機密情報は含まれない
- 再起動処理自体はクライアント側で制御される

## 備考

- このボタンは MWS_NOT_SUPPORT（No.1）と必ずセットで使用される
- 実際の再起動処理はクライアント（エディタ拡張）側で実装される

---

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

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

### 推奨読解順序

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

ボタンラベルの定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 191-192行目: MWS_RESTART = 'Restart' |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | 191-192行目: MWS_RESTART = '再起動' |

**読解のコツ**: MWS_RESTART は単純な文字列定数で、MWS_NOT_SUPPORT のアクションボタンとして使用される。

#### Step 2: ボタン送信機構を理解する

requestMessage でボタンが送信される仕組みを理解する。

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

**主要処理フロー**:
1. **124-131行**: titles配列からactions配列を生成
2. **133-138行**: window/showMessageRequest でボタン付きダイアログ送信
3. **137-143行**: ユーザー選択時のコールバック処理

#### Step 3: 使用箇所を理解する

MWS_RESTART がどこで使用されるかを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | loading.lua | `script/workspace/loading.lua` | 45-62行目: checkMaxPreload での requestMessage 使用例 |

**主要処理フロー**:
- **45-62行**: プリロード上限到達時の通知例（同様のパターンで MWS_RESTART も使用される）

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

```
client.requestMessage (client.lua:119)
    │
    ├─ titles配列 (MWS_RESTART等のボタンラベル)
    │
    ├─ actions配列生成 (124-131行)
    │
    └─ proto.request('window/showMessageRequest')
           │
           └─ callback(item.title, map[item.title])
                  │
                  └─ 再起動処理実行
```

### データフロー図

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

MWS_NOT_SUPPORT      ───▶  requestMessage()         ───▶  LSPクライアント
メッセージ                  │                              (エディタ)
                           ├─ titles: [MWS_RESTART]
                           │
                           └─ ユーザー選択
                                  │
                                  └─ callback → 再起動
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語ボタンラベル定義（191-192行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語ボタンラベル定義（191-192行） |
| client.lua | `script/client.lua` | ソース | requestMessage 実装（119-145行） |
| loading.lua | `script/workspace/loading.lua` | ソース | 類似パターンの使用例（45-62行） |
