# バッチ設計書 9-RemoteNotificationsRefreshOperation

## 概要

本ドキュメントは、Wikipedia iOSアプリにおけるリモート通知リフレッシュオペレーション（RemoteNotificationsRefreshOperation）のバッチ設計について記述します。

### 本バッチの処理概要

RemoteNotificationsRefreshOperationは、Wikimediaサーバーからユーザー通知を取得し、ローカルデータベースに保存するバッチ処理です。RemoteNotificationsPagingOperationを継承し、ページング処理をサポートします。

**業務上の目的・背景**：ログインユーザーに対して、Talk Page（トークページ）メッセージ、Thanks（感謝）、Mention（言及）などの通知をリアルタイムに提供する必要があります。サーバーから通知を取得し、ローカルに保存することで、Notifications Center画面で通知を表示できます。

**バッチの実行タイミング**：Notifications Center画面の表示時、プッシュ通知受信時、バックグラウンド更新時に実行されます。

**主要な処理内容**：
1. サーバーからの通知リスト取得（ページング対応）
2. 既存の通知との重複チェック
3. 新規通知のローカル保存
4. Cross-Wiki Summary通知の処理

**前後の処理との関連**：RemoteNotificationsControllerから呼び出されます。取得した通知はNotifications Center画面で表示されます。

**影響範囲**：RemoteNotificationテーブル、Notifications Center UI、バッジカウントに影響します。

## バッチ種別

データ同期 / 通知取得

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | イベント駆動 |
| 実行時刻 | 随時 |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | 画面表示 / プッシュ通知 / バックグラウンド更新 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| ユーザーがログイン済み | 認証セッションが有効 |
| プロジェクトが指定済み | WikimediaProjectが設定されていること |
| APIコントローラーが初期化済み | RemoteNotificationsAPIControllerが設定 |
| モデルコントローラーが初期化済み | RemoteNotificationsModelControllerが設定 |

### 実行可否判定

shouldExecuteプロパティがtrueの場合に実行されます。基底クラスでは常にtrueですが、サブクラスでオーバーライド可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| project | WikimediaProject | Yes | - | 対象プロジェクト |
| apiController | RemoteNotificationsAPIController | Yes | - | API通信コントローラー |
| modelController | RemoteNotificationsModelController | Yes | - | データモデルコントローラー |
| needsCrossWikiSummary | Bool | Yes | - | Cross-Wiki Summary取得要否 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| Wikimedia Notifications API | REST API | 通知リスト |
| CoreData (RemoteNotification) | DB | ローカル通知キャッシュ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| CoreData (RemoteNotification) | DB | 保存された通知 |
| crossWikiSummaryNotification | プロパティ | Cross-Wiki Summary情報 |

### 出力ファイル仕様

ファイル出力はありません。

## 処理フロー

### 処理シーケンス

```
1. execute()呼び出し（基底クラス）
   └─ shouldExecuteチェック
2. recursivelyFetchAndSaveNotifications開始
   └─ 最初はcontinueId=nil
3. API呼び出し
   └─ apiController.getAllNotifications
4. 応答処理
   └─ Cross-Wiki Summary抽出（needsCrossWikiSummary時）
   └─ 通常通知のフィルタリング
5. バックグラウンドコンテキストで保存
   └─ modelController.createNewNotifications
6. 次ページ判定
   └─ shouldContinueToPage呼び出し
7. 重複チェック（RemoteNotificationsRefreshOperation固有）
   └─ 最後の通知がDBに既存かチェック
8. ページング継続または終了
   └─ 継続: recursivelyFetchAndSaveNotifications(continueId:)
   └─ 終了: didFetchAndSaveAllPages、finish()
```

### フローチャート

```mermaid
flowchart TD
    A[execute] --> B{shouldExecute?}
    B -->|No| C[finish]
    B -->|Yes| D[recursivelyFetchAndSaveNotifications]
    D --> E[apiController.getAllNotifications]
    E --> F{エラー発生?}
    F -->|Yes| G[finish with error]
    F -->|No| H{通知リストあり?}
    H -->|No| I[didFetchAndSaveAllPages, finish]
    H -->|Yes| J{needsCrossWikiSummary?}
    J -->|Yes| K[Cross-Wiki Summary抽出]
    J -->|No| L[createNewNotifications]
    K --> L
    L --> M{保存成功?}
    M -->|No| N[finish with error]
    M -->|Yes| O{次ページあり?}
    O -->|No| I
    O -->|Yes| P[shouldContinueToPage?]
    P -->|No| I
    P -->|Yes| Q[recursivelyFetchAndSaveNotifications with continueId]
    Q --> E
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 重複チェック | RemoteNotification | SELECT | 最後の通知がDBに存在するか確認 |
| 通知保存 | RemoteNotification | INSERT | 新規通知の保存 |
| 通知更新 | RemoteNotification | UPDATE | 既存通知の更新 |

### テーブル別操作詳細

#### RemoteNotification

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | key | lastNotification.keyと一致 | 重複チェック |
| INSERT | key | 通知の一意キー | サーバーから取得 |
| INSERT | wiki | プロジェクト識別子 | サーバーから取得 |
| INSERT | type | 通知タイプ | talk-page-message等 |
| INSERT | isRead | 既読フラグ | サーバーから取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| RequestError.unexpectedResponse | RequestError | API応答が不正 | finish with error |
| CoreData保存エラー | NSError | DB書き込み失敗 | finish with error |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | 次回画面表示時 |
| リトライ対象エラー | - |

### 障害時対応

エラー発生時はfinish(with: error)で操作を終了します。部分的に取得したデータは保存されます。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ページ単位 |
| コミットタイミング | 各ページ保存後 |
| ロールバック条件 | CoreData保存エラー時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ページあたり数十件 |
| 目標処理時間 | 数秒（ネットワーク依存） |
| メモリ使用量上限 | ページサイズに依存 |

## 排他制御

- NSOperation継承で排他制御
- バックグラウンドコンテキストで独立したCoreData操作

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| - | - | 直接的なログ出力なし |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | 呼び出し元で管理 |

## 備考

- RemoteNotificationsPagingOperationを継承
- shouldContinueToPageをオーバーライドして重複チェック実装
- Cross-Wiki Summary通知（id="-1", type="foreign"）の特別処理
- @unchecked Sendableマークでコンパイラ警告を抑制
- バックグラウンドコンテキストはmodelController.newBackgroundContext()で取得
- fetchLimit=1で重複チェックを最適化
