# 機能設計書 164-Widgetイベント

## 概要

本ドキュメントは、Chatwoot WebウィジェットにおけるWidgetイベント機能の設計を記載する。この機能はエンドユーザー（訪問者）がWebサイト上のチャットウィジェットを通じてカスタムイベントを送信するためのAPIを提供する。

### 本機能の処理概要

Widgetイベント機能は、Webサイト訪問者のアクション（ページ閲覧、ボタンクリック等）をChatwootに送信し、オートメーションルールのトリガーや訪問者行動の追跡に利用するための機能を提供する。イベントにはブラウザ情報や言語設定などのコンテキスト情報が自動的に付加される。

**業務上の目的・背景**：Webサイト訪問者の行動を追跡し、行動ベースのオートメーション（特定ページ訪問時のキャンペーントリガー、特定アクション実行時の自動対応等）を実現するため、カスタムイベントの送信機能が必要である。これにより、プロアクティブなカスタマーサポートや行動分析が可能になる。

**機能の利用シーン**：
- 訪問者が特定のページを閲覧した際にイベントを記録する場面
- 訪問者が商品をカートに追加した際にイベントを送信する場面
- 訪問者がフォームを送信した際にイベントをトリガーする場面
- ウィジェットの開閉などのUI操作をイベントとして記録する場面

**主要な処理内容**：
1. カスタムイベントの受信
2. ブラウザ情報・言語情報の付加
3. イベントディスパッチャーへのイベント配信
4. オートメーションルールとの連携

**関連システム・外部連携**：
- Rails.configuration.dispatcher（イベントディスパッチャー）
- オートメーションルール（イベントトリガー）
- キャンペーン（イベントベーストリガー）

**権限による制御**：
- website_tokenによるウィジェット認証が必要

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 114 | ホーム画面 | 参照画面 | ウィジェット操作イベントの送信元 |
| 116 | メッセージ画面 | 参照画面 | チャット操作イベントの送信元 |

## 機能種別

イベント送信 / データ連携

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| website_token | String | Yes | ウェブウィジェットの識別トークン | 有効なトークンである必要がある |
| name | String | Yes | イベント名 | - |
| event_info | Hash | No | イベントに付加する追加情報 | - |
| locale | String | No | ウィジェットの言語設定 | - |

### 入力データソース

- Webウィジェット（JavaScript SDK）からのHTTPリクエスト
- ブラウザ情報（User-Agent、Accept-Language）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | - | 204 No Contentを返却 |

### 出力先

- イベントディスパッチャー（Rails.configuration.dispatcher）
- オートメーションルールのトリガー

## 処理フロー

### 処理シーケンス

```
1. イベント作成（create）
   └─ パラメータ検証
   └─ ブラウザ情報の取得
   └─ イベント情報のマージ
   └─ ディスパッチャーへのイベント配信
   └─ 204 No Contentを返却
```

### フローチャート

```mermaid
flowchart TD
    A[リクエスト受信] --> B[パラメータ検証]
    B --> C[ブラウザ情報取得]
    C --> D[イベント情報マージ]
    D --> E[ディスパッチャー配信]
    E --> F[204 No Content]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-164-01 | 自動情報付加 | widget_language, browser_language, browserを自動付加 | 全イベント |
| BR-164-02 | イベント名の自由度 | 任意のイベント名を送信可能 | - |
| BR-164-03 | 非同期配信 | イベントは非同期で処理される | - |

### 計算ロジック

特になし

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| create | - | - | データベースへの直接操作なし |

### テーブル別操作詳細

本機能はイベントディスパッチャーを通じて処理を行うため、直接的なデータベース操作は発生しない。イベントをトリガーとしたオートメーションルールやキャンペーンが間接的にデータベース操作を行う可能性がある。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 401 | Unauthorized | website_tokenが無効 | 正しいトークンを使用 |

### リトライ仕様

特になし（204 No Content即座返却）

## トランザクション仕様

データベース操作がないため、トランザクション制御は不要

## パフォーマンス要件

- レスポンス時間: 100ms以内（イベント配信は非同期）

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

- website_tokenによるウィジェット認証
- イベント情報のサニタイズは呼び出し側の責任

## 備考

- イベント名は任意の文字列を指定可能
- event_infoにはカスタムデータを含めることができる
- ブラウザ情報（名前、バージョン、デバイス、プラットフォーム）は自動付加
- オートメーションルールのトリガー条件に使用可能

---

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

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

### 推奨読解順序

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

イベントに関連するデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | types.rb | `app/models/concerns/events/types.rb` | イベントタイプの定義 |

**読解のコツ**: Events::Typesモジュールで定義されているイベント定数を確認すること。

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

処理の起点となるコントローラーを確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | events_controller.rb | `app/controllers/api/v1/widget/events_controller.rb` | イベント送信の実装 |

**主要処理フロー**:
1. **4-8行目**: create処理（ディスパッチャーへのイベント配信）
2. **12-17行目**: event_infoプライベートメソッド（自動付加情報の生成）
3. **19-21行目**: permitted_params（許可パラメータ）

#### Step 3: ベースコントローラーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | base_controller.rb | `app/controllers/api/v1/widget/base_controller.rb` | browser_params（ブラウザ情報取得） |

**主要処理フロー**:
- **62-69行目**: browser_params（ブラウザ情報の構造）

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

```
Api::V1::Widget::EventsController
    │
    ├─ BaseController (認証・共通処理)
    │      ├─ set_web_widget
    │      ├─ set_contact
    │      └─ browser_params
    │
    ├─ event_info (イベント情報生成)
    │      ├─ widget_language
    │      ├─ browser_language
    │      └─ browser_params
    │
    └─ Rails.configuration.dispatcher#dispatch (イベント配信)
           └─ オートメーションルール / キャンペーン
```

### データフロー図

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

website_token ────────▶ BaseController#set_web_widget ────▶ @web_widget
                              │
name (イベント名) ────▶ permitted_params ─────────────────▶ イベント名
                              │
event_info ───────────▶ event_info (マージ) ──────────────▶ 完全なイベント情報
                              │                              - widget_language
                              │                              - browser_language
                              │                              - browser
                              │
                        Rails.configuration.dispatcher ───▶ イベント配信
                              │
                        head :no_content ─────────────────▶ 204 No Content
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| events_controller.rb | `app/controllers/api/v1/widget/events_controller.rb` | ソース | Widgetイベントのメインコントローラー |
| base_controller.rb | `app/controllers/api/v1/widget/base_controller.rb` | ソース | Widget APIの基底コントローラー |
| types.rb | `app/models/concerns/events/types.rb` | ソース | イベントタイプ定義 |
| dispatcher.rb | `lib/chatwoot/dispatcher.rb` | ソース | イベントディスパッチャー |
| routes.rb | `config/routes.rb` | 設定 | ルーティング定義（393行目） |
