# 通知設計書 2-サーバー未接続

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「サーバー未接続」通知の設計仕様を定義する。サーバーに接続されていない状態でユーザーが操作を試みた際に表示される警告通知の仕様を記載する。

### 本通知の処理概要

この通知は、InvenTreeサーバーに接続されていない状態でユーザーがサーバー接続を必要とする操作を実行しようとした際に、警告として表示される機能である。

**業務上の目的・背景**：在庫管理システムにおいて、サーバーとの接続は必須条件である。ユーザーがサーバー未接続状態で操作を試みた場合、その操作が実行できないことを明確に伝える必要がある。これにより、ユーザーは接続状態を確認し、再接続を行うことで業務を継続できる。接続状態を通知しないと、ユーザーは操作失敗の原因を特定できず混乱する可能性がある。

**通知の送信タイミング**：`InvenTreeAPI.checkConnection()`メソッドが呼び出され、`isConnected()`が`false`を返した場合にトリガーされる。これは主にAPIリクエストの前提条件チェック時や、バーコードスキャン操作時など、サーバー接続を必要とする機能の実行前に発生する。

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

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

**期待されるアクション**：ユーザーは通知を確認後、設定画面からサーバープロファイルを選択して接続を行う。または、ネットワーク接続を確認してから再度操作を試みる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | Colors.deepOrange（エラー/警告時） |
| 表示時間 | 5秒 |
| 形式 | テキスト + アイコン |

### 本文テンプレート

```
[サーバーアイコン] 接続されていません
```

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

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | API操作の前提チェック | `isConnected() == false` | checkConnection()呼び出し時にサーバー未接続の場合 |
| 画面操作 | バーコードスキャン操作 | `isConnected() == false` | スキャン前の接続確認で未接続の場合 |
| 画面操作 | データ取得・更新操作 | `isConnected() == false` | CRUD操作前の接続確認で未接続の場合 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザー操作] --> B[checkConnection呼び出し]
    B --> C{isConnected?}
    C -->|No| D[showSnackIcon呼び出し]
    D --> E{hasContext?}
    E -->|Yes| F[スナックバー表示]
    E -->|No| G[表示スキップ]
    C -->|Yes| H[操作続行]
    F --> I[5秒後自動消去]
    I --> J[return false]
    G --> J
    H --> K[return true]
    J --> L[終了]
    K --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | メモリ上の接続状態フラグのみ参照 |

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

#### InvenTreeAPI（インスタンス変数）

| 参照項目（変数名） | 用途 | 取得条件 |
|-------------------|------|---------|
| _connected | 接続状態フラグ | - |
| profile | ユーザープロファイル | - |
| baseUrl | サーバーURL | - |
| token | 認証トークン | - |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

UI通知のため、リトライは実施しない。

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 通知には機密情報を含まない
- 接続状態のみを表示し、サーバー情報は含まない
- ユーザーのデバイス上でのみ表示され、外部への送信は行わない

## 備考

- 通知音は再生されない
- checkConnection()は`false`を返すため、呼び出し元で操作を中断できる
- スナックバーは閉じるボタン（×）でユーザーが手動で閉じることも可能
- 前のスナックバーが表示中の場合は、`hideCurrentSnackBar()`で閉じてから新しいものを表示

---

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

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

### 推奨読解順序

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

まず、接続状態の判定に使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | api.dart | `lib/api.dart` | InvenTreeAPIクラスの接続状態管理変数 |

**読解のコツ**: `_connected`フラグ、`profile`、`baseUrl`、`token`の4つの条件がすべて満たされた場合のみ接続状態となる。

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

処理の起点となる接続チェック処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | api.dart | `lib/api.dart` | checkConnectionメソッドとisConnectedメソッド |

**主要処理フロー**:
1. **行260-274**: `checkConnection()`メソッド - 接続チェックとUI通知
2. **行262**: `isConnected()`の呼び出し
3. **行263-268**: 未接続時の`showSnackIcon()`呼び出し
4. **行391-393**: `isConnected()`メソッド - 接続状態の判定ロジック

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

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

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

**主要処理フロー**:
- **行11-81**: `showSnackIcon()`関数 - スナックバーの生成と表示
- **行42-47**: エラー/警告時の背景色（Colors.deepOrange）設定
- **行45-47**: 失敗時のデフォルトアイコン設定

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

```
[各種操作]
    |
    +-- InvenTreeAPI.checkConnection() [api.dart:260]
            |
            +-- isConnected() [api.dart:391]
            |       |
            |       +-- profile != null
            |       +-- _connected == true
            |       +-- baseUrl.isNotEmpty
            |       +-- hasToken
            |
            +-- showSnackIcon() [snacks.dart:11] ※未接続時
                    |
                    +-- hasContext() [helpers.dart:55]
                    +-- debug() [helpers.dart:66]
                    +-- OneContext().showSnackBar()
```

### データフロー図

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

ユーザー操作         checkConnection()              スナックバー表示
                   |                              "接続されていません"
                   v                              [オレンジ背景+サーバーアイコン]
              isConnected()
                   |
                   v
              [false]
                   |
                   v
            showSnackIcon()
                   |
                   v
            return false ──> 操作中断
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| api.dart | `lib/api.dart` | ソース | API通信と接続状態管理 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示 |
| helpers.dart | `lib/helpers.dart` | ソース | 共通ヘルパー関数 |
| l10.dart | `lib/l10.dart` | ソース | 多言語対応 |
