# 通知設計書 50-WINDOW_LUA_STATUS_MEMORY_COUNT

## 概要

本ドキュメントは、lua-language-serverにおける「メモリ使用量」通知（WINDOW_LUA_STATUS_MEMORY_COUNT）の設計仕様を定義する。この通知は、ステータスバーのツールチップに言語サーバーのメモリ使用量を表示するためのテンプレートメッセージを提供する。

### 本通知の処理概要

この通知は、IDEのステータスバーに表示される「Lua」アイコンのツールチップコンテンツの一部として使用される。言語サーバープロセスのメモリ使用量をMB単位で表示し、リソース消費状況を把握できるようにする。

**業務上の目的・背景**：言語サーバーは大規模プロジェクトで大量のメモリを消費する可能性がある。メモリ使用量を監視できることで、ユーザーはパフォーマンス問題の原因を特定したり、メモリリークの兆候を早期に発見したりできる。また、言語サーバーの再起動が必要かどうかの判断材料となる。

**通知の送信タイミング**：`m.reportStatus`関数が呼び出されるたびに、ステータス情報の一部として送信される。これはサービスのメインループで定期的に実行され、ステータスバーを更新する。

**通知の受信者**：VSCode等のIDEを使用している開発者。ステータスバーの「Lua」アイコンにマウスをホバーした際に表示される。

**通知内容の概要**：「Memory usage: {mem}M」（日本語：「メモリ使用量：{mem}M」）という形式で、メモリ使用量がMB単位で表示される。小数点以下は`.f`フォーマットで整数表示される。

**期待されるアクション**：ユーザーはこの情報を参照して、メモリ消費状況を確認する。異常に高い場合は、言語サーバーの再起動を検討する。

## 通知種別

LSPカスタム通知（`$/status/report`）のツールチップコンテンツ

## 送信仕様

### 基本情報

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

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

LSPクライアントに対して`$/status/report`通知として送信される。`statusBar`オプションが有効な場合にのみ送信される。

## 通知テンプレート

### ステータスツールチップの場合

| 項目 | 内容 |
|-----|------|
| 通知種別 | $/status/report |
| 用途 | ツールチップ内メモリ情報 |
| 形式 | テキスト（パラメータ付き） |

### 本文テンプレート

```
英語: Memory usage: {mem:.f}M
日本語: メモリ使用量：{mem:.f}M
中国語(簡体): 内存占用: {mem:.f}M
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {mem:.f} | メモリ使用量（MB単位、整数表示） | collectgarbage('count') / 1000 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 定期実行 | m.reportStatus | statusBar オプション有効 | サービスメインループ |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| statusBar オプション無効 | クライアントがステータスバーをサポートしない場合 |
| 前回と同じ内容 | util.equal(m.lastInfo, info)がtrueの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[m.reportStatus呼び出し] --> B{statusBar有効?}
    B -->|No| C[return - 処理終了]
    B -->|Yes| D[params構築]
    D --> E[collectgarbage count 呼び出し]
    E --> F[KB → MB変換 / 1000]
    F --> G[WINDOW_LUA_STATUS_MEMORY_COUNT展開]
    G --> H[tooltipsに追加]
    H --> I{前回と同じ内容?}
    I -->|Yes| C
    I -->|No| J[proto.notify $/status/report]
    J --> K[終了]
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| N/A | N/A | データベース不使用 |

### メモリ内データ参照

| 関数/API | 用途 | 説明 |
|----------|------|------|
| collectgarbage('count') | メモリ使用量取得 | LuaランタイムのKB単位メモリ使用量 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 数値取得失敗 | collectgarbageが失敗した場合 | デフォルト値（0）を使用 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 更新間隔 | サービスメインループの実行間隔に依存 |
| 重複排除 | util.equalによる前回値との比較 |

### 配信時間帯

制限なし（サービス稼働中は常時）

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

- メモリ使用量のみを表示し、機密情報は含まれない
- 外部ネットワークには送信されない（クライアント-サーバー間のローカル通信）
- システム全体のメモリ情報ではなく、Luaランタイムのみの情報

## 備考

- `collectgarbage('count')`はKB単位で返すため、1000で除算してMB単位に変換
- `{mem:.f}`の`.f`は小数点以下を省略した整数表示のフォーマット指定
- 関連する通知：WINDOW_LUA_STATUS_WORKSPACE、WINDOW_LUA_STATUS_CACHED_FILES
- メモリリーク検出（DEBUG_MEMORY_LEAK）とは別の監視目的

---

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

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

### 推奨読解順序

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

reportStatus関数でのメモリ取得を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | service.lua | `script/service/service.lua` | 228行目：メモリ使用量取得 |

**主要処理フロー**:
- **228行目**: `mem = collectgarbage('count') / 1000` - KB→MB変換

**読解のコツ**: Luaの`collectgarbage('count')`は、Luaが使用しているメモリをKB単位で返す。これを1000で割ることでMB単位に変換している。

#### Step 2: メッセージ展開を理解する

テンプレートへのパラメータ挿入を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | service.lua | `script/service/service.lua` | 234行目：WINDOW_LUA_STATUS_MEMORY_COUNT展開 |

**主要処理フロー**:
- **234行目**: `lang.script('WINDOW_LUA_STATUS_MEMORY_COUNT', params)` - パラメータ付きで展開

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

テンプレート変数とフォーマット指定を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/en-us/script.lua` | 568-569行目：英語メッセージ |
| 3-2 | script.lua | `locale/ja-jp/script.lua` | 568-569行目：日本語メッセージ |

**読解のコツ**: `{mem:.f}`の`.f`はフォーマット指定子で、小数点以下を省略した整数表示を指定している。

#### Step 4: ツールチップ全体の構成を理解する

他のステータス情報との関係を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | service.lua | `script/service/service.lua` | 231-234行目：tooltips配列への追加順序 |

**主要処理フロー**:
- **231行目**: WINDOW_LUA_STATUS_WORKSPACE（各ワークスペース）
- **233行目**: WINDOW_LUA_STATUS_CACHED_FILES
- **234行目**: WINDOW_LUA_STATUS_MEMORY_COUNT

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

```
m.reportStatus (service.lua:211)
    |
    +-- [params構築] (225-229行目)
    |       |
    |       +-- collectgarbage('count') / 1000 → params.mem
    |
    +-- [tooltips構築] (224-237行目)
    |       |
    |       +-- lang.script('WINDOW_LUA_STATUS_MEMORY_COUNT', params) (234行目)
    |               |
    |               +-- "Memory usage: {mem:.f}M" → "Memory usage: 256M"
    |
    +-- proto.notify('$/status/report', info) (244行目)
```

### データフロー図

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

collectgarbage('count')  ───▶  / 1000              ───▶  params.mem = 256.78
(256780 KB)                        |
                                   ▼
                              lang.script展開       ───▶  "Memory usage: 256M"
                              {mem:.f} フォーマット        (.fで整数表示)
                                   |
                                   ▼
                              table.concat          ───▶  ツールチップ文字列
                                   |
                                   ▼
                              proto.notify          ───▶  $/status/report通知
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| service.lua | `script/service/service.lua` | ソース | サービスメイン処理 |
| proto.lua | `script/proto/proto.lua` | ソース | LSP通知送信 |
| script.lua | `locale/en-us/script.lua` | 言語リソース | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
