# 通知設計書 57-WINDOW_TELEMETRY_ENABLE

## 概要

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

### 本通知の処理概要

本通知は、テレメトリ許可確認ダイアログにおいて「許可」ボタンのラベルテキストとして使用される。ユーザーが匿名の使用データとエラーレポートの送信を許可する際にクリックするボタンのテキストを提供する。

**業務上の目的・背景**：テレメトリデータの収集には明示的なユーザー同意が必要である。この通知は、ユーザーがデータ送信を許可する意思を表明するためのアクションボタンのラベルとして機能し、GDPR等のプライバシー規制に準拠した同意取得プロセスを実現する。

**通知の送信タイミング**：WINDOW_TELEMETRY_HINTダイアログが表示される際に、選択肢の一つとしてこのラベルが表示される。

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

**通知内容の概要**：「許可します」または「Allow」というボタンラベルテキスト。

**期待されるアクション**：ユーザーがこのボタンをクリックすると、テレメトリデータの送信が許可され、匿名の使用統計とエラーレポートが収集・送信されるようになる。

## 通知種別

アプリ内通知（ダイアログボタンラベル）

## 送信仕様

### 基本情報

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

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

- 送信先はLSPクライアント（エディタ）
- WINDOW_TELEMETRY_HINTダイアログの選択肢として表示

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 表示場所 | テレメトリ許可ダイアログのボタン |
| 形式 | ボタンテキスト |

### 本文テンプレート

英語版:
```
Allow
```

日本語版:
```
許可します
```

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ダイアログ表示 | WINDOW_TELEMETRY_HINTダイアログ表示時 | 常時 | 許可ボタンとして表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| テレメトリダイアログが不要な場合 | 既に設定済みの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[WINDOW_TELEMETRY_HINTダイアログ表示] --> B[WINDOW_TELEMETRY_ENABLEをボタンとして表示]
    B --> C{ユーザー選択}
    C -->|許可ボタンクリック| D[テレメトリ許可設定を保存]
    C -->|拒否ボタンクリック| E[テレメトリ拒否設定を保存]
    C -->|キャンセル| F[設定保持]
    D --> G[テレメトリデータ送信有効化]
    E --> H[テレメトリデータ送信無効化]
    F --> I[終了]
    G --> I
    H --> I
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 設定保存失敗 | ファイル書き込みエラー等 | エラーメッセージを表示 |

### リトライ仕様

該当なし

## 配信設定

### レート制限

該当なし

### 配信時間帯

制限なし

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

- ユーザーの明示的な同意を記録
- 設定変更は永続化される

## 備考

- この通知はWINDOW_TELEMETRY_HINT（No.56）およびWINDOW_TELEMETRY_DISABLE（No.58）と連携して使用される
- テレメトリ許可後のデータ収集内容は匿名化された使用統計とエラーレポート

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: ボタンラベルは非常にシンプルで、肯定的なアクションを示す単語を使用している。

#### Step 2: 関連する通知を理解する

テレメトリ関連の他の通知を確認する。

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

**主要処理フロー**:
1. WINDOW_TELEMETRY_HINTがダイアログ本文として表示
2. WINDOW_TELEMETRY_ENABLEが「許可」ボタンとして表示（本通知）
3. ユーザーがクリックするとテレメトリが有効化される

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

```
テレメトリ許可ダイアログ
    │
    ├─ lang.script.WINDOW_TELEMETRY_HINT（メッセージ本文）
    │
    ├─ lang.script.WINDOW_TELEMETRY_ENABLE ← 本通知（許可ボタン）
    │
    └─ lang.script.WINDOW_TELEMETRY_DISABLE（拒否ボタン）
           │
           ▼
    ユーザー選択に基づく設定保存
```

### データフロー図

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

TELEMETRY_HINT ───▶ ダイアログ表示 ───▶ 選択肢表示
ダイアログ               │                    │
                         ▼                    ▼
                 lang.script() ───▶ WINDOW_TELEMETRY_ENABLE
                                              │
                                              ▼
                                        許可ボタンラベル
                                              │
                     ユーザークリック ───▶ テレメトリ有効化
                                              │
                                              ▼
                                        設定保存・データ送信開始
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | 設定 | テレメトリ関連設定定義 |
