# 通知設計書 7-エントリステータス更新成功通知

## 概要

本ドキュメントは、Decap CMSの編集ワークフローにおいてエントリのステータス変更が正常に完了した場合に表示される成功トースト通知の設計仕様を定義する。ワークフロー上でエントリのステータス（Draft → In Review → Ready 等）を変更し、バックエンドでの更新が成功した際にフィードバックとして表示される。

### 本通知の処理概要

本通知は、Decap CMSの編集ワークフロー機能においてエントリのステータス更新が成功した場合に発火する成功トースト通知である。`updateUnpublishedEntryStatus` 関数内で `backend.updateUnpublishedEntryStatus()` のPromiseが正常にresolveした直後の `.then` ブロック内で通知が発行される。

**業務上の目的・背景**：編集ワークフローにおいて、編集者やレビュアーがエントリのステータスを変更した際に、その変更がバックエンドに正常に反映されたことを即座にフィードバックする。ワークフローの進行状況を視覚的に確認できることで、チーム内のコンテンツ管理プロセスが円滑に進む。

**通知の送信タイミング**：バックエンドの `backend.updateUnpublishedEntryStatus(collection, slug, newStatus)` のPromiseが正常にresolveした直後に通知が発行される。

**通知の受信者**：ステータス変更操作を行った当該ユーザー本人。ブラウザ画面上のトースト通知として表示される。

**通知内容の概要**：i18nキー `ui.toast.entryUpdated` に基づくメッセージが表示される。英語ロケールでは `Entry status updated` という固定メッセージ。

**期待されるアクション**：ユーザーはステータス更新成功を確認し、ワークフローの次のステップに進む。特別な対応は不要。

## 通知種別

アプリ内通知（トースト通知）

react-toastify ライブラリを使用したブラウザ内トースト通知。画面右上（`top-right`）に `colored` テーマで表示される。

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Redux dispatch → react-toastify） |
| 優先度 | 中（成功フィードバック） |
| リトライ | なし |

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

ステータス変更操作を実行したユーザーのブラウザセッションに対して直接表示する。

## 通知テンプレート

### メール通知の場合

該当なし

### 本文テンプレート

```
Entry status updated
```

i18nキー `ui.toast.entryUpdated` の英語テンプレート。動的変数を含まない固定メッセージ。

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| （なし） | 本通知には動的変数がない | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | エントリステータス変更 | `updateUnpublishedEntryStatus` 内で `backend.updateUnpublishedEntryStatus()` が正常に完了 | ワークフロー上でのステータス変更成功時（editorialWorkflow.ts 424-434行目） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ステータス更新失敗時 | APIがrejectした場合は本通知を発行せず、ステータス更新失敗通知（No.8）が発行される |
| 同一ステータスへの変更 | `oldStatus === newStatus` の場合は関数が早期リターンし、API呼び出し自体が行われない（editorialWorkflow.ts 418行目） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ユーザーがステータス変更操作] --> B[updateUnpublishedEntryStatus 発火]
    B --> C{oldStatus === newStatus?}
    C -->|同じ| D[早期リターン - 処理なし]
    C -->|異なる| E[dispatch unpublishedEntryStatusChangeRequest]
    E --> F[backend.updateUnpublishedEntryStatus 呼び出し]
    F -->|成功| G[dispatch addNotification - 成功トースト表示]
    F -->|失敗| H[ステータス更新失敗通知]
    G --> I[dispatch unpublishedEntryStatusChangePersisted]
    I --> J[Notifications コンポーネントがトースト描画]
    J --> K[4秒後に自動消去]
    K --> L[終了]
    D --> L
    H --> L
```

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし（バックエンドでのステータス更新は別途実行されるが、通知の発行に関してはデータベース更新はない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 本通知は成功時のみ発行されるため、エラーケースは存在しない | - |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | 該当なし |

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- 固定メッセージのみが表示されるため、セキュリティ上の懸念はない

## 備考

- `oldStatus === newStatus` の場合は関数冒頭で早期リターンし、バックエンドAPIの呼び出し自体が行われない（editorialWorkflow.ts 418行目）
- ステータス変更後に `unpublishedEntryStatusChangePersisted` アクションが発行され、Redux storeのワークフロー状態が更新される
- 本通知は編集ワークフロー（`publish_mode: editorial_workflow`）が有効な場合にのみ使用される機能に関連する

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | publishModes | `packages/decap-cms-core/src/constants/publishModes` | ワークフローのステータス定数（`status`）を理解する。`PENDING_PUBLISH` 等のステータス値を確認 |

**読解のコツ**: `Status` 型はpublishModesから importされ、`oldStatus` と `newStatus` の比較に使用される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | editorialWorkflow.ts | `packages/decap-cms-core/src/actions/editorialWorkflow.ts` | `updateUnpublishedEntryStatus` 関数（411-449行目）全体のフローを理解する。 |

**主要処理フロー**:
1. **418行目**: `if (oldStatus === newStatus) return;` - 同一ステータスへの変更はスキップ
2. **421行目**: `dispatch(unpublishedEntryStatusChangeRequest(...))` - ステータス変更リクエスト状態
3. **422-423行目**: `backend.updateUnpublishedEntryStatus(collection, slug, newStatus)` - バックエンドAPI呼び出し
4. **424-433行目**: `.then` - 成功時に `addNotification` で通知発行、`unpublishedEntryStatusChangePersisted` で状態更新
5. **436-448行目**: `.catch` - 失敗時のエラー処理

#### Step 3: i18nメッセージテンプレートを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.js (en) | `packages/decap-cms-locales/src/en/index.js` | 280行目: `entryUpdated: 'Entry status updated'` |

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

```
updateUnpublishedEntryStatus (editorialWorkflow.ts:411)
    |
    +-- [oldStatus === newStatus] 早期リターン (editorialWorkflow.ts:418)
    |
    +-- dispatch(unpublishedEntryStatusChangeRequest()) (editorialWorkflow.ts:421)
    |
    +-- backend.updateUnpublishedEntryStatus() (editorialWorkflow.ts:422)
            |
            +-- [成功時] .then (editorialWorkflow.ts:424)
            |       |
            |       +-- dispatch(addNotification({key:'ui.toast.entryUpdated', type:'success'}))
            |       +-- dispatch(unpublishedEntryStatusChangePersisted())
            |
            +-- [失敗時] .catch (editorialWorkflow.ts:436)
                    +-- ステータス更新失敗通知
```

### データフロー図

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

ステータス変更操作     -->  backend.updateUnpublished    -->  [成功] void
(collection, slug,          EntryStatus()                      |
 oldStatus, newStatus)      (バックエンドステータス更新)         v
                                                          addNotification()
                                                          (ui.toast.entryUpdated)
                                                                |
                                                                v
                                                          Redux store → toast UI
                                                          (画面右上, 4秒で消去)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| editorialWorkflow.ts | `packages/decap-cms-core/src/actions/editorialWorkflow.ts` | ソース | `updateUnpublishedEntryStatus` 関数がステータス更新成功時にトースト通知を発行 |
| notifications.ts (actions) | `packages/decap-cms-core/src/actions/notifications.ts` | ソース | 通知アクション作成関数 |
| notifications.ts (reducers) | `packages/decap-cms-core/src/reducers/notifications.ts` | ソース | 通知リデューサー |
| Notifications.tsx | `packages/decap-cms-core/src/components/UI/Notifications.tsx` | ソース | 通知UIコンポーネント |
| index.js (en) | `packages/decap-cms-locales/src/en/index.js` | i18nリソース | 英語ロケール定義 |
| publishModes | `packages/decap-cms-core/src/constants/publishModes` | 定数定義 | ワークフローステータスの定数 |
