# 通知設計書 9-WORKSPACE_SKIP_LARGE_FILE

## 概要

本ドキュメントは、Lua Language Server における大容量ファイルスキップ通知（WORKSPACE_SKIP_LARGE_FILE）の設計仕様を定義する。

### 本通知の処理概要

この通知は、ワークスペース内のファイルが設定されたサイズ上限を超えているため、プリロード（自動解析）がスキップされたことをユーザーに通知するメッセージである。

**業務上の目的・背景**：大容量のLuaファイル（自動生成コード、巨大なデータテーブル等）を解析すると、メモリ消費量が増大しパフォーマンスが低下する可能性がある。そのため、`Lua.workspace.preloadFileSize` 設定で上限（KB単位）が設けられている。この上限を超えるファイルは自動プリロードの対象外となり、ユーザーが手動で開いた場合のみ解析される。この通知により、ユーザーはファイルがスキップされた理由を理解できる。

**通知の送信タイミング**：ワークスペースのファイルスキャン・プリロード処理中に、ファイルサイズが `Lua.workspace.preloadFileSize` で設定された上限（KB）を超えていることが検出された時点で送信される。

**通知の受信者**：エディタを使用している開発者（ユーザー）。最初の1件はダイアログで表示され、2件目以降はログに記録される。

**通知内容の概要**：「ファイル {ファイル名} のサイズが上限を超えているためスキップしました。設定上限: {上限} KB、ファイルサイズ: {サイズ} KB」というメッセージが表示される。

**期待されるアクション**：ユーザーは必要に応じて preloadFileSize 設定を増加させるか、ファイルを手動で開いて解析を実行する。

## 通知種別

アプリ内通知（LSP window/showMessage または window/logMessage）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（Info） |
| リトライ | 無 |

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

LSP クライアントに対して直接送信される。最初の1件は showMessage、2件目以降は logMessage で送信。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージタイプ | Info |
| ボタン | なし |

### 本文テンプレート

```
Too large file: {} skipped. The currently set size limit is: {} KB, and the file size is: {} KB.
```

日本語:
```
ファイル {} のサイズが {} KB を超えているため、解析をスキップしました。現在のサイズは {} KB です。
```

中国語（簡体）:
```
已跳过过大的文件：{}。当前设置的大小限制为：{} KB，该文件大小为：{} KB
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| {} (位置1) | ファイル相対パス | workspace.getRelativePath(uri) | Yes |
| {} (位置2) | 設定上限値（KB） | config.get('Lua.workspace.preloadFileSize') | Yes |
| {} (位置3) | ファイルサイズ（KB） | #file.text / 1000 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| システムイベント | ファイルプリロード時 | #file.text >= preloadFileSize * 1000 | ファイルサイズが上限を超えている場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ファイルが開かれている | isOpen(uri) == true の場合は解析する |
| ライブラリファイル | isLibrary(uri) == true の場合は解析する |
| 既に通知済み | 同一ファイルについて既に通知した場合 |
| 2件目以降 | showMessage は最初の1件のみ、以降は logMessage |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイルプリロード処理] --> B{ファイルサイズ > preloadFileSize?}
    B -->|No| C[通常解析継続]
    B -->|Yes| D{ファイルが開かれている?}
    D -->|Yes| C
    D -->|No| E{ライブラリファイル?}
    E -->|Yes| C
    E -->|No| F{既に通知済み?}
    F -->|Yes| G[スキップ＆ログ記録のみ]
    F -->|No| H[notifyCacheに記録]
    H --> I{最初の通知?}
    I -->|Yes| J[showMessage送信]
    I -->|No| K[logMessage送信]
    J --> L[プリロードスキップ]
    K --> L
    G --> L
    C --> M[終了]
    L --> M
```

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

### 参照テーブル一覧

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

### 参照データ

| データ | 取得元 | 用途 |
|--------|--------|------|
| preloadFileSize | config.get('Lua.workspace.preloadFileSize') | 上限値取得 |
| notifyCache['preloadFileSize'] | files.notifyCache | 重複通知防止 |
| skipLargeFileCount | files.notifyCache | 通知方法判定 |

### 更新データ

| データ | 更新先 | 用途 |
|--------|--------|------|
| notifyCache['preloadFileSize'][uri] | files.notifyCache | 通知済みファイル記録 |
| skipLargeFileCount | files.notifyCache | 通知件数カウント |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | 情報通知のためエラーなし | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| showMessage | 最初の1件のみ |
| logMessage | 2件目以降すべて |

### 配信時間帯

制限なし

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

- ファイル名（相対パス）が表示されるが、これはワークスペース内の情報のため問題なし

## 備考

- WORKSPACE_SKIP_HUGE_FILE（No.12）とは異なる通知（巨大ファイルは10MB超で警告）
- preloadFileSize のデフォルト値は 500KB

---

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

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

### 推奨読解順序

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

メッセージ定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | 206-207行目: WORKSPACE_SKIP_LARGE_FILE 定義 |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | 206-207行目: 日本語訳 |

**読解のコツ**: {} が3つあり、順にファイル名、上限値、実サイズが挿入される。

#### Step 2: 通知送信処理を理解する

checkPreload関数の実装を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | files.lua | `script/files.lua` | 585-616行目: checkPreload 関数 |

**主要処理フロー**:
1. **592-594行**: isOpen, isLibrary チェック
2. **594行**: preloadFileSize 設定値との比較
3. **595-601行**: notifyCache の初期化と更新
4. **602-606行**: メッセージ生成
5. **607-611行**: showMessage または logMessage で送信

#### Step 3: 呼び出し元を理解する

checkPreloadがどこから呼び出されるかを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | files.lua | `script/files.lua` | 673-684行目: compileState での checkPreload 呼び出し |

**主要処理フロー**:
- **681行**: checkPreload(uri) の呼び出し
- **682-683行**: false なら return（解析スキップ）

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

```
files.compileState (files.lua:673)
    │
    ├─ files.checkPreload (681行)
    │      │
    │      ├─ isOpen(uri) チェック (592行)
    │      │
    │      ├─ isLibrary(uri) チェック (593行)
    │      │
    │      ├─ #file.text >= preloadFileSize * 1000 (594行)
    │      │
    │      ├─ notifyCache 更新 (595-601行)
    │      │
    │      ├─ lang.script('WORKSPACE_SKIP_LARGE_FILE', ...) (602-606行)
    │      │
    │      └─ [skipLargeFileCount <= 1]
    │             ├─ client.showMessage (608行)
    │             └─ [else] client.logMessage (610行)
    │
    └─ [checkPreload == false] → return (解析スキップ)
```

### データフロー図

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

ファイル解析要求    ───▶  compileState()           ───▶  解析結果 or スキップ
                         │
                         └─ checkPreload()
                                │
                                ├─ [サイズ超過]
                                │      │
                                │      ├─ notifyCache 更新
                                │      │
                                │      └─ WORKSPACE_SKIP_LARGE_FILE通知
                                │             │
                                │             ├─ [1件目] → showMessage
                                │             └─ [2件目~] → logMessage
                                │
                                └─ [サイズOK] → 解析継続
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | ローカライズ | メッセージ定義（206-207行） |
| script.lua | `locale/ja-jp/script.lua` | ローカライズ | 日本語メッセージ定義 |
| files.lua | `script/files.lua` | ソース | checkPreload 実装（585-616行） |
| client.lua | `script/client.lua` | ソース | showMessage, logMessage 実装 |
| workspace.lua | `script/workspace/workspace.lua` | ソース | getRelativePath 実装 |
