# 通知設計書 8-データ同期不整合（初回）

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「データ同期不整合（初回）」通知の設計仕様を定義する。この通知は、データの同期に問題が発生した場合の初回警告を通知するものである。

### 本通知の処理概要

**業務上の目的・背景**：データ同期中に CRDT（Conflict-free Replicated Data Type）の整合性エラーなどが発生した場合、ユーザーにその状況を通知し、修復の機会を提供する必要がある。初回のエラーでは、比較的軽度な対処（修復ボタン）を提案し、ユーザーに最小限の影響で問題を解決できるようにする。

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

**通知の受信者**：同期エラーが発生したユーザー（ローカルのクライアント）。

**通知内容の概要**：データ同期に問題が発生した旨の警告と、修復を試みる「Repair」ボタン、および詳細情報へのリンクが表示される。警告種別は `warning` として黄色の警告スタイルで表示される。

**期待されるアクション**：ユーザーは「Repair」ボタンをクリックして同期の修復を試みるか、リンクから詳細情報を確認して対処方法を決定する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `warning` |
| 通知 ID | `repair-sync` |
| タイトル | Your data is out of sync |
| 固定表示 | true（sticky） |
| ボタン | Repair |
| スタイル | 警告背景色（黄系） |

### 本文テンプレート

```
There was a problem syncing your data. We can try to repair your sync state to fix it. [Learn more](https://actualbudget.org/docs/getting-started/sync/#debugging-sync-issues)
```

（日本語訳：データの同期に問題がありました。同期状態を修復して解決を試みることができます。[詳細を見る]）

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'error'` かつ `subtype === 'out-of-sync'` かつ `attemptedSyncRepair === false` | 初回の同期エラー時 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 同期エラー | CRDT 整合性エラー等 | 修復ボタンで sync-repair を実行 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- `sticky: true` が設定されているため、ユーザーが明示的に閉じるまで通知は消えない
- 通知 ID として `repair-sync` が設定されており、同一エラーの重複表示を防止
- 「Repair」ボタンをクリックすると `attemptedSyncRepair` フラグが `true` に設定され、`sync-repair` API が呼び出される
- 修復が成功すると「同期修復完了」通知が表示される
- 修復が失敗すると「データ同期不整合（修復後）」通知が表示される
- i18next による国際化対応が行われている

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: `type: 'warning'` は `error` よりも軽度な問題を示す。

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

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

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

**主要処理フロー**:
1. **97行目**: `case 'out-of-sync':` でサブタイプを判定
2. **116-139行目**: `attemptedSyncRepair === false` の場合（初回エラー）
3. **119-139行目**: 初回エラー通知のオブジェクト構築
4. **127行目**: `type: 'warning'` の設定
5. **131-136行目**: Repair ボタンの定義

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | Repair ボタンアクション（132-135行目）を確認 |

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

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

```
sync-event (type: 'error', subtype: 'out-of-sync')
    │
    └─ attemptedSyncRepair === false
           │
           └─ 初回エラー通知を構築
                  │
                  ├─ title: 'Your data is out of sync'
                  ├─ message: '同期問題メッセージ + Learn more リンク'
                  ├─ type: 'warning'
                  ├─ sticky: true
                  ├─ id: 'repair-sync'
                  └─ button: { title: 'Repair', action: ... }
                         │
                         └─ dispatch(addNotification({ notification: { type: 'error', ...notif } }))
                                │
                                └─ Notifications.tsx (UI 表示)
                                       │
                                       └─ Repair ボタンクリック時
                                              │
                                              ├─ attemptedSyncRepair = true
                                              ├─ send('sync-repair')
                                              └─ dispatch(sync())
```

### データフロー図

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

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

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | sync アクション定義 |
