# 通知設計書 5-タイムアウト

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「タイムアウト」通知の設計仕様を定義する。サーバーからの応答がない場合に表示されるタイムアウトエラー通知の仕様を記載する。

### 本通知の処理概要

この通知は、InvenTreeサーバーへのリクエストに対して指定時間内に応答が得られなかった場合、つまり`TimeoutException`が発生した際にユーザーに通知する機能である。

**業務上の目的・背景**：在庫管理システムにおいて、サーバーからの応答が長時間得られない状態はユーザー体験を著しく低下させる。タイムアウトを明確に通知することで、ユーザーは以下の対処が可能になる：
- ネットワーク接続状態の確認
- サーバーの負荷状況の確認
- 操作の再試行判断
- 管理者への連絡

**通知の送信タイミング**：HTTP通信を行う際に`TimeoutException`がキャッチされた場合にトリガーされる。タイムアウト時間は処理によって異なる：
- `apiRequest()`: 10秒
- `completeRequest()`: 10秒
- `downloadFile()`: 10秒
- `uploadFile()`: 120秒（2分、大容量ファイル対応）

**通知の受信者**：アプリケーションを操作している現在のユーザー。画面上にスナックバーとして表示され、タップすると詳細ダイアログが開く。

**通知内容の概要**：「Timeout」（タイムアウト）というタイトルと「No Response」（応答なし）というメッセージが表示される。詳細ボタンをタップすると、URLを含む詳細情報が表示される。サーバーエラーとして扱われるため、音声フィードバック（設定有効時）も提供される。

**期待されるアクション**：ユーザーは通知を確認し、以下のような対処を行う：
- ネットワーク接続（Wi-Fi/モバイルデータ）の確認
- 操作の再試行
- サーバーの稼働状況確認
- 時間をおいてから再試行

## 通知種別

アプリ内通知（スナックバー + 詳細ダイアログ + 音声）

## 送信仕様

### 基本情報

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

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

現在アプリケーションを操作しているユーザーに対して、画面下部にスナックバー形式で表示する。`showTimeoutError`関数経由で`showServerError`が呼び出され、詳細ダイアログへのアクセスも提供される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面下部 |
| 背景色 | Colors.deepOrange（エラー時） |
| 表示時間 | 10秒（アクションボタンあり） |
| 形式 | テキスト + 詳細ボタン |

### 本文テンプレート

```
[タイムアウト]  [詳細ボタン]
```

### 詳細ダイアログ

| 項目 | 内容 |
|-----|------|
| ダイアログタイプ | SimpleDialog |
| アイコン | TablerIcons.server |
| タイトル | L10().timeout |
| 本文 | L10().noResponse + URL |

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| timeout | タイムアウトメッセージ | L10()（多言語リソース） | Yes |
| noResponse | 応答なしメッセージ | L10()（多言語リソース） | Yes |
| url | リクエストURL | API通信処理から | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API通信 | HTTP接続タイムアウト | TimeoutException発生時（10秒） | サーバーへの接続が10秒でタイムアウト |
| API通信 | リクエスト完了タイムアウト | TimeoutException発生時（10秒） | レスポンス受信が10秒でタイムアウト |
| ファイル転送 | ダウンロードタイムアウト | TimeoutException発生時（10秒） | ファイルダウンロードが10秒でタイムアウト |
| ファイル転送 | アップロードタイムアウト | TimeoutException発生時（120秒） | ファイルアップロードが120秒でタイムアウト |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| コンテキストなし | `hasContext()`が`false`を返す場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[HTTP通信開始] --> B[タイムアウト監視]
    B --> C{応答受信?}
    C -->|Yes| D[処理続行]
    C -->|No| E{タイムアウト?}
    E -->|Yes| F[showTimeoutError呼び出し]
    E -->|No| B
    F --> G[showServerError呼び出し]
    G --> H[音声再生]
    H --> I[スナックバー表示]
    I --> J{ユーザーが詳細タップ?}
    J -->|Yes| K[showErrorDialog表示]
    J -->|No| L[10秒後自動消去]
    K --> M[終了]
    L --> M
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| settings | 音声設定確認 | Sembast NoSQL DB |

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

#### settings

| 参照項目（キー名） | 用途 | 取得条件 |
|-------------------|------|---------|
| INV_SOUNDS_SERVER | サーバーエラー音有効/無効 | デフォルト: true |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| TimeoutException | 指定時間内に応答がない | showTimeoutErrorで通知表示 |

### リトライ仕様

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

タイムアウトエラーのため、自動リトライは行わない。ユーザーによる再試行が必要。

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（エラー発生時に即座に表示）

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

- エラー詳細にはURL情報が含まれるが、認証トークンは含まれない
- ユーザーのデバイス上でのみ表示され、外部への送信は行わない

## 備考

- タイムアウト時間は処理内容によって異なる（通常10秒、アップロード120秒）
- `showTimeoutError`は`showServerError`のラッパー関数
- タイムアウトは一時的なネットワーク問題の可能性があるため、再試行で解決する場合がある
- HttpClientの`connectionTimeout`は30秒に設定されている

---

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

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

### 推奨読解順序

#### Step 1: 専用関数を理解する

まず、タイムアウト通知専用の関数を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | dialogs.dart | `lib/widget/dialogs.dart` | showTimeoutError関数 |

**読解のコツ**: `showTimeoutError`は`showServerError`のラッパーで、タイトルと説明をL10()から取得して渡す。

#### Step 2: 例外の発生箇所を理解する

TimeoutExceptionがキャッチされる箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | api.dart | `lib/api.dart` | apiRequest、completeRequest、downloadFile、uploadFileでのTimeoutExceptionキャッチ |

**主要処理フロー**:
1. **行1271-1274**: `apiRequest()`でのTimeoutExceptionキャッチ
2. **行1385-1387**: `completeRequest()`でのTimeoutExceptionキャッチ
3. **行936-938**: `downloadFile()`でのTimeoutExceptionキャッチ
4. **行1079-1081**: `uploadFile()`でのTimeoutExceptionキャッチ

#### Step 3: タイムアウト設定を理解する

各処理のタイムアウト時間設定を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | api.dart | `lib/api.dart` | timeout()メソッドの引数 |

**主要処理フロー**:
- **行1252-1254**: `apiRequest()`でのタイムアウト設定（10秒）
- **行1330-1332**: `completeRequest()`でのタイムアウト設定（10秒）
- **行924-926**: `downloadFile()`でのタイムアウト設定（10秒）
- **行1034-1036**: `uploadFile()`でのタイムアウト設定（120秒）
- **行1196**: HttpClientのconnectionTimeout設定（30秒）

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

```
InvenTreeAPI.apiRequest() [api.dart:1208]
    |
    +-- client.openUrl().timeout(10秒) [api.dart:1252]
    |       |
    |       +-- [TimeoutException発生]
    |
    +-- catch (TimeoutException) [api.dart:1271]
            |
            +-- debug() [helpers.dart:66]
            +-- showTimeoutError() [dialogs.dart:306]
                    |
                    +-- showServerError() [dialogs.dart:207]
                            |
                            +-- playAudioFile() [helpers.dart:92]
                            +-- showSnackIcon() [snacks.dart:11]
```

### データフロー図

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

HTTPリクエスト        timeout(Duration)             スナックバー表示
     |          --->  catch(TimeoutException)  --> "タイムアウト"
     v                     |                        [詳細ボタン]
[10秒/120秒経過]           v
                    showTimeoutError()
                          |
                          v
                    showServerError(
                      L10().timeout,
                      L10().noResponse
                    )
                          |
                          v
                    音声再生 + スナックバー
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| api.dart | `lib/api.dart` | ソース | HTTP通信とTimeoutExceptionキャッチ |
| dialogs.dart | `lib/widget/dialogs.dart` | ソース | タイムアウトエラー通知表示 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示 |
| helpers.dart | `lib/helpers.dart` | ソース | 音声再生・共通ヘルパー関数 |
| l10.dart | `lib/l10.dart` | ソース | 多言語対応（timeout, noResponse） |
