# 通知設計書 19-YAMLコピー失敗

## 概要

本ドキュメントは、YAMLスキーマのクリップボードへのコピーが失敗した際に表示されるUI通知（トースト）の設計書である。

### 本通知の処理概要

ERD（Entity-Relationship Diagram）ビューアーのエクスポート機能で「Copy YAML」を選択し、クリップボードへの書き込み処理が失敗した場合にエラー通知をトースト形式で表示する機能である。

**業務上の目的・背景**：データベース設計者や開発者がYAMLをクリップボードにコピーしようとした際に、ブラウザのセキュリティ制限やその他の技術的な理由でコピーが失敗することがある。この通知は、ユーザーにコピー操作が失敗したことを即座に伝え、再試行または代替手段の検討を促すために必要である。YAML生成自体は成功しているがクリップボード書き込みが失敗した場合に表示される。

**通知の送信タイミング**：ExportDropdownコンポーネントで「Copy YAML」メニューアイテムをクリックし、YAML生成は成功したがnavigator.clipboard.writeText()によるクリップボード書き込みが失敗した時点で即座にトースト通知が表示される。

**通知の受信者**：コピー操作を実行したユーザー。操作を実行しているブラウザセッション上にのみ表示される。

**通知内容の概要**：タイトル「Copy failed」とステータス「error」で赤色のトースト通知が表示される。説明文には「Failed to copy YAML to clipboard: {エラーメッセージ}」が表示される。

**期待されるアクション**：ユーザーは通知を確認後、再度コピー操作を試みるか、ブラウザの設定を確認するか、代替の方法（ファイルダウンロードなど）を検討することが期待される。

## 通知種別

UI通知（トースト）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（クライアントサイド即時表示） |
| 優先度 | 高（エラー通知） |
| リトライ | なし（UI通知のため再送は不要） |

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

操作を実行したユーザーのブラウザセッションに対して即座に表示される。ToastContextを通じて管理されるグローバルなトースト表示機能により、現在アクティブなウィンドウに通知が表示される。

## 通知テンプレート

### UI通知の場合

| 項目 | 内容 |
|-----|------|
| タイトル | Copy failed |
| 説明 | Failed to copy YAML to clipboard: {error.message} |
| ステータス | error |
| 表示位置 | header（画面上部） |

### 本文テンプレート

```
タイトル: Copy failed
説明: Failed to copy YAML to clipboard: {error.message}
ステータス: error
```

### 添付ファイル

該当なし（UI通知のため添付ファイルは存在しない）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| error.message | クリップボード書き込みエラーの詳細メッセージ | navigator.clipboard.writeText()のエラーオブジェクト | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | ExportDropdownの「Copy YAML」クリック | YAML生成成功 かつ navigator.clipboard.writeText()が失敗した場合 | YAMLコピー処理の失敗時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| コピー成功時 | clipboardResult.isOk()の場合は本通知は表示されない |
| YAML生成失敗時 | yamlResult.isErr()の場合は「Export failed」通知が代わりに表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Copy YAMLメニュークリック] --> B{Clipboard API利用可能?}
    B -->|No| C[Clipboard unavailable通知]
    B -->|Yes| D[yamlSchemaDeparser実行]
    D --> E{YAML生成成功?}
    E -->|No| F[Export failed通知]
    E -->|Yes| G[navigator.clipboard.writeText]
    G --> H{コピー結果}
    H -->|成功| I[成功通知表示]
    H -->|失敗| J[toast関数呼び出し]
    J --> K[エラートースト通知表示]
```

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

### 参照テーブル一覧

本通知はクライアントサイドのみで動作するため、直接のデータベース参照は行わない。

### 更新テーブル一覧

本通知はデータベース更新を行わない。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| クリップボード書き込みエラー | navigator.clipboard.writeText()がPromiseをreject | エラーメッセージを表示し、コンソールにエラーログを出力 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（ユーザーによる手動再試行が必要） |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

24時間対応（UI通知のため時間帯制限なし）

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

- エラーメッセージにはクリップボードAPIのエラー内容が含まれる（通常は技術的なエラー情報のみ）
- クリップボードへのアクセスはブラウザのセキュリティポリシーに従う
- ユーザーの操作によってのみ処理が実行される

## 備考

- 本通知はRadix UI Toastコンポーネントを使用して実装されている
- トーストは一定時間後に自動的に非表示となる
- neverthrowライブラリのfromPromiseを使用して非同期処理の結果をResultで扱う
- コンソールにもエラーログが出力される
- Clipboard API未対応の場合は別のエラー通知（Clipboard unavailable）が表示される
- YAML生成失敗の場合は別のエラー通知（Export failed）が表示される

---

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

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

### 推奨読解順序

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

トースト通知のオプション型定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.ts | `frontend/packages/ui/src/components/Toast/types.ts` | ToastOptions型（title, description, status）の定義を確認 |

**読解のコツ**: ToastOptionsのstatusフィールドが'error'の場合にエラースタイルが適用される。

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

ExportDropdownコンポーネントからコピー処理と通知が発火する流れを把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ExportDropdown.tsx | `frontend/packages/erd-core/src/features/erd/components/ERDRenderer/AppBar/ExportDropdown/ExportDropdown.tsx` | handleCopyYaml関数でのエラーハンドリング（行93-100） |

**主要処理フロー**:
1. **行57-102**: handleCopyYaml関数の定義
2. **行67**: yamlSchemaDeparserでYAML生成
3. **行69-78**: YAML生成エラー時のハンドリング（これは別の通知）
4. **行81-83**: fromPromiseでクリップボード書き込み（PromiseをResultに変換）
5. **行85-101**: clipboardResult.matchで成功/失敗ハンドリング
6. **行93-100**: 失敗時のエラーハンドリング
7. **行94**: console.errorでエラーログ出力
8. **行95-99**: toast関数でエラー通知を生成

#### Step 3: トースト表示機構を理解する

トースト通知の表示ロジックを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Toast.tsx | `frontend/packages/ui/src/components/Toast/Toast.tsx` | ToastProvider、error状態のスタイル適用（行32） |
| 3-2 | useToast.tsx | `frontend/packages/ui/src/components/Toast/useToast.tsx` | useToastフックの実装 |

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

```
ExportDropdown (handleCopyYaml)
    |
    +-- navigator.clipboard チェック
    |
    +-- yamlSchemaDeparser(schema.current)
    |       |
    |       +-- isOk(): YAML文字列を返す
    |
    +-- fromPromise(navigator.clipboard.writeText(yamlContent))
    |
    +-- clipboardResult.match()
            |
            +-- 成功: toast({ title: 'YAML copied!', status: 'success' })
            |
            +-- 失敗: console.error() + toast({ title: 'Copy failed', status: 'error' })
                            |
                            +-- ToastContext.createHeaderToastItem()
                                    |
                                    +-- Toast (Radix UI Toast)
```

### データフロー図

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

schema.current    yamlSchemaDeparser         Result<YAML文字列>
(スキーマ     --->       (YAML生成)       --->      |
オブジェクト)                                       |
                                              [isOk()の場合]
                                                    |
                                                    v
                                        navigator.clipboard.writeText()
                                                    |
                                                    v
                                        fromPromise (Result化)
                                                    |
                                             [Promiseがreject]
                                                    |
                                                    v
                                        clipboardResult.match()
                                                    |
                                               [失敗ハンドラ]
                                                    |
                                              +-----+-----+
                                              |           |
                                       console.error()  toast()
                                                           |
                                                           v
                                               [トースト通知表示]
                                               title: "Copy failed"
                                               status: "error"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ExportDropdown.tsx | `frontend/packages/erd-core/src/features/erd/components/ERDRenderer/AppBar/ExportDropdown/ExportDropdown.tsx` | ソース | ERDビューアーのエクスポートドロップダウン |
| ExportDropdown.tsx | `frontend/apps/app/components/SessionDetailPage/components/Output/components/Header/ExportDropdown.tsx` | ソース | アプリ側のエクスポートドロップダウン（同様の実装） |
| yamlSchemaDeparser.ts | `frontend/packages/schema/src/deparser/yamlSchemaDeparser.ts` | ソース | YAML生成 |
| Toast.tsx | `frontend/packages/ui/src/components/Toast/Toast.tsx` | ソース | トースト通知コンポーネント |
| useToast.tsx | `frontend/packages/ui/src/components/Toast/useToast.tsx` | ソース | トースト表示フック |
| Toast.module.css | `frontend/packages/ui/src/components/Toast/Toast.module.css` | スタイル | トースト通知のスタイル定義 |
