# 通知設計書 3-Edit summary mention

## 概要

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

### 本通知の処理概要

本通知は、他のユーザーが記事を編集した際の編集要約（edit summary）内で言及された場合に、言及されたユーザーに通知する機能を提供する。

**業務上の目的・背景**：Wikipediaでは記事を編集する際に編集要約を記入することが推奨されている。編集者が編集要約内で他のユーザーに言及することで、編集内容に関連するユーザーに注意を促すことができる。これにより、編集に対するフィードバックや協力の依頼を効率的に行える。本通知は高い優先度（`timeSensitive`、関連性スコア0.85）に設定されている。

**通知の送信タイミング**：他のユーザーが記事を編集し、その編集要約（edit summary）内でユーザー名を言及した時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。

**通知の受信者**：編集要約内でメンションされたユーザー本人のみが受信者となる。

**通知内容の概要**：通知には編集を行ったユーザー名、編集が行われたページ、編集要約の内容が含まれる。サブヘッダーには「Mention in edit summary」と表示される。

**期待されるアクション**：受信者は通知をタップして該当記事の編集履歴や差分を確認し、必要に応じて編集者との対話を行うことが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能が編集保存時の編集要約内のメンションパターンを検出し、メンションされたユーザーのアカウントIDに基づいて通知対象を決定する。

## 通知テンプレート

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

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

### 本文テンプレート

```
# 単一メンションの場合
{message.header（HTML除去済み）}

# フォールバック
New activity on Wikipedia
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| 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 | mention-summary イベント | ユーザーがログイン中かつ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[UNNotificationContent配信]
    J --> K[バッジカウント更新]
    K --> L[終了]
    H --> L
```

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

### 参照テーブル一覧

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

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

#### RemoteNotification（Core Data）

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

即座に配信（時間帯制限なし）。

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

- ユーザー認証が必須
- APNsを通じた暗号化通信
- 編集要約内容はサーバーサイドで検証

## 備考

- 本通知は`RemoteNotificationType.mentionInEditSummary`として定義
- カテゴリ識別子: `mention`
- タイプ識別子: `mention-summary`
- アイコン: `notifications-type-mention`（mentionInTalkPageと同じ）
- mentionInTalkPageと同じカテゴリだがタイプが異なる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `mentionInEditSummary`ケース（行6）、優先度設定（行147-148: `.timeSensitive, 0.85`） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行21-22: category="mention", type="mention-summary"） |

**読解のコツ**: `mentionInTalkPage`（type="mention"）と`mentionInEditSummary`（type="mention-summary"）の違いに注目。

#### Step 2: 表示テキスト生成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行31-32）で固定テキスト"Mention in edit summary"を返す |

**主要処理フロー**:
- **行31-32**: mentionInEditSummaryは常に固定のローカライズ文字列を返す

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

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

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

```
NotificationService (Extension起点)
    │
    ├─ RemoteNotificationsAPIController.getUnreadPushNotifications()
    │
    └─ RemoteNotificationType.mentionInEditSummary.priority
           └─ (interruptionLevel: .timeSensitive, relevanceScore: 0.85)

RemoteNotification.typeFrom(category:type:section:)
    │
    └─ case ("mention", "mention-summary"):
           └─ return .mentionInEditSummary
```

### データフロー図

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

Echo API Response ─────▶ タイプ判定 ────────────────────▶ mentionInEditSummary
                              │
                              ▼
                     category="mention"
                     type="mention-summary"
                              │
                              ▼
                     表示テキスト生成 ──────────────────▶ "Mention in edit summary"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | 表示テキスト生成 |
| RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | ソース | フィルタ定義 |
