# 通知設計書 5-イベント通知（コメント作成）

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：プロジェクト管理において、タスクや課題に対するコメントは重要なコミュニケーション手段である。質問、進捗報告、フィードバック、決定事項の共有など、様々な目的でコメントが投稿される。関係者がコメントを見落とすと、重要な情報の伝達漏れ、意思決定の遅延、誤解によるトラブルが発生するリスクがある。

**通知の送信タイミング**：カードに新しいコメントが追加された際に、Eventモデルが"comment_created"アクションで作成され、そのafter_create_commitコールバックによりNotifyRecipientsJobが非同期で実行される。

**通知の受信者**：対象カードのウォッチャーのうち、コメント作成者（creator）およびコメント本文中でメンションされたユーザー（mentionees）を除外した全員が受信者となる。メンションされたユーザーには別途MentionNotifierによる通知が送信される。

**通知内容の概要**：通知には、カードのタイトル（またはカード番号）にREプレフィックスを付けたもの、コメント本文の抜粋（200文字まで）、コメント作成者の名前が含まれる。ユーザーは通知から直接コメント位置へ遷移できる。

**期待されるアクション**：受信者は通知を確認し、コメント内容を確認、必要に応じて返信コメントの追加、タスクの対応、質問への回答などのアクションを行うことが期待される。

## 通知種別

アプリ内通知

## 送信仕様

### 基本情報

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

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

1. コメントが所属するカード（`comment.card`）のウォッチャー一覧を取得
2. コメント作成者（`creator`）を除外
3. コメント本文中でメンションされたユーザー（`source.eventable.mentionees`）を除外

```ruby
card.watchers.without(creator, *source.eventable.mentionees)
```

## 通知テンプレート

### アプリ内通知

| 項目 | 内容 |
|-----|------|
| 表示形式 | リスト形式（通知一覧画面） |
| アバター | コメント作成者のアバター画像 |
| リンク先 | カード詳細画面（コメント位置へのアンカー付き） |

### 本文テンプレート

Webプッシュ通知連動時のメッセージ:
```
Title: "RE: {カードタイトル}" または "RE: Card {カード番号}"
Body: {コメント本文の抜粋（最大200文字）}
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| card.title | カードのタイトル | cards.title | No |
| card.number | カード番号 | cards.number | Yes |
| comment.body | コメント本文 | action_text_rich_texts.body | Yes |
| creator.name | コメント作成者名 | users.name | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | コメント投稿 | action = "comment_created" | カードに新しいコメントが追加された際 |
| API | コメント作成API | action = "comment_created" | APIを通じてコメントが追加された際 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コメント作成イベント発生] --> B[Event作成 action=comment_created]
    B --> C[after_create_commit]
    C --> D[NotifyRecipientsJob キュー投入]
    D --> E[Notifier.for source 実行]
    E --> F[Notifier::CommentEventNotifier 生成]
    F --> G[should_notify? チェック]
    G -->|creator.system? = false| H[recipients 決定]
    G -->|creator.system? = true| I[処理終了]
    H --> J[card.watchers.without creator, mentionees]
    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の場合 |
| comments | コメント情報取得 | eventable経由 |
| cards | カード情報取得 | comment.card |
| users | ユーザー情報取得 | creator, watchers |
| watches | ウォッチャー情報取得 | card.watchersの取得 |
| mentions | メンション情報取得 | comment.mentionees |
| action_text_rich_texts | コメント本文 | comment.body |

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

#### events

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | イベント識別子 | 通知のsource_id |
| action | アクション種別 | "comment_created" |
| creator_id | コメント作成者ID | 通知除外判定 |
| eventable_id | 対象コメントID | コメント情報取得 |
| board_id | ボードID | アクセス制御 |

#### comments

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | コメントID | eventable_id |
| card_id | カードID | ウォッチャー取得 |
| creator_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でスコープされ、同一アカウント内のユーザーにのみ配信される
- コメント本文は抜粋として通知に含まれるが、200文字に制限される
- Turbo Stream配信はユーザー固有のチャンネルを使用

## 備考

- コメント内でメンションされたユーザーには、別途MentionNotifierによるメンション通知が送信される
- CardEventNotifierではなくCommentEventNotifierが使用される（eventable.classがCommentのため）
- プッシュ通知ではコメント位置へのアンカー（`#comment_xxx`）が含まれる
- コメント本文はformat_excerptヘルパーで抜粋される

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notification.rb | `app/models/notification.rb` | 通知モデルの構造、スコープ、コールバック定義 |
| 1-2 | event.rb | `app/models/event.rb` | イベントモデル、eventableがCommentの場合 |
| 1-3 | schema.rb | `db/schema.rb` | notifications, events, commentsテーブル定義（252-260行目） |

**読解のコツ**: comment_createdイベントではeventableがCommentを指す。Notifier.forでCommentEventNotifierが選択される仕組みを理解する。

#### 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` | eventable.classがCommentの場合、CommentEventNotifierが生成 |

**主要処理フロー**:
1. **8行目（notifier.rb）**: `"Notifier::#{source.eventable.class}EventNotifier"` でCommentEventNotifierを生成

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

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

**主要処理フロー**:
- **5-6行目（comment_event_notifier.rb）**: comment_createdアクションの受信者決定
  ```ruby
  def recipients
    card.watchers.without(creator, *source.eventable.mentionees)
  end
  ```

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

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

**主要処理フロー**:
- **48-53行目**: comment_createdのプッシュ通知ペイロード
  ```ruby
  when "comment_created"
    base_payload.merge(
      title: "RE: #{base_payload[:title]}",
      body: comment_notification_body(event),
      path: card_path_with_comment_anchor(event.eventable)
    )
  ```

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

```
Event#create (コメント作成時、action="comment_created", eventable=Comment)
    │
    ├─ Notifiable#notify_recipients_later (after_create_commit)
    │      └─ NotifyRecipientsJob.perform_later(self)
    │             └─ Notifier.for(event)
    │                    └─ Notifier::CommentEventNotifier.new(event)  ← eventable.classがComment
    │                           └─ #notify
    │                                  ├─ #recipients
    │                                  │     └─ card.watchers.without(creator, *eventable.mentionees)
    │                                  └─ Notification.create_or_find_by
    │                                         ├─ #bundle (after_create)
    │                                         └─ PushNotificationJob.perform_later (after_save_commit)
    │                                               └─ NotificationPusher#push
    │                                                      └─ #build_event_payload
    │                                                             ├─ title: "RE: ..."
    │                                                             ├─ body: comment抜粋
    │                                                             └─ path: #comment_xxx
    └─ Turbo Stream broadcast
```

### データフロー図

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

Event                ───▶ Notifier.for(event)          ───▶ Notifier::CommentEventNotifier
  │                                                           │
  ├─ action: "comment_created"                                ├─ recipients決定
  ├─ creator_id                                               │   └─ card.watchers
  ├─ eventable (Comment)                                      │       - creator除外
  │     ├─ card                                               │       - mentionees除外
  │     ├─ body                                               │
  │     └─ mentionees                                         └─ Notification
  └─ board_id                                                       │
                                                                    ├─ notifications テーブル INSERT/UPDATE
                                                                    ├─ notification_bundles テーブル INSERT
                                                                    ├─ Turbo Stream broadcast
                                                                    └─ PushNotificationJob
                                                                          ├─ title: "RE: {card.title}"
                                                                          ├─ body: {comment抜粋}
                                                                          └─ path: /cards/x#comment_y
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| notification.rb | `app/models/notification.rb` | モデル | 通知モデル定義 |
| event.rb | `app/models/event.rb` | モデル | イベントモデル定義 |
| notifier.rb | `app/models/notifier.rb` | モデル | 通知生成の基底クラス |
| comment_event_notifier.rb | `app/models/notifier/comment_event_notifier.rb` | モデル | コメントイベント用通知生成 |
| notifiable.rb | `app/models/concerns/notifiable.rb` | Concern | 通知可能モデル用Concern |
| notification_pusher.rb | `app/models/notification_pusher.rb` | モデル | プッシュ通知送信処理（48-53行目, 109-111行目, 117-123行目） |
| schema.rb | `db/schema.rb` | スキーマ | テーブル定義（comments: 252-260行目） |
