# 通知設計書 9-Page linked

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Page linked（ページリンク）」通知の設計仕様を定義する。ユーザーが作成したページが他の記事からリンクされた際に送信されるプッシュ通知およびアプリ内通知の仕組みを規定する。

### 本通知の処理概要

本通知は、ユーザーが作成した記事に対して、他の記事から新しいリンクが作成された場合に、記事作成者に通知する機能を提供する。

**業務上の目的・背景**：Wikipediaでは記事間のリンクは重要な要素であり、記事が他の記事からリンクされることは、その記事がWikipedia内で認知され、ナビゲーション構造に組み込まれたことを意味する。記事作成者にリンクを通知することで、作成した記事の価値が認められたことを確認できる。本通知は`passive`の割り込みレベルと低い関連性スコア（0.2）に設定されており、情報提供的な補助通知として位置付けられている。

**通知の送信タイミング**：他のユーザーが記事を編集し、その中でユーザーの作成した記事へのリンクを追加した時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。

**通知の受信者**：リンクされた記事を作成したユーザー本人が受信者となる。

**通知内容の概要**：通知にはリンクを追加したユーザー名、リンク元の記事、リンク先の記事（ユーザーの記事）が含まれる。ヘッダーには「Page link」と表示される。

**期待されるアクション**：受信者は通知をタップしてリンク元の記事を確認できる。特別なアクションは必須ではない。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能がリンク作成イベントを検出し、リンク先の記事を作成したユーザーのアカウントIDに基づいて通知対象を決定する。

## 通知テンプレート

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

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

### 本文テンプレート

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

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| agentName | リンクを追加したユーザー名 | notification.agent.name | Yes |
| titleFull | リンク元ページ | notification.title.full | Yes |
| messageHeader | メッセージヘッダー | notification.message.header | No |
| timestamp | 通知日時 | notification.timestamp.utciso8601 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | page-linked イベント | ユーザーがログイン中かつ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[passive優先度設定]
    I --> J[UNNotificationContent配信]
    J --> K[終了]
    H --> K
```

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

### 参照テーブル一覧

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

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

#### RemoteNotification（Core Data）

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

即座に配信。ただし`passive`優先度のため、集中モード時などは遅延配信される可能性がある。

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

- ユーザー認証が必須
- APNsを通じた暗号化通信

## 備考

- 本通知は`RemoteNotificationType.pageLinked`として定義
- カテゴリ識別子: `article-linked`
- タイプ識別子: `page-linked`
- アイコン: `notifications-type-link`（connectionWithWikidataと共有）
- アイコン背景色: リンク色（theme.colors.link）- デフォルト

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `pageLinked`ケース（行12）、優先度設定（行154-155: `.passive, 0.2`）、アイコン（行51-52） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行34-35: category="article-linked", type="page-linked"） |

**読解のコツ**: カテゴリ名（`article-linked`）とタイプ名（`page-linked`）が異なり、また`connectionWithWikidata`と同じアイコンを共有する点に注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行43-44）で"Page link"を返す |
| 2-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | `footerText`（行82-89）でtitleFullを返す |

**主要処理フロー**:
- **行43-44**: pageLinkedは"Page link"を返す
- **行77-90**: messageHeaderからメッセージを取得

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

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

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

```
RemoteNotification.typeFrom(category:type:section:)
    │
    └─ case ("article-linked", "page-linked"):
           └─ return .pageLinked

RemoteNotificationType.pageLinked
    │
    ├─ .priority → (interruptionLevel: .passive, relevanceScore: 0.2)
    ├─ .imageName → "notifications-type-link"
    └─ .imageBackgroundColorWithTheme → theme.colors.link (default)

NotificationsCenterCommonViewModel
    │
    ├─ .verboseTitle → "Page link"
    └─ .message → messageHeader（HTML除去）
```

### データフロー図

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

Echo API Response ─────▶ タイプ判定 ────────────────────▶ pageLinked
                              │
                              ▼
                     category="article-linked"
                     type="page-linked"
                              │
                              ▼
                     スタイル設定 ──────────────────────▶ アイコン: link
                              │                          背景色: link (default)
                              ▼                          優先度: passive, 0.2
                     表示テキスト生成 ─────────────────▶ ヘッダー: "Page link"
                                                       フッター: ページタイトル
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | フィルタ定義 |
