# 通知設計書 4-イベント通知（カード再オープン）

## 概要

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

### 本通知の処理概要

カードが再オープン（card_reopened）された際に、該当ボードのウォッチャーに対してアプリ内通知を送信する機能を提供する。

**業務上の目的・背景**：一度クローズされたタスクや課題が再び作業対象となることは、プロジェクト管理において珍しくない。追加対応が必要になった、バグが再発した、要件が変更されたなどの理由でカードが再オープンされた際、関係者がその変更を把握し、適切に対応できるようにする必要がある。再オープン通知がなければ、完了したと思っていたタスクが再び未完了になったことに気づかず、対応が遅れるリスクがある。

**通知の送信タイミング**：カードがクローズ状態から再オープンされた際（Closureレコードの削除時）に、Eventモデルが"card_reopened"アクションで作成され、そのafter_create_commitコールバックによりNotifyRecipientsJobが非同期で実行される。

**通知の受信者**：対象ボードのウォッチャーのうち、再オープンを実行したユーザー（creator）を除外した全員が受信者となる。

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

**期待されるアクション**：受信者は通知を確認し、カードが再オープンされた理由を確認、必要に応じて作業の再開、コメントでの状況確認、担当者の再調整などのアクションを行うことが期待される。

## 通知種別

アプリ内通知

## 送信仕様

### 基本情報

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

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

1. カードが所属するボード（`card.board`）のウォッチャー一覧を取得
2. 再オープンを実行したユーザー（`creator`）を除外

```ruby
board.watchers.without(creator)
```

## 通知テンプレート

### アプリ内通知

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

### 本文テンプレート

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | カード再オープン操作 | action = "card_reopened" | クローズされたカードが再オープンされた際 |
| API | カード再オープンAPI | action = "card_reopened" | APIを通じてカードが再オープンされた際 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| creator.system? = true | システムユーザーによる操作の場合は通知しない |
| 受信者が0人 | ウォッチャーが存在しない、または全員がcreatorの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[カード再オープンイベント発生] --> B[Event作成 action=card_reopened]
    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[board.watchers.without 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経由 |
| boards | ボード情報取得 | card.board |
| users | ユーザー情報取得 | creator, watchers |
| watches | ウォッチャー情報取得 | board.watchersの取得 |

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

#### events

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | イベント識別子 | 通知のsource_id |
| action | アクション種別 | "card_reopened" |
| creator_id | 再オープン実行者ID | 通知除外判定 |
| eventable_id | 対象カードID | カード情報取得 |
| board_id | ボードID | ウォッチャー取得 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| 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配信はユーザー固有のチャンネルを使用
- カード情報は当該アカウントのメンバーに限定される

## 備考

- card_reopenedはcard_closedと同じelse分岐で受信者が決定される（board.watchers.without(creator)）
- 同一カードに対するクローズ→再オープン→クローズの連続操作では、各イベントで通知が更新される
- Webプッシュ通知はPushNotifiableコンサーンにより自動的に連動する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: card_reopenedはカードのClosureレコードが削除された際に発生するイベント。クローズ状態の解除を意味する。

#### 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作成後に非同期処理開始

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

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

**主要処理フロー**:
- **14-16行目（card_event_notifier.rb）**: card_reopenedアクションの受信者決定（else分岐）
  ```ruby
  else
    board.watchers.without(creator)
  ```

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

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

**主要処理フロー**:
- **66-68行目**: card_reopenedのプッシュ通知ペイロード
  ```ruby
  when "card_reopened"
    base_payload.merge(
      body: "Reopened by #{event.creator.name}"
    )
  ```

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

```
Event#create (カード再オープン時、action="card_reopened")
    │
    ├─ Notifiable#notify_recipients_later (after_create_commit)
    │      └─ NotifyRecipientsJob.perform_later(self)
    │             └─ Notifier.for(event)
    │                    └─ Notifier::CardEventNotifier.new(event)
    │                           └─ #notify
    │                                  ├─ #recipients
    │                                  │     └─ board.watchers.without(creator)
    │                                  └─ Notification.create_or_find_by
    │                                         ├─ #bundle (after_create)
    │                                         └─ PushNotificationJob.perform_later (after_save_commit)
    │                                               └─ NotificationPusher#push
    │                                                      └─ #build_event_payload
    │                                                             └─ "Reopened by ..."
    └─ Turbo Stream broadcast
```

### データフロー図

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

Event                ───▶ Notifier.for(event)          ───▶ Notifier::CardEventNotifier
  │                                                           │
  ├─ action: "card_reopened"                                  ├─ recipients決定
  ├─ creator_id                                               │   └─ board.watchers
  ├─ eventable (Card)                                         │       - creator除外
  └─ board_id                                                 │
                                                              └─ Notification
                                                                    │
                                                                    ├─ notifications テーブル INSERT/UPDATE
                                                                    ├─ notification_bundles テーブル INSERT
                                                                    ├─ Turbo Stream broadcast
                                                                    └─ PushNotificationJob
                                                                          └─ "Reopened 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 |
| notification_pusher.rb | `app/models/notification_pusher.rb` | モデル | プッシュ通知送信処理 |
| schema.rb | `db/schema.rb` | スキーマ | テーブル定義 |
