# 通知設計書 15-ActionCable::Channel::Streams#stream_for

## 概要

本ドキュメントは、ActionCableのモデルベースストリーミング購読機能について、設計情報を記載するものである。

### 本通知の処理概要

ActionCable::Channel::Streams#stream_forは、Active RecordモデルやGlobalIDを持つオブジェクトに関連付けられたブロードキャストチャンネルを自動的に購読するメソッドである。stream_fromの高レベルラッパーであり、モデルインスタンスからブロードキャストチャンネル名を自動生成する。

**業務上の目的・背景**：特定のモデルインスタンス（例：チャットルーム、プロジェクト、ドキュメント）に関連するリアルタイム更新を購読する際に、手動でチャンネル名を構築する必要がなくなる。これにより、コードの可読性が向上し、チャンネル名の命名規則が一貫する。GlobalIDを使用することで、異なるモデルタイプ間でも一意なチャンネル名が保証される。

**通知の送信タイミング**：クライアントがチャンネルを購読した際に、subscribedコールバック内でstream_forが呼び出される。対応するモデルへのbroadcast_toでメッセージが送信される。

**通知の受信者**：stream_forを呼び出したチャンネルインスタンスに紐づくWebSocketクライアント。

**通知内容の概要**：モデルに対してbroadcast_toされたメッセージ（JSON形式）がクライアントに転送される。

**期待されるアクション**：クライアント側でreceivedコールバックが発火し、モデルに関連するUI更新が実行される。

## 通知種別

WebSocket通知（モデルベースストリーミング購読）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | リアルタイムストリーミング（stream_from経由） |
| 優先度 | 高（WebSocket直接転送） |
| リトライ | なし |

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

1. チャンネルのsubscribedコールバック内で`stream_for model`を呼び出す
2. `broadcasting_for(model)`でモデルからチャンネル名を生成（GlobalID使用）
3. 生成されたチャンネル名で`stream_from`を呼び出す

## 通知テンプレート

### チャンネル名生成ルール

| 項目 | 内容 |
|-----|------|
| 形式 | `{channel_name}:{model.to_gid_param}` |
| 例 | `comments:Z2lkOi8vVGVzdEFwcC9Qb3N0LzE` |

### メッセージ受信例

```javascript
// クライアント側
App.comments = App.cable.subscriptions.create(
  { channel: "CommentsChannel", post_id: 1 },
  {
    received: function(data) {
      // CommentsChannel.broadcast_to(@post, data)で送信されたデータ
      console.log("New comment:", data);
    }
  }
);
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| N/A | - | - | WebSocket通知には添付ファイルの概念なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| broadcastables | 購読対象のモデル/オブジェクト | 呼び出し元で指定 | Yes |
| callback | カスタムメッセージハンドラ | ブロックまたは引数 | No |
| coder | デコーダー | デフォルトnil | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| チャンネル購読 | subscribed | 購読成功時 | モデルに対する購読開始 |
| ブロードキャスト | broadcast_to | メッセージ送信時 | モデルへのbroadcast_to呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| モデルがnil | stream_or_reject_forを使用時は購読拒否 |
| unsubscribed? | チャンネル購読解除済み |

## 処理フロー

### 購読フロー

```mermaid
flowchart TD
    A[stream_for model 呼び出し] --> B[broadcasting_for model]
    B --> C[serialize_broadcasting]
    C --> D{GlobalID対応?}
    D -->|Yes| E[model.to_gid_param]
    D -->|No| F[model.to_param]
    E --> G[channel_name:gid形式]
    F --> G
    G --> H[stream_from broadcasting]
    H --> I[stream_fromの処理フロー]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | stream_for自体はDBを参照しない（モデルは呼び出し元で取得済み） |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | stream_forはDBを更新しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| GlobalID未対応 | モデルがto_gid_paramに対応していない | to_paramにフォールバック |
| nil指定 | broadcastablesがnil | stream_or_reject_for使用でreject |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | stream_fromに準拠 |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- stream_for呼び出し前に、ユーザーが対象モデルにアクセス権限を持つことを確認する
- GlobalIDにはモデルのIDが含まれるため、URL推測攻撃に注意
- subscribedコールバック内で適切な認可チェックを実施する

## 備考

- stream_forはstream_fromの高レベルラッパーで、内部でbroadcasting_forを使用
- broadcasting_forはチャンネルクラスメソッドでも使用可能（broadcast_to用）
- stop_stream_forでモデル指定でストリーム停止可能
- stream_or_reject_forでモデルがnilの場合に自動reject

---

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

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

### 推奨読解順序

#### Step 1: stream_forメソッドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | streams.rb | `actioncable/lib/action_cable/channel/streams.rb` | stream_forメソッド |

**主要処理フロー**:
1. **行118-120**: `stream_for(broadcastables, callback = nil, coder: nil, &block)` - エントリーポイント
2. **行119**: `stream_from(broadcasting_for(broadcastables), callback || block, coder: coder)` - stream_fromに委譲

#### Step 2: broadcasting_forメソッドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | broadcasting.rb | `actioncable/lib/action_cable/channel/broadcasting.rb` | broadcasting_forメソッド |

**主要処理フロー**:
- **行24-26**: `broadcasting_for(broadcastables)` - チャンネル名生成
- **行25**: `serialize_broadcasting([ channel_name ] + Array(broadcastables))` - シリアライズ
- **行29-37**: `serialize_broadcasting` - GlobalID対応オブジェクトはto_gid_param、それ以外はto_param

#### Step 3: broadcast_toとの関連を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | broadcasting.rb | `actioncable/lib/action_cable/channel/broadcasting.rb` | broadcast_toメソッド |

**主要処理フロー**:
- **行14-16**: `broadcast_to(broadcastables, message)` - モデルへのブロードキャスト
- **行15**: `ActionCable.server.broadcast(broadcasting_for(broadcastables), message)` - 同じbroadcasting_forを使用

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

```
stream_for(broadcastables, callback, coder:, &block)
    │
    └─ stream_from(broadcasting_for(broadcastables), ...) (行119)
           │
           ├─ broadcasting_for(broadcastables) (broadcasting.rb 行24-26)
           │      │
           │      └─ serialize_broadcasting([channel_name] + Array(broadcastables))
           │             │
           │             ├─ object.is_a?(Array)
           │             │      └─ 再帰的にserialize_broadcasting
           │             │
           │             ├─ object.respond_to?(:to_gid_param)
           │             │      └─ object.to_gid_param (GlobalID)
           │             │
           │             └─ otherwise
           │                    └─ object.to_param
           │
           └─ stream_from処理 (streams.rb)

# 対になるbroadcast_to
CommentsChannel.broadcast_to(post, message)
    │
    └─ ActionCable.server.broadcast(broadcasting_for(post), message)
           │
           └─ 同じbroadcasting_for → 同じチャンネル名
```

### データフロー図

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

broadcastables ─────────▶ broadcasting_for ───▶ "comments:Z2lkOi8v..."
(Post, User, etc.)              │
                                │
                                ├─ channel_name (e.g., "comments")
                                │
                                └─ model.to_gid_param or to_param
                                       │
                                       ▼
                               stream_from(broadcasting_name)
                                       │
                                       ▼
                               購読開始 (stream_fromフロー)

# broadcast_to側
CommentsChannel.broadcast_to(@post, data)
    │
    └─ broadcasting_for(@post) → 同じチャンネル名
           │
           └─ ActionCable.server.broadcast → クライアントへ配信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| streams.rb | `actioncable/lib/action_cable/channel/streams.rb` | ソース | stream_for, stop_stream_for |
| broadcasting.rb | `actioncable/lib/action_cable/channel/broadcasting.rb` | ソース | broadcasting_for, broadcast_to |
| base.rb | `actioncable/lib/action_cable/channel/base.rb` | ソース | チャンネル基底クラス |
| global_id.rb | `globalid/lib/global_id/identification.rb` | ソース | GlobalID対応 |
