# 通知設計書 10-暗号化キー不整合

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「暗号化キー不整合」通知の設計仕様を定義する。この通知は、暗号化キーの状態に問題がある場合に発生するエラーを通知するものである。

### 本通知の処理概要

**業務上の目的・背景**：エンドツーエンド暗号化を使用している場合、サーバーに登録されている暗号化キー ID とローカルの暗号化キー ID が一致している必要がある。登録プロセス中に問題が発生し、キー ID の不一致が検出された場合、ユーザーに状況を通知し、暗号化キーの再作成を促す必要がある。

**通知の送信タイミング**：同期イベント（`sync-event`）でタイプが `error`、サブタイプが `file-key-mismatch` の場合に発行される。これはサーバー側で暗号化キー ID の不一致が検出された際に発生する。

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

**通知内容の概要**：暗号化キーのリセットが必要である旨のエラーメッセージと、「Reset key」ボタン、詳細情報へのリンクが表示される。エラー種別は `error` として赤色の警告スタイルで表示される。

**期待されるアクション**：ユーザーは「Reset key」ボタンをクリックして暗号化キーを再作成する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `error` |
| 通知 ID | `invalid-key-state` |
| タイトル | Your encryption key need to be reset |
| 固定表示 | true（sticky） |
| ボタン | Reset key |
| スタイル | エラー背景色（赤系） |

### 本文テンプレート

```
Something went wrong when registering your encryption key id. You need to recreate your key. [Learn more](https://actualbudget.org/docs/getting-started/sync/#debugging-sync-issues)
```

（日本語訳：暗号化キー ID の登録中に問題が発生しました。キーを再作成する必要があります。[詳細を見る]）

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'error'` かつ `subtype === 'file-key-mismatch'` | 暗号化キー ID 不一致時 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| キー不一致 | サーバーとローカルの暗号化キー ID が異なる | Reset key ボタンで暗号化キーを再作成 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 通知メッセージには暗号化キーの内容を含まない
- キー ID の具体的な値はユーザーに表示されない
- 外部ドキュメントへのリンクは公開情報のみ

## 備考

- `sticky: true` が設定されているため、ユーザーが明示的に閉じるまで通知は消えない
- 通知 ID として `invalid-key-state` が設定されており、同一エラーの重複表示を防止
- 「Reset key」ボタンをクリックすると `create-encryption-key` モーダルが表示される
- キーの再作成後、同期が自動的に再開される
- i18next による国際化対応が行われている

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: ボタンの `action` は非同期関数を指定でき、クリック後に通知が自動的に閉じられる。

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

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

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

**主要処理フロー**:
1. **174行目**: `case 'file-key-mismatch':` でサブタイプを判定
2. **177-183行目**: タイトルとメッセージの定義
3. **184行目**: `sticky: true` の設定
4. **185行目**: `id: 'invalid-key-state'` の設定
5. **186-194行目**: Reset key ボタンの定義

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

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

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

**主要処理フロー**:
- `pushModal` で `create-encryption-key` モーダルを開く
- モーダルにはオプションが空のオブジェクトとして渡される

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

```
sync-event (type: 'error', subtype: 'file-key-mismatch')
    │
    └─ 通知オブジェクトを構築
           │
           ├─ title: 'Your encryption key need to be reset'
           ├─ message: 'キー登録エラーメッセージ + Learn more リンク'
           ├─ sticky: true
           ├─ id: 'invalid-key-state'
           └─ button: { title: 'Reset key', action: ... }
                  │
                  └─ dispatch(addNotification({ notification: { type: 'error', ...notif } }))
                         │
                         └─ Notifications.tsx (UI 表示)
                                │
                                └─ Reset key ボタンクリック時
                                       │
                                       └─ dispatch(pushModal({
                                              modal: { name: 'create-encryption-key', options: {} }
                                          }))
```

### データフロー図

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

同期処理 ───▶ サーバー応答 ───▶ file-key-mismatch エラー
(暗号化データ)        │                    │
                     ▼                    ▼
               sync-event 発行     subtype: 'file-key-mismatch'
                     │
                     ▼
               通知オブジェクト構築
               {
                 title, message,
                 button: Reset key,
                 sticky: true,
                 id: 'invalid-key-state'
               }
                     │
                     ▼
                画面に通知表示
                     │
                     ▼
              「Reset key」ボタン
                     │
                     ▼
           create-encryption-key
               モーダル表示
                     │
                     ▼
           新しい暗号化キー作成
```

### 関連ファイル一覧

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