# 通知設計書 45-ダウンロード中

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「ダウンロード中」通知の設計仕様を定義するものである。ラベルファイルのダウンロードが開始された際に、ユーザーに処理状態を知らせるスナックバー通知について記載する。

### 本通知の処理概要

本通知は、ラベル印刷処理の結果としてラベルファイル（PDFなど）のダウンロードが開始されたことをユーザーに通知するためのアプリ内スナックバー通知である。

**業務上の目的・背景**：在庫管理システムでは、ラベル印刷の結果としてPDFファイルなどが生成される場合がある。これは外部プリンターではなく、ユーザーのデバイスでラベルを表示・印刷するためである。ダウンロード中であることをユーザーに通知することで、処理が進行中であることを明示し、ユーザーが他の操作を行う際の判断材料を提供する。

**通知の送信タイミング**：ラベル印刷API（POST `/api/label/print/`）のレスポンスで`complete`がtrueかつ`output`フィールドにダウンロードURLが含まれる場合に通知される。具体的には、`handlePrintingSuccess`関数内でoutputが検出された時点でトリガーされる。

**通知の受信者**：印刷操作を実行したユーザー本人のみ。アプリ内通知であるため、他のユーザーには通知されない。

**通知内容の概要**：「ダウンロード中」を示すローカライズされたメッセージ（`L10().downloading`）と、成功を示す緑色の背景、チェックマークアイコンがスナックバーとして画面下部に表示される。

**期待されるアクション**：ユーザーはダウンロードが開始されたことを確認し、ダウンロード完了を待つ。完了後、ダウンロードされたファイルが自動的に開かれ、ユーザーは印刷やラベルの確認を行うことができる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

操作を実行したユーザーのアプリ画面に直接表示。ユーザー選択や条件分岐は不要。

## 通知テンプレート

### スナックバー通知

| 項目 | 内容 |
|-----|------|
| 背景色 | `Colors.lightGreen`（成功時） |
| アイコン | `TablerIcons.circle_check` |
| 表示時間 | 5秒 |
| 形式 | スナックバー（画面下部） |

### 本文テンプレート

```
{L10().downloading}
```

英語の場合: "Downloading..." または類似のメッセージ

### 添付ファイル

なし（ダウンロード対象のファイルは通知とは別に処理される）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| downloading | ダウンロード中メッセージ | L10()（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API応答 | ラベル印刷APIの成功レスポンス | `complete`=true かつ `output`がnull/空でない | ダウンロードURLが含まれる |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| outputがnullまたは空 | 外部プリンター送信の場合はprintLabelSuccess通知 |
| errorsフィールドあり | エラーがある場合は印刷失敗通知 |
| completeがfalse | 処理中のためまだ通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[印刷実行] --> B[API POST label/print/]
    B --> C{レスポンス確認}
    C -->|complete=true, output有| D[showSnackIcon ダウンロード中]
    D --> E[downloadFile実行]
    E --> F[ファイル保存]
    F --> G[ファイル自動オープン]
    C -->|complete=true, output無| H[印刷成功通知]
    C -->|errors有| I[印刷失敗通知]
    C -->|complete=false| J[ポーリング開始]
    G --> K[終了]
    H --> K
    I --> K
    J --> C
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| DataOutput | 印刷ジョブ情報とoutput URL | InvenTreeサーバー側 |

### ローカルストレージ

| 項目 | 用途 | 備考 |
|------|------|------|
| TemporaryDirectory | ダウンロードファイルの一時保存 | path_providerで取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ローカルファイル | CREATE | ダウンロードしたラベルファイル |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ダウンロード失敗 | ネットワークエラー、URLが無効 | エラー通知を表示 |
| ファイル保存失敗 | ストレージ不足、権限なし | エラー通知を表示 |
| ファイルオープン失敗 | 対応アプリがない | エラー通知を表示 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（ユーザー操作による再試行） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ダウンロードURLは認証済みセッションでのみアクセス可能
- ダウンロードされたファイルは端末のローカルストレージに保存される
- 一時ファイルは適切に管理される

## 備考

- ダウンロード完了後、`OpenFilex.open()`でファイルが自動的に開かれる
- PDFビューアなどの対応アプリがデバイスにインストールされている必要がある
- スナックバーはタップで即座に閉じることが可能
- 国際化対応済み（L10()による多言語サポート）

---

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

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

### 推奨読解順序

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

ラベル印刷レスポンスのoutputフィールドを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | labels.dart | `lib/labels.dart` | handlePrintingSuccess関数のoutput検知ロジック |

**読解のコツ**: `output`フィールドにダウンロードURLが含まれることを確認する。

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

ダウンロード通知のトリガー処理を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | labels.dart | `lib/labels.dart` | handlePrintingSuccess関数（165-202行目） |

**主要処理フロー**:
1. **175行目**: `String? output = data["output"] as String?;` でoutput取得
2. **177-181行目**: complete=true かつ output有の処理
3. **180行目**: `showSnackIcon(L10().downloading, success: true);`
4. **181行目**: `InvenTreeAPI().downloadFile(output);`

#### Step 3: ダウンロード処理を理解する

ファイルダウンロードの実装詳細を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | api.dart | `lib/api.dart` | downloadFile関数（887-985行目） |

**主要処理フロー**:
- **894-898行目**: ローカルファイルパスの構築
- **952-964行目**: ファイル保存と自動オープン処理

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

```
handlePrintingSuccess() (labels.dart line 165)
    │
    ├─ [complete=true, output!=null かつ output.isNotEmpty]
    │      │
    │      ├─ showSnackIcon(L10().downloading, success: true)
    │      │      └─ OneContext().showSnackBar() - スナックバー表示
    │      │
    │      └─ InvenTreeAPI().downloadFile(output) (api.dart line 887)
    │             │
    │             ├─ getTemporaryDirectory() - 一時ディレクトリ取得
    │             │
    │             ├─ HttpClient.get() - ファイルダウンロード
    │             │
    │             ├─ File.writeAsBytes() - ファイル保存
    │             │
    │             └─ OpenFilex.open() - ファイル自動オープン
    │
    └─ [その他の条件]
           └─ 別の通知または再帰処理
```

### データフロー図

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

API Response     ┌─────────────────┐
(output URL) ───▶│handlePrintingSuccess│
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │output有 ?       │
                 └────────┬────────┘
                          │ Yes
                          ▼
                 ┌─────────────────┐
                 │showSnackIcon()  │───▶ "ダウンロード中"表示
                 │downloading      │
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐     HTTP GET
                 │downloadFile()   │────────────────▶ ファイルサーバー
                 │                 │◀────────────────  バイナリデータ
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │ファイル保存     │───▶ TemporaryDirectory
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │OpenFilex.open() │───▶ ファイル表示
                 └─────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| labels.dart | `lib/labels.dart` | ソース | ラベル印刷処理、ダウンロード通知トリガー |
| api.dart | `lib/api.dart` | ソース | downloadFile関数の実装 |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示関数 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義（downloading） |
