# 通知設計書 14-Edit milestone

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Edit milestone（編集マイルストーン）」通知の設計を定義する。この通知は、ユーザーが特定の編集回数（1回目、10回目、100回目など）に到達した際に、祝福メッセージとして配信される。

### 本通知の処理概要

本通知は、編集活動に対する達成感を提供し、継続的な貢献を促進するための機能を提供する。

**業務上の目的・背景**：Wikipediaでは、編集者のモチベーション維持と達成感を提供するため、特定の編集回数に到達した際に祝福の通知を送信する。これにより新規編集者の定着率向上と、継続的な編集活動の促進を図る。

**通知の送信タイミング**：ユーザーが記事を編集し、その編集回数が特定のマイルストーン（1回目、10回目、100回目など）に達した時点で、MediaWiki Echo拡張機能がイベントを生成し、通知がトリガーされる。

**通知の受信者**：マイルストーンを達成した編集者本人が受信者となる。

**通知内容の概要**：達成したマイルストーンに応じた祝福メッセージ（「You just made your first edit; thank you, and welcome!」など）と、マイルストーン達成時に編集した記事のタイトルが表示される。

**期待されるアクション**：受信者は達成を確認し、編集活動を継続することが期待される。本通知にはシンプルなアクション（既読/未読の切り替え、通知設定のみ）が設定されている。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（MediaWiki Echo APIからのプル型） |
| 優先度 | passive（0.4） |
| リトライ | APIフェッチ時に自動リトライあり |

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

MediaWiki Echo拡張機能が編集イベントを検知し、マイルストーン達成時に対象ユーザーに対して通知を生成する。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Wikipediaアプリ |
| タイトル | Edit milestone |
| 本文 | マイルストーンに応じたメッセージ |
| 割り込みレベル | passive |
| 関連スコア | 0.4 |

### 本文テンプレート

```
// 1回目の編集
"You just made your first edit; thank you, and welcome!"

// 10回目の編集
"You just made your tenth edit; thank you, and please keep going!"

// 100回目の編集
"You just made your hundredth edit; thank you very much!"
```

### アプリ内通知表示

| 項目 | 内容 |
|-----|------|
| ヘッダーテキスト | "Editing milestone" |
| サブヘッダーテキスト | {projectName}（例: "English Wikipedia"） |
| ボディテキスト | messageHeader（祝福メッセージ） |
| フッターテキスト | {titleFull}（編集した記事タイトル） |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| projectName | プロジェクト名 | WikimediaProject.projectName | Yes |
| titleFull | 編集した記事のタイトル | RemoteNotification.titleFull | No |
| messageHeader | メッセージヘッダー | RemoteNotification.messageHeader | Yes |
| date | 通知日時 | RemoteNotification.date | Yes |
| wiki | プロジェクト識別子 | RemoteNotification.wiki | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | Echo API通知取得 | ユーザーがログイン中 | アプリがアクティブになった際にAPIから通知を取得 |
| プッシュ | APNs経由のプッシュ通知 | デバイス登録済み | MediaWikiサーバーからAPNs経由でプッシュ通知を受信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| フィルター設定 | ユーザーがeditMilestone通知タイプをフィルターで除外している場合 |
| 未認証状態 | ユーザーがログインしていない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[編集が保存される] --> B{マイルストーン達成?}
    B -->|Yes| C[Echo APIに通知登録]
    B -->|No| D[通知なし]
    C --> E{プッシュ通知対応?}
    E -->|Yes| F[APNs経由でプッシュ送信]
    E -->|No| G[アプリ内通知のみ]
    F --> H[NotificationService Extension処理]
    H --> I[通知コンテンツ生成]
    I --> J[ユーザーに表示]
    G --> K[アプリ起動時にAPI取得]
    K --> L[CoreDataに保存]
    L --> M[Notifications Centerに表示]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| RemoteNotification | 通知データの保存・取得 | Core Data Entity |
| PushNotificationsCache | プッシュ通知キャッシュ | SharedContainerCache |

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

#### RemoteNotification

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| categoryString | 通知カテゴリ判定 | "thank-you-edit" |
| typeString | 通知タイプ判定 | "thank-you-edit" |
| titleFull | 記事タイトル表示 | - |
| messageHeader | メッセージ表示 | - |
| isRead | 既読状態 | - |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API取得失敗 | ネットワークエラー | リトライ処理、フォールバックテキスト表示 |
| 認証エラー | トークン期限切れ | 再認証フローへ遷移 |
| データベースエラー | Core Data保存失敗 | エラーログ出力、次回同期時に再取得 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 自動（OperationQueue管理） |
| リトライ間隔 | 30秒のデッドライン制御 |
| リトライ対象エラー | ネットワークエラー、一時的なサーバーエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| リフレッシュ間隔 | 30秒以上 |
| バッチ取得 | APIから一括取得 |

### 配信時間帯

制限なし（24時間配信）

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

- 通知データはCore Dataに保存される
- APNs通信はTLS暗号化
- ユーザー認証状態の検証が必須

## 備考

- categoryString: "thank-you-edit"
- typeString: "thank-you-edit"
- 画像アイコン: "notifications-type-milestone"
- 背景色: theme.colors.accent（アクセントカラー）
- **特記事項**: sheetActionsはシンプル（markAsRead、notificationSettingsのみ）

---

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

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

### 推奨読解順序

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

通知のデータモデルとタイプ定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | 17行目: `.editMilestone`タイプの定義、164-165行目: 優先度(.passive, 0.4)の設定、55行目: 画像アイコン名 |
| 1-2 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | 18行目: `editMilestone`フィルタータイプ、134-135行目: カテゴリ文字列"thank-you-edit"の定義 |
| 1-3 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | 48-49行目: category/typeからの型変換ロジック |

**読解のコツ**: Translation milestoneと異なり、Edit milestoneは関連値を持たないシンプルなenumケース。

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

プッシュ通知受信とアプリ内表示の起点を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | 19-92行目: プッシュ通知受信時の処理フロー、70-73行目: 優先度設定 |
| 2-2 | RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | 125-163行目: loadNotifications関数 |

#### Step 3: ViewModel層を理解する

通知の表示ロジックを把握。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | 53-54行目: "Editing milestone"サブヘッダーテキスト、82-85行目: messageHeaderの取得 |
| 3-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | 25-28行目: editMilestoneのサブヘッダー処理（projectName）、86-88行目: フッターテキスト（titleFull） |
| 3-3 | NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | 19-25行目: プライマリアクション（titleAction） |
| 3-4 | NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | 40-42行目: editMilestoneのアクション（break = アクションなし） |

**主要処理フロー**:
- **53-54行目**: verboseTitle - "Editing milestone"
- **19-25行目**: primaryAction - titleAction（記事ページへのリンク）
- **40-42行目**: sheetActions - アクションなし（markAsRead、notificationSettingsのみ）

#### Step 4: テストケースを確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | NotificationsCenterCellViewModelEditMilestoneTests.swift | `WikipediaUnitTests/Code/Notifications Tests/NotificationsCenterCellViewModelEditMilestoneTests.swift` | テストケース全体: 1回目、10回目、100回目のマイルストーンテスト |

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

```
NotificationService.didReceive (Push受信)
    │
    ├─ RemoteNotificationsAPIController.getUnreadPushNotifications
    │      └─ APIからJSON取得
    │
    └─ NotificationServiceHelper.determineNotificationsToDisplayAndCache
           └─ pushContentText生成

RemoteNotificationsController.loadNotifications (アプリ内)
    │
    ├─ RemoteNotificationsOperationsController.loadNotifications
    │      └─ RemoteNotificationsAPIController
    │
    └─ RemoteNotificationsModelController
           └─ Core Data保存
                  └─ typeFrom: thank-you-edit → .editMilestone

NotificationsCenterViewController
    │
    └─ NotificationsCenterCellViewModel
           ├─ NotificationsCenterCommonViewModel (テキスト生成)
           └─ sheetActions → [markAsRead, notificationSettings] のみ
```

### データフロー図

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

MediaWiki Echo API ──▶ NotificationService Extension ──▶ iOS Push通知表示
        │
        └──────────▶ RemoteNotificationsController ──▶ CoreData保存
                            │
                            └──▶ NotificationsCenterViewModel ──▶ UI表示
                                        │
                                        └──▶ sheetActions
                                               ├─ Mark as read/unread
                                               └─ Notification settings
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | ソース | 通知タイプ定義 |
| RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | ソース | フィルタータイプ定義 |
| RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | ソース | Core Dataエンティティ |
| NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | ソース | プッシュ通知処理 |
| RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | ソース | 通知コントローラー |
| NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | ソース | テキスト生成 |
| NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | ソース | セルテキスト生成 |
| NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | ソース | アクション定義 |
| NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | ソース | シートアクション定義 |
| NotificationsCenterCellViewModelEditMilestoneTests.swift | `WikipediaUnitTests/Code/Notifications Tests/NotificationsCenterCellViewModelEditMilestoneTests.swift` | テスト | Edit milestoneテストケース |
| CommonStrings.swift | `WMF Framework/CommonStrings.swift` | ソース | ローカライズ文字列 |
