# 通知設計書 15-Welcome

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Welcome（ウェルカム）」通知の設計を定義する。この通知は、新規ユーザーがWikipediaアカウントを作成した後に送信される歓迎メッセージである。

### 本通知の処理概要

本通知は、新規ユーザーのWikipediaコミュニティへの参加を歓迎し、編集活動への参加を促進するための機能を提供する。

**業務上の目的・背景**：Wikipediaでは、新規編集者の定着率向上と、コミュニティへの帰属意識を高めるため、アカウント作成直後にウェルカム通知を送信する。これにより新規ユーザーが歓迎されていることを実感し、積極的な参加を促す。

**通知の送信タイミング**：ユーザーがWikipediaアカウントを新規作成した直後に、MediaWiki Echo拡張機能が自動的にウェルカム通知を生成する。

**通知の受信者**：新規にアカウントを作成したユーザー本人が受信者となる。

**通知内容の概要**：「Welcome to Wikipedia, {username}! We're glad you're here.」という歓迎メッセージが表示される。

**期待されるアクション**：受信者は歓迎を受け、Getting Startedガイドなどを参照して編集活動を開始することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

MediaWiki Echo拡張機能がアカウント作成イベントを検知し、新規ユーザーに対して自動的に通知を生成する。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Wikipediaアプリ |
| タイトル | Welcome |
| 本文 | "Welcome to Wikipedia, {username}! We're glad you're here." |
| 割り込みレベル | active |
| 関連スコア | 0.8 |

### 本文テンプレート

```
Welcome to Wikipedia, {username}! We're glad you're here.
```

### アプリ内通知表示

| 項目 | 内容 |
|-----|------|
| ヘッダーテキスト | "Welcome!" |
| サブヘッダーテキスト | {projectName}（例: "English Wikipedia"） |
| ボディテキスト | messageHeader（歓迎メッセージ） |
| フッターテキスト | なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| username | ユーザー名 | messageHeaderから抽出 | Yes |
| projectName | プロジェクト名 | WikimediaProject.projectName | Yes |
| messageHeader | メッセージヘッダー | RemoteNotification.messageHeader | Yes |
| date | 通知日時 | RemoteNotification.date | Yes |
| wiki | プロジェクト識別子 | RemoteNotification.wiki | Yes |

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[アカウント作成完了] --> B[Echo APIに通知登録]
    B --> C{プッシュ通知対応?}
    C -->|Yes| D[APNs経由でプッシュ送信]
    C -->|No| E[アプリ内通知のみ]
    D --> F[NotificationService Extension処理]
    F --> G[通知コンテンツ生成]
    G --> H[ユーザーに表示]
    E --> I[アプリ起動時にAPI取得]
    I --> J[CoreDataに保存]
    J --> K[Notifications Centerに表示]
```

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

### 参照テーブル一覧

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

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

#### RemoteNotification

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（24時間配信）

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

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

## 備考

- categoryString: "system-noemail"
- typeString: "welcome"
- 画像アイコン: "notifications-type-milestone"
- 背景色: theme.colors.accent（アクセントカラー）
- **特記事項**: フッターテキストなし、sheetActionsはシンプル（markAsRead、notificationSettingsのみ）
- プライマリアクション: Getting Startedガイドへのリンク

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | 18行目: `.welcome`タイプの定義、170-171行目: 優先度(.active, 0.8)の設定、55行目: 画像アイコン名 |
| 1-2 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | 21行目: `welcome`フィルタータイプ、141-142行目: カテゴリ文字列"system-noemail"の定義、185-186行目: タイプ文字列"welcome" |
| 1-3 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | 50-51行目: category/typeからの型変換ロジック |

**読解のコツ**: welcomeタイプはsystem-noemailカテゴリに属する点に注意。

#### 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` | 55-56行目: "Welcome!"サブヘッダーテキスト、82-86行目: messageHeaderの取得 |
| 3-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | 25-28行目: welcomeのサブヘッダー処理（projectName）、58-61行目: フッターテキストなし |
| 3-3 | NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | 48-51行目: プライマリアクション（gettingStartedAction） |
| 3-4 | NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | 40-42行目: welcomeのアクション（break = アクションなし） |

**主要処理フロー**:
- **55-56行目**: verboseTitle - "Welcome!"
- **58-61行目**: footerText - nil（フッターなし）
- **48-51行目**: primaryAction - gettingStartedAction
- **40-42行目**: sheetActions - アクションなし

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | NotificationsCenterCellViewModelWelcomeTests.swift | `WikipediaUnitTests/Code/Notifications Tests/NotificationsCenterCellViewModelWelcomeTests.swift` | テストケース全体: welcomeのテキスト、アイコン、アクション検証 |

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

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

RemoteNotificationsController.loadNotifications (アプリ内)
    │
    ├─ RemoteNotificationsOperationsController.loadNotifications
    │      └─ RemoteNotificationsAPIController
    │
    └─ RemoteNotificationsModelController
           └─ Core Data保存
                  └─ typeFrom: system-noemail/welcome → .welcome

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

NotificationsCenterDetailViewModel
    │
    └─ primaryAction → gettingStartedAction
```

### データフロー図

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

MediaWiki Echo API ──▶ NotificationService Extension ──▶ iOS Push通知表示
        │
        └──────────▶ RemoteNotificationsController ──▶ CoreData保存
                            │
                            └──▶ NotificationsCenterViewModel ──▶ UI表示
                                        │
                                        └──▶ primaryAction
                                               └─ Getting Started ガイド
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | シートアクション定義 |
| NotificationsCenterCellViewModelWelcomeTests.swift | `WikipediaUnitTests/Code/Notifications Tests/NotificationsCenterCellViewModelWelcomeTests.swift` | テスト | Welcomeテストケース |
| CommonStrings.swift | `WMF Framework/CommonStrings.swift` | ソース | ローカライズ文字列 |
