# 通知設計書 2-Talk page mention

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Talk page mention（トークページメンション）」通知の設計仕様を定義する。トークページでユーザーがメンション（@ユーザー名形式）された際に送信されるプッシュ通知およびアプリ内通知の仕組みを規定する。

### 本通知の処理概要

本通知は、トークページのディスカッション内で他のユーザーから言及された際に、言及されたユーザーに通知する機能を提供する。

**業務上の目的・背景**：Wikipediaのトークページでは、編集者間でディスカッションが行われる。@ユーザー名形式でメンションすることで、特定のユーザーに対して注意を促すことができる。このメンション機能により、議論への参加を促進し、編集者間のコラボレーションを円滑にする。本通知は高い優先度（`timeSensitive`、関連性スコア0.9）に設定されており、重要なディスカッションへの迅速な対応を促す。

**通知の送信タイミング**：他のユーザーがトークページ（Talk:ページ名またはUser talk:ユーザー名）に編集を行い、その中で`@ユーザー名`形式でユーザーをメンションした時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。

**通知の受信者**：メンションされたユーザー本人のみが受信者となる。メンション形式で言及されたユーザー名に対応するアカウントが受信者として決定される。

**通知内容の概要**：通知には送信者名（メンションした人）、メンションが行われたページ、メンションを含む文脈（トピックタイトルまたはメッセージの一部）が含まれる。

**期待されるアクション**：受信者は通知をタップしてトークページの該当セクションに遷移し、ディスカッションの内容を確認して必要に応じて返信・参加することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能がトークページ編集時のメンションパターン（@ユーザー名）を検出し、メンションされたユーザーのアカウントIDに基づいて通知対象を決定する。iOSアプリはEcho Subscriptionを通じてAPNsに登録されたデバイストークンに通知を配信する。

## 通知テンプレート

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

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

### 本文テンプレート

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

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

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| agentName | メンションしたユーザー名 | notification.agent.name | Yes |
| titleFull | トークページのフルタイトル | notification.title.full | Yes |
| namespace | ページの名前空間 | notification.title.namespaceKey | Yes |
| messageHeader | メッセージヘッダー | notification.message.header | No |
| messageBody | メッセージ本文 | notification.message.body | No |
| timestamp | 通知日時 | notification.timestamp.utciso8601 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | mention イベント | ユーザーがログイン中かつ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 |
| PushNotificationsCache | プッシュ通知のキャッシュ管理 | SharedContainerCache |

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

#### RemoteNotification（Core Data）

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

### 更新テーブル一覧

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

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | key | {wiki}-{id} | 通知識別子 |
| INSERT | isRead | false | 初期状態 |

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ユーザー認証が必須
- APNsを通じた暗号化通信
- メンションパターンはサーバーサイドで検証

## 備考

- 本通知は`RemoteNotificationType.mentionInTalkPage`として定義
- カテゴリ識別子: `mention`
- タイプ識別子: `mention`
- アイコン: `notifications-type-mention`
- Talk名前空間とUser Talk名前空間で表示テキストが異なる

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `mentionInTalkPage`ケース（行5）、優先度設定（行145-146: `.timeSensitive, 0.9`） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行19-20: category="mention", type="mention"） |

**読解のコツ**: `mentionInTalkPage`と`mentionInEditSummary`は同じカテゴリ"mention"だがtypeが異なる点に注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行17-29）で名前空間によって表示テキストが変わるロジック |

**主要処理フロー**:
1. **行17-29**: mentionInTalkPageの場合、トピックタイトル取得を試みる
2. **行21-26**: 名前空間がTalkか判定し、適切なローカライズ文字列を選択

#### Step 3: API通信と通知処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | カテゴリ・タイプ文字列定義（行119-121, 159-160） |
| 3-2 | NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | 複数通知が同一トークページの場合の処理（行75-77） |

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

```
NotificationService (Extension起点)
    │
    ├─ RemoteNotificationsAPIController.getUnreadPushNotifications()
    │
    ├─ NotificationServiceHelper.allNotificationsAreForSameTalkPage()
    │      └─ 名前空間チェック (namespace == .talk || .userTalk)
    │
    └─ RemoteNotificationType.mentionInTalkPage.priority
           └─ (interruptionLevel: .timeSensitive, relevanceScore: 0.9)

NotificationsCenterCommonViewModel
    │
    └─ verboseTitle
           ├─ topicTitleFromTalkPageNotification()
           └─ 名前空間による分岐表示
```

### データフロー図

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

APNs Silent Push ─────▶ NotificationService ─────────────▶ UNNotificationContent
                              │
                              ▼
                     名前空間判定 ─────▶ Talk/UserTalk
                              │
                              ▼
                     表示テキスト選択 ────────────────────▶ "Mention on article talk page"
                                                         または
                                                         "Mention on talk page"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | フィルタ定義 |
| NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | ソース | プッシュ通知処理 |
