# 通知設計書 25-DEBUG_MEMORY_LEAK

## 概要

本ドキュメントは、Lua Language Serverにおけるメモリリーク検出通知（DEBUG_MEMORY_LEAK）の設計について記述する。

### 本通知の処理概要

この通知は、言語サーバーが重大なメモリリークを検出した際に、ユーザーに対してサービスの再起動を促すメッセージを表示する機能を提供する。

**業務上の目的・背景**：Lua Language Serverは長時間稼働するプロセスであり、メモリ管理は重要な課題である。内部的なバグや特定の操作パターンによりメモリリークが発生する可能性がある。深刻なメモリリークが検出された場合、パフォーマンスの低下やシステムの不安定化を防ぐため、ユーザーに通知してサービスの再起動を提案する必要がある。

**通知の送信タイミング**：メモリ監視機能によりメモリリークが検出された時点で送信される。具体的な検出ロジックはサービス層で実装されており、メモリ使用量が異常に増加した場合などにトリガーされる。

**通知の受信者**：エディタを使用しているユーザー（開発者）。LSPクライアント経由でwindow/showMessageRequest通知として受信する。

**通知内容の概要**：メモリリークが発生したことの謝罪と、サービスの自動再起動が予定されている旨のメッセージが表示される。DEBUG_RESTART_NOWボタンと組み合わせて使用される。

**期待されるアクション**：ユーザーは「今すぐ再起動」ボタンをクリックしてサービスを即座に再起動するか、自動再起動を待つことが期待される。

## 通知種別

LSP window/showMessageRequest通知（ユーザー選択を伴うダイアログ）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（LSP request/response） |
| 優先度 | 高（Error相当） |
| リトライ | なし |

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

LSPクライアント（エディタ）に対してwindow/showMessageRequest通知を送信する。受信者はエディタを操作しているユーザー。

## 通知テンプレート

### LSP通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessageRequest |
| メッセージタイプ | Error（1） |
| アクション | DEBUG_RESTART_NOW |

### 本文テンプレート

英語版:
```
{timestamp} I'm sorry for the serious memory leak. The language service will be restarted soon.
```

日本語版:
```
{timestamp} 重大なメモリリークが発生したため、言語サービスを再起動します。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| timestamp | エラー発生時刻またはメモリ情報 | システム情報 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| メモリ監視 | メモリリーク検出 | メモリ使用量が閾値を超過 | 定期的なメモリ監視で検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 既に通知済み | 同一セッション内で既に通知済みの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[メモリ監視処理] --> B{メモリリーク検出?}
    B -->|No| C[監視継続]
    B -->|Yes| D[DEBUG_MEMORY_LEAKメッセージ生成]
    D --> E[window/showMessageRequest送信]
    E --> F{ユーザー選択}
    F -->|DEBUG_RESTART_NOW| G[サービス即座に再起動]
    F -->|タイムアウト| H[自動再起動スケジュール]
    G --> I[サービス終了]
    H --> I
```

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

### 参照テーブル一覧

データベースは使用しない（インメモリ処理のみ）。

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 通知送信失敗 | LSPクライアント接続断 | ログに記録、再起動実行 |
| ユーザー応答なし | ダイアログがタイムアウト | 自動再起動を実行 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1セッションあたり上限 | 1回（検出後は再起動するため） |

### 配信時間帯

制限なし（メモリリーク検出時即座に通知）

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

- メモリ情報が含まれる可能性があるが、ユーザー本人への通知のためセキュリティリスクは低い
- 再起動により作業中のデータが失われる可能性があるため、エディタ側でのファイル保存機能が重要

## 備考

- DEBUG_RESTART_NOWボタンと組み合わせて使用される
- メモリリーク検出の詳細ロジックはservice.luaに実装されている
- 通知後は基本的にサービスが再起動される

---

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

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

### 推奨読解順序

#### Step 1: メッセージ定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | DEBUG_MEMORY_LEAK定義（517-518行目） |
| 1-2 | script.lua | `locale/en-us/script.lua` | DEBUG_RESTART_NOW定義（519-520行目） |

**読解のコツ**: メッセージには{}プレースホルダーがあり、タイムスタンプやメモリ情報が挿入される。

#### Step 2: メモリ監視処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | service.lua | `script/service/service.lua` | countMemory関数（26-36行目） |
| 2-2 | service.lua | `script/service/service.lua` | reportMemory関数（55-65行目） |
| 2-3 | service.lua | `script/service/service.lua` | report関数（134-148行目） |

**主要処理フロー**:
1. **26-36行目**: メモリ使用量の計測処理
2. **55-65行目**: メモリレポートの生成
3. **135行目**: 600秒（10分）ごとのレポート生成

#### Step 3: クライアント通知層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | client.lua | `script/client.lua` | awaitRequestMessage関数（153-157行目） |

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

```
service.report (script/service/service.lua:134)
    │
    ├─ timer.loop(600.0) - 定期実行
    │
    └─ reportMemory
           │
           └─ countMemory
                  │
                  └─ collectgarbage('count')
```

### データフロー図

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

メモリ監視       ───▶  メモリリーク検出       ───▶  正常継続
タイマー                    │                              or
                           ▼ [異常検出]               再起動通知
                    DEBUG_MEMORY_LEAK
                    メッセージ生成
                           │
                           ▼
                    window/showMessageRequest
                           │
                           ▼
                    [DEBUG_RESTART_NOW]
                           │
                           ▼
                    サービス再起動 ──────────▶  プロセス終了
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| service.lua | `script/service/service.lua` | ソース | サービス管理、メモリ監視 |
| client.lua | `script/client.lua` | ソース | LSPクライアント通信 |
| script.lua | `locale/en-us/script.lua` | ローカライズ | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
