# 通知設計書 14-WORKSPACE_SCAN_TOO_MUCH

## 概要

本ドキュメントは、Lua Language Serverにおける「スキャンファイル数過多」通知（WORKSPACE_SCAN_TOO_MUCH）の設計仕様を定義する。この通知は、ワークスペースまたはライブラリのスキャン中にファイル数が100,000件を超えた場合に表示される警告メッセージであり、設定の見直しを促すものである。

### 本通知の処理概要

**業務上の目的・背景**：Lua Language Serverはワークスペース内のLuaファイルをスキャンしてインデックスを作成するが、大量のファイルをスキャンすることはメモリ消費とパフォーマンスに大きな影響を与える。100,000ファイルを超えるスキャンは、通常のLuaプロジェクトとしては異常であり、以下の問題が考えられる：不要なディレクトリ（node_modules等）の包含、誤ったワークスペース設定、または巨大なライブラリの参照。ユーザーに早期に警告し、設定の見直しを促すために本通知が必要である。

**通知の送信タイミング**：ワークスペースプリロード処理（`awaitPreload`関数）またはライブラリスキャン中に、スキャンされたファイル数が100,000件に達した時点で送信される。

**通知の受信者**：LSPクライアント（VSCode等のエディタ）を通じてユーザーに表示される。警告メッセージとしてエディタのUI上にポップアップ表示される。

**通知内容の概要**：「{count} 個以上のファイルをスキャンしました。現在スキャンしているディレクトリは `{path}` です。」というメッセージが表示され、FAQへのリンクと設定誤りの可能性についても言及される。

**期待されるアクション**：ユーザーはワークスペース設定を確認し、不要なディレクトリを除外パターン（ignoreDir、files.exclude）に追加するか、FAQを参照して適切な設定を行うことが期待される。

## 通知種別

アプリ内通知（LSP Window Message - Warning）

## 送信仕様

### 基本情報

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

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

LSPプロトコルに従い、接続中のLSPクライアントに対してwindow/showMessage通知を送信する。受信者の決定は不要（接続中のクライアントすべてに送信）。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | window/showMessage |
| メッセージタイプ | Warning（警告） |

### 本文テンプレート

```
{count} 個以上のファイルをスキャンしました。現在スキャンしているディレクトリは `{path}` です。不要なファイルを除外する方法については、[FAQ](https://luals.github.io/wiki/faq#how-can-i-improve-startup-speeds) を参照してください。また、[設定に誤りがある可能性があります](https://luals.github.io/wiki/faq#why-is-the-server-scanning-the-wrong-folder)。
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| count | スキャンされたファイル数 | ローカルカウンター変数 | Yes |
| path | スキャン中のディレクトリパス | furi.decode(scp.uri) | Yes |
| lang.script.WORKSPACE_SCAN_TOO_MUCH | メッセージテンプレート | locale/ja-jp/script.lua | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ワークスペーススキャン | native:scan コールバック | count == 100000 | ワークスペースファイルスキャン |
| ライブラリスキャン | libMatcher.matcher:scan コールバック | count == 100000 | ライブラリファイルスキャン |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| count != 100000 | 100,000件ちょうどの時のみ送信 |
| 'bad root'フラグ有り | 危険なルートの場合はスキャンスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[awaitPreload開始] --> B{bad rootフラグ?}
    B -->|Yes| Z[スキャンスキップ]
    B -->|No| C[native:scan開始]
    C --> D[ファイルスキャンループ]
    D --> E{count == 100000?}
    E -->|No| F[次のファイル]
    F --> D
    E -->|Yes| G[client.showMessage - Warning]
    G --> H[WORKSPACE_SCAN_TOO_MUCH通知]
    H --> F
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| scp.uri | ワークスペースURI | スコープ情報 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| scp:get('cachedUris') | INSERT | スキャンされたファイルURIの追加 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| スキャン過多 | ファイル数 >= 100,000 | 警告表示、スキャン継続 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし（100,000件到達時のみ） |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（ワークスペース読み込み時）

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

- スキャン中のディレクトリパスがメッセージに含まれるが、ローカル表示のみ
- 大量スキャンはDoS攻撃のような状態になりうるため、早期警告が重要
- FAQリンクで適切な設定方法を案内

## 備考

- 100,000の閾値はハードコードされている
- 警告表示後もスキャンは継続される（中止されない）
- ワークスペースとライブラリの両方でチェックされる
- FAQリンク1：https://luals.github.io/wiki/faq#how-can-i-improve-startup-speeds
- FAQリンク2：https://luals.github.io/wiki/faq#why-is-the-server-scanning-the-wrong-folder

---

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

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

### 推奨読解順序

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

スキャン処理の基本構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | loading.lua | `script/workspace/loading.lua` | ローディング処理の構造 |

**読解のコツ**: loading.create()でローディングオブジェクトを生成し、loadFile()でファイルを読み込むことを把握する。

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

処理の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | workspace.lua | `script/workspace/workspace.lua` | awaitPreload関数（行318-390） |

**主要処理フロー**:
1. **行346-358**: ワークスペーススキャン処理
2. **行346-357**: native:scanコールバック
3. **行354-356**: count == 100000時の警告表示
4. **行355**: `client.showMessage('Warning', lang.script('WORKSPACE_SCAN_TOO_MUCH', count, furi.decode(scp.uri)))`
5. **行360-382**: ライブラリスキャン処理
6. **行376-380**: ライブラリでの同様のチェック

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

通知メッセージの定義を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | script.lua | `locale/ja-jp/script.lua` | WORKSPACE_SCAN_TOO_MUCH定義（行216-217） |

**主要処理フロー**:
- **行216-217**: メッセージテンプレートとFAQリンク

#### Step 4: globスキャン処理を理解する

スキャン機能の詳細を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | glob.lua | `script/glob/glob.lua` | glob:scan関数のコールバック機構 |

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

```
workspace.lua
    │
    └─ m.awaitPreload(scp)
           │
           ├─ loading.create(scp) -- ローディング開始
           │
           ├─ m.getNativeMatcher(scp)
           │      └─ glob.gitignore() -- マッチャー作成
           │
           ├─ native:scan(path, callback, countCallback)
           │      │
           │      └─ countCallback
           │             │
           │             └─ count == 100000
           │                    │
           │                    └─ client.showMessage('Warning', ...)
           │
           └─ libMatcher.matcher:scan(path, callback, countCallback)
                  │
                  └─ 同様のカウントチェック
```

### データフロー図

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

ワークスペースパス ───▶ native:scan()
                            │
                            ▼
                   ファイルカウント (count++)
                            │
                            ▼ (count == 100000)
                   lang.script('WORKSPACE_SCAN_TOO_MUCH', ...)
                            │
                            ▼
                   client.showMessage() ───▶ window/showMessage通知
                            │
                            ▼
                   スキャン継続 ───▶ cachedUrisに登録
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| workspace.lua | `script/workspace/workspace.lua` | ソース | ワークスペース管理・awaitPreload関数 |
| loading.lua | `script/workspace/loading.lua` | ソース | ファイルローディング管理 |
| glob.lua | `script/glob/glob.lua` | ソース | ファイルパターンマッチング |
| client.lua | `script/client.lua` | ソース | クライアント通知機能 |
| script.lua | `locale/ja-jp/script.lua` | 言語リソース | 日本語メッセージ定義 |
| scope.lua | `script/workspace/scope.lua` | ソース | スコープ管理 |
