# 通知設計書 3-ActionSavedToast

## 概要

本ドキュメントは、Windows Terminal におけるアクション保存成功トースト通知（ActionSavedToast）の設計仕様を定義する。ユーザーがスニペットアクション（キーバインド等）の保存に成功した際に、保存内容を一時的に表示する TeachingTip ベースの通知機能である。

### 本通知の処理概要

ActionSavedToast は、`saveSnippet` アクションによりユーザーが定義したコマンド入力やキーバインドが正常に設定ファイルへ保存された際に、保存された内容（名前、キーコード、コマンドライン）を確認用に表示するトースト通知である。

**業務上の目的・背景**：Windows Terminal ではユーザーが独自のアクション（SendInput等）をスニペットとして保存できる。保存操作が成功したことをユーザーに明示的にフィードバックし、保存された内容を即座に確認できるようにすることで、設定ミスの早期発見と操作の安心感を提供する。

**通知の送信タイミング**：`_HandleSaveSnippet` アクションハンドラ内で、`ActionMap().AddSendInputAction()` による設定追加と `WriteSettingsToDisk()` によるファイル書き込みが成功した後に `ActionSaved()` メソッドが呼び出されて表示される。

**通知の受信者**：アクションの保存操作を実行したユーザー自身。アプリ内UI通知としてウィンドウ上にオーバーレイ表示される。

**通知内容の概要**：保存されたアクションの名前（Name）、キーコード（KeyChord）、コマンドライン入力（CommandLine）が表示される。各項目は空でない場合のみ表示される。

**期待されるアクション**：ユーザーは表示された保存内容を確認する。3秒後に自動的に消去されるため、特別な操作は不要。

## 通知種別

アプリ内通知（TeachingTip ベースの Toast 通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（UIスレッド上で即時表示） |
| 優先度 | 中 |
| リトライ | 無し |

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

アクションを実行したウィンドウの TerminalPage 上に直接表示される。

## 通知テンプレート

### アプリ内通知（TeachingTip）の場合

| 項目 | 内容 |
|-----|------|
| UIコントロール | `Microsoft.UI.Xaml.Controls.TeachingTip` |
| 名前 | `ActionSavedToast` |
| x:Uid | `ActionSavedToast`（ローカライズキー） |
| Title | "Action Saved"（ハードコード） |
| IsLightDismissEnabled | True |

### 本文テンプレート

```
Title: Action Saved
Content:
  Name: {SavedActionName}        ← 空でない場合のみ表示
  Key Chord: {SavedActionKeyChord} ← 空でない場合のみ表示
  Input: {SavedActionCommandLine}  ← 空でない場合のみ表示
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| SavedActionName | 保存されたアクションの名前 | TerminalPage.SavedActionName（WINRT_OBSERVABLE_PROPERTY） | No |
| SavedActionKeyChord | 保存されたキーコード文字列 | TerminalPage.SavedActionKeyChord（WINRT_OBSERVABLE_PROPERTY） | No |
| SavedActionCommandLine | 保存されたコマンドライン入力 | TerminalPage.SavedActionCommandLine（WINRT_OBSERVABLE_PROPERTY） | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザーアクション | `saveSnippet` アクション | AddSendInputAction と WriteSettingsToDisk が成功 | スニペット保存成功時にトースト表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Feature_SaveSnippet 未有効 | フィーチャーフラグが無効の場合、ハンドラが即 return する |
| CommandLine が空 | コマンドラインが空の場合、ActionSaveFailed が呼ばれる |
| 設定書き込み例外 | WriteSettingsToDisk や AddSendInputAction で例外が発生した場合は ActionSaveFailed に遷移 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがsaveSnippetアクション実行] --> B[_HandleSaveSnippet]
    B --> C{Feature_SaveSnippet有効?}
    C -->|No| D[即return]
    C -->|Yes| E{CommandLine取得}
    E --> F{CommandLine空?}
    F -->|Yes - 選択テキストなし| G[ActionSaveFailed呼び出し]
    F -->|No| H[AddSendInputAction実行]
    H --> I[WriteSettingsToDisk実行]
    I --> J{例外発生?}
    J -->|Yes| K[ActionSaveFailed呼び出し]
    J -->|No| L[ActionSaved呼び出し]
    L --> M{_actionSavedToast == nullptr?}
    M -->|Yes| N[FindName でTeachingTip取得]
    N --> O[Toast オブジェクト生成]
    M -->|No| P[テーマ更新]
    O --> P
    P --> Q[SavedActionName/KeyChord/CommandLine設定]
    Q --> R[Toast::Open 呼び出し]
    R --> S[3秒後自動消去]
```

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

### 参照テーブル一覧

該当なし（データベースは使用しない。設定ファイルへの書き込みのみ）

### 更新テーブル一覧

該当なし（設定ファイル `settings.json` が更新されるが、データベースではない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| CommandLine 未指定 | commandLine が空で選択テキストもない場合 | ActionSaveFailed("CommandLine is Required") を表示 |
| 設定保存例外 | AddSendInputAction / WriteSettingsToDisk で hresult_error 発生 | ActionSaveFailed(例外メッセージ) を表示 |
| XAML要素未発見 | FindName が null を返す場合 | Toast が生成されず表示されない |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | 特になし |

### 配信時間帯

制限なし

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

保存されたコマンドライン入力が画面に表示されるため、機密性の高いコマンドが含まれる場合はスクリーンシェアリング環境で注意が必要。

## 備考

- ActionSavedToast と ActionSaveFailedToast は対になる通知であり、saveSnippet アクションの成否に応じていずれかが表示される。
- 各テキスト項目（Name, KeyChord, CommandLine）は `StringNotEmptyToVisibility` コンバーターにより、空文字列の場合は非表示となる。
- SavedActionName, SavedActionKeyChord, SavedActionCommandLine は `WINRT_OBSERVABLE_PROPERTY` マクロで定義されたバインディング可能なプロパティである。
- フィーチャーフラグ `Feature_SaveSnippet` により機能の有効/無効が制御される。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Toast.h | `src/cascadia/TerminalApp/Toast.h` | Toast クラスの定義（行29-38） |
| 1-2 | TerminalPage.h | `src/cascadia/TerminalApp/TerminalPage.h` | SavedActionName/KeyChord/CommandLine のプロパティ定義（行210-212）と _actionSavedToast メンバ（行273） |
| 1-3 | TerminalPage.idl | `src/cascadia/TerminalApp/TerminalPage.idl` | 公開プロパティの定義（行68-70） |

**読解のコツ**: `WINRT_OBSERVABLE_PROPERTY` マクロは getter/setter と PropertyChanged イベントを自動生成する WinRT のマクロである。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | `_HandleSaveSnippet` メソッド（行1281-1336）。フィーチャーフラグチェック、CommandLine取得、設定保存、成功/失敗分岐を確認 |

**主要処理フロー**:
1. **行1284**: `Feature_SaveSnippet::IsEnabled()` でフィーチャーフラグチェック
2. **行1293-1304**: CommandLine の取得（引数 or 選択テキスト）
3. **行1320**: `ActionMap().AddSendInputAction()` で設定追加
4. **行1321**: `WriteSettingsToDisk()` でファイル保存
5. **行1322**: `ActionSaved(commandLine, name, keyChord)` で成功トースト表示

#### Step 3: Toast 表示処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | `ActionSaved()` メソッド（行1338-1362）。Toast 初期化、プロパティ設定、Open を実行 |

**主要処理フロー**:
- **行1342**: `_actionSavedToast` が null かチェック
- **行1344**: `FindName` で TeachingTip を遅延ロード
- **行1346**: `std::make_shared<Toast>(tip)` で Toast 生成
- **行1354-1356**: SavedActionName/KeyChord/CommandLine プロパティに値を設定
- **行1360**: `_actionSavedToast->Open()` で表示

#### Step 4: XAML定義を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | `ActionSavedToast` TeachingTip の定義（行214-240）。Content 内の StackPanel で3つの TextBlock を条件付き表示 |

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

```
ユーザーアクション (saveSnippet)
    |
    +-- AppActionHandlers::_HandleSaveSnippet (行1281)
           |
           +-- [Feature_SaveSnippet チェック] (行1284)
           +-- [CommandLine 取得] (行1293-1304)
           +-- ActionMap::AddSendInputAction() (行1320)
           +-- Settings::WriteSettingsToDisk() (行1321)
           +-- TerminalPage::ActionSaved() (行1322 -> 行1338)
                  |
                  +-- FindName("ActionSavedToast") ... 初回のみ (行1344)
                  |      +-- std::make_shared<Toast>(tip) (行1346)
                  |      +-- tip.Closed += _FocusActiveControl (行1349)
                  |
                  +-- _UpdateTeachingTipTheme() (行1352)
                  +-- SavedActionName/KeyChord/CommandLine 設定 (行1354-1356)
                  +-- Toast::Open() (行1360)
                         |
                         +-- TeachingTip.IsOpen(true)
                         +-- タイマー開始（3秒後に自動消去）
```

### データフロー図

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

saveSnippet アクション        _HandleSaveSnippet                  TeachingTip 表示
(Name, KeyChord,       --->  設定保存 → ActionSaved()      --->  (3秒後自動消去)
 CommandLine)                                                      Name / KeyChord /
                                                                   CommandLine を表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Toast.h | `src/cascadia/TerminalApp/Toast.h` | ソース | Toast ヘルパークラスのヘッダ定義 |
| Toast.cpp | `src/cascadia/TerminalApp/Toast.cpp` | ソース | Toast クラスの実装 |
| TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | XAML | ActionSavedToast TeachingTip のUI定義 |
| TerminalPage.h | `src/cascadia/TerminalApp/TerminalPage.h` | ソース | SavedAction プロパティと _actionSavedToast メンバ |
| TerminalPage.idl | `src/cascadia/TerminalApp/TerminalPage.idl` | IDL | SavedAction プロパティの公開定義 |
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleSaveSnippet と ActionSaved の実装 |
