# 通知設計書 37-ファイルアップロード成功

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：InvenTreeでは各種モデルに対してドキュメント、図面、仕様書などのファイルを添付できます。ファイルアップロードは非同期処理であり、成功/失敗をユーザーに明確に伝える必要があります。この通知により、ユーザーはアップロードが正常に完了したことを即座に確認でき、作業の継続性を担保します。

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

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

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

**期待されるアクション**：ユーザーはアップロードが成功したことを確認し、必要に応じて追加のファイルをアップロードするか、添付ファイル一覧を確認することが期待されます。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中 |
| リトライ | なし |

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

アプリの現在アクティブなユーザーに対してのみ表示されます。アップロード権限を持つユーザーのみがアップロード機能にアクセスできます。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 背景色 | ライトグリーン（Colors.lightGreen） |
| アイコン | TablerIcons.circle_check |
| 表示時間 | 5秒 |
| 閉じるボタン | あり |

### 本文テンプレート

```
{L10().uploadSuccess}
```

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

### 添付ファイル

該当なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| アップロード失敗 | uploadAttachment()がfalseを返した場合は失敗通知が表示される |
| ファイル未選択 | 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画面更新]
```

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

### 参照テーブル一覧

該当なし（クライアントサイドのみの処理、サーバー側でDB更新）

### 更新テーブル一覧

サーバー側でAttachmentテーブルへの挿入が行われる

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| アップロード失敗 | サーバーエラー、ネットワークエラー | 失敗通知（No.38）を表示 |
| コンテキスト不在 | Flutterコンテキストが無効 | 通知をスキップ |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間対応）

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

- アップロードされたファイル名は通知に含まれない
- アップロード権限を持つユーザーのみがアップロード機能を利用可能
- 認証済みユーザーのみがアプリを使用可能

## 備考

- アップロード中はローディングオーバーレイが表示され、ユーザーの操作がブロックされる
- アップロード完了後に自動的に添付ファイル一覧が更新される
- 国際化対応により、アプリの言語設定に応じたメッセージが表示される

---

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

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

### 推奨読解順序

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

まず、InvenTreeAttachmentクラスとuploadAttachment()メソッドを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | attachment.dart | `lib/inventree/attachment.dart` | InvenTreeAttachmentクラス、uploadAttachment()メソッド |

**読解のコツ**: uploadAttachment()はbool値を返し、成功/失敗を示す

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

upload()メソッドでのアップロード処理と通知を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | attachment_widget.dart | `lib/widget/attachment_widget.dart` | upload()メソッド（行80-99） |

**主要処理フロー**:
1. **行80-81**: メソッド定義、null チェック
2. **行83**: showLoadingOverlay()でローディング表示
3. **行85-89**: uploadAttachment()でファイルアップロード実行
4. **行91**: hideLoadingOverlay()でローディング非表示
5. **行93-97**: 結果に応じてshowSnackIcon呼び出し
6. **行94**: `showSnackIcon(L10().uploadSuccess, success: true)`
7. **行99**: refresh(context)で画面更新

#### Step 3: ファイル選択のトリガーを理解する

appBarActions()でのアップロードボタンを確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | attachment_widget.dart | `lib/widget/attachment_widget.dart` | appBarActions()メソッド（行49-78） |

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

```
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()  [行94 or 96]
           │      └─ L10().uploadSuccess or L10().uploadFailed
           │
           └─ refresh()  [行99]
```

### データフロー図

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

ファイル選択       ───▶  upload()メソッド              ───▶  スナックバー表示
                          ├─ showLoadingOverlay              │
                          ├─ uploadAttachment                └─ 「File uploaded」
                          ├─ 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() |
| fields.dart | `lib/widget/fields.dart` | ソース | FilePickerDialog |
