# 通知設計書 37-page.published

## 概要

本ドキュメントは、Ghost CMSにおける `page.published` Webhookイベントの設計仕様を定義する。このWebhookはページが公開された際にトリガーされる。

### 本通知の処理概要

**業務上の目的・背景**：ページの公開は、サイトコンテンツを一般ユーザーに公開する重要な操作である。外部システム（静的サイトジェネレーター、検索エンジン、SNS連携、サイトマップ生成ツール、キャッシュシステムなど）がページの公開を検知し、適切な処理（静的ファイル生成、インデックス追加、SNS通知、キャッシュ更新など）を行う必要がある。このWebhookにより、ページ公開のタイミングで外部システムへリアルタイムに通知を送信する。

**通知の送信タイミング**：ページのステータスが `draft` や `scheduled` から `published` に変更された際、または新規ページが `published` ステータスで作成された際にトリガーされる。具体的には、Postモデルの `onSaved`（新規作成時）または `onUpdated`（更新時）イベントハンドラ内で、ステータスが `published` に変化したことを検知し、`page.published` イベントを発火する。

**通知の受信者**：`webhooks` テーブルに登録されている `event = 'page.published'` のWebhookエンドポイント全て。各Webhookは特定のIntegration（連携アプリケーション）に紐づいており、カスタムIntegration制限がある場合は内部Integrationのみに制限される。

**通知内容の概要**：ページの現在の状態（`current`）と変更前の状態（`previous`）を含むJSONペイロード。`current` には公開されたページの全データ、`previous` には変更前の状態（特に `status` や `published_at`）が含まれる。

**期待されるアクション**：受信システムは、公開されたページの情報を基に、静的サイトの再生成、検索インデックスへの追加、SNSへの通知投稿、サイトマップの更新などを実行することが期待される。

## 通知種別

Webhook（HTTP POST リクエスト）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（イベント駆動） |
| 優先度 | 中 |
| リトライ | 有・5回（テスト環境では0回） |

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

1. `webhooks` テーブルから `event = 'page.published'` に一致するレコードを取得
2. カスタムIntegration制限（`customIntegrations` limit）が有効な場合、`integration.type = 'internal'` のWebhookのみに絞り込み
3. 各Webhookの `target_url` に対してHTTP POSTリクエストを送信

## 通知テンプレート

### Webhook通知の場合

| 項目 | 内容 |
|-----|------|
| HTTPメソッド | POST |
| Content-Type | application/json |
| Content-Version | v{Ghost APIバージョン} |
| タイムアウト | 2000ms |

### ペイロード構造

```json
{
  "page": {
    "current": {
      "id": "ページID",
      "uuid": "UUID",
      "title": "ページタイトル",
      "slug": "スラグ",
      "html": "HTMLコンテンツ",
      "plaintext": "プレーンテキスト",
      "status": "published",
      "published_at": "公開日時（ISO8601形式）",
      "created_at": "作成日時",
      "updated_at": "更新日時",
      "url": "ページURL",
      "authors": [...],
      "tags": [...],
      "tiers": [...],
      "primary_author": {...}
    },
    "previous": {
      "status": "変更前のステータス",
      "updated_at": "変更前の更新日時"
    }
  }
}
```

### 署名ヘッダー

Webhookに `secret` が設定されている場合、以下の形式で署名ヘッダーが付与される：

```
X-Ghost-Signature: sha256={HMAC-SHA256署名}, t={タイムスタンプ}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| page.current.id | ページID | posts.id | Yes |
| page.current.uuid | UUID | posts.uuid | Yes |
| page.current.title | タイトル | posts.title | Yes |
| page.current.slug | スラグ | posts.slug | Yes |
| page.current.status | ステータス | posts.status | Yes |
| page.current.published_at | 公開日時 | posts.published_at | Yes |
| page.current.html | HTMLコンテンツ | posts.html | No |
| page.current.url | ページURL | 生成値 | Yes |
| page.previous.status | 変更前ステータス | モデル._previousAttributes.status | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作/API | Page作成（status=published） | 新規ページがpublishedステータスで作成 | Admin APIまたは管理画面からページを公開作成 |
| 画面操作/API | Page更新（status変更→published） | ステータスがpublishedに変更 | 既存ページを公開 |
| 画面操作/API | リソースタイプ変更 | post→pageの変換でpublished状態 | 投稿からページへの変換時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| options.importing = true | データインポート中は送信しない |
| webhooks テーブルに該当レコードなし | 登録されたWebhookがない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ページ作成/更新] --> B{ステータス変更?}
    B -->|Yes| C{published に変更?}
    B -->|No| Z[終了]
    C -->|Yes| D[page.published イベント発火]
    C -->|No| E[他のステータスイベント]
    D --> F[WebhookTrigger.trigger 呼び出し]
    F --> G[webhooks テーブル検索]
    G --> H{Webhook存在?}
    H -->|No| Z
    H -->|Yes| I[各Webhookにペイロード送信]
    I --> J{送信結果}
    J -->|成功| K[last_triggered_at/status更新]
    J -->|失敗| L[エラー記録・リトライ]
    K --> Z
    L --> Z
    E --> Z
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| posts | ページデータ取得 | type='page'、currentとpreviousの値を取得 |
| webhooks | Webhook設定取得 | event='page.published'で検索 |
| integrations | Integration情報 | Webhook経由で関連取得 |
| users | 著者情報 | posts_authors経由 |
| tags | タグ情報 | posts_tags経由 |
| products | ティア情報 | posts_products経由 |

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

#### posts

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| type | ページ判定 | type = 'page' |
| status | ステータス確認 | published であること |
| 全カラム | ペイロード生成 | id指定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| webhooks | UPDATE | 送信結果の記録 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | ネットワークエラー、タイムアウト | リトライ実行、エラーログ記録 |
| 410 Gone | 送信先が恒久的に削除 | Webhookレコードを自動削除 |
| 4xx/5xx | サーバーエラー | ステータス記録、リトライ実行 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 5回（本番環境）、0回（テスト環境） |
| リトライ間隔 | @tryghost/requestライブラリのデフォルト設定に依存 |
| リトライ対象エラー | ネットワークエラー、一時的なサーバーエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし（イベント発生ベース） |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし（イベント発生時に即座に送信）

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

- Webhookに `secret` を設定することで、HMAC-SHA256署名による送信元検証が可能
- HTTPS URLの使用を推奨
- 署名検証により、受信側でリクエストの正当性を確認可能

## 備考

- `page.published` はページが公開状態になった時にトリガー
- 新規作成時に `status=published` の場合、`page.added` と `page.published` の両方が発火
- リソースタイプ変更時（post→page）で公開状態の場合も発火
- 公開済みページの編集時は `page.published.edited` がトリガー（`page.published` ではない）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | listen.js | `ghost/core/core/server/services/webhooks/listen.js` | WEBHOOKS配列で'page.published'が定義されている（26行目） |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | post.js | `ghost/core/core/server/models/post.js` | `onSaved`（378-392行目）と`onUpdated`（394-464行目）でpublishedイベント発火を確認 |

**主要処理フロー**:
1. **389-391行目**: 新規作成時、statusが'published'なら`model.emitChange('published')`を呼び出し
2. **433-436行目**: 更新時、statusが'published'に変化したら`model.emitChange('published')`を呼び出し
3. **419-421行目**: リソースタイプ変更時も、新しいタイプでpublished状態なら発火

#### Step 3: Webhook送信処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | webhook-trigger.js | `ghost/core/core/server/services/webhooks/webhook-trigger.js` | triggerメソッド |
| 3-2 | serialize.js | `ghost/core/core/server/services/webhooks/serialize.js` | ペイロード生成 |

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

```
Page公開（Admin API / 管理画面）
    │
    └─ Post.edit() / Post.add() (type='page')
           │
           ├─ onSaved() (新規作成時)
           │      └─ if (status === 'published')
           │              └─ emitChange('published')
           │
           └─ onUpdated() (更新時)
                  │
                  └─ if (statusChanging && isPublished)
                         └─ emitChange('published')
                                │
                                └─ events.emit('page.published', model)
                                       │
                                       └─ WebhookTrigger.trigger('page.published', model)
```

### データフロー図

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

ページ公開リクエスト ───▶ Postモデル (type='page')
(status: published)      │ (ステータス変更検知)
                         ▼
                       emitChange('published')
                         │
                         ▼
                       WebhookTrigger ───▶ HTTP POST
                         │                 {page: {current: {status: 'published', ...},
                         │                         previous: {status: 'draft', ...}}}
                         ▼
                       webhooksテーブル更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| post.js | `ghost/core/core/server/models/post.js` | ソース | ページモデル、イベント発火 |
| listen.js | `ghost/core/core/server/services/webhooks/listen.js` | ソース | イベントリスナー登録（26行目） |
| webhook-trigger.js | `ghost/core/core/server/services/webhooks/webhook-trigger.js` | ソース | Webhook送信処理 |
| serialize.js | `ghost/core/core/server/services/webhooks/serialize.js` | ソース | シリアライズ |
| pages.test.js | `ghost/core/test/e2e-webhooks/pages.test.js` | テスト | E2Eテスト（122-171行目） |
