# 通知設計書 44-ラベル印刷失敗

## 概要

本ドキュメントは、InvenTreeモバイルアプリにおける「ラベル印刷失敗」通知の設計仕様を定義するものである。ラベル印刷処理中にエラーが発生した際に、ユーザーに視覚的なフィードバックを提供するスナックバー通知について記載する。

### 本通知の処理概要

本通知は、ラベル印刷処理が失敗したことをユーザーに通知するためのアプリ内スナックバー通知である。

**業務上の目的・背景**：在庫管理や物流業務において、ラベル印刷の失敗は業務の中断を意味する。印刷が失敗した場合、ユーザーは迅速に原因を把握し、適切な対処（再試行、プリンター確認、テンプレート確認など）を行う必要がある。本通知は、失敗の事実をユーザーに明確に伝えることで、問題解決を支援する。

**通知の送信タイミング**：ラベル印刷API（POST `/api/label/print/`）のレスポンスで`errors`フィールドが存在する場合、または処理中にエラーが発生した場合に通知される。具体的には、`handlePrintingSuccess`関数内で`data["errors"]`が検出された時点でトリガーされる。

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

**通知内容の概要**：「印刷失敗」を示すローカライズされたメッセージ（`L10().printLabelFailure`）と、失敗を示すオレンジ色の背景、警告アイコンがスナックバーとして画面下部に表示される。

**期待されるアクション**：ユーザーは印刷が失敗したことを確認し、以下のアクションを取る：プリンターの状態確認、ラベルテンプレートの確認、ネットワーク接続の確認、または再試行。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期/非同期（ポーリング結果に応じて） |
| 優先度 | 高 |
| リトライ | なし（通知自体のリトライはなし） |

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

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

## 通知テンプレート

### スナックバー通知

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

### 本文テンプレート

```
{L10().printLabelFailure}
```

英語の場合: "Label printing failed" または類似のメッセージ

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| printLabelFailure | 印刷失敗メッセージ | L10()（国際化リソース） | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API応答 | ラベル印刷APIのエラーレスポンス | `errors`フィールドが存在 | 印刷処理中にエラー発生 |
| ポーリング | data-output APIでエラー検知 | `errors`フィールドが存在 | 非同期印刷でエラー検知 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| errorsフィールドなし | エラーがない場合は成功通知が表示される |
| complete=false かつ errors=null | 処理中のためまだ通知しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[印刷実行] --> B[API POST label/print/]
    B --> C{レスポンス確認}
    C -->|errors有| D[showSnackIcon 印刷失敗]
    C -->|complete=true, output有| E[ダウンロード処理]
    C -->|complete=true, output無| F[印刷成功通知]
    C -->|complete=false| G[ポーリング開始]
    G --> H[data-output API確認]
    H --> I{エラー確認}
    I -->|errors有| D
    I -->|errors無, complete=true| F
    I -->|complete=false| G
    D --> J[終了]
    E --> J
    F --> J
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| LabelTemplate | ラベルテンプレート情報 | InvenTreeサーバー側 |
| Plugin | プリンタープラグイン情報 | InvenTreeサーバー側 |
| DataOutput | 印刷ジョブ情報 | ポーリング時に参照 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 失敗時はクライアント側の更新なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| プリンターエラー | プリンターが応答しない | プリンターの状態確認を案内 |
| テンプレートエラー | テンプレートが無効 | テンプレートの確認を案内 |
| プラグインエラー | 印刷プラグインのエラー | プラグイン設定の確認を案内 |
| ネットワークエラー | API通信失敗 | 接続確認を案内 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- エラーメッセージに機密情報が含まれないよう、サーバー側で適切なエラーレスポンスを返す必要がある
- スタックトレースなどの詳細な技術情報はユーザーに表示しない

## 備考

- 具体的なエラー詳細はスナックバーには表示されない（シンプルな失敗メッセージのみ）
- 詳細なエラー情報はサーバーのログで確認する必要がある
- スナックバーはタップで即座に閉じることが可能
- 国際化対応済み（L10()による多言語サポート）

---

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

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

### 推奨読解順序

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

ラベル印刷のレスポンス構造とエラー検知を理解する。

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

**読解のコツ**: レスポンスの`errors`フィールドの存在確認方法を確認する。

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

エラー検知処理の起点を特定。

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

**主要処理フロー**:
1. **174行目**: `bool error = data["errors"] != null;` でエラー検知
2. **186-187行目**: エラー時の通知表示処理

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

失敗時のスナックバー表示の実装詳細を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | snacks.dart | `lib/widget/snacks.dart` | showSnackIcon関数のsuccess=false時の処理 |

**主要処理フロー**:
- **42-47行目**: success=falseの場合の処理（オレンジ背景、警告アイコン）

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

```
selectAndPrintLabel() (labels.dart line 209)
    │
    ├─ launchApiForm() - 印刷フォーム表示
    │      │
    │      └─ onSuccess callback
    │             │
    │             └─ handlePrintingSuccess() (line 165)
    │                    │
    │                    ├─ [errors検知]
    │                    │      │
    │                    │      └─ error = data["errors"] != null (line 174)
    │                    │             │
    │                    │             └─ [error == true]
    │                    │                    │
    │                    │                    └─ showSnackIcon(L10().printLabelFailure)
    │                    │                           (line 187)
    │                    │
    │                    └─ [ポーリング中のエラー検知]
    │                           │
    │                           └─ 再帰呼び出しでerrors検知
    │
    └─ LabelFormWidgetState - フォーム状態管理
```

### データフロー図

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

ユーザー操作      ┌─────────────────┐
(印刷ボタン) ───▶│selectAndPrintLabel│
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐     API Request
                 │ launchApiForm   │────────────────▶ InvenTreeサーバー
                 │ (label/print/)  │◀────────────────  (Error Response)
                 └────────┬────────┘     {errors: [...]}
                          │
                          ▼
                 ┌─────────────────┐
                 │handlePrintingSuccess│
                 └────────┬────────┘
                          │
                          ▼
                 ┌─────────────────┐
                 │data["errors"]   │
                 │!= null ?        │
                 └────────┬────────┘
                          │ Yes
                          ▼
                 ┌─────────────────┐
                 │showSnackIcon()  │───▶ エラースナックバー表示
                 │printLabelFailure│     (オレンジ背景)
                 └─────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| labels.dart | `lib/labels.dart` | ソース | ラベル印刷のメイン処理、エラーハンドリング |
| snacks.dart | `lib/widget/snacks.dart` | ソース | スナックバー通知の表示関数 |
| api_form.dart | `lib/api_form.dart` | ソース | APIフォーム処理 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数 |
| app_en.arb | `lib/l10n/app_en.arb` | リソース | 英語メッセージ定義（printLabelFailure） |
