# 通知設計書 56-WINDOW_TELEMETRY_HINT

## 概要

本ドキュメントは、Lua Language Serverにおけるテレメトリ許可案内通知（WINDOW_TELEMETRY_HINT）の設計仕様を定義するものである。

### 本通知の処理概要

本通知は、ユーザーに対して匿名の使用データとエラーレポートの送信許可を求めるメッセージを表示する。拡張機能の改善に役立てるためのテレメトリデータ収集についてユーザーに説明し、同意を求める役割を果たす。

**業務上の目的・背景**：Lua Language Serverの開発チームは、拡張機能を継続的に改善するために匿名の使用統計とエラーレポートを収集したいと考えている。この通知は、プライバシーに配慮した形でユーザーに許可を求め、透明性のあるデータ収集を実現する。GDPRなどのプライバシー規制に準拠するため、明示的な同意を取得する。

**通知の送信タイミング**：テレメトリ設定が未設定の場合、拡張機能の初期化時または特定のタイミングでユーザーに許可を求めるダイアログが表示される。

**通知の受信者**：エディタ（VSCode等のLSPクライアント）を使用しているユーザー。メッセージダイアログの本文として表示される。

**通知内容の概要**：匿名の使用データとエラーレポートの送信許可を求めるメッセージ。プライバシーポリシーへのリンクも含まれる。

**期待されるアクション**：ユーザーがWINDOW_TELEMETRY_ENABLE（許可）またはWINDOW_TELEMETRY_DISABLE（拒否）を選択する。

## 通知種別

アプリ内通知（メッセージダイアログ本文）

## 送信仕様

### 基本情報

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

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

- 送信先はLSPクライアント（エディタ）
- テレメトリ設定が未設定の場合に表示

## 通知テンプレート

### ダイアログ通知の場合

| 項目 | 内容 |
|-----|------|
| 表示場所 | メッセージダイアログ本文 |
| 形式 | テキスト（マークダウン対応） |

### 本文テンプレート

英語版:
```
Please allow sending anonymous usage data and error reports to help us further improve this extension. Read our privacy policy [here](https://luals.github.io/privacy#language-server) .
```

日本語版:
```
匿名の使用データとエラーレポートの送信を許可し、このプラグインの改善にご協力ください。プライバシーポリシーについては[こちら](https://luals.github.io/privacy/#language-server)をご覧ください。
```

### 添付ファイル

該当なし

## テンプレート変数

該当なし（固定メッセージ）

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 初期化 | 拡張機能の初期化時 | テレメトリ設定が未設定 | 初回起動またはリセット後 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| テレメトリ設定済み | 既に許可または拒否が設定されている場合 |
| WINDOW_DONT_SHOW_AGAIN選択済み | ユーザーが「再度表示しない」を選択済みの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[拡張機能初期化] --> B{テレメトリ設定確認}
    B -->|未設定| C[WINDOW_TELEMETRY_HINTダイアログ表示]
    B -->|設定済み| D[通常処理継続]
    C --> E{ユーザー選択}
    E -->|WINDOW_TELEMETRY_ENABLE| F[テレメトリ許可設定保存]
    E -->|WINDOW_TELEMETRY_DISABLE| G[テレメトリ拒否設定保存]
    E -->|キャンセル| H[次回また表示]
    F --> I[テレメトリ送信開始]
    G --> J[テレメトリ無効化]
    H --> K[終了]
    I --> K
    J --> K
    D --> K
```

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

### 参照テーブル一覧

該当なし（データベースを使用しない）

### 更新テーブル一覧

該当なし（設定ファイルへの書き込み）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ダイアログ表示失敗 | クライアントが対応していない場合 | デフォルトでテレメトリ無効 |

### リトライ仕様

該当なし

## 配信設定

### レート制限

該当なし

### 配信時間帯

制限なし

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

- プライバシーポリシーへのリンクを必ず含める
- 明示的な同意がない限りテレメトリは無効
- 収集データは匿名化されることを明記

## 備考

- この通知はWINDOW_TELEMETRY_ENABLE（No.57）およびWINDOW_TELEMETRY_DISABLE（No.58）と連携して使用される
- プライバシーポリシーURL: https://luals.github.io/privacy#language-server
- マークダウン形式でリンクが埋め込まれている

---

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

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

### 推奨読解順序

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

まず、通知メッセージの定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | script.lua | `locale/en-us/script.lua` | WINDOW_TELEMETRY_HINTの英語メッセージ定義（585-586行目） |
| 1-2 | script.lua | `locale/ja-jp/script.lua` | WINDOW_TELEMETRY_HINTの日本語メッセージ定義（585-586行目） |

**読解のコツ**: マークダウンリンク形式 `[テキスト](URL)` でプライバシーポリシーへのリンクが含まれている。

#### Step 2: 関連する選択肢を理解する

テレメトリ許可・拒否の選択肢を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | script.lua | `locale/en-us/script.lua` | WINDOW_TELEMETRY_ENABLE/DISABLEの定義（587-590行目） |

**主要処理フロー**:
1. WINDOW_TELEMETRY_HINTが本文として表示
2. WINDOW_TELEMETRY_ENABLEが「許可」ボタンとして表示
3. WINDOW_TELEMETRY_DISABLEが「拒否」ボタンとして表示

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

```
テレメトリ設定確認
    │
    ├─ 設定状態チェック
    │
    └─ requestMessage / awaitRequestMessage
           │
           ├─ lang.script.WINDOW_TELEMETRY_HINT ← 本通知（メッセージ本文）
           │
           ├─ lang.script.WINDOW_TELEMETRY_ENABLE（許可ボタン）
           │
           └─ lang.script.WINDOW_TELEMETRY_DISABLE（拒否ボタン）
```

### データフロー図

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

拡張機能起動 ───▶ テレメトリ設定確認 ───▶ 未設定の場合ダイアログ表示
                                              │
                                              ▼
                     lang.script() ───▶ WINDOW_TELEMETRY_HINT
                                              │
                                              ▼
                     requestMessage ───▶ [クライアント（エディタ）]
                                              │
                                              ▼
                                        テレメトリ許可ダイアログ表示
                                              │
                     ユーザー選択 ───▶ 設定保存
                                              │
                                              ▼
                              [テレメトリ有効/無効化]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| script.lua | `locale/en-us/script.lua` | 設定 | 英語メッセージ定義 |
| script.lua | `locale/ja-jp/script.lua` | 設定 | 日本語メッセージ定義 |
| client.lua | `script/client.lua` | ソース | メッセージダイアログ表示 |
| setting.lua | `locale/en-us/setting.lua` | 設定 | テレメトリ関連設定定義 |
