# 通知設計書 2-イベント通知（カード担当者変更）

## 概要

本ドキュメントは、Fizzyアプリケーションにおける「カード担当者変更」イベント発生時のアプリ内通知機能について、その設計仕様を記載するものである。

### 本通知の処理概要

カードの担当者が変更（card_assigned）された際に、新しく担当者となったユーザーに対してアプリ内通知を送信する機能を提供する。

**業務上の目的・背景**：プロジェクト管理において、タスクや課題の担当者アサインは重要なワークフローの一部である。担当者に指名されたユーザーが即座にその事実を認識し、適切なアクションを取れるようにする必要がある。担当者への通知がなければ、アサインされたことに気づかず、タスクの放置や対応遅延を招くリスクがある。

**通知の送信タイミング**：カードに担当者が追加された際（Assignment作成時）に、Eventモデルが"card_assigned"アクションで作成され、そのafter_create_commitコールバックによりNotifyRecipientsJobが非同期で実行される。

**通知の受信者**：新しくカードの担当者となったユーザー（assignees）のうち、担当者変更を実行したユーザー（creator）を除外した全員が受信者となる。自分自身を担当者にアサインした場合は通知されない。

**通知内容の概要**：通知には、カードのタイトル（またはカード番号）、アサインを実行したユーザーの名前が含まれる。ユーザーは通知から直接カード詳細画面へ遷移できる。

**期待されるアクション**：受信者は通知を確認し、カードの内容を確認して作業を開始する、必要に応じて質問やコメントを追加する、または担当辞退の意思を表明するなどのアクションを行うことが期待される。

## 通知種別

アプリ内通知

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（Active Job） |
| 優先度 | 中 |
| リトライ | Active Jobのデフォルト設定に準拠 |

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

1. イベントソースから担当者一覧（`source.assignees`）を取得
2. 担当者変更を実行したユーザー（`creator`）を除外

```ruby
source.assignees.excluding(creator)
```

## 通知テンプレート

### アプリ内通知

| 項目 | 内容 |
|-----|------|
| 表示形式 | リスト形式（通知一覧画面） |
| アバター | アサイン実行者のアバター画像 |
| リンク先 | カード詳細画面 |

### 本文テンプレート

Webプッシュ通知連動時のメッセージ:
```
Title: {カードタイトル} または "Card {カード番号}"
Body: "Assigned to you by {アサイン実行者名}"
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| - | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| card.title | カードのタイトル | cards.title | No |
| card.number | カード番号 | cards.number | Yes |
| creator.name | アサイン実行者名 | users.name | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | 担当者追加操作 | action = "card_assigned" | カードに担当者が追加された際 |
| API | 担当者追加API | action = "card_assigned" | APIを通じて担当者が追加された際 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| creator.system? = true | システムユーザーによる操作の場合は通知しない |
| 自己アサイン | アサイン実行者が自分自身を担当者にした場合 |
| 受信者が0人 | 全担当者がcreatorの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[担当者変更イベント発生] --> B[Event作成 action=card_assigned]
    B --> C[after_create_commit]
    C --> D[NotifyRecipientsJob キュー投入]
    D --> E[Notifier.for source 実行]
    E --> F[Notifier::CardEventNotifier 生成]
    F --> G[should_notify? チェック]
    G -->|creator.system? = false| H[recipients 決定]
    G -->|creator.system? = true| I[処理終了]
    H --> J[source.assignees.excluding creator]
    J --> K[各recipientにNotification作成/更新]
    K --> L[after_create_commit: bundle処理]
    L --> M[after_save_commit: PushNotificationJob]
    M --> N[Turbo Stream配信]
    N --> O[終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| events | イベント情報取得 | source_typeがEventの場合 |
| cards | カード情報取得 | eventable経由 |
| users | ユーザー情報取得 | creator, assignees |
| assignments | 担当者情報取得 | source.assignees |

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

#### events

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | イベント識別子 | 通知のsource_id |
| action | アクション種別 | "card_assigned" |
| creator_id | アサイン実行者ID | 通知除外判定 |
| eventable_id | 対象カードID | カード情報取得 |
| particulars | 追加情報 | assigneesのID等 |

#### assignments

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| assignee_id | 担当者ID | 通知受信者決定 |
| card_id | カードID | カード特定 |
| assigner_id | アサイン実行者ID | creator確認 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| notifications | INSERT/UPDATE | 通知レコードの作成または更新 |
| notification_bundles | INSERT/UPDATE | メールバンドル用レコード |

#### notificationsテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT/UPDATE | user_id | 担当者のID | 通知対象ユーザー |
| INSERT/UPDATE | card_id | 対象カードのID | set_cardで自動設定 |
| INSERT/UPDATE | source_type | "Event" | ポリモーフィック関連 |
| INSERT/UPDATE | source_id | EventのID | イベント参照 |
| INSERT/UPDATE | creator_id | アサイン実行者のID | 通知作成者 |
| INSERT/UPDATE | unread_count | 1（新規）/ +1（更新） | 未読カウント |
| UPDATE | read_at | nil | 再度未読にする |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ActiveJob::DeserializationError | 通知対象レコードが削除済み | PushNotificationJobでdiscard |
| ActiveRecord::RecordNotUnique | 同一user_id, card_idの重複 | create_or_find_byで対応済み |
| ActiveRecord::RecordInvalid | バリデーションエラー | 例外発生、ジョブリトライ |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Active Jobデフォルト（5回） |
| リトライ間隔 | 指数バックオフ |
| リトライ対象エラー | StandardError（DeserializationError除く） |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間配信可能）

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

- 通知はaccount_idでスコープされ、同一アカウント内のユーザーにのみ配信される
- 担当者情報は当該アカウントのメンバーに限定される
- Turbo Stream配信はユーザー固有のチャンネルを使用し、他ユーザーには表示されない

## 備考

- 複数人を同時に担当者として追加した場合、全員に個別の通知が送信される
- 担当者追加時にカードのウォッチャーとして自動的に登録される（別ロジック）
- Webプッシュ通知はPushNotifiableコンサーンにより自動的に連動する

---

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

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

### 推奨読解順序

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

まず、通知処理で使用されるデータモデルの構造を理解することが重要である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notification.rb | `app/models/notification.rb` | 通知モデルの構造、スコープ、コールバック定義 |
| 1-2 | event.rb | `app/models/event.rb` | イベントモデル、particularsでassignees情報保持 |
| 1-3 | schema.rb | `db/schema.rb` | notifications, events, assignmentsテーブル定義 |

**読解のコツ**: card_assignedイベントでは、Event#particularsにアサインされたユーザーIDが含まれる場合がある。Event::Particularsモジュールを確認すると詳細がわかる。

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

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | notifiable.rb | `app/models/concerns/notifiable.rb` | after_create_commitでnotify_recipients_laterが呼ばれる |
| 2-2 | notifier.rb | `app/models/notifier.rb` | Notifier.forでCardEventNotifierを生成 |

**主要処理フロー**:
1. **7行目**: `after_create_commit :notify_recipients_later` - Event作成後に非同期処理開始
2. **8行目（notifier.rb）**: `"Notifier::#{source.eventable.class}EventNotifier"` でカード用Notifierを特定

#### Step 3: 通知生成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | card_event_notifier.rb | `app/models/notifier/card_event_notifier.rb` | card_assignedの受信者決定ロジック（8-9行目） |
| 3-2 | notifier.rb | `app/models/notifier.rb` | notifyメソッドの実装 |

**主要処理フロー**:
- **8-9行目（card_event_notifier.rb）**: card_assignedアクションの受信者決定
  ```ruby
  when "card_assigned"
    source.assignees.excluding(creator)
  ```

#### Step 4: プッシュ通知ペイロードを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | notification_pusher.rb | `app/models/notification_pusher.rb` | card_assignedのペイロード構築（54-57行目） |

**主要処理フロー**:
- **54-57行目**: card_assignedのプッシュ通知ペイロード
  ```ruby
  when "card_assigned"
    base_payload.merge(
      body: "Assigned to you by #{event.creator.name}"
    )
  ```

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

```
Event#create (担当者変更時、action="card_assigned")
    │
    ├─ Notifiable#notify_recipients_later (after_create_commit)
    │      └─ NotifyRecipientsJob.perform_later(self)
    │             └─ Notifier.for(event)
    │                    └─ Notifier::CardEventNotifier.new(event)
    │                           └─ #notify
    │                                  ├─ #recipients
    │                                  │     └─ source.assignees.excluding(creator)
    │                                  └─ Notification.create_or_find_by
    │                                         ├─ #bundle (after_create)
    │                                         └─ PushNotificationJob.perform_later (after_save_commit)
    │                                               └─ NotificationPusher#push
    │                                                      └─ #build_event_payload
    │                                                             └─ "Assigned to you by ..."
    └─ Turbo Stream broadcast
```

### データフロー図

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

Event                ───▶ Notifier.for(event)          ───▶ Notifier::CardEventNotifier
  │                                                           │
  ├─ action: "card_assigned"                                  ├─ recipients決定
  ├─ creator_id                                               │   └─ source.assignees
  ├─ eventable (Card)                                         │       - creator除外
  └─ particulars                                              │
       └─ assignees情報                                       └─ Notification
                                                                    │
                                                                    ├─ notifications テーブル INSERT/UPDATE
                                                                    ├─ notification_bundles テーブル INSERT
                                                                    ├─ Turbo Stream broadcast
                                                                    └─ PushNotificationJob
                                                                          └─ "Assigned to you by {name}"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| notification.rb | `app/models/notification.rb` | モデル | 通知モデル定義 |
| event.rb | `app/models/event.rb` | モデル | イベントモデル定義 |
| notifier.rb | `app/models/notifier.rb` | モデル | 通知生成の基底クラス |
| card_event_notifier.rb | `app/models/notifier/card_event_notifier.rb` | モデル | カードイベント用通知生成 |
| notifiable.rb | `app/models/concerns/notifiable.rb` | Concern | 通知可能モデル用Concern |
| push_notifiable.rb | `app/models/concerns/push_notifiable.rb` | Concern | プッシュ通知用Concern |
| notification_pusher.rb | `app/models/notification_pusher.rb` | モデル | プッシュ通知送信処理 |
| push_notification_job.rb | `app/jobs/push_notification_job.rb` | ジョブ | プッシュ通知非同期ジョブ |
| schema.rb | `db/schema.rb` | スキーマ | テーブル定義 |
