# 通知設計書 12-ファイルアップロード必要

## 概要

本ドキュメントは、Actualアプリケーションにおける「ファイルアップロード必要」エラー通知の設計仕様を定義する。この通知は、クラウドファイル作成時に問題が発生し、ファイルのアップロードが必要な場合に表示される。

### 本通知の処理概要

この通知は、同期処理中にサーバー側でファイルのアップロードが必要と判断された場合（file-needs-upload エラー）に発行される。これは、クラウドファイル作成プロセスが中断された、またはサーバー上のファイル状態が不整合になった場合に発生する。

**業務上の目的・背景**：クラウドファイル作成プロセスは複数のステップで構成されており、途中で失敗する可能性がある。例えば、ファイルIDは生成されたがデータのアップロードが完了していない状態などが考えられる。この通知は、そのような不完全な状態を検出し、ユーザーに修復アクションを促すことで、データの整合性を確保する目的がある。

**通知の送信タイミング**：同期処理（fullSync）の実行時に、サーバーから`file-needs-upload`エラーが返却された場合に発行される。具体的には、cloudFileIdは存在するがサーバー上にファイルデータが存在しない、またはファイルのメタデータとデータの整合性が取れない場合にトリガーされる。

**通知の受信者**：現在アプリケーションを操作しているユーザー。通知はアプリ内のUIに直接表示されるため、ログイン中のユーザーが受信者となる。

**通知内容の概要**：クラウドファイル作成時に問題が発生したことを伝え、ファイルをアップロードして問題を修復する必要があることを説明する。また、詳細情報へのリンク（Learn more）を提供する。

**期待されるアクション**：ユーザーは「Upload」ボタンをクリックして同期リセット処理を実行し、ローカルファイルをサーバーにアップロードすることが期待される。

## 通知種別

アプリ内通知（In-App Notification）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（イベントリスナー経由） |
| 優先度 | 高（error） |
| リトライ | 無し（ユーザーアクション依存） |

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

通知は現在アクティブなブラウザ/アプリウィンドウに表示される。特定のユーザー選定ロジックは存在せず、同期エラーが発生したセッションに対して直接通知が発行される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | error |
| タイトル | File needs upload |
| sticky | true（手動で閉じるまで表示継続） |
| 識別ID | upload-file |

### 本文テンプレート

```
Something went wrong when creating this cloud file. You need to upload this file to fix it.
[Learn more](https://actualbudget.org/docs/getting-started/sync/#debugging-sync-issues)
```

### ボタン

| ボタン名 | アクション |
|---------|----------|
| Upload | resetSync実行（同期リセット＋アップロード） |

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| 該当なし | 固定テキストのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| イベント | sync-event (type: error, subtype: file-needs-upload) | クラウドファイル作成が不完全 | 同期処理でファイルデータが不完全な場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 予算ファイル未読み込み | prefs.local.idが未設定の場合、通知は発行されない |
| 同一ID通知が表示中 | id: 'upload-file' の通知が既に表示中の場合、重複発行されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期処理開始] --> B{ファイル状態チェック}
    B -->|データ不完全| C[file-needs-upload エラー発生]
    B -->|正常| D[通常の同期処理継続]
    C --> E[sync-event エミット]
    E --> F[listenForSyncEvent がキャッチ]
    F --> G[通知オブジェクト作成]
    G --> H[addNotification ディスパッチ]
    H --> I[UI に通知表示]
    I --> J{ユーザーアクション}
    J -->|Upload クリック| K[resetSync 実行]
    K --> L[sync-reset API呼び出し]
    L --> M{リセット成功?}
    M -->|成功| N[sync 実行]
    N --> O[通知自動削除]
    M -->|失敗| P[エラーモーダル表示]
    J -->|閉じるボタン| Q[通知削除]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| metadata (JSON) | cloudFileId, groupId の確認 | ファイルシステム上の metadata.json |

### テーブル別参照項目詳細

#### metadata.json

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| cloudFileId | クラウドファイルID確認 | 同期処理時に参照 |
| groupId | 同期グループID確認 | 同期処理時に参照 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| metadata.json | UPDATE | resetSync実行時にgroupIdを更新 |
| messages_crdt | DELETE/INSERT | 同期リセット時にCRDTメッセージを再構築 |
| messages_clock | UPDATE | 同期クロックをリセット |

#### 同期リセット時の更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | groupId | サーバー返却値 | リセット成功時 |
| UPDATE | lastUploaded | 現在日付 | アップロード成功時 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 暗号化キー不足 | 暗号化有効だがキーがない | fix-encryption-keyモーダル表示 |
| 暗号化失敗 | 暗号化処理でエラー | create-encryption-keyモーダル表示 |
| ネットワークエラー | サーバー接続失敗 | エラーメッセージ表示 |
| 認証エラー | トークン無効 | ログイン促進 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 自動リトライなし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（同一IDの重複防止のみ） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

時間帯制限なし（イベント発生時に即座に表示）

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

- 同期リセット時にユーザートークンによる認証を実施
- 暗号化が有効な場合、アップロード前にファイル内容を暗号化
- サーバー側でファイルのオーナーシップを確認

## 備考

- この通知はstickyフラグがtrueのため、ユーザーが手動で閉じるまで表示が継続される
- UploadボタンはresetSyncを呼び出すが、これはファイル全体を再アップロードする処理
- 「Learn more」リンクは外部ドキュメントサイトへ遷移する

---

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

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

### 推奨読解順序

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

通知オブジェクトの型定義と、同期イベントの型定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | Notification型の定義（9-26行目） |
| 1-2 | server-events.ts | `packages/loot-core/src/types/server-events.ts` | SyncSubtype型（14行目: file-needs-upload） |

**読解のコツ**: file-needs-uploadがSyncSubtypeとして定義されていることを確認する。

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

同期イベントのリスナー登録と通知発行の起点を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | file-needs-uploadケースの処理（225-244行目） |

**主要処理フロー**:
1. **225-244行目**: case 'file-needs-upload' の処理ブロック
2. **227-228行目**: タイトルとメッセージの設定
3. **236-243行目**: Uploadボタンのアクション定義（resetSync呼び出し）

#### Step 3: リセット処理層を理解する

resetSync処理の詳細を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | appSlice.ts | `packages/desktop-client/src/app/appSlice.ts` | resetSync関数（53-93行目） |
| 3-2 | reset.ts | `packages/loot-core/src/server/sync/reset.ts` | resetSync実装 |

**主要処理フロー**:
- **53行目**: resetSync thunkの定義
- **56行目**: send('sync-reset')でサーバーAPIを呼び出し
- **58-89行目**: エラーハンドリング（暗号化キー関連）
- **90-91行目**: 成功時にsync()を実行

#### Step 4: サーバー通信層を理解する

同期リセットのサーバー側処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | cloud-storage.ts | `packages/loot-core/src/server/cloud-storage.ts` | resetSyncState関数（99-138行目）、upload関数（251-339行目） |

**主要処理フロー**:
- **99行目**: resetSyncState関数開始
- **105-108行目**: サーバーのreset-user-fileエンドポイント呼び出し
- **120-135行目**: 新しい暗号化キーの設定（必要な場合）

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

```
listenForSyncEvent (sync-events.ts:23)
    │
    ├─ listen('sync-event') (sync-events.ts:42)
    │      │
    │      └─ case 'file-needs-upload' (sync-events.ts:225)
    │             │
    │             └─ addNotification dispatch (sync-events.ts:371-375)
    │
    └─ button.action (sync-events.ts:240)
           │
           └─ resetSync (appSlice.ts:53)
                  │
                  ├─ send('sync-reset')
                  │      └─ cloud-storage.ts:resetSyncState
                  │             └─ POST /reset-user-file
                  │
                  └─ sync (appSlice.ts:95)
```

### データフロー図

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

サーバー応答               sync-events.ts                   UI表示
(file-needs-upload) ───▶ listenForSyncEvent ───▶ addNotification ───▶ Notifications.tsx
                               │
                               ▼
                      [Uploadボタンクリック]
                               │
                               ▼
                      appSlice.ts:resetSync
                               │
                               ▼
                      cloud-storage.ts:resetSyncState
                               │
                               ▼
                      POST /reset-user-file ───▶ サーバー
                               │
                               ▼
                      appSlice.ts:sync ───▶ 同期再開
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sync-events.ts | `packages/desktop-client/src/sync-events.ts` | ソース | 同期イベントリスナー、通知発行 |
| notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | ソース | 通知状態管理 |
| Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | ソース | 通知UI表示 |
| appSlice.ts | `packages/desktop-client/src/app/appSlice.ts` | ソース | resetSync, syncアクション |
| cloud-storage.ts | `packages/loot-core/src/server/cloud-storage.ts` | ソース | resetSyncState, upload関数 |
| reset.ts | `packages/loot-core/src/server/sync/reset.ts` | ソース | 同期リセット処理 |
| server-events.ts | `packages/loot-core/src/types/server-events.ts` | 型定義 | SyncSubtype定義 |
| errors.ts | `packages/loot-core/src/shared/errors.ts` | ソース | getUploadError関数 |
