# 通知設計書 43-ユーザー取得エラー

## 概要

本ドキュメントは、ユーザー一覧の取得に失敗した際に管理者に表示されるエラー通知の設計を定義します。

### 本通知の処理概要

この通知は、管理者がユーザーディレクトリ画面や所有権移転モーダルでユーザー一覧を取得しようとした際に、サーバーからのデータ取得に失敗した場合に表示されるエラー通知です。認証エラー、トークン期限切れ、サーバーエラーなど様々な原因でユーザー一覧が取得できない場合に発行されます。

**業務上の目的・背景**：マルチユーザー環境でのActualでは、管理者がユーザーの追加・編集・削除を行うためにユーザーディレクトリ機能を使用します。ユーザー一覧の取得に失敗した場合、管理者に問題を明確に通知し、適切な対処（再ログイン、サポートへの連絡など）を促す必要があります。

**通知の送信タイミング**：以下のタイミングでユーザー取得APIがエラーを返した場合に通知が発行されます。
1. ユーザーディレクトリ画面の初期読み込み時
2. 所有権移転モーダルでのユーザー一覧取得時

**通知の受信者**：ユーザー一覧を取得しようとした管理者ユーザー（ローカル通知）

**通知内容の概要**：「Error getting users」というタイトルとともに、エラーの種類に応じたメッセージ（認証切れ、ユーザー名重複、内部エラーなど）を表示します。sticky属性により、ユーザーが明示的に閉じるまで表示され続けます。

**期待されるアクション**：管理者はエラー内容を確認し、認証切れの場合は再ログイン、その他のエラーの場合はサポートへの連絡などの対処を行います。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

ユーザー一覧取得を試みた管理者ユーザーのみに対してローカル通知を表示します。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 通知タイプ | error |
| 通知ID | error |
| タイトル | Error getting users |
| メッセージ | エラー種別に応じた動的メッセージ |
| sticky | true（自動消去しない） |

### エラーメッセージ一覧

| エラーコード | メッセージ |
|-------------|----------|
| unauthorized | You are not logged in. |
| token-expired | Login expired, please log in again. |
| user-cant-be-empty | Please enter a value for the username; the field cannot be empty. |
| role-cant-be-empty | Select a role; the field cannot be empty. |
| user-already-exists | The username you entered already exists. Please choose a different username. |
| not-all-deleted | Not all users were deleted. Check if one of the selected users is the server owner. |
| role-does-not-exists | Selected role does not exist, possibly a bug? Visit https://actualbudget.org/contact/ for support. |
| その他 | An internal error occurred, sorry! Visit https://actualbudget.org/contact/ for support. (ref: {reason}) |

### 本文テンプレート

```
{getUserDirectoryErrors(errorCode)}
```

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| errorCode | エラーコード | APIレスポンス.error | Yes |
| reason | エラー参照コード | APIレスポンス.reason | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | users-get API | 'error' in loadedUsers | ユーザー一覧取得失敗時 |
| API呼び出し | users-get API（所有権移転） | 'error' in data | 所有権移転時のユーザー取得失敗 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| APIが成功した場合 | エラーがない場合は通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザー一覧画面表示] --> B[users-get API呼び出し]
    B --> C{APIレスポンス}
    C -->|成功| D[ユーザー一覧表示]
    C -->|エラー| E[getUserDirectoryErrors でメッセージ生成]
    E --> F[addNotification dispatch]
    F --> G[通知表示]
    G --> H[ユーザーが閉じるまで表示継続]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| users | ユーザー一覧取得 | サーバー側で参照 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知はクライアント側のRedux storeのみ更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| unauthorized | 未ログイン状態 | ログイン画面への誘導 |
| token-expired | 認証トークン期限切れ | 再ログインを促す |
| その他 | サーバー内部エラー | サポートへの連絡を促す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- エラーメッセージにはユーザーの個人情報を含めない
- 内部エラーの詳細はサーバーログに記録し、クライアントには参照コードのみ表示
- 管理者権限を持つユーザーのみがこの画面にアクセス可能

## 備考

- sticky: true により、ユーザーが明示的に閉じるまで通知が消えない
- 通知IDが'error'で固定されているため、同種のエラーは上書きされる
- マルチユーザー機能が有効な環境でのみ関連する通知

---

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

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

### 推奨読解順序

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

エラーメッセージの生成ロジックを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | UserDirectory.tsx | `packages/desktop-client/src/components/admin/UserDirectory/UserDirectory.tsx` | useGetUserDirectoryErrorsフック（41-80行目） |

**読解のコツ**: エラーコードとメッセージのマッピングがswitch文で定義されている。i18n対応のためt()関数でラップされている。

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

通知を発行するコンポーネントを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | UserDirectory.tsx | `packages/desktop-client/src/components/admin/UserDirectory/UserDirectory.tsx` | loadUsers関数（117-136行目） |

**主要処理フロー**:
1. **118行目**: `send('users-get')`でサーバーからユーザー一覧を取得
2. **119行目**: レスポンスにerrorプロパティがあるかチェック
3. **120-131行目**: エラーがある場合、`addNotification`をdispatch
4. **127行目**: `getUserDirectoryErrors(loadedUsers.error)`でエラーメッセージを生成

#### Step 3: 所有権移転時の通知を理解する

所有権移転モーダルでの同様のエラー処理を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TransferOwnership.tsx | `packages/desktop-client/src/components/modals/TransferOwnership.tsx` | useEffect内のユーザー取得（56-88行目） |

**主要処理フロー**:
- **57行目**: `send('users-get')`でユーザー一覧を取得
- **61-73行目**: エラーがある場合、addNotificationをdispatch

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

```
UserDirectory.tsx / TransferOwnership.tsx
    │
    ├─ loadUsers() / useEffect
    │      │
    │      └─ send('users-get')
    │             │
    │             └─ APIレスポンス
    │                    │
    │                    ├─ 成功: setAllUsers(loadedUsers)
    │                    │
    │                    └─ エラー: dispatch(addNotification({...}))
    │                           │
    │                           └─ getUserDirectoryErrors(error)
    │                                  │
    │                                  └─ エラーメッセージ生成
    │
    └─ Notifications コンポーネント
           └─ 通知を画面に描画
```

### データフロー図

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

画面読み込み ───────▶ send('users-get') ───────────▶ サーバーAPI
                              │                          │
                              ▼                          ▼
                        APIレスポンス ◀─────────── users データ or エラー
                              │
                              ├─ 成功: ユーザー一覧表示
                              │
                              └─ エラー: addNotification dispatch
                                     │
                                     └─ getUserDirectoryErrors()
                                            │
                                            ▼
                                      エラーメッセージ生成
                                            │
                                            ▼
                                      Notifications.tsx
                                            │
                                            ▼
                                      トースト表示（sticky）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| UserDirectory.tsx | `packages/desktop-client/src/components/admin/UserDirectory/UserDirectory.tsx` | ソース | ユーザーディレクトリ画面コンポーネント |
| TransferOwnership.tsx | `packages/desktop-client/src/components/modals/TransferOwnership.tsx` | ソース | 所有権移転モーダル |
| notificationsSlice.ts | `packages/desktop-client/src/notifications/notificationsSlice.ts` | ソース | 通知の状態管理（Redux slice） |
| Notifications.tsx | `packages/desktop-client/src/components/Notifications.tsx` | ソース | 通知表示コンポーネント |
| app-admin.js | `packages/sync-server/src/app-admin.js` | ソース | サーバー側ユーザー管理API |
| user-service.js | `packages/sync-server/src/services/user-service.js` | ソース | ユーザーサービス |
