# 通知設計書 4-ActionSaveFailedToast

## 概要

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

### 本通知の処理概要

ActionSaveFailedToast は、`saveSnippet` アクションの実行中にエラーが発生した場合に、失敗理由をユーザーに通知するトースト通知である。

**業務上の目的・背景**：スニペット保存操作が失敗した際に、ユーザーに失敗の事実とその理由を即座にフィードバックする。これにより、ユーザーは問題の原因を把握し、再試行やパラメータ修正などの適切な対処を行うことができる。

**通知の送信タイミング**：`_HandleSaveSnippet` アクションハンドラ内で、以下の2つのケースで `ActionSaveFailed()` メソッドが呼び出される。(1) CommandLine が空の場合に "CommandLine is Required" メッセージで呼び出される。(2) `AddSendInputAction` や `WriteSettingsToDisk` で `winrt::hresult_error` 例外が発生した場合に、例外のメッセージで呼び出される。

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

**通知内容の概要**：Title に "Action Save Failed" と表示され、Content にエラーメッセージが表示される。

**期待されるアクション**：ユーザーはエラーメッセージを確認し、原因に応じてコマンドラインの指定やパラメータの修正を行い、再度保存を試みる。3秒後に自動消去される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Title: Action Save Failed
Content: {エラーメッセージ}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | エラーメッセージ文字列 | ActionSaveFailed() の引数 / 例外メッセージ | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ユーザーアクション | `saveSnippet` アクション（CommandLine 空） | CommandLine が空で選択テキストも空 | "CommandLine is Required" メッセージを表示 |
| ユーザーアクション | `saveSnippet` アクション（例外発生） | AddSendInputAction/WriteSettingsToDisk で例外 | 例外メッセージを表示 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Feature_SaveSnippet 未有効 | フィーチャーフラグが無効の場合、ハンドラが即 return し失敗通知も出ない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[saveSnippet アクション内でエラー発生] --> B[ActionSaveFailed 呼び出し]
    B --> C{_actionSaveFailedToast == nullptr?}
    C -->|Yes| D[FindName でTeachingTip取得]
    D --> E[Toast オブジェクト生成]
    E --> F[Closed コールバック登録]
    C -->|No| G[テーマ更新]
    F --> G
    G --> H[ActionSaveFailedMessage.Text にメッセージ設定]
    H --> I[Toast::Open 呼び出し]
    I --> J[3秒後自動消去]
```

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| XAML要素未発見 | FindName が null を返す場合 | Toast が生成されず表示されない |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

例外メッセージがそのまま表示されるため、内部エラー情報がユーザーに見える。ただし、アプリケーション内のローカル表示であり、外部への情報漏洩リスクは低い。

## 備考

- ActionSavedToast と対になるエラー通知である。
- エラーメッセージは `ActionSaveFailedMessage` という名前の TextBlock に `Text` プロパティとしてコードから直接設定される（データバインディングではない）。
- フィーチャーフラグ `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` | `_actionSaveFailedToast` メンバ（行274） |

**読解のコツ**: ActionSaveFailedToast は ActionSavedToast と同じ Toast パターンを使うが、表示内容の設定方法が異なる（プロパティバインディングではなく直接 Text 設定）。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | `_HandleSaveSnippet` のエラーパス。CommandLine 空の場合（行1307-1311）と例外キャッチ（行1324-1330） |

**主要処理フロー**:
1. **行1307-1309**: CommandLine が空の場合、`ActionSaveFailed(L"CommandLine is Required")` を呼び出し
2. **行1324-1328**: `winrt::hresult_error` 例外キャッチ時、`ActionSaveFailed(message)` を呼び出し

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | `ActionSaveFailed()` メソッド（行1364-1386）。Toast 初期化、メッセージ設定、Open を実行 |

**主要処理フロー**:
- **行1368**: `_actionSaveFailedToast` が null かチェック
- **行1370**: `FindName` で TeachingTip を遅延ロード
- **行1372**: `std::make_shared<Toast>(tip)` で Toast 生成
- **行1380**: `ActionSaveFailedMessage().Text(message)` でエラーメッセージ設定
- **行1384**: `_actionSaveFailedToast->Open()` で表示

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | `ActionSaveFailedToast` TeachingTip の定義（行241-250）。Content 内の TextBlock（ActionSaveFailedMessage）を確認 |

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

```
ユーザーアクション (saveSnippet) - エラーパス
    |
    +-- AppActionHandlers::_HandleSaveSnippet (行1281)
           |
           +-- [CommandLine 空] --> ActionSaveFailed("CommandLine is Required") (行1309)
           +-- [例外発生] --> ActionSaveFailed(ex.message()) (行1328)
                  |
                  +-- TerminalPage::ActionSaveFailed() (行1364)
                         |
                         +-- FindName("ActionSaveFailedToast") ... 初回のみ (行1370)
                         |      +-- std::make_shared<Toast>(tip) (行1372)
                         |      +-- tip.Closed += _FocusActiveControl (行1375)
                         |
                         +-- _UpdateTeachingTipTheme() (行1378)
                         +-- ActionSaveFailedMessage().Text(message) (行1380)
                         +-- Toast::Open() (行1384)
```

### データフロー図

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

saveSnippet エラー      _HandleSaveSnippet (エラーパス)     TeachingTip 表示
(CommandLine空 or  ---> ActionSaveFailed()             ---> Title: "Action Save Failed"
 例外メッセージ)                                              Content: エラーメッセージ
                                                            (3秒後自動消去)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Toast.h | `src/cascadia/TerminalApp/Toast.h` | ソース | Toast ヘルパークラスのヘッダ定義 |
| Toast.cpp | `src/cascadia/TerminalApp/Toast.cpp` | ソース | Toast クラスの実装 |
| TerminalPage.xaml | `src/cascadia/TerminalApp/TerminalPage.xaml` | XAML | ActionSaveFailedToast TeachingTip のUI定義 |
| TerminalPage.h | `src/cascadia/TerminalApp/TerminalPage.h` | ソース | _actionSaveFailedToast メンバの宣言 |
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleSaveSnippet と ActionSaveFailed の実装 |
