# 通知設計書 5-Sent mention failure

## 概要

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

### 本通知の処理概要

本通知は、ユーザーが他のユーザーをメンションしようとしたが、何らかの理由で失敗した場合に送信者に通知する機能を提供する。

**業務上の目的・背景**：メンション機能は編集者間のコミュニケーションにおいて重要な役割を果たす。メンションが失敗した場合（無効なユーザー名、存在しないユーザー、過剰なメンション数など）、送信者にその失敗を通知することで、意図したコミュニケーションが行われなかったことを認識させ、修正行動を促す。本通知は`active`の割り込みレベルと関連性スコア0.5に設定されており、注意が必要な警告通知として位置付けられている。背景色は警告色（warning）で表示される。

**通知の送信タイミング**：ユーザーがトークページまたは編集要約で他のユーザーをメンションしようとし、そのメンションが失敗した時点でMediaWiki Echo拡張機能がイベントを検出し、通知がトリガーされる。失敗理由には、ユーザー名が無効、ユーザーが存在しない、一度に多すぎるメンションを行った（mention-failure-too-many）などがある。

**通知の受信者**：メンションを試みたユーザー本人（送信者）が受信者となる。

**通知内容の概要**：通知にはメンション失敗の警告メッセージ、失敗理由、メンションしようとしたページ情報が含まれる。サブヘッダーには「Alert」と表示される。

**期待されるアクション**：受信者（メンション送信者）は失敗理由を確認し、正しいユーザー名でメンションをやり直すか、メンション数を減らすなどの修正行動を取ることが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

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

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| titleFull | メンションを試みたページ | notification.title.full | Yes |
| messageHeader | 失敗理由を含むメッセージ | notification.message.header | Yes |
| timestamp | 通知日時 | notification.timestamp.utciso8601 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | mention-failure イベント | ユーザーがログイン中かつEcho通知購読中 | 単一メンション失敗 |
| API | mention-failure-too-many イベント | ユーザーがログイン中かつEcho通知購読中 | 過剰メンション失敗 |
| Push | APNs Silent Push | アプリがバックグラウンド時 | NotificationServiceExtensionで処理 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 未認証状態 | ユーザーがログインしていない場合は通知不可 |
| Echo未購読 | Echo通知サービスに未登録の場合 |
| 通知許可なし | iOSの通知許可が拒否されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[メンション送信失敗] --> B[MediaWiki Echo検出]
    B --> C[失敗理由判定]
    C -->|無効なユーザー| D[mention-failureイベント]
    C -->|過剰メンション| E[mention-failure-too-manyイベント]
    D --> F[APNs経由でiOSにプッシュ]
    E --> F
    F --> G[NotificationService Extension起動]
    G --> H[Echo APIから詳細取得]
    H --> I[通知コンテンツ生成]
    I --> J[警告色でアイコン背景設定]
    J --> K[UNNotificationContent配信]
    K --> L[終了]
```

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

### 参照テーブル一覧

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

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

#### RemoteNotification（Core Data）

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- 本通知は`RemoteNotificationType.failedMention`として定義
- カテゴリ識別子: `mention-failure`
- タイプ識別子: `mention-failure` または `mention-failure-too-many`
- アイコン: `notifications-type-mention`
- アイコン背景色: 警告色（theme.colors.warning）

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `failedMention`ケース（行8）、優先度設定（行166-167: `.active, 0.5`）、背景色（行74） |
| 1-2 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | タイプマッピング（行25-27: 2つのタイプパターン） |

**読解のコツ**: `mention-failure`と`mention-failure-too-many`の2つのタイプが同じ`failedMention`にマッピングされることに注意。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | `verboseTitle`（行35-36）で固定テキスト"Failed mention"を返す |
| 2-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | `subheaderText`（行29-34）で「Alert」を返す |
| 2-3 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | `imageBackgroundColorWithTheme`（行73-74）で警告色を返す |

**主要処理フロー**:
- **行35-36**: failedMentionは固定のローカライズ文字列"Failed mention"を返す
- **行73-74**: 背景色は警告色（warning）

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

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

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

```
RemoteNotification.typeFrom(category:type:section:)
    │
    ├─ case ("mention-failure", "mention-failure"):
    │      └─ return .failedMention
    │
    └─ case ("mention-failure", "mention-failure-too-many"):
           └─ return .failedMention

RemoteNotificationType.failedMention.priority
    │
    └─ (interruptionLevel: .active, relevanceScore: 0.5)

RemoteNotificationType.failedMention.imageBackgroundColorWithTheme
    │
    └─ theme.colors.warning
```

### データフロー図

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

Echo API Response ─────▶ タイプ判定 ────────────────────▶ failedMention
                              │
                              ▼
                     category="mention-failure"
                     type="mention-failure" or
                          "mention-failure-too-many"
                              │
                              ▼
                     スタイル設定 ──────────────────────▶ 背景色: warning
                              │                          サブヘッダー: "Alert"
                              ▼                          タイトル: "Failed 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` | ソース | フィルタ定義 |
