# 通知設計書 5-同期認証失敗

## 概要

本ドキュメントは、Actual Budget アプリケーションにおける「同期認証失敗」通知の設計仕様を定義する。この通知は、サーバーとの同期時に認証に失敗した場合に発生する警告を通知するものである。

### 本通知の処理概要

**業務上の目的・背景**：クラウド同期機能を使用している場合、サーバーとの認証が必要である。認証トークンの期限切れや無効化、サーバー側の問題などにより認証に失敗した場合、ユーザーに状況を通知し、データの同期ができない状態であることを明確にする必要がある。

**通知の送信タイミング**：同期イベント（`sync-event`）でタイプが `unauthorized` の場合に発行される。これはサーバーが認証エラー（401 Unauthorized など）を返した際に発生する。

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

**通知内容の概要**：サーバーとの認証に失敗した旨の警告メッセージが表示される。警告種別は `warning` として黄色の警告スタイルで表示される。この通知は `sticky`（固定表示）であり、ユーザーが明示的に閉じるまで消えない。

**期待されるアクション**：ユーザーは再度ログインするか、サーバー設定を確認する。セッションの再確立が必要な場合がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | `warning` |
| 通知 ID | `auth-issue` |
| タイトル | なし |
| 固定表示 | true（sticky） |
| スタイル | 警告背景色（黄系） |

### 本文テンプレート

```
Unable to authenticate with server
```

（日本語訳：サーバーとの認証ができませんでした）

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 同期イベント | `sync-event` | `type === 'unauthorized'` | サーバー認証エラー発生時 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期処理開始] --> B[サーバーへリクエスト]
    B --> C{認証結果}
    C -->|認証失敗| D[sync-event type:unauthorized 発行]
    C -->|認証成功| E[同期処理続行]
    D --> F[listenForSyncEvent でイベント受信]
    F --> G[addNotification 発行]
    G --> H[Redux Store に通知追加]
    H --> I[Notifications コンポーネントで通知表示]
    I --> J[ユーザーが閉じるまで表示継続]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 認証失敗 | サーバーが 401 エラーを返した | ユーザーに再ログインを促す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（同期イベント発生時に即座に通知）

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

- 通知メッセージには機密情報を含まない
- 認証トークンやエラー詳細は通知に含まれない
- ユーザーが対処するための一般的な案内のみを表示

## 備考

- `sticky: true` が設定されているため、ユーザーが明示的に閉じるまで通知は消えない
- 通知 ID として `auth-issue` が設定されており、同一エラーの重複表示を防止
- この通知は `warning` タイプであり、`error` タイプよりも軽度の問題を示す
- 同期が再度成功した場合、この通知は自動的に消去されない（ユーザーが手動で閉じる必要がある）

---

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

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

### 推奨読解順序

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

通知の型定義と同期イベントの構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | `Notification` 型の `sticky` プロパティに注目 |
| 1-2 | server-events.ts | `packages/loot-core/src/types/server-events.ts` | 同期イベントの型定義を確認 |

**読解のコツ**: `sticky: true` の場合、タイムアウトによる自動消去が行われない。

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

同期イベントリスナーを特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | `listenForSyncEvent` 関数（23-383行目）を確認 |

**主要処理フロー**:
1. **25-38行目**: `sync-event` イベントをリッスン
2. **26-37行目**: `type === 'unauthorized'` の場合の処理
3. **27-36行目**: `addNotification` で警告通知を発行

#### Step 3: 通知オプションを理解する

通知の各オプションの効果を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | `sticky` プロパティの処理（132-134行目）を確認 |

**主要処理フロー**:
- **132-134行目**: `sticky` が `false` の場合のみタイムアウトが設定される

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

```
listenForSyncEvent (sync-events.ts)
    │
    └─ listen('sync-event', callback)
           │
           └─ event.type === 'unauthorized'
                  │
                  └─ store.dispatch(addNotification({
                         notification: {
                             type: 'warning',
                             message: 'Unable to authenticate with server',
                             sticky: true,
                             id: 'auth-issue'
                         }
                     }))
                         │
                         └─ notificationsSlice (Redux Store 更新)
                                 │
                                 └─ Notifications.tsx (UI 表示)
                                         └─ sticky: true → タイムアウトなし
```

### データフロー図

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

同期リクエスト ───▶ サーバー認証 ───▶ 認証失敗
                        │              (401 Unauthorized)
                        │                    │
                        ▼                    ▼
              sync-event 発行         type: 'unauthorized'
                        │
                        ▼
              listenForSyncEvent
                        │
                        ▼
              addNotification 発行
              {
                type: 'warning',
                sticky: true,
                id: 'auth-issue'
              }
                        │
                        ▼
                画面に通知表示
                (ユーザーが閉じるまで継続)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sync-events.ts | `packages/desktop-client/src/sync-events.ts` | ソース | 同期イベントリスナー（unauthorized 処理） |
| notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | ソース | 通知の Redux Slice |
| Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | ソース | 通知表示用 React コンポーネント |
| server-events.ts | `packages/loot-core/src/types/server-events.ts` | ソース | サーバーイベントの型定義 |
