# バッチ設計書 1-Webhook::DeliveryJob

## 概要

本ドキュメントは、Webhook配信処理を行うバックグラウンドジョブ `Webhook::DeliveryJob` の設計仕様を記載したものである。

### 本バッチの処理概要

このバッチは、登録されたWebhookエンドポイントに対してイベント通知をHTTP POSTリクエストで配信する処理を行う。外部システムとの連携において、fizzyアプリケーションで発生したイベントをリアルタイムに通知するための重要な機能を担う。

**業務上の目的・背景**：fizzyで発生するカード作成、コメント追加などの各種イベントを外部システム（Slack、Basecamp、Campfire、カスタムWebhookエンドポイント）にリアルタイムで通知するために必要である。これにより、ユーザーは複数のツールを横断して効率的に情報を把握でき、ワークフローの自動化が可能となる。

**バッチの実行タイミング**：Webhook配信レコード（`Webhook::Delivery`）が作成された直後に非同期で実行される。`after_create_commit`コールバックにより自動的にキューイングされる。

**主要な処理内容**：
1. 配信対象のDeliveryレコードを受け取り、配信処理を開始
2. Webhookエンドポイントに対してHTTP POSTリクエストを送信
3. SSRF防止のためのIPアドレス解決とバリデーション
4. レスポンスの検証と配信結果の記録
5. Webhookの配信追跡システムへの結果通知

**前後の処理との関連**：イベント発生時に`Webhook::Delivery`レコードが作成され、本ジョブがキューイングされる。配信結果は`Webhook::DelinquencyTracker`に記録され、連続失敗時のWebhook無効化判定に使用される。

**影響範囲**：外部Webhookエンドポイント、`webhook_deliveries`テーブル、Webhookの配信追跡システム

## バッチ種別

通知配信 / 外部システム連携

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（イベント発生時） |
| 実行時刻 | N/A |
| 実行曜日 | N/A |
| 実行日 | N/A |
| トリガー | `Webhook::Delivery`レコード作成時のコールバック |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Deliveryレコードの存在 | 有効な`Webhook::Delivery`レコードが存在すること |
| Webhookの有効性 | 関連するWebhookが有効な状態であること |
| エンドポイントURL | 有効なHTTP/HTTPSのURLが設定されていること |

### 実行可否判定

`ActiveJob::DeserializationError`が発生した場合（Deliveryレコードが削除済みの場合など）はジョブを破棄する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| delivery | Webhook::Delivery | Yes | - | 配信対象のDeliveryオブジェクト |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| webhook_deliveries | DB | 配信対象のレコード |
| webhooks | DB | Webhook設定情報 |
| events | DB | 配信対象のイベント情報 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| webhook_deliveries | DB | 配信結果（state, request, response）の更新 |
| 外部Webhookエンドポイント | HTTP POST | イベントペイロード |

### 出力ファイル仕様

ファイル出力なし（HTTPリクエストのみ）

## 処理フロー

### 処理シーケンス

```
1. ジョブ開始
   └─ delivery.deliverメソッドを呼び出し
2. 配信状態を「in_progress」に更新
   └─ delivery.in_progress!
3. リクエストヘッダーの設定
   └─ User-Agent, Content-Type, X-Webhook-Signature, X-Webhook-Timestamp
4. IPアドレスの解決とSSRF防止チェック
   └─ SsrfProtection.resolve_public_ip
5. HTTP POSTリクエストの実行
   └─ レスポンスサイズ上限チェック（100KB）
6. 配信結果の記録
   └─ state: completed, responseの保存
7. 配信追跡システムへの通知
   └─ webhook.delinquency_tracker.record_delivery_of
8. ジョブ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[in_progress状態に更新]
    B --> C[ヘッダー設定]
    C --> D{IPアドレス解決}
    D -->|プライベートIP| E[エラー記録: private_uri]
    D -->|パブリックIP| F[HTTP POST送信]
    F --> G{レスポンス検証}
    G -->|成功| H[completed状態に更新]
    G -->|タイムアウト| I[エラー記録: connection_timeout]
    G -->|その他エラー| J[エラー記録]
    E --> K[errored状態に更新]
    I --> K
    J --> K
    H --> L[配信追跡に記録]
    K --> M[例外を再throw]
    L --> N[バッチ終了]
    M --> N
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 状態更新 | webhook_deliveries | UPDATE | state, request, responseカラムの更新 |
| 参照 | webhooks | SELECT | Webhook設定の取得 |
| 参照 | events | SELECT | イベント情報の取得 |

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

#### webhook_deliveries

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | state | in_progress → completed/errored | 処理状態 |
| UPDATE | request | HTTPリクエストヘッダー情報 | JSON形式で保存 |
| UPDATE | response | HTTPレスポンス情報（code, error） | JSON形式で保存 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| private_uri | セキュリティエラー | プライベートIPへのアクセス試行 | 配信失敗として記録 |
| dns_lookup_failed | 接続エラー | DNS解決失敗 | 配信失敗として記録 |
| connection_timeout | タイムアウト | 7秒以内に接続/読み取り不可 | 配信失敗として記録 |
| destination_unreachable | 接続エラー | ホスト到達不可 | 配信失敗として記録 |
| failed_tls | SSLエラー | TLSハンドシェイク失敗 | 配信失敗として記録 |
| response_too_large | レスポンスエラー | レスポンスが100KBを超過 | 配信失敗として記録 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0回（リトライなし） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A（全てのエラーで配信失敗として記録） |

### 障害時対応

配信失敗時は`errored`状態として記録され、`Webhook::DelinquencyTracker`が連続失敗を追跡する。一定回数の連続失敗でWebhook自体が無効化される可能性がある。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | レコード単位 |
| コミットタイミング | 各状態更新時 |
| ロールバック条件 | 例外発生時（errored状態への更新後） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1件/ジョブ実行 |
| 目標処理時間 | 7秒以内（タイムアウト設定） |
| メモリ使用量上限 | 100KB（レスポンスサイズ上限） |

## 排他制御

同時実行の制限なし。各Deliveryレコードは独立して処理される。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | ジョブ開始時 | ActiveJob標準ログ |
| 終了ログ | ジョブ終了時 | ActiveJob標準ログ |
| エラーログ | エラー発生時 | 例外情報 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 配信失敗率 | Webhook設定に依存 | DelinquencyTrackerで管理 |
| キュー滞留 | webhooksキューの滞留状況 | ジョブ監視システム |

## 備考

- キュー名: `webhooks`
- User-Agent: `fizzy/1.0.0 Webhook`
- タイムアウト: 7秒（接続/読み取り共通）
- 対応フォーマット: JSON（標準）、HTML（Campfire/Basecamp）、mrkdwn（Slack）
- STALE_THRESHOLD: 7日（古い配信レコードのクリーンアップ閾値）
