# 通知設計書 8-ステータス更新失敗通知

## 概要

本ドキュメントは、Decap CMSの編集ワークフローにおいてエントリのステータス更新に失敗した場合に表示されるエラートースト通知の設計仕様を定義する。ワークフロー上でのステータス変更がバックエンドで失敗した際にエラーを通知する仕組みの詳細を記載する。

### 本通知の処理概要

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

**業務上の目的・背景**：編集ワークフローにおいてステータス変更が失敗した場合、ユーザーにその事実を即座に通知し、ワークフロー状態の不整合を防止する。レビューフローの進行が阻害されていることを認識させ、再試行や管理者への報告を促す。

**通知の送信タイミング**：バックエンドの `backend.updateUnpublishedEntryStatus(collection, slug, newStatus)` のPromiseがrejectされた時点で即座に通知が発行される。

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

**通知内容の概要**：i18nキー `ui.toast.onFailToUpdateStatus` に基づくメッセージが表示される。英語ロケールでは `Failed to update status: %{details}` として、バックエンドから返されたエラーの詳細がメッセージに含まれる。

**期待されるアクション**：ユーザーはエラーメッセージを確認し、ステータス変更を再試行するか、システム管理者に連絡することが期待される。

## 通知種別

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

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（Redux dispatch → react-toastify） |
| 優先度 | 高（ワークフロー操作の失敗） |
| リトライ | なし |

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

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

## 通知テンプレート

### メール通知の場合

該当なし

### 本文テンプレート

```
Failed to update status: %{details}
```

i18nキー `ui.toast.onFailToUpdateStatus` の英語テンプレート。

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| details | ステータス更新失敗の詳細情報 | catchブロックで捕捉されたerrorオブジェクト | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 画面操作 | エントリステータス変更 | `updateUnpublishedEntryStatus` 内で `backend.updateUnpublishedEntryStatus()` がrejectされた場合 | ワークフロー上でのステータス変更失敗時（editorialWorkflow.ts 436-448行目） |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ステータス更新成功時 | APIが正常にresolveした場合は本通知を発行しない |
| 同一ステータスへの変更 | `oldStatus === newStatus` の場合は関数が早期リターンし、API呼び出し自体が行われない |

## 処理フロー

### 送信フロー

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

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

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし（ステータス更新が失敗しているため、データの変更は行われていない）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バックエンドAPI失敗 | updateUnpublishedEntryStatus APIがエラーを返す | エラートースト通知を表示し、unpublishedEntryStatusChangeErrorアクションでRedux stateを更新 |
| ネットワークエラー | バックエンドへの接続が失敗 | 同上 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- エラーオブジェクトが `details` として画面に表示されるため、バックエンドが内部情報を含むエラーメッセージを返さないよう注意が必要

## 備考

- catchブロック内で `unpublishedEntryStatusChangeError` アクションが発行され、Redux storeのステータス変更状態がエラーにリセットされる（editorialWorkflow.ts 447行目）
- 成功通知（No.7）と対になる失敗通知である

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | notifications.ts (actions) | `packages/decap-cms-core/src/actions/notifications.ts` | `NotificationMessage` の `details` フィールドがエラーオブジェクトを受け取る |

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | editorialWorkflow.ts | `packages/decap-cms-core/src/actions/editorialWorkflow.ts` | `updateUnpublishedEntryStatus` 関数の `.catch` ブロック（436-448行目）に注目 |

**主要処理フロー**:
1. **437-445行目**: `addNotification` でエラートースト通知を発行（i18nキー: `ui.toast.onFailToUpdateStatus`、details: error）
2. **447行目**: `dispatch(unpublishedEntryStatusChangeError(collection, slug))` - エラー状態をReduxに記録

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | index.js (en) | `packages/decap-cms-locales/src/en/index.js` | 273行目: `onFailToUpdateStatus: 'Failed to update status: %{details}'` |

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

```
updateUnpublishedEntryStatus (editorialWorkflow.ts:411)
    |
    +-- backend.updateUnpublishedEntryStatus() (editorialWorkflow.ts:422)
            |
            +-- [失敗時] .catch (editorialWorkflow.ts:436)
                    |
                    +-- dispatch(addNotification({key:'ui.toast.onFailToUpdateStatus', details: error}))
                    +-- dispatch(unpublishedEntryStatusChangeError(collection, slug))
```

### データフロー図

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

ステータス変更操作     -->  backend.updateUnpublished    -->  [失敗] Error オブジェクト
(collection, slug,          EntryStatus()                      |
 oldStatus, newStatus)                                         v
                                                          addNotification()
                                                          (ui.toast.onFailToUpdateStatus)
                                                                |
                                                                v
                                                          Redux store → toast UI
                                                          (画面右上, 8秒で消去)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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リソース | 英語ロケール定義 |
