# 通知設計書 1-サーバー接続成功

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「サーバー接続成功」通知の設計仕様を定義する。サーバーへの接続が正常に完了した際にユーザーに表示されるスナックバー通知の仕様を記載する。

### 本通知の処理概要

この通知は、InvenTreeサーバーへの接続処理が正常に完了したことをユーザーに視覚的にフィードバックするための機能である。

**業務上の目的・背景**：在庫管理システムにおいて、サーバーとの接続状態はすべての操作の前提条件となる。ユーザーがサーバー接続を試みた際に、接続が成功したことを明確に伝えることで、ユーザーは安心してアプリケーションの機能を利用開始できる。接続成功の確認がないと、ユーザーは操作を開始してよいか判断できず、業務効率が低下する可能性がある。

**通知の送信タイミング**：`InvenTreeAPI.connectToServer()`メソッドにおいて、サーバーへの接続処理（認証確認、ロール取得、プラグイン情報取得）がすべて正常に完了した直後にトリガーされる。具体的には、`_connectToServer()`内部メソッドが`true`を返した後、`_connected`フラグが`true`に設定されたタイミングで発火する。

**通知の受信者**：アプリケーションを操作している現在のユーザー。画面上にスナックバーとして表示されるため、アプリを操作中のユーザーのみが対象となる。

**通知内容の概要**：「Connected to Server」（サーバーに接続しました）というローカライズされたメッセージと、サーバーアイコン（TablerIcons.server）が緑色の背景で表示される。成功を示す視覚的フィードバックとして、背景色は`Colors.lightGreen`が使用される。

**期待されるアクション**：ユーザーは通知を確認後、在庫確認、バーコードスキャン、発注管理などのアプリケーション機能を利用開始する。通知は自動的に5秒後に消えるため、特別な操作は不要である。

## 通知種別

アプリ内通知（スナックバー）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | 無し（UI通知のため） |

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

現在アプリケーションを操作しているユーザーに対して、画面下部にスナックバー形式で表示する。`OneContext`を使用してグローバルコンテキストから`ScaffoldMessenger`を取得し、スナックバーを表示する。

## 通知テンプレート

### スナックバー通知の場合

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | Colors.lightGreen（成功時） |
| 表示時間 | 5秒 |
| 形式 | テキスト + アイコン |

### 本文テンプレート

```
[サーバーアイコン] サーバーに接続しました
```

実際の表示テキストは`L10().serverConnected`から取得され、ユーザーのロケール設定に応じて多言語対応される。

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| serverConnected | 接続成功メッセージ | L10()（多言語リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | サーバー接続ボタン押下 | `_connected == true` | ユーザーがサーバー接続を実行し成功した場合 |
| 画面操作 | アプリ起動時の自動接続 | `_connected == true` | 保存されたプロファイルで自動接続が成功した場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| コンテキストなし | `hasContext()`が`false`を返す場合（テスト環境など） |
| 接続失敗 | `_connected`が`false`の場合は通知されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[connectToServer呼び出し] --> B[_connectToServer実行]
    B --> C{接続成功?}
    C -->|Yes| D[_connected = true]
    D --> E[showSnackIcon呼び出し]
    E --> F{hasContext?}
    F -->|Yes| G[スナックバー表示]
    F -->|No| H[表示スキップ]
    C -->|No| I[エラー処理]
    G --> J[5秒後自動消去]
    J --> K[終了]
    H --> K
    I --> K
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| UserProfile | サーバー接続情報 | SQLiteローカルDB |
| settings | アプリ設定 | Sembast NoSQL DB |

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

#### UserProfile

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| server | サーバーURL | 選択されたプロファイル |
| token | 認証トークン | 選択されたプロファイル |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知表示のみで更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コンテキスト不在 | テスト環境などでUIコンテキストがない | デバッグログのみ出力 |
| スナックバー表示失敗 | ScaffoldMessengerが取得できない | 例外をキャッチしてログ出力 |

### リトライ仕様

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

UI通知のため、リトライは実施しない。表示に失敗した場合でもアプリケーション動作には影響しない。

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（ユーザー操作に応じて即座に表示）

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

- 通知には機密情報（サーバーURL、認証情報など）を含まない
- ユーザーのデバイス上でのみ表示され、外部への送信は行わない

## 備考

- 通知音は再生されない（サーバーエラー時のみ音声フィードバックあり）
- スナックバーは閉じるボタン（×）でユーザーが手動で閉じることも可能
- 前のスナックバーが表示中の場合は、`hideCurrentSnackBar()`で閉じてから新しいものを表示

---

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

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

### 推奨読解順序

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

まず、通知表示に使用されるデータ構造と設定値を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | l10.dart | `lib/l10.dart` | 多言語対応の仕組み。L10()関数がI18Nインスタンスを返す |
| 1-2 | preferences.dart | `lib/preferences.dart` | 設定値の定義。INV_SOUNDS_SERVERなどの定数 |

**読解のコツ**: `L10()`関数はシングルトンパターンで、現在のコンテキストからロケールを取得する。テスト環境では英語のフォールバックが使用される。

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

処理の起点となる接続処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | api.dart | `lib/api.dart` | InvenTreeAPIクラスのconnectToServerメソッドが起点 |

**主要処理フロー**:
1. **行656-701**: `connectToServer()`メソッド - 接続処理全体を制御
2. **行678**: `_connected = await _connectToServer()` - 内部接続処理の呼び出し
3. **行681-686**: 接続成功時の`showSnackIcon()`呼び出し

#### Step 3: 通知表示層を理解する

スナックバー表示の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数の実装 |

**主要処理フロー**:
- **行11-81**: `showSnackIcon()`関数 - スナックバーの生成と表示
- **行21-24**: コンテキスト確認とアーリーリターン
- **行29**: 既存スナックバーの非表示処理
- **行35-37**: 成功時の背景色とアイコン設定
- **行58-80**: OneContextを使用したスナックバー表示

#### Step 4: ヘルパー関数を理解する

共通ユーティリティの理解。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | helpers.dart | `lib/helpers.dart` | hasContext()関数、debug()関数 |

**主要処理フロー**:
- **行55-61**: `hasContext()` - UIコンテキストの有無確認
- **行66-72**: `debug()` - デバッグログ出力

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

```
InvenTreeAPI.connectToServer() [api.dart:656]
    |
    +-- _connectToServer() [api.dart:412]
    |       |
    |       +-- _checkServer() [api.dart:453]
    |       +-- _checkAuth() [api.dart:521]
    |       +-- _fetchRoles() [api.dart:706]
    |       +-- _fetchPlugins() [api.dart:739]
    |
    +-- showSnackIcon() [snacks.dart:11]
            |
            +-- hasContext() [helpers.dart:55]
            +-- debug() [helpers.dart:66]
            +-- OneContext().showSnackBar() [外部ライブラリ]
```

### データフロー図

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

UserProfile          connectToServer()              スナックバー表示
  - server     --->  _connectToServer()   --->     "サーバーに接続しました"
  - token            |                              [緑色背景+サーバーアイコン]
                     v
                showSnackIcon()
                     |
                     v
                OneContext
                .showSnackBar()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| api.dart | `lib/api.dart` | ソース | API通信とサーバー接続管理 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示 |
| helpers.dart | `lib/helpers.dart` | ソース | 共通ヘルパー関数 |
| l10.dart | `lib/l10.dart` | ソース | 多言語対応 |
| preferences.dart | `lib/preferences.dart` | ソース | 設定値管理 |
| user_profile.dart | `lib/user_profile.dart` | ソース | ユーザープロファイルモデル |
