# 通知設計書 34-フォームエラー

## 概要

本ドキュメントは、InvenTreeモバイルアプリケーションにおける「フォームエラー」通知の設計仕様を定義するものです。この通知は、APIフォーム送信時にバリデーションエラー（HTTP 400）が返却された際にユーザーに表示されるスナックバー通知です。

### 本通知の処理概要

この通知は、ユーザーがフォームデータを送信した際、サーバー側でバリデーションエラーが検出され、HTTP 400ステータスコードが返却された場合にユーザーにフィードバックを提供する機能です。

**業務上の目的・背景**：ユーザーがフォームに入力したデータが不正な場合、サーバーはバリデーションエラーを返します。この通知により、ユーザーは入力内容に問題があることを即座に把握でき、適切な修正を行うことができます。これにより、データ品質の維持とユーザビリティの向上を実現します。

**通知の送信タイミング**：`APIFormWidgetState._save()` メソッドでフォームをサーバーに送信した後、HTTP 400ステータスコードが返却された場合に通知が発生します。

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

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

**期待されるアクション**：ユーザーはフォームのエラー箇所を確認し、入力内容を修正して再送信することが期待されます。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

アプリの現在アクティブなユーザーに対してのみ表示されます。ユーザーロールや権限による制限はありません。

## 通知テンプレート

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

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

### 本文テンプレート

```
{L10().formError}
```

実際の表示例（英語）：
```
Form Error
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| formError | フォームエラーメッセージ | L10()国際化リソース | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API応答 | _save() | response.statusCode == 400 | フォーム送信時のバリデーションエラー |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 成功レスポンス | HTTP 200/201の場合は成功通知が表示される |
| 他のエラー | 401/403/404/500等の場合は別のエラー通知が表示される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[フォーム入力完了] --> B[保存ボタン押下]
    B --> C[クライアントバリデーション]
    C -->|失敗| D[フィールドエラー表示]
    C -->|成功| E[APIリクエスト送信]
    E --> F{ステータスコード確認}
    F -->|200/201| G[成功処理]
    F -->|400| H[showSnackIcon呼び出し]
    F -->|401-500| I[その他エラー通知]
    H --> J[フィールドエラー抽出]
    J --> K[スナックバー表示]
    K --> L[フォーム再表示]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし（バリデーションエラーのため更新は行われない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バリデーションエラー | フォームデータが不正 | フィールドごとにエラーメッセージを表示 |
| 非フィールドエラー | __all__, non_field_errors | 非フィールドエラーとして表示 |
| コンテキスト不在 | Flutterコンテキストが無効 | 通知をスキップ |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間対応）

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

- エラーの詳細情報はフォーム画面内に表示され、スナックバーには含まれない
- 認証済みユーザーのみがアプリを使用可能

## 備考

- この通知はスナックバーでの簡易通知であり、詳細なエラー内容はフォームの各フィールドに表示される
- 国際化対応により、アプリの言語設定に応じたメッセージが表示される
- 非フィールドエラーは extractNonFieldErrors() で抽出されフォーム上部に表示される

---

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

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

### 推奨読解順序

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

まず、APIResponseクラスとフォームフィールドのエラー構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | api.dart | `lib/api.dart` | APIResponseクラスの定義（行35-110） |
| 1-2 | api_form.dart | `lib/api_form.dart` | APIFormFieldクラスのerrorMessages()（行234-252） |

**読解のコツ**: asMap()でレスポンスデータをMapに変換、エラーはフィールド名をキーとして格納される

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

_save()メソッドでのステータスコード400の処理を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | api_form.dart | `lib/api_form.dart` | _save()メソッド（行1384-1491） |

**主要処理フロー**:
1. **行1384-1386**: メソッド定義、データ収集開始
2. **行1437**: _submit()でAPIリクエスト送信
3. **行1444**: switch文でステータスコード分岐
4. **行1460-1470**: ステータスコード400の処理
5. **行1462**: `showSnackIcon(L10().formError, success: false)`
6. **行1465-1467**: 各フィールドのエラーメッセージ抽出
7. **行1469**: extractNonFieldErrors()で非フィールドエラー抽出

#### Step 3: エラーメッセージ抽出を理解する

extractErrorMessages()メソッドの実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | api_form.dart | `lib/api_form.dart` | extractErrorMessages()（行210-232） |
| 3-2 | api_form.dart | `lib/api_form.dart` | extractNonFieldErrors()（行1295-1318） |

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

```
APIFormWidgetState._save()  [lib/api_form.dart:1384]
    │
    ├─ _submit()  [行1437]
    │      └─ API POST/PATCHリクエスト
    │
    ├─ showSnackIcon()  [行1462]
    │      └─ L10().formError
    │
    ├─ field.extractErrorMessages()  [行1466]
    │      └─ 各フィールドのエラー抽出
    │
    └─ extractNonFieldErrors()  [行1469]
           └─ __all__, non_field_errors, errors の抽出
```

### データフロー図

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

フォームデータ     ───▶  _save()メソッド              ───▶  スナックバー表示
                          ├─ API送信                         │ 「Form Error」
                          ├─ 400レスポンス受信               │
                          ├─ フィールドエラー抽出            └─ フィールドエラー表示
                          └─ 非フィールドエラー抽出
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| api_form.dart | `lib/api_form.dart` | ソース | APIFormWidgetState、_save()メソッド |
| api.dart | `lib/api.dart` | ソース | APIResponseクラス |
| snacks.dart | `lib/widget/snacks.dart` | ソース | showSnackIcon関数の実装 |
| l10.dart | `lib/l10.dart` | ソース | 国際化ヘルパー関数L10() |
