# 通知設計書 35-レビューログイン要求通知

## 概要

本ドキュメントは、ECモバイルアプリケーションにおける「レビューログイン要求通知」の設計仕様を定義する。未ログイン状態のユーザーがウィッシュリスト追加や比較リスト追加などの認証が必要な操作を試みた際に、ログインを促すアプリ内通知を表示する機能について記載する。

### 本通知の処理概要

レビューログイン要求通知は、ホームページや商品一覧画面において、未ログイン状態のユーザーがウィッシュリスト追加（fetchDeleteAdd）や比較リスト追加（addCompare）などの認証が必要な操作を行おうとした際に、ログインが必要である旨を警告通知で表示する機能である。

**業務上の目的・背景**：ECサイトにおいて、ウィッシュリストや比較リストはユーザーアカウントに紐づいて管理される機能である。ゲストユーザーがこれらの機能を使用しようとした場合、操作が失敗する前にログインを促すことで、ユーザー体験の向上とアカウント登録の促進を図る。明確なフィードバックにより、ユーザーは何故操作ができないのかを理解し、適切なアクション（ログインまたは会員登録）を取ることができる。

**通知の送信タイミング**：ホームページや商品一覧画面において、未ログイン状態のユーザーがウィッシュリストアイコンや比較アイコンをタップした時点で即座に通知が表示される。API呼び出しの前にクライアント側でログイン状態をチェックし、未ログインの場合はイベントを抑止して通知を表示する。

**通知の受信者**：操作を試みた未ログインユーザー本人のみが通知を受け取る。通知はアプリ内のオーバーレイ表示であり、他のユーザーには影響しない。

**通知内容の概要**：黄色（amber）の背景で警告アイコンとともに「ログインしてください」（Please Login）というメッセージを表示する。

**期待されるアクション**：ユーザーはログイン画面へ移動してログインするか、新規会員登録を行う。その後、再度目的の操作（ウィッシュリスト追加等）を実行する。

## 通知種別

アプリ内通知（オーバーレイ通知）- 警告タイプ

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（ユーザー操作に対する即時レスポンス） |
| 優先度 | 中 |
| リトライ | 無（単発表示、自動消失） |

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

操作を試みたユーザー本人のアプリ画面にのみ表示される。ログイン状態はappStoragePref.getCustomerLoggedIn()で判定される。

## 通知テンプレート

### アプリ内通知の場合

| 項目 | 内容 |
|-----|------|
| 表示位置 | 画面上部オーバーレイ |
| 表示時間 | 自動消失（約3秒） |
| スワイプ操作 | 上方向スワイプで即時消去可能 |

### 警告時テンプレート

| 項目 | 内容 |
|-----|------|
| タイトル | "Warning"（ローカライズ対応） |
| 背景色 | 黄色/琥珀色（Colors.amber） |
| アイコン | 警告マーク（Icons.warning_amber） |

```
本文: "Please Login"（ローカライズ対応：StringConstants.pleaseLogin）
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本通知には添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| message | 警告メッセージ | StringConstants.pleaseLogin | Yes |
| title | 通知タイトル | StringConstants.warning | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | fetchDeleteAdd（ウィッシュリスト追加） | isLogin == false | ホームページでのウィッシュリスト操作 |
| 画面操作 | addCompare（比較リスト追加） | isLogin == false | ホームページでの比較リスト操作 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ログイン済み | isLogin == true の場合は通常処理を実行 |
| 画面遷移中 | 対象画面から離脱している場合は表示されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ウィッシュリスト/比較アイコンタップ] --> B[homepageEvent関数呼び出し]
    B --> C{HomePageAction判定}
    C -->|fetchDeleteAdd| D{isLogin判定}
    C -->|addCompare| E{isLogin判定}
    D -->|true| F[FetchAddWishlistHomepageEvent発行]
    D -->|false| G[OnClickLoaderEvent発行]
    E -->|true| H[AddToCompareHomepageEvent発行]
    E -->|false| G
    G --> I[ShowMessage.warningNotification]
    I --> J[オーバーレイ表示]
    J --> K[自動消失/スワイプ消去]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | クライアント側の状態チェックのみ |

### テーブル別参照項目詳細

データベース参照は行わない。ログイン状態はSharedPreferences（appStoragePref）から取得。

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知表示のみのためDB更新なし |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| なし | - | - | アプリ内通知のためログ記録なし |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | - | 本通知はバリデーションチェックの結果表示であり、エラー処理は不要 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（ユーザーによるログイン後の再操作） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（ユーザー操作起点） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（24時間対応）

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

- ログイン状態の判定はクライアント側のSharedPreferencesを使用
- 通知内容に個人情報は含まない
- 認証が必要な操作を未ログインユーザーから保護

## 備考

- overlay_supportパッケージを使用したオーバーレイ通知を採用
- ShowMessage.warningNotificationメソッドで警告通知を表示
- OnClickLoaderEvent(isReqToShowLoader: false)でローディング表示を解除
- 通知表示後、ユーザーは手動でログイン画面に遷移する必要がある

---

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

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

### 推奨読解順序

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

通知に関連するイベントとアクション定義を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | home_page_event.dart | `lib/screens/home_page/utils/home_page_event.dart` | HomePageAction enumの定義（48-52行目） |

**読解のコツ**: HomePageActionには`addToCart`、`fetchDeleteAdd`、`addCompare`の3つのアクションがあり、後者2つがログインチェック対象。

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

処理の起点となる関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | home_page_event.dart | `lib/screens/home_page/utils/home_page_event.dart` | homepageEvent関数全体（13-46行目） |

**主要処理フロー**:
1. **25行目**: `case HomePageAction.fetchDeleteAdd:` - ウィッシュリスト追加アクション
2. **26行目**: `if (isLogin ?? false)` - ログイン状態チェック
3. **30-32行目**: 未ログイン時の処理（OnClickLoaderEvent + warningNotification）
4. **35行目**: `case HomePageAction.addCompare:` - 比較リスト追加アクション
5. **36行目**: `if (isLogin ?? false)` - ログイン状態チェック
6. **40-42行目**: 未ログイン時の処理（OnClickLoaderEvent + warningNotification）

#### Step 3: 通知表示ロジックを理解する

実際の通知表示処理を把握する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | show_message.dart | `lib/widgets/show_message.dart` | warningNotificationメソッド（58-77行目） |

**主要処理フロー**:
- **58行目**: `static warningNotification(String msg, BuildContext context, {String? title})` - メソッドシグネチャ
- **60-61行目**: タイトル設定（デフォルトはStringConstants.warning）
- **64行目**: 背景色（Colors.amber）
- **65-68行目**: アイコン（Icons.warning_amber）

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

```
home_page.dart / new_product_view.dart (UI Layer)
    │
    └─ homepageEvent() 呼び出し
           │
           ├─ HomePageAction.fetchDeleteAdd
           │      │
           │      ├─ isLogin == true → FetchAddWishlistHomepageEvent発行
           │      │
           │      └─ isLogin == false
           │             │
           │             ├─ OnClickLoaderEvent(isReqToShowLoader: false)
           │             │
           │             └─ ShowMessage.warningNotification()
           │                    └─ showSimpleNotification()
           │
           └─ HomePageAction.addCompare
                  │
                  ├─ isLogin == true → AddToCompareHomepageEvent発行
                  │
                  └─ isLogin == false
                         │
                         ├─ OnClickLoaderEvent(isReqToShowLoader: false)
                         │
                         └─ ShowMessage.warningNotification()
                                └─ showSimpleNotification()
```

### データフロー図

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

User Tap Icon      ───▶  homepageEvent()            ───▶  Action判定
                              │
                              ▼
                         isLogin判定
                              │
                              ├─ true → イベント発行（API呼び出しへ）
                              │
                              └─ false
                                    │
                                    ▼
                              OnClickLoaderEvent
                              (ローディング解除)
                                    │
                                    ▼
                    ShowMessage.warningNotification()
                                    │
                                    ▼
                              Overlay Display
                              "Please Login"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| home_page_event.dart | `lib/screens/home_page/utils/home_page_event.dart` | ソース | イベントハンドリング、ログインチェック |
| show_message.dart | `lib/widgets/show_message.dart` | ソース | 通知表示ユーティリティ |
| home_page.dart | `lib/screens/home_page/home_page.dart` | ソース | ホームページ画面 |
| new_product_view.dart | `lib/screens/home_page/widget/new_product_view.dart` | ソース | 新商品表示ウィジェット |
| string_constants.dart | `lib/utils/string_constants.dart` | 設定 | 文字列定数定義（pleaseLogin） |
| app_storage_pref.dart | `lib/utils/app_storage_pref.dart` | ソース | ログイン状態の永続化 |
| index.dart | `lib/screens/home_page/utils/index.dart` | ソース | 関連ファイルのexport |
