# 通知設計書 1-Talk page message

## 概要

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

### 本通知の処理概要

本通知は、他のユーザーからトークページへのメッセージ投稿を受信者に通知する機能を提供する。

**業務上の目的・背景**：Wikipediaはコラボレーションプラットフォームであり、編集者間のコミュニケーションはトークページを通じて行われる。トークページへの新規メッセージを即座に通知することで、編集者間の迅速なコミュニケーションを実現し、コラボレーションの効率を向上させる。この通知は最も重要な通知の一つとして位置付けられており、`timeSensitive`の割り込みレベルと最高の関連性スコア（1.0）が設定されている。

**通知の送信タイミング**：他のユーザーがユーザートークページ（User talk:ユーザー名）に編集を行い、新しいメッセージやセクションを追加した時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。

**通知の受信者**：トークページの所有者であるユーザー本人のみが受信者となる。具体的には、`User talk:ユーザー名`の「ユーザー名」に対応するアカウントが受信者として決定される。

**通知内容の概要**：通知には送信者名、メッセージの投稿先ページ、メッセージの一部プレビュー（トピックタイトルまたはメッセージ本文の冒頭）が含まれる。プッシュ通知では「New message」または「New messages」というタイトルが表示される。

**期待されるアクション**：受信者は通知をタップしてトークページに遷移し、メッセージを確認して必要に応じて返信することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能がトークページ編集イベントを検出し、トークページ所有者のユーザーIDに基づいて通知対象を決定する。iOSアプリはEcho Subscriptionを通じてAPNsに登録されたデバイストークンに通知を配信する。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Wikipedia iOS App (APNs) |
| タイトル | Wikipedia |
| サブタイトル | New message / New messages（複数の場合） |
| 形式 | リッチプッシュ通知 |

### 本文テンプレート

```
# 単一メッセージの場合
{message.header（HTML除去済み）}

# 複数メッセージ（同一トークページ）の場合
{n} new messages on {talkPageTitle}

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 未認証状態 | ユーザーがログインしていない場合は通知不可 |
| Echo未購読 | Echo通知サービスに未登録の場合 |
| 通知許可なし | iOSの通知許可が拒否されている場合 |
| キャッシュ済み | 過去24時間以内に同一通知をキャッシュ済みの場合（重複防止） |

## 処理フロー

### 送信フロー

```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 | 通知カテゴリ | "edit-user-talk" |
| typeString | 通知タイプ | "edit-user-talk" |
| isRead | 既読状態 | フィルタリング用 |
| date | 通知日時 | ソート用 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| RemoteNotification | INSERT | 新規通知の保存 |
| RemoteNotification | UPDATE | 既読状態の更新 |
| PushNotificationsCache | UPDATE | キャッシュの更新・クリーンアップ |

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

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| APIエラー | Echo API通信失敗 | フォールバックテキスト表示 |
| 認証エラー | 認証トークン無効 | 再認証フローへ遷移 |
| データベースエラー | Core Data保存失敗 | ログ記録・次回同期で再取得 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

即座に配信（時間帯制限なし）。ただし、iOSの集中モードや通知設定により配信タイミングが調整される場合がある。

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

- ユーザー認証が必須（`authStateIsPermanent`または一時アカウント有効時の`authStateIsTemporary`）
- APNsを通じた暗号化通信
- デバイストークンはSecure Enclaveで保護
- 通知コンテンツには機密情報を含まない（ユーザー名・ページタイトルのみ）

## 備考

- 本通知は`RemoteNotificationType.userTalkPageMessage`として定義
- カテゴリ識別子: `edit-user-talk`
- タイプ識別子: `edit-user-talk`
- アイコン: `notifications-type-user-talk-message`

---

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

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

### 推奨読解順序

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

まず、通知データの構造と型定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | 通知タイプのenum定義、`userTalkPageMessage`ケース、優先度設定（行143: `.timeSensitive, 1`） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | Core Dataエンティティ、`typeFrom(category:type:section:)`メソッド（行17-18: category="edit-user-talk", type="edit-user-talk"） |
| 1-3 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | フィルタタイプ定義、カテゴリ/タイプ文字列マッピング |

**読解のコツ**: Swiftのenum with associated valuesパターンを理解しておくと良い。`RemoteNotificationType`は通知の種類を型安全に表現している。

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

プッシュ通知受信時の処理起点を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | UNNotificationServiceExtensionの実装、`didReceive(_:withContentHandler:)`が起点 |

**主要処理フロー**:
1. **行19-33**: リクエスト受信とコンテンツ準備
2. **行40-91**: Echo APIからの通知取得と処理
3. **行59-67**: トークページ専用のコンテンツ生成ロジック
4. **行70-82**: 優先度・関連性スコアの設定

#### Step 3: API通信層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | RemoteNotificationsAPIController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsAPIController.swift` | Echo API通信、`getUnreadPushNotifications`メソッド（行243-252） |
| 3-2 | NotificationServiceHelper.swift | `WMF Framework/Remote Notifications/NotificationServiceHelper.swift` | トークページ判定ロジック、`allNotificationsAreForSameTalkPage`（行5-21）、`talkPageContent`（行40-60） |

**主要処理フロー**:
- **行5-21**: 全通知が同一トークページかどうかの判定
- **行40-60**: トークページ用のサブタイトル・本文生成

#### Step 4: アプリ内通知センターを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | 表示テキスト生成、`verboseTitle`（行10-17: userTalkPageMessageケース） |
| 4-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | セルの表示テキスト、`subheaderText`、`footerText` |
| 4-3 | RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | 通知管理の中核、`loadNotifications`（行125-163） |

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

```
NotificationService (Extension起点)
    │
    ├─ RemoteNotificationsAPIController.getUnreadPushNotifications()
    │      └─ Session.jsonDecodableTask() → MediaWiki Echo API
    │
    ├─ NotificationServiceHelper.determineNotificationsToDisplayAndCache()
    │      └─ キャッシュとの差分計算
    │
    ├─ NotificationServiceHelper.talkPageContent()
    │      └─ allNotificationsAreForSameTalkPage()
    │
    └─ RemoteNotificationType.priority
           └─ (interruptionLevel: .timeSensitive, relevanceScore: 1.0)

RemoteNotificationsController (アプリ内通知)
    │
    ├─ RemoteNotificationsOperationsController.loadNotifications()
    │      └─ RemoteNotificationsPagingOperation
    │
    ├─ RemoteNotificationsModelController
    │      └─ Core Data永続化
    │
    └─ NotificationsCenterViewModel
           └─ NotificationsCenterCellViewModel
```

### データフロー図

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

APNs Silent Push ─────▶ NotificationService ─────────────▶ UNNotificationContent
                              │                                    │
                              ▼                                    ▼
                     Echo API呼び出し ─────▶ JSON Parse ─▶ プッシュ通知表示
                              │
                              ▼
                     PushNotificationsCache ─────────────▶ 重複チェック

Echo API Response ────▶ RemoteNotificationsController ───▶ Core Data保存
                              │                                    │
                              ▼                                    ▼
                     RemoteNotification Entity ──────────▶ Notifications Center
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | ソース | プッシュ通知Extension |
| RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | ソース | 通知タイプ定義 |
| RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | ソース | Core Dataエンティティ |
| RemoteNotificationsAPIController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsAPIController.swift` | ソース | Echo API通信 |
| NotificationServiceHelper.swift | `WMF Framework/Remote Notifications/NotificationServiceHelper.swift` | ソース | ヘルパーメソッド |
| RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | ソース | 通知管理コントローラ |
| NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | ソース | 表示テキスト生成 |
| PushNotificationsCache.swift | `WMF Framework/Remote Notifications/Model/PushNotificationsCache.swift` | ソース | キャッシュ管理 |
| WMFNotificationsController.m | `Wikipedia/Code/WMFNotificationsController.m` | ソース | 通知権限・購読管理 |
