# 通知設計書 11-クラウドファイル未登録

## 概要

本ドキュメントは、Actualアプリケーションにおける「クラウドファイル未登録」警告通知の設計仕様を定義する。この通知は、ローカルで作成された予算ファイルがクラウドに登録されていない場合に、ユーザーにクラウド登録を促すために表示される。

### 本通知の処理概要

この通知は、予算ファイルの同期処理中にサーバー側でファイルが見つからない場合（file-not-found エラー）に発行される。ユーザーはこの通知を通じて、ローカルファイルをクラウドに登録し、複数デバイス間での同期機能を有効化できる。

**業務上の目的・背景**：Actualはクラウド同期機能により、複数デバイス間でのデータ共有とバックアップを実現している。ローカルで作成されたファイルがクラウドに登録されていない場合、同期機能が利用できず、データ損失のリスクがある。この通知は、ユーザーにクラウド登録の重要性を認識させ、データ保護を促進する目的がある。

**通知の送信タイミング**：同期処理（fullSync）の実行時に、サーバーから`file-not-found`エラーが返却された場合に発行される。具体的には、ローカルファイルのcloudFileIdがサーバー上に存在しない、または一度も登録されていない状態で同期を試みた際にトリガーされる。

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

**通知内容の概要**：ファイルがクラウドファイルではない旨を伝え、クラウド登録のメリット（複数デバイス間同期、データ損失防止）を説明する。また、詳細情報へのリンク（Learn more）を提供する。

**期待されるアクション**：ユーザーは「Register」ボタンをクリックしてファイルをクラウドに登録することが期待される。登録後、同期機能が有効化され、複数デバイスでの利用が可能となる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | warning |
| タイトル | This file is not a cloud file |
| sticky | true（手動で閉じるまで表示継続） |
| 識別ID | register-file |

### 本文テンプレート

```
You need to register it to take advantage of syncing which allows you to use it
across devices and never worry about losing your data. [Learn more](https://actualbudget.org/docs/getting-started/sync/#debugging-sync-issues)
```

### ボタン

| ボタン名 | アクション |
|---------|----------|
| Register | uploadBudget実行 → sync実行 → loadPrefs実行 |

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| イベント | sync-event (type: error, subtype: file-not-found) | サーバーがファイルを認識していない | 同期処理でファイルがサーバーに存在しない場合 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[同期処理開始] --> B{サーバーにファイルが存在?}
    B -->|存在しない| C[file-not-found エラー発生]
    B -->|存在する| D[通常の同期処理継続]
    C --> E[sync-event エミット]
    E --> F[listenForSyncEvent がキャッチ]
    F --> G[通知オブジェクト作成]
    G --> H[addNotification ディスパッチ]
    H --> I[UI に通知表示]
    I --> J{ユーザーアクション}
    J -->|Register クリック| K[uploadBudget 実行]
    K --> L[sync 実行]
    L --> M[loadPrefs 実行]
    M --> N[通知自動削除]
    J -->|閉じるボタン| O[通知削除]
```

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

### 参照テーブル一覧

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

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

#### metadata.json

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

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| metadata.json | UPDATE | Register実行時にcloudFileId, groupIdを更新 |

#### メタデータ更新

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ネットワークエラー | アップロード時にネットワーク接続失敗 | エラー通知を表示、リトライを促す |
| 認証エラー | ユーザートークンが無効 | ログイン画面への遷移を促す |
| 暗号化エラー | 暗号化キーが不足 | キー作成モーダルを表示 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイルアップロード時にユーザートークンによる認証を実施
- 暗号化が有効な場合、アップロード前にファイル内容を暗号化
- cloudFileIdはUUIDv4を使用し、推測困難な識別子を生成

## 備考

- この通知はstickyフラグがtrueのため、ユーザーが手動で閉じるまで表示が継続される
- 「Learn more」リンクは外部ドキュメントサイトへ遷移する
- Registerボタンクリック後、処理が完了すると通知は自動的に削除される

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | Notification型の定義（9-26行目）、sticky, button, messageActionsプロパティの構造 |
| 1-2 | server-events.ts | `packages/loot-core/src/types/server-events.ts` | SyncSubtype型（4-18行目）、SyncEvent型（20-44行目）の定義 |

**読解のコツ**: TypeScriptの型定義を先に把握することで、通知オブジェクトがどのようなプロパティを持つかを理解できる。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sync-events.ts | `packages/desktop-client/src/sync-events.ts` | listenForSyncEvent関数（23-383行目）、file-not-foundケースの処理（200-223行目） |

**主要処理フロー**:
1. **23行目**: listenForSyncEvent関数がエクスポートされ、Reduxストアを引数に取る
2. **42行目**: sync-eventリスナーの登録
3. **90行目**: event.type === 'error' の条件分岐開始
4. **200-223行目**: case 'file-not-found' の処理ブロック - 通知オブジェクトの作成

#### Step 3: 同期処理層を理解する

サーバーとの同期処理でfile-not-foundエラーが発生する条件を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.ts | `packages/loot-core/src/server/sync/index.ts` | fullSync関数（553-621行目）、エラーイベントのエミット |
| 3-2 | encoder.ts | `packages/loot-core/src/server/sync/encoder.ts` | encode/decode関数、サーバーとの通信データ形式 |

**主要処理フロー**:
- **553行目**: fullSync関数の定義
- **602行目**: PostError発生時のsubtype設定

#### Step 4: アクション実行層を理解する

Registerボタンクリック時の処理フローを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | budgetfilesSlice.ts | `packages/desktop-client/src/budgetfiles/budgetfilesSlice.ts` | uploadBudget関数の実装 |
| 4-2 | cloud-storage.ts | `packages/loot-core/src/server/cloud-storage.ts` | upload関数（251-339行目）、サーバーへのファイルアップロード処理 |

**主要処理フロー**:
- **251行目**: upload関数開始
- **289行目**: cloudFileIdが未設定の場合、UUIDを生成
- **327-335行目**: 成功時のprefs保存処理

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

```
listenForSyncEvent (sync-events.ts:23)
    │
    ├─ listen('sync-event') (sync-events.ts:42)
    │      │
    │      └─ case 'file-not-found' (sync-events.ts:200)
    │             │
    │             └─ addNotification dispatch (sync-events.ts:371-375)
    │
    └─ button.action (sync-events.ts:216-220)
           │
           ├─ uploadBudget (budgetfilesSlice.ts)
           │      └─ upload (cloud-storage.ts:251)
           │
           ├─ sync (appSlice.ts:95)
           │
           └─ loadPrefs (prefsSlice.ts)
```

### データフロー図

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

サーバー応答              sync-events.ts                   UI表示
(file-not-found) ───▶ listenForSyncEvent ───▶ addNotification ───▶ Notifications.tsx
                              │
                              ▼
                     [Registerボタンクリック]
                              │
                              ▼
ローカルファイル ───▶ cloud-storage.ts:upload ───▶ サーバーへ保存
(db.sqlite,                   │
metadata.json)                ▼
                     prefs更新 (cloudFileId, groupId)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| sync-events.ts | `packages/desktop-client/src/sync-events.ts` | ソース | 同期イベントリスナー、通知発行 |
| notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | ソース | 通知状態管理、Reduxスライス |
| Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | ソース | 通知UI表示コンポーネント |
| index.ts | `packages/loot-core/src/server/sync/index.ts` | ソース | 同期処理コア、エラーイベントエミット |
| cloud-storage.ts | `packages/loot-core/src/server/cloud-storage.ts` | ソース | クラウドストレージ操作 |
| appSlice.ts | `packages/desktop-client/src/app/appSlice.ts` | ソース | sync, resetSyncアクション |
| server-events.ts | `packages/loot-core/src/types/server-events.ts` | 型定義 | サーバーイベント型定義 |
| errors.ts | `packages/loot-core/src/server/errors.ts` | ソース | エラークラス定義 |
