# 通知設計書 9-同期フォーマット更新通知

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「同期フォーマット更新通知」の設計仕様を定義する。この通知は、同期フォーマットが変更され、同期のリセットが必要な場合に発生する通知である。

### 本通知の処理概要

**業務上の目的・背景**：アプリケーションの内部同期フォーマット（データ構造やプロトコル）が更新された場合、古いフォーマットで保存されたデータは新しいフォーマットと互換性がない可能性がある。この通知は、そのような稀なケースでユーザーに状況を説明し、同期リセットを実行するよう案内する。また、暗号化を使用している場合は暗号化キーのリセットも必要であることを示す。

**通知の送信タイミング**：同期イベント（`sync-event`）でタイプが `error`、サブタイプが `file-old-version` の場合に発行される。これはサーバー側で同期フォーマットのバージョン不一致が検出された際に発生する。

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

**通知内容の概要**：同期フォーマットが更新されたこと、同期リセットが必要であること、暗号化キーのリセット方法へのリンクが表示される。「Reset sync」ボタンと詳細情報へのリンクが提供される。エラー種別は `error` として赤色の警告スタイルで表示される。

**期待されるアクション**：ユーザーは「Reset sync」ボタンをクリックして同期をリセットする。暗号化を使用している場合は、事前に暗号化キーのリセットを行う。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `error` |
| 通知 ID | `old-file` |
| タイトル | Actual has updated the syncing format |
| 固定表示 | true（sticky） |
| ボタン | Reset sync |
| メッセージアクション | makeKey（暗号化キー作成モーダルを開く） |
| スタイル | エラー背景色（赤系） |

### 本文テンプレート

```
This happens rarely (if ever again). The internal syncing format has changed and you need to reset sync. This will upload data from this device and revert all other devices. [Learn more about what this means](https://actualbudget.org/docs/getting-started/sync/#what-does-resetting-sync-mean).

Old encryption keys are not migrated. If using encryption, [reset encryption here](#makeKey).
```

（日本語訳：これは稀に（もう二度と起こらないかもしれませんが）発生します。内部同期フォーマットが変更されたため、同期をリセットする必要があります。これにより、このデバイスからデータがアップロードされ、他のすべてのデバイスが元に戻ります。[これが何を意味するか詳しく見る]

古い暗号化キーは移行されません。暗号化を使用している場合は、[ここで暗号化をリセット]してください。）

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'error'` かつ `subtype === 'file-old-version'` | 同期フォーマットバージョン不一致時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 同一 ID の通知が存在 | `old-file` の ID を持つ通知が既に表示されている場合は重複追加しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期処理実行] --> B[サーバーへリクエスト]
    B --> C{同期フォーマットバージョン}
    C -->|不一致| D[sync-event type:error, subtype:file-old-version 発行]
    C -->|一致| E[同期処理続行]
    D --> F[listenForSyncEvent でイベント受信]
    F --> G[通知オブジェクト構築]
    G --> H[addNotification 発行]
    H --> I[Redux Store に通知追加]
    I --> J[Notifications コンポーネントで通知表示]
    J --> K{ユーザーアクション}
    K -->|Reset sync| L[resetSync アクション実行]
    K -->|makeKey リンク| M[暗号化キー作成モーダル表示]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| フォーマット不一致 | 同期フォーマットのバージョンが古い | Reset sync ボタンで同期をリセット |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 通知メッセージには機密情報を含まない
- 暗号化キーのリセットリンクは、暗号化を使用しているユーザーに対するガイダンス
- 外部ドキュメントへのリンクは公開情報のみ

## 備考

- `sticky: true` が設定されているため、ユーザーが明示的に閉じるまで通知は消えない
- 通知 ID として `old-file` が設定されており、同一エラーの重複表示を防止
- `messageActions` に `makeKey` アクションが設定されており、メッセージ内の `#makeKey` リンクをクリックすると暗号化キー作成モーダルが表示される
- このエラーは稀に発生し、アプリケーションのメジャーアップデート時などに起こり得る
- i18next による国際化対応が行われている

---

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

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

### 推奨読解順序

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

通知の型定義と messageActions を理解する。

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

**読解のコツ**: `messageActions` は `Record<string, () => void>` 型で、メッセージ内の `#アクション名` リンクと対応する。

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

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

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

**主要処理フロー**:
1. **142行目**: `case 'file-old-version':` でサブタイプを判定
2. **145-148行目**: タイトルとメッセージの定義
3. **155-161行目**: `messageActions` の定義（makeKey アクション）
4. **163-168行目**: Reset sync ボタンの定義

#### Step 3: メッセージアクションを理解する

makeKey アクションの動作を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | messageActions の makeKey（156-160行目）を確認 |

**主要処理フロー**:
- `makeKey` アクションは `create-encryption-key` モーダルを開く
- `pushModal` アクションを使用してモーダルスタックに追加

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

```
sync-event (type: 'error', subtype: 'file-old-version')
    │
    └─ 通知オブジェクトを構築
           │
           ├─ title: 'Actual has updated the syncing format'
           ├─ message: 'フォーマット更新メッセージ + リンク'
           ├─ messageActions: { makeKey: () => pushModal(...) }
           ├─ sticky: true
           ├─ id: 'old-file'
           └─ button: { title: 'Reset sync', action: resetSync }
                  │
                  └─ dispatch(addNotification({ notification: { type: 'error', ...notif } }))
                         │
                         └─ Notifications.tsx (UI 表示)
                                │
                                ├─ Reset sync ボタンクリック時
                                │      └─ dispatch(resetSync())
                                │
                                └─ #makeKey リンククリック時
                                       └─ dispatch(pushModal({ modal: { name: 'create-encryption-key' } }))
```

### データフロー図

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

同期処理 ───▶ サーバー応答 ───▶ file-old-version エラー
                   │                    │
                   ▼                    ▼
             sync-event 発行     subtype: 'file-old-version'
                   │
                   ▼
             通知オブジェクト構築
             {
               title, message,
               messageActions: { makeKey },
               button: Reset sync,
               sticky: true,
               id: 'old-file'
             }
                   │
                   ▼
              画面に通知表示
                   │
          ┌────────┴────────┐
          ▼                 ▼
    Reset sync       #makeKey リンク
          │                 │
          ▼                 ▼
    resetSync()     create-encryption-key
                       モーダル表示
```

### 関連ファイル一覧

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