# 通知設計書 4-接続拒否

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「接続拒否」通知の設計仕様を定義する。サーバーへの接続がネットワークレベルで拒否された際に表示されるエラー通知の仕様を記載する。

### 本通知の処理概要

この通知は、InvenTreeサーバーへの接続試行時に`SocketException`が発生した場合、つまりネットワークレベルで接続が拒否された際にユーザーに通知する機能である。

**業務上の目的・背景**：在庫管理システムにおいて、サーバーへの接続はすべての操作の前提条件である。接続拒否は、サーバーが起動していない、ファイアウォールでブロックされている、ネットワーク障害など、ネットワークレベルの問題を示す。ユーザーにこの状態を明確に伝えることで、適切な対処（サーバー管理者への連絡、ネットワーク設定の確認など）が可能になる。

**通知の送信タイミング**：HTTP通信を行う際に`SocketException`または`OSError`がキャッチされた場合にトリガーされる。これは主に以下の場面で発生する：
- `apiRequest()`でのHTTPクライアント接続時
- `completeRequest()`でのリクエスト完了時
- `downloadFile()`でのファイルダウンロード時
- `uploadFile()`でのファイルアップロード時

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

**通知内容の概要**：「Connection Refused」（接続が拒否されました）というローカライズされたメッセージと、SocketExceptionの詳細情報を含むエラー通知が表示される。詳細ボタンをタップすると、URL、エラー詳細などを含むダイアログが表示される。

**期待されるアクション**：ユーザーは通知を確認し、以下のような対処を行う：
- サーバーが起動しているか確認
- ネットワーク接続（Wi-Fi/モバイルデータ）を確認
- サーバーURLが正しいか確認
- ファイアウォール設定を確認
- サーバー管理者に連絡

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
[接続が拒否されました]  [詳細ボタン]
```

### 詳細ダイアログ

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

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| connectionRefused | エラータイトル | L10()（多言語リソース） | Yes |
| error.toString() | エラー詳細 | SocketException | Yes |
| url | リクエストURL | API通信処理から | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API通信 | HTTP接続失敗 | SocketException発生時 | サーバーへのソケット接続が拒否された |
| API通信 | HTTP接続失敗 | OSError発生時 | OS レベルのネットワークエラー |
| ファイル転送 | ダウンロード失敗 | SocketException発生時 | ファイルダウンロード中の接続拒否 |
| ファイル転送 | アップロード失敗 | SocketException発生時 | ファイルアップロード中の接続拒否 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[HTTP接続試行] --> B{接続成功?}
    B -->|Yes| C[処理続行]
    B -->|No| D{SocketException?}
    D -->|Yes| E[showServerError呼び出し]
    D -->|No| F[他のエラー処理]
    E --> G[音声再生]
    G --> H[スナックバー表示]
    H --> I{ユーザーが詳細タップ?}
    I -->|Yes| J[showErrorDialog表示]
    I -->|No| K[10秒後自動消去]
    J --> L[終了]
    K --> L
```

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

### 参照テーブル一覧

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

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

#### settings

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| SocketException | サーバーへの接続が拒否された | showServerErrorで通知表示 |
| OSError | OSレベルのネットワークエラー | showServerErrorで通知表示 |

### リトライ仕様

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

ネットワークエラーのため、自動リトライは行わない。ユーザーによる再試行が必要。

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- エラー詳細にはURL情報が含まれるが、認証トークンは含まれない
- SocketExceptionのメッセージにはサーバーのIPアドレスやポート番号が含まれる可能性がある
- ユーザーのデバイス上でのみ表示され、外部への送信は行わない

## 備考

- SocketExceptionは通常、サーバーが起動していない、または到達不能な場合に発生
- OSErrorは通常、ネットワークインターフェースの問題で発生
- 接続拒否は一時的な問題の可能性があるため、ユーザーに再試行を促す
- 同じエラーが連続して発生する場合でも、毎回通知が表示される

---

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

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

### 推奨読解順序

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

まず、SocketExceptionがキャッチされる箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | api.dart | `lib/api.dart` | apiRequestメソッドのcatchブロック |

**読解のコツ**: `try-catch`ブロックで`SocketException`と`OSError`が個別にキャッチされ、`showServerError`が呼び出される。

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

SocketExceptionをキャッチして通知を表示する処理を確認する。

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

**主要処理フロー**:
1. **行1267-1270**: `apiRequest()`でのSocketExceptionキャッチ
2. **行1275-1278**: `apiRequest()`でのOSErrorキャッチ
3. **行1377-1380**: `completeRequest()`でのSocketExceptionキャッチ
4. **行932-935**: `downloadFile()`でのSocketExceptionキャッチ
5. **行1059-1062**: `uploadFile()`でのSocketExceptionキャッチ

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

showServerError経由での通知表示を確認する。

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

**主要処理フロー**:
- **行207-248**: `showServerError()`関数 - サーバーエラー通知のメイン処理
- titleパラメータに`L10().connectionRefused`が渡される
- descriptionパラメータに`error.toString()`が渡される

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

```
InvenTreeAPI.apiRequest() [api.dart:1208]
    |
    +-- client.openUrl() [api.dart:1252]
    |       |
    |       +-- [SocketException発生]
    |
    +-- catch (SocketException) [api.dart:1267]
            |
            +-- debug() [helpers.dart:66]
            +-- showServerError() [dialogs.dart:207]
                    |
                    +-- playAudioFile() [helpers.dart:92]
                    +-- showSnackIcon() [snacks.dart:11]
```

### データフロー図

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

HTTPリクエスト        apiRequest()                  スナックバー表示
     |          --->  catch(SocketException)   --> "接続が拒否されました"
     v                     |                        [詳細ボタン]
[接続失敗]                 v
                    showServerError()
                          |
                          v
                    L10().connectionRefused
                    error.toString()
                          |
                          v
                    音声再生 + スナックバー
```

### 関連ファイル一覧

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