# 通知設計書 38-ファイルアップロード失敗

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「ファイルアップロード失敗」通知の設計仕様を定義するものです。この通知は、添付ファイルのアップロードが失敗した際にユーザーに表示されるスナックバー通知です。

### 本通知の処理概要

この通知は、ユーザーが各種モデル（パーツ、在庫アイテム、発注など）に添付ファイルをアップロードする際、サーバーへのファイル送信が何らかの理由で失敗した場合にエラーフィードバックを提供する機能です。

**業務上の目的・背景**：ファイルアップロードはネットワーク状態、サーバー状態、ファイルサイズ、ファイル形式などの要因で失敗する可能性があります。この通知により、ユーザーはアップロードが失敗したことを即座に把握でき、再試行や問題の調査など適切な対応を取ることができます。

**通知の送信タイミング**：`AttachmentWidget.upload()` メソッドでファイルをサーバーにアップロードした後、`uploadAttachment()` がfalseを返した場合に通知が発生します。

**通知の受信者**：通知は、アプリでファイルアップロード操作を実行している現在のユーザーに対してのみ表示されます。

**通知内容の概要**：国際化対応されたメッセージ「File upload failed」（または相当するローカライズ文字列）がスナックバーとして画面下部に表示されます。エラーを示すオレンジ色の背景と警告アイコンが付加されます。

**期待されるアクション**：ユーザーはアップロードが失敗したことを確認し、ネットワーク接続を確認するか、ファイルサイズや形式を確認して再試行することが期待されます。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高 |
| リトライ | なし（ユーザーによる手動再試行） |

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

アプリの現在アクティブなユーザーに対してのみ表示されます。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 背景色 | オレンジ（Colors.deepOrange） |
| アイコン | TablerIcons.exclamation_circle |
| 表示時間 | 5秒 |
| 閉じるボタン | あり |

### 本文テンプレート

```
{L10().uploadFailed}
```

実際の表示例（英語）：
```
File upload failed
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| uploadFailed | アップロード失敗メッセージ | L10()国際化リソース | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | upload() | result == false | 添付ファイルアップロードの失敗時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| アップロード成功 | uploadAttachment()がtrueを返した場合は成功通知が表示される |
| ファイル未選択 | file == nullの場合は処理をスキップ |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイル選択ボタン押下] --> B[FilePickerDialog.pickFileFromDevice]
    B --> C{ファイル選択?}
    C -->|なし| D[処理終了]
    C -->|あり| E[upload()メソッド呼び出し]
    E --> F[showLoadingOverlay表示]
    F --> G[uploadAttachment実行]
    G --> H{アップロード成功?}
    H -->|成功| I[showSnackIcon success: true]
    H -->|失敗| J[showSnackIcon success: false]
    I --> K[hideLoadingOverlay]
    J --> K
    K --> L[refresh画面更新]
```

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

### 参照テーブル一覧

該当なし（クライアントサイドのみの処理）

### 更新テーブル一覧

該当なし（失敗のため更新は行われない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ネットワークエラー | サーバーに接続できない | 通知表示、ネットワーク確認を促す |
| サーバーエラー | サーバー側でエラー発生 | 通知表示、再試行を促す |
| ファイルサイズエラー | ファイルが大きすぎる | 通知表示、小さいファイルで再試行 |
| コンテキスト不在 | Flutterコンテキストが無効 | 通知をスキップ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（ユーザーによる手動再試行） |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間対応）

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

- 失敗の詳細な原因（エラーメッセージ）は通知に含まれない
- 認証済みユーザーのみがアプリを使用可能

## 備考

- 失敗の詳細な原因はサーバーログやAPIレスポンスで確認可能
- アップロード中はローディングオーバーレイが表示される
- 国際化対応により、アプリの言語設定に応じたメッセージが表示される

---

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

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

### 推奨読解順序

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

まず、InvenTreeAttachmentクラスとuploadAttachment()メソッドの失敗パターンを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | attachment.dart | `lib/inventree/attachment.dart` | uploadAttachment()メソッドの戻り値（false）条件 |

**読解のコツ**: uploadAttachment()がfalseを返すパターン（APIエラー、ネットワークエラーなど）を確認

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

upload()メソッドでの失敗時処理を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | attachment_widget.dart | `lib/widget/attachment_widget.dart` | upload()メソッドの失敗分岐（行96-97） |

**主要処理フロー**:
1. **行80-81**: メソッド定義、null チェック
2. **行85-89**: uploadAttachment()でファイルアップロード実行
3. **行93-97**: if/else で成功/失敗を分岐
4. **行96**: `showSnackIcon(L10().uploadFailed, success: false)` - 失敗時

#### Step 3: スナックバー表示ロジックを理解する

showSnackIcon関数のsuccess=falseの実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | success=falseの場合のスタイル（行42-48） |

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

```
AttachmentWidget  [lib/widget/attachment_widget.dart]
    │
    ├─ appBarActions()  [行49]
    │      └─ IconButton(file_upload)
    │             └─ FilePickerDialog.pickFileFromDevice()
    │                    └─ upload()呼び出し
    │
    └─ upload()  [行80]
           │
           ├─ showLoadingOverlay()  [行83]
           │
           ├─ InvenTreeAttachment().uploadAttachment()  [行85]
           │      └─ API uploadFile() → 失敗
           │
           ├─ hideLoadingOverlay()  [行91]
           │
           ├─ showSnackIcon()  [行96]
           │      └─ L10().uploadFailed, success: false
           │
           └─ refresh()  [行99]
```

### データフロー図

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

ファイル選択       ───▶  upload()メソッド              ───▶  スナックバー表示
                          ├─ showLoadingOverlay              │
                          ├─ uploadAttachment → false        └─ 「File upload failed」
                          ├─ hideLoadingOverlay                 メッセージ
                          └─ refresh
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| attachment_widget.dart | `lib/widget/attachment_widget.dart` | ソース | AttachmentWidget、upload()メソッド |
| attachment.dart | `lib/inventree/attachment.dart` | ソース | InvenTreeAttachmentクラス、uploadAttachment()メソッド |
| api.dart | `lib/api.dart` | ソース | uploadFile()メソッド |
| snacks.dart | `lib/widget/snacks.dart` | ソース | showSnackIcon関数の実装 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数L10() |
