# 通知設計書 4-Sent mention success

## 概要

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

### 本通知の処理概要

本通知は、ユーザーが他のユーザーをメンションした際に、そのメンションが正常に処理されたことを送信者に確認通知する機能を提供する。

**業務上の目的・背景**：メンション機能を使用する際、メンションが正常に相手に通知されたかどうかを確認することは編集者にとって重要である。この通知により、メンションが成功したことを確認でき、コミュニケーションが確実に行われたという安心感を提供する。本通知は`passive`の割り込みレベルと関連性スコア0.65に設定されており、確認用の補助的な通知として位置付けられている。

**通知の送信タイミング**：ユーザーがトークページまたは編集要約で他のユーザーをメンションし、そのメンションが正常に処理された時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。

**通知の受信者**：メンションを行ったユーザー本人（送信者）が受信者となる。これは受信確認の性質を持つ通知である。

**通知内容の概要**：通知にはメンション成功の確認メッセージ、メンションされたユーザー名、メンションが行われたページ情報が含まれる。サブヘッダーには「Successful mention」と表示される。

**期待されるアクション**：受信者（メンション送信者）はメンションが成功したことを確認する。特別なアクションは必須ではないが、必要に応じてメンション先のページを確認できる。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能がメンション処理完了を検出し、メンションを行ったユーザーのアカウントIDに基づいて通知対象を決定する。

## 通知テンプレート

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

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

### 本文テンプレート

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

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| titleFull | メンションが行われたページ | notification.title.full | Yes |
| messageHeader | メッセージヘッダー | notification.message.header | No |
| timestamp | 通知日時 | notification.timestamp.utciso8601 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | mention-success イベント | ユーザーがログイン中かつ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[終了]
    H --> K
```

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

### 参照テーブル一覧

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

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

#### RemoteNotification（Core Data）

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- 本通知は`RemoteNotificationType.successfulMention`として定義
- カテゴリ識別子: `mention-success`
- タイプ識別子: `mention-success`
- アイコン: `notifications-type-mention`
- サブヘッダーは「Alert」固定

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `successfulMention`ケース（行7）、優先度設定（行168-169: `.passive, 0.65`） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行23-24: category="mention-success", type="mention-success"） |

**読解のコツ**: `successfulMention`は`passive`優先度であり、失敗通知（`failedMention`）とは異なる優先度設定に注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行33-34）で固定テキスト"Successful mention"を返す |
| 2-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | `subheaderText`（行29-34）で「Alert」を返す |

**主要処理フロー**:
- **行33-34**: successfulMentionは固定のローカライズ文字列"Successful mention"を返す
- **行29-34**: サブヘッダーは「Alert」固定

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

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

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

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

RemoteNotificationType.successfulMention.priority
    │
    └─ (interruptionLevel: .passive, relevanceScore: 0.65)

NotificationsCenterCellViewModel.subheaderText
    │
    └─ case .successfulMention:
           └─ return CommonStrings.notificationsCenterAlert
```

### データフロー図

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

Echo API Response ─────▶ タイプ判定 ────────────────────▶ successfulMention
                              │
                              ▼
                     category="mention-success"
                     type="mention-success"
                              │
                              ▼
                     表示テキスト生成 ──────────────────▶ サブヘッダー: "Alert"
                                                       タイトル: "Successful mention"
```

### 関連ファイル一覧

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