# 通知設計書 7-データ同期不整合（修復後）

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「データ同期不整合（修復後）」通知の設計仕様を定義する。この通知は、同期修復を試みたが失敗した場合に発生するエラーを通知するものである。

### 本通知の処理概要

**業務上の目的・背景**：データ同期に問題が発生し、ユーザーが修復を試みた際に、修復が失敗することがある。この場合、より強力な対処（同期状態のリセット）が必要であることをユーザーに通知し、適切な次のステップを案内する必要がある。

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

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

**通知内容の概要**：データがまだ同期されていない状態であること、修復が失敗したこと、同期状態のリセットが必要であることが表示される。「Reset sync」ボタンと、詳細情報へのリンクが提供される。エラー種別は `error` として赤色の警告スタイルで表示される。

**期待されるアクション**：ユーザーは「Reset sync」ボタンをクリックして同期状態をリセットするか、リンクから詳細情報を確認して対処方法を決定する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `error` |
| 通知 ID | `reset-sync` |
| タイトル | Your data is still out of sync |
| 固定表示 | true（sticky） |
| ボタン | Reset sync |
| スタイル | エラー背景色（赤系） |

### 本文テンプレート

```
We were unable to repair your sync state, sorry! You need to reset your sync state. [Learn more](https://actualbudget.org/docs/getting-started/sync/#debugging-sync-issues)
```

（日本語訳：申し訳ありませんが、同期状態を修復できませんでした。同期状態をリセットする必要があります。[詳細を見る]）

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'error'` かつ `subtype === 'out-of-sync'` かつ `attemptedSyncRepair === true` | 同期修復失敗時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| attemptedSyncRepair が false | 修復が試みられていない初回のエラーでは別の通知が発行される |
| 同一 ID の通知が存在 | `reset-sync` の ID を持つ通知が既に表示されている場合は重複追加しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期エラー発生 - out-of-sync] --> B[ユーザーが修復ボタンをクリック]
    B --> C[sync-repair API 呼び出し]
    C --> D[attemptedSyncRepair フラグを true に設定]
    D --> E[sync アクション実行]
    E --> F{同期結果}
    F -->|error: out-of-sync| G{attemptedSyncRepair?}
    G -->|true| H[修復失敗通知を発行]
    G -->|false| I[初回エラー通知を発行]
    H --> J[Redux Store に通知追加]
    J --> K[Notifications コンポーネントで通知表示]
    K --> L[ユーザーが閉じるか Reset sync を実行]
    L -->|Reset sync| M[resetSync アクション実行]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知自体はDBを更新しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 修復失敗 | sync-repair が同期を修復できなかった | 同期リセットを促す |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（ユーザー操作待ち） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（同期エラー発生時に即座に通知）

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

- 通知メッセージには機密情報を含まない
- 外部ドキュメントへのリンクは公開情報のみ

## 備考

- `sticky: true` が設定されているため、ユーザーが明示的に閉じるまで通知は消えない
- 通知 ID として `reset-sync` が設定されており、同一エラーの重複表示を防止
- 「Reset sync」ボタンをクリックすると `resetSync` アクションが実行される
- 外部リンク（Learn more）はデバッグ情報のドキュメントへ誘導する
- i18next による国際化対応が行われている

---

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

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

### 推奨読解順序

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

通知の型定義とボタンオプションを理解する。

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

**読解のコツ**: `button` オブジェクトには `title` と `action` が含まれ、クリック時に非同期アクションを実行できる。

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

同期エラーイベントのハンドリングを特定する。

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

**主要処理フロー**:
1. **97行目**: `case 'out-of-sync':` でサブタイプを判定
2. **98-115行目**: `attemptedSyncRepair === true` の場合（修復失敗）
3. **99-115行目**: 修復失敗通知のオブジェクト構築
4. **109-113行目**: Reset sync ボタンの定義

#### Step 3: ボタンアクションを理解する

Reset sync ボタンのアクションを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | appSlice.ts | `packages/desktop-client/src/app/appSlice.ts` | `resetSync` アクションの定義を確認 |

**主要処理フロー**:
- `resetSync` アクションは同期状態を完全にリセットし、サーバーとの同期をやり直す

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

```
sync-event (type: 'error', subtype: 'out-of-sync')
    │
    └─ attemptedSyncRepair === true
           │
           └─ 修復失敗通知を構築
                  │
                  ├─ title: 'Your data is still out of sync'
                  ├─ message: '修復失敗メッセージ + Learn more リンク'
                  ├─ sticky: true
                  ├─ id: 'reset-sync'
                  └─ button: { title: 'Reset sync', action: resetSync }
                         │
                         └─ dispatch(addNotification({ notification: { type: 'error', ...notif } }))
                                │
                                └─ Notifications.tsx (UI 表示)
                                       │
                                       └─ ボタンクリック時
                                              │
                                              └─ dispatch(resetSync())
```

### データフロー図

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

修復試行後 ───▶ sync-event ───▶ type: 'error'
sync エラー          │           subtype: 'out-of-sync'
                     │                    │
                     ▼                    ▼
           attemptedSyncRepair チェック
                     │
              ┌──────┴──────┐
              ▼             ▼
           true          false
           (修復失敗)      (初回エラー)
              │             │
              ▼             ▼
      修復失敗通知      初回エラー通知
      (reset-sync)     (repair-sync)
              │
              ▼
         画面に通知表示
         (sticky: true)
              │
              ▼
      「Reset sync」ボタン
              │
              ▼
      resetSync() 実行
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sync-events.ts | `packages/desktop-client/src/sync-events.ts` | ソース | 同期イベントリスナー（out-of-sync 処理） |
| 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` | ソース | resetSync アクション定義 |
