# 通知設計書 3-イベント通知（カードクローズ）

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：プロジェクト管理において、タスクや課題の完了・クローズはチーム全体に共有すべき重要なマイルストーンである。カードがクローズされたことを関係者に通知することで、進捗状況の把握、次のアクションへの移行、関連タスクの着手判断などを促進する。クローズ通知がなければ、依存関係のあるタスクの着手が遅れたり、重複作業が発生するリスクがある。

**通知の送信タイミング**：カードがクローズされた際（Closureモデル作成時または"Done"へ移動時）に、Eventモデルが"card_closed"アクションで作成され、そのafter_create_commitコールバックによりNotifyRecipientsJobが非同期で実行される。

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

**通知内容の概要**：通知には、カードのタイトル（またはカード番号）、クローズを実行したユーザーの名前、クローズ方法（"Moved to Done" または "Closed"）が含まれる。ユーザーは通知から直接カード詳細画面へ遷移できる。

**期待されるアクション**：受信者は通知を確認し、必要に応じてカードの完了内容を確認、関連タスクの着手、レビューコメントの追加などのアクションを行うことが期待される。

## 通知種別

アプリ内通知

## 送信仕様

### 基本情報

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

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

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

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

## 通知テンプレート

### アプリ内通知

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

### 本文テンプレート

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

※ カードにclosure（Doneカラムへの移動）が存在する場合は"Moved to Done"、それ以外は"Closed"と表示される。

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| card.title | カードのタイトル | cards.title | No |
| card.number | カード番号 | cards.number | Yes |
| card.closure | クローズ情報 | closures テーブル | No |
| creator.name | クローズ実行者名 | users.name | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | カードクローズ操作 | action = "card_closed" | カードがクローズされた際 |
| 画面操作 | Doneカラムへ移動 | action = "card_closed" | カードがDoneカラムに移動された際 |
| API | カードクローズAPI | action = "card_closed" | APIを通じてカードがクローズされた際 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[カードクローズイベント発生] --> B[Event作成 action=card_closed]
    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の取得 |
| closures | クローズ情報取得 | card.closure |

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

#### events

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

#### closures

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| card_id | カードID | card.closure確認 |
| user_id | クローズ実行者ID | 表示用 |
| created_at | クローズ日時 | 表示用 |

### 更新テーブル一覧

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

## 備考

- カードがDoneカラムに移動された場合と、直接クローズされた場合で通知メッセージが異なる
- 同一カードの再クローズ時は通知が更新され、unread_countがインクリメントされる
- Webプッシュ通知はPushNotifiableコンサーンにより自動的に連動する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: closuresテーブルはcard_idにユニーク制約があり、1カードにつき1つのクローズ状態のみ保持。card.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作成後に非同期処理開始
2. **8行目（notifier.rb）**: CardEventNotifierの生成

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

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

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

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

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

**主要処理フロー**:
- **62-65行目**: card_closedのプッシュ通知ペイロード
  ```ruby
  when "card_closed"
    base_payload.merge(
      body: card.closure ? "Moved to Done by #{event.creator.name}" : "Closed by #{event.creator.name}"
    )
  ```

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

```
Event#create (カードクローズ時、action="card_closed")
    │
    ├─ 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
    │                                                             └─ card.closure判定
    │                                                                   ├─ "Moved to Done by ..."
    │                                                                   └─ "Closed by ..."
    └─ Turbo Stream broadcast
```

### データフロー図

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

Event                ───▶ Notifier.for(event)          ───▶ Notifier::CardEventNotifier
  │                                                           │
  ├─ action: "card_closed"                                    ├─ recipients決定
  ├─ creator_id                                               │   └─ board.watchers
  ├─ eventable (Card)                                         │       - creator除外
  │     └─ closure                                            │
  └─ board_id                                                 └─ Notification
                                                                    │
                                                                    ├─ notifications テーブル INSERT/UPDATE
                                                                    ├─ notification_bundles テーブル INSERT
                                                                    ├─ Turbo Stream broadcast
                                                                    └─ PushNotificationJob
                                                                          └─ closure判定でメッセージ分岐
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | スキーマ | テーブル定義（closures: 227-237行目） |
