# 通知設計書 6-Edit reverted

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Edit reverted（編集差し戻し）」通知の設計仕様を定義する。ユーザーの編集が他のユーザーによって差し戻された際に送信されるプッシュ通知およびアプリ内通知の仕組みを規定する。

### 本通知の処理概要

本通知は、ユーザーが行った編集が他のユーザーによって差し戻し（リバート）された場合に、編集者に通知する機能を提供する。

**業務上の目的・背景**：Wikipediaでは編集内容に問題がある場合、他の編集者がその編集を差し戻すことがある。差し戻しはコンテンツ品質を維持するための重要な機能であり、差し戻された編集者にその事実を通知することで、編集ポリシーの理解促進やコンテンツの改善に貢献する。本通知は高い優先度（`timeSensitive`、関連性スコア0.9）に設定されており、編集者が迅速に状況を把握できるようにしている。背景色は警告色（warning）で表示され、注意が必要な通知であることを視覚的に示す。

**通知の送信タイミング**：他のユーザーが編集を差し戻した時点でMediaWiki Echo拡張機能がリバートイベントを検出し、通知がトリガーされる。

**通知の受信者**：差し戻された編集を行ったユーザー本人が受信者となる。

**通知内容の概要**：通知には差し戻しを行ったユーザー名、差し戻しが行われたページ、差し戻しの事実を示すメッセージが含まれる。ヘッダーには「Your edit was reverted」と表示される。

**期待されるアクション**：受信者は通知をタップして差分や編集履歴を確認し、差し戻しの理由を理解することが期待される。必要に応じてトークページで議論を行うか、編集ポリシーに沿った再編集を行う。

## 通知種別

- プッシュ通知（iOS Remote Notification）
- アプリ内通知（Notifications Center）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（APNs経由） |
| 優先度 | timeSensitive（高優先度） |
| 関連性スコア | 0.9 |
| リトライ | APNsの標準リトライ機構に依存 |

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

MediaWiki Echo拡張機能がリバート編集を検出し、差し戻された編集を行ったユーザーのアカウントIDに基づいて通知対象を決定する。

## 通知テンプレート

### プッシュ通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Wikipedia iOS App (APNs) |
| タイトル | Wikipedia |
| サブタイトル | - |
| 形式 | リッチプッシュ通知 |

### 本文テンプレート

```
{message.header（HTML除去済み）}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本通知には添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| agentName | 差し戻しを行ったユーザー名 | notification.agent.name | Yes |
| titleFull | 差し戻しが行われたページ | notification.title.full | Yes |
| revisionID | リビジョンID | notification.revisionID | No |
| messageHeader | メッセージヘッダー | notification.message.header | No |
| timestamp | 通知日時 | notification.timestamp.utciso8601 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | reverted イベント | ユーザーがログイン中かつEcho通知購読中 | MediaWiki Echo APIからの通知受信 |
| Push | APNs Silent Push | アプリがバックグラウンド時 | NotificationServiceExtensionで処理 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 未認証状態 | ユーザーがログインしていない場合は通知不可 |
| Echo未購読 | Echo通知サービスに未登録の場合 |
| 通知許可なし | iOSの通知許可が拒否されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[編集が差し戻される] --> B[MediaWiki Echo検出]
    B --> C[APNs経由でiOSにプッシュ]
    C --> D[NotificationService Extension起動]
    D --> E[Echo APIから詳細取得]
    E --> F{キャッシュ確認}
    F -->|未キャッシュ| G[通知コンテンツ生成]
    F -->|キャッシュ済み| H[通知スキップ]
    G --> I[警告色でアイコン背景設定]
    I --> J[優先度・関連性スコア設定]
    J --> K[UNNotificationContent配信]
    K --> L[終了]
    H --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| RemoteNotification | 通知データの永続化・フィルタリング | Core Data Entity |

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

#### RemoteNotification（Core Data）

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 通知の一意識別子 | WHERE wiki = {project} |
| wiki | プロジェクト識別子 | 言語コード+wiki |
| categoryString | 通知カテゴリ | "reverted" |
| typeString | 通知タイプ | "reverted" |
| isRead | 既読状態 | フィルタリング用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| RemoteNotification | INSERT | 新規通知の保存 |
| RemoteNotification | UPDATE | 既読状態の更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| APIエラー | Echo API通信失敗 | フォールバックテキスト表示 |
| 認証エラー | 認証トークン無効 | 再認証フローへ遷移 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | APNs側で管理 |
| リトライ間隔 | N/A |
| リトライ対象エラー | 一時的なネットワークエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | APNs制限に準拠 |
| 1日あたり上限 | 制限なし |

### 配信時間帯

即座に配信（時間帯制限なし）。`timeSensitive`優先度のため、集中モード時も配信される可能性が高い。

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

- ユーザー認証が必須
- APNsを通じた暗号化通信
- 差し戻し理由は通知に含まれないが、リンク先で確認可能

## 備考

- 本通知は`RemoteNotificationType.editReverted`として定義
- カテゴリ識別子: `reverted`
- タイプ識別子: `reverted`
- アイコン: `notifications-type-edit-revert`
- アイコン背景色: 警告色（theme.colors.warning）
- message（本文テキスト）はnilを返す（ヘッダーのみ表示）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `editReverted`ケース（行9）、優先度設定（行148-149: `.timeSensitive, 0.9`）、アイコン（行45-46）、背景色（行74） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行28-29: category="reverted", type="reverted"） |

**読解のコツ**: `editReverted`は独自のアイコン（`notifications-type-edit-revert`）を持ち、警告色で表示される点に注目。

#### Step 2: 表示テキストとスタイルを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行37-38）で"Your edit was reverted"を返す、`message`（行73-74）でnilを返す |
| 2-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | `footerText`（行76-89）でtitleFullを返す |

**主要処理フロー**:
- **行37-38**: editRevertedは"Your edit was reverted"を返す
- **行73-74**: editRevertedはmessageとしてnilを返す（本文なし）
- **行82-89**: フッターにページタイトルを表示

#### Step 3: フィルタリングを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | カテゴリ（行129）とタイプ（行171）の定義 |

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

```
RemoteNotification.typeFrom(category:type:section:)
    │
    └─ case ("reverted", "reverted"):
           └─ return .editReverted

RemoteNotificationType.editReverted
    │
    ├─ .priority → (interruptionLevel: .timeSensitive, relevanceScore: 0.9)
    ├─ .imageName → "notifications-type-edit-revert"
    └─ .imageBackgroundColorWithTheme → theme.colors.warning

NotificationsCenterCommonViewModel
    │
    ├─ .verboseTitle → "Your edit was reverted"
    └─ .message → nil
```

### データフロー図

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

Echo API Response ─────▶ タイプ判定 ────────────────────▶ editReverted
                              │
                              ▼
                     category="reverted"
                     type="reverted"
                              │
                              ▼
                     スタイル設定 ──────────────────────▶ アイコン: edit-revert
                              │                          背景色: warning
                              ▼                          ヘッダー: "Your edit was reverted"
                     表示テキスト生成 ─────────────────▶ 本文: (なし)
                                                       フッター: ページタイトル
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | ソース | 通知タイプ・スタイル定義 |
| RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | ソース | タイプマッピング |
| NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | ソース | 表示テキスト生成 |
| NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | ソース | セル表示テキスト |
| RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | ソース | フィルタ定義 |
