# 通知設計書 6-同期修復完了

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「同期修復完了」通知の設計仕様を定義する。この通知は、同期の修復が成功した場合にユーザーに成功を通知するものである。

### 本通知の処理概要

**業務上の目的・背景**：データ同期に問題が発生した場合、ユーザーは「修復」ボタンを押して同期状態の修復を試みることができる。修復が成功した場合、この通知によってユーザーに成功を伝え、安心して予算管理を続けられることを示す。

**通知の送信タイミング**：同期イベント（`sync-event`）でタイプが `success` または `applied` の場合で、かつ事前に同期修復が試みられていた（`attemptedSyncRepair` フラグが `true`）場合に発行される。

**通知の受信者**：同期修復を試みたユーザー（ローカルのクライアント）。

**通知内容の概要**：同期が修復されたことを示すタイトルと、「Happy budgeting!」というポジティブなメッセージが表示される。メッセージ種別は `message` として緑色の成功スタイルで表示される。

**期待されるアクション**：特に追加のアクションは不要。ユーザーは通常の予算管理作業を継続できる。

## 通知種別

アプリ内通知（トースト通知）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（イベント駆動） |
| 優先度 | 低 |
| リトライ | 無し |

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

- 同期修復を試みたローカルユーザーに対してのみ通知が表示される
- 他のユーザーやセッションには影響しない

## 通知テンプレート

### アプリ内通知の場合

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `message` |
| タイトル | Syncing has been fixed! |
| 固定表示 | false（自動消去） |
| スタイル | 成功背景色（緑系） |

### 本文テンプレート

```
Happy budgeting!
```

（日本語訳：楽しい予算管理を！）

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | この通知は固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'success' \|\| type === 'applied'` かつ `attemptedSyncRepair === true` | 同期修復後の成功時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| attemptedSyncRepair が false | 修復が試みられていない通常の同期成功では通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期エラー発生] --> B[ユーザーが修復ボタンをクリック]
    B --> C[sync-repair API 呼び出し]
    C --> D[attemptedSyncRepair フラグを true に設定]
    D --> E[sync アクション実行]
    E --> F{同期結果}
    F -->|success/applied| G{attemptedSyncRepair?}
    G -->|true| H[addNotification 発行]
    G -->|false| I[通知なし]
    F -->|error| J[エラー通知発行]
    H --> K[attemptedSyncRepair を false にリセット]
    K --> L[Redux Store に通知追加]
    L --> M[Notifications コンポーネントで通知表示]
    M --> N[6.5秒後に自動消去]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | この通知はDBを参照しない | Redux Store とローカル変数のみ使用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | データベースへの永続化は行わない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | この通知は成功時のみ発行 | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 対象外（成功通知のため） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（同期成功時に即座に通知）

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

- 通知メッセージには機密情報を含まない
- 単純な成功メッセージのみを表示

## 備考

- `sticky` プロパティが設定されていないため、デフォルトのタイムアウト（6.5秒）後に自動的に消去される
- `attemptedSyncRepair` はクロージャ内のローカル変数として管理される
- 修復成功後は `attemptedSyncRepair` が `false` にリセットされ、以降の通常同期成功では通知が発行されない
- i18next による国際化対応が行われている（タイトルとメッセージの両方）

---

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

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

### 推奨読解順序

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

通知の型定義と同期修復フラグを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | `Notification` 型の `title` プロパティに注目 |

**読解のコツ**: この通知には `title` と `message` の両方が設定される。

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

同期イベントリスナーと修復フラグを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | `listenForSyncEvent` 関数内の `attemptedSyncRepair` 変数（40行目）と success/applied 処理（49-62行目）を確認 |

**主要処理フロー**:
1. **40行目**: `attemptedSyncRepair` フラグ初期化（`false`）
2. **49行目**: `success` または `applied` イベントの処理開始
3. **50-61行目**: `attemptedSyncRepair` が `true` の場合、通知を発行
4. **51行目**: フラグを `false` にリセット

#### Step 3: 修復トリガーを理解する

修復ボタンのアクションを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | `out-of-sync` サブタイプの処理（116-139行目）で修復ボタンを確認 |

**主要処理フロー**:
- **132-135行目**: 修復ボタンのアクション
- **133行目**: `attemptedSyncRepair = true` に設定
- **134行目**: `sync-repair` API 呼び出し
- **135行目**: `sync()` アクション実行

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

```
データ同期不整合（初回）通知
    │
    └─ 修復ボタンクリック
           │
           ├─ attemptedSyncRepair = true
           ├─ send('sync-repair')
           └─ dispatch(sync())
                  │
                  └─ sync-event 発生
                         │
                         └─ type === 'success' || type === 'applied'
                                │
                                └─ attemptedSyncRepair === true
                                       │
                                       ├─ attemptedSyncRepair = false
                                       └─ dispatch(addNotification({
                                              title: 'Syncing has been fixed!',
                                              message: 'Happy budgeting!',
                                              type: 'message'
                                          }))
                                              │
                                              └─ Notifications.tsx (UI 表示)
```

### データフロー図

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

同期エラー ───▶ 修復ボタン ───▶ attemptedSyncRepair = true
                    │                    │
                    │                    ▼
                    │              sync-repair API
                    │                    │
                    │                    ▼
                    │              sync() 実行
                    │                    │
                    ▼                    ▼
              sync-event 発生 ───▶ type: success/applied
                                        │
                                        ▼
                               attemptedSyncRepair チェック
                                        │
                                 ┌──────┴──────┐
                                 ▼             ▼
                              true          false
                                │             │
                                ▼             ▼
                         通知発行        通知なし
                   {title, message, type}
                                │
                                ▼
                          画面に通知表示
                          (6.5秒後自動消去)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sync-events.ts | `packages/desktop-client/src/sync-events.ts` | ソース | 同期イベントリスナー（修復成功処理） |
| notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | ソース | 通知の Redux Slice |
| Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | ソース | 通知表示用 React コンポーネント |
| appSlice.ts | `packages/desktop-client/src/app/appSlice.ts` | ソース | sync アクション定義 |
