# 通知設計書 13-Translation milestone

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Translation milestone（翻訳マイルストーン）」通知の設計を定義する。この通知は、ユーザーがContent Translation機能を使用して翻訳のマイルストーン（1件目、10件目、100件目）を達成した際に配信される。

### 本通知の処理概要

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

**業務上の目的・背景**：Wikipediaでは、多言語間の知識共有を促進するためのContent Translation（CX）機能が提供されている。翻訳者のモチベーション維持と達成感を提供するため、特定のマイルストーン到達時に祝福の通知を送信する。これにより翻訳コミュニティの活性化と翻訳品質の向上を図る。

**通知の送信タイミング**：ユーザーがContent Translation機能を使用して翻訳を公開し、その翻訳件数が1件目、10件目、または100件目に達した時点で、MediaWiki Content Translation拡張機能がイベントを生成し、通知がトリガーされる。

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

**通知内容の概要**：達成したマイルストーンの種類（1件目、10件目、100件目）に応じた祝福メッセージが表示される。

**期待されるアクション**：受信者は達成を確認し、翻訳活動を継続することが期待される。本通知にはリンク先アクションが設定されていない（翻訳ダッシュボードへの誘導なし）。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Content Translation拡張機能が翻訳公開イベントを検知し、マイルストーン達成時に対象ユーザーに対して通知を生成する。

## 通知テンプレート

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

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

### 本文テンプレート

```
// 1件目の翻訳
cx-first-translation: "Congratulations on your first translation!"

// 10件目の翻訳
cx-tenth-translation: "Congratulations on your tenth translation!"

// 100件目の翻訳
cx-hundredth-translation: "Congratulations on your hundredth translation!"
```

### アプリ内通知表示

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| milestoneCount | マイルストーンの件数（1, 10, 100） | typeStringから推定 | Yes |
| 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経由でプッシュ通知を受信 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Content Translationで翻訳公開] --> 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 | 通知カテゴリ判定 | "cx" |
| typeString | 通知タイプ判定 | "cx-first-translation", "cx-tenth-translation", "cx-hundredth-translation" |
| titleFull | 記事タイトル表示 | - |
| messageHeader | メッセージ表示 | - |
| isRead | 既読状態 | - |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間配信）

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

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

## 備考

- categoryString: "cx"
- typeString: "cx-first-translation"（1件目）, "cx-tenth-translation"（10件目）, "cx-hundredth-translation"（100件目）
- 画像アイコン: "notifications-type-milestone"
- 背景色: theme.colors.accent（アクセントカラー）
- **特記事項**: 本通知にはプライマリアクション（遷移先URL）が設定されていない。ビジネス要件として翻訳通知にはリンク先を設定しないことが明示されている。

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | 16行目: `.translationMilestone(Int)`タイプの定義（関連値付き）、162-163行目: 優先度(.passive, 0.5)の設定、55行目: 画像アイコン名 |
| 1-2 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | 17行目: `translationMilestone`フィルタータイプ、136-137行目: カテゴリ文字列"cx"の定義、179-182行目: タイプ文字列の定義 |
| 1-3 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | 42-47行目: category/typeからの型変換ロジック（1, 10, 100の判定） |

**読解のコツ**: `.translationMilestone(Int)`は関連値を持つ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` | 51-52行目: "Translation milestone"サブヘッダーテキスト、82-85行目: messageHeaderの取得 |
| 3-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | 25-28行目: translationMilestoneのサブヘッダー処理（projectName）、86-88行目: フッターテキスト（titleFull） |
| 3-3 | NotificationsCenterCellViewModel+LinkExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+LinkExtensions.swift` | 36-39行目: **重要** - translationMilestoneには遷移先URLを設定しない（return nil） |
| 3-4 | NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | 46-47行目: プライマリアクションなし（return nil） |
| 3-5 | NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | 40-42行目: translationMilestoneのアクション（break = アクションなし） |

**主要処理フロー**:
- **51-52行目**: verboseTitle - "Translation milestone"
- **36-39行目**: primaryURL - **return nil**（ビジネス要件：リンクなし）
- **40-42行目**: sheetActions - アクションなし

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

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

RemoteNotificationsController.loadNotifications (アプリ内)
    │
    ├─ RemoteNotificationsOperationsController.loadNotifications
    │      └─ RemoteNotificationsAPIController
    │
    └─ RemoteNotificationsModelController
           └─ Core Data保存
                  └─ typeFrom: cx-first/tenth/hundredth-translation → .translationMilestone(1/10/100)

NotificationsCenterViewController
    │
    └─ NotificationsCenterCellViewModel
           ├─ NotificationsCenterCommonViewModel (テキスト生成)
           ├─ primaryURL → nil (リンクなし)
           └─ 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` | ソース | セルテキスト生成 |
| NotificationsCenterCellViewModel+LinkExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+LinkExtensions.swift` | ソース | リンク生成（return nil） |
| NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | ソース | アクション定義 |
| NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | ソース | シートアクション定義 |
| CommonStrings.swift | `WMF Framework/CommonStrings.swift` | ソース | ローカライズ文字列 |
