# バッチ設計書 8-EventPlatformClientWorker

## 概要

本ドキュメントは、Wikipedia iOSアプリにおけるイベントプラットフォームクライアントワーカー（EventPlatformClientWorker）のバッチ設計について記述します。

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

EventPlatformClientWorkerは、分析イベントのバッチ送信処理を行うワーカークラスです。PeriodicWorkerおよびBackgroundFetcherプロトコルを実装し、定期的およびバックグラウンドでイベントの送信と古いイベントの削除を行います。

**業務上の目的・背景**：Wikimediaのイベントプラットフォームに分析データを送信することで、ユーザー行動の分析やアプリ改善のためのデータ収集を行います。イベントは一時的にローカルに保存され、ネットワーク接続時やバックグラウンドフェッチ時にバッチ送信されます。これにより、ネットワーク効率を最適化しつつ、データの損失を防ぎます。

**バッチの実行タイミング**：PeriodicWorkerControllerによる定期実行、BackgroundAppRefreshTaskによるバックグラウンド実行で呼び出されます。

**主要な処理内容**：
1. 古いイベントの削除（pruneStaleEvents）
2. スケジュールされたイベントのバッチ送信（postAllScheduled）

**前後の処理との関連**：PeriodicWorkerControllerおよびBackgroundFetcherControllerから呼び出されます。EventPlatformClientと連携してイベント送信を行います。

**影響範囲**：ローカルイベントストレージ、Wikimedia Event Platformサーバーに影響します。

## バッチ種別

イベント送信 / データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 定期実行 / バックグラウンドフェッチ |
| 実行時刻 | 設定間隔による |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | PeriodicWorkerController / BackgroundFetcherController |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| EventPlatformClient.sharedが初期化済み | シングルトンインスタンスが存在 |
| storageManagerが設定済み | イベントストレージが初期化されていること |

### 実行可否判定

storageManagerがnilの場合は即座にreturnします。それ以外の場合は処理が実行されます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| completion | () -> Void | Yes | - | PeriodicWorker完了コールバック |
| completion | (UIBackgroundFetchResult) -> Void | Yes | - | BackgroundFetcher完了コールバック |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| EventPlatformClient.storageManager | メモリ/DB | ローカルイベントストレージ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Wikimedia Event Platform | HTTP POST | 送信されたイベント |
| EventPlatformClient.storageManager | メモリ/DB | 削除された古いイベント |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. doPeriodicWork(completion:)またはperformBackgroundFetch(completion:)呼び出し
2. storageManager存在チェック
   └─ nilの場合はreturn
3. 古いイベントの削除
   └─ storageManager.pruneStaleEvents
4. スケジュールイベントの送信
   └─ client.postAllScheduled
5. 完了コールバック呼び出し
   └─ PeriodicWorker: completion()
   └─ BackgroundFetcher: completion(.noData)
```

### フローチャート

```mermaid
flowchart TD
    A[doPeriodicWork/performBackgroundFetch] --> B{storageManager != nil?}
    B -->|No| C[return]
    B -->|Yes| D[pruneStaleEvents]
    D --> E[postAllScheduled]
    E --> F[completion呼び出し]
    F --> G[処理完了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 古いイベント削除 | EventStorage | DELETE | 期限切れイベントの削除 |
| イベント送信後 | EventStorage | DELETE | 送信済みイベントの削除 |

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

#### EventStorage（EventPlatformClient管理）

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | 期限切れイベント | pruneStaleEvents |
| DELETE | - | 送信済みイベント | postAllScheduled後 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ネットワークエラー | サーバー接続失敗 | 次回実行時にリトライ |
| - | storageManager未設定 | 初期化前呼び出し | 即座にreturn |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（次回定期実行でリトライ） |
| リトライ間隔 | PeriodicWorker間隔 |
| リトライ対象エラー | ネットワークエラー |

### 障害時対応

ネットワークエラー時はイベントがローカルに保持され、次回の実行時に再送信されます。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | EventPlatformClient管理 |
| コミットタイミング | イベント送信成功時 |
| ロールバック条件 | 送信失敗時（イベント保持） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | イベント数に依存 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | イベントバッファサイズに依存 |

## 排他制御

- シングルトンパターン（EventPlatformClientWorker.shared）
- EventPlatformClient内部で排他制御

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| - | - | EventPlatformClient内部で管理 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | EventPlatformClient内部で管理 |

## 備考

- EventPlatformClientWorker.sharedでシングルトンアクセス
- PeriodicWorkerとBackgroundFetcherの両プロトコルに準拠
- doPeriodicWorkをperformBackgroundFetchが再利用
- BackgroundFetcherでは常に.noDataを返す（イベント送信は新データ取得ではないため）
- pruneStaleEventsとpostAllScheduledの順序実行で効率化
