# バッチ設計書 4-PeriodicWorkerController

## 概要

本ドキュメントは、Wikipedia iOSアプリにおける定期実行ワーカーコントローラー（PeriodicWorkerController）のバッチ設計について記述します。

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

PeriodicWorkerControllerは、RepeatingTimerを使用して指定間隔で定期的にバックグラウンドワーカー処理を実行するコントローラークラスです。

**業務上の目的・背景**：アプリがフォアグラウンドで実行中に、定期的なメンテナンス処理やデータ送信を自動的に実行する必要があります。ユーザー操作を妨げることなく、バックグラウンドで軽量な処理を定期実行することで、データの鮮度を保ち、分析イベントの送信漏れを防ぎます。

**バッチの実行タイミング**：初期遅延後、指定間隔で繰り返し実行されます。アプリがフォアグラウンドにある間のみ動作します。

**主要な処理内容**：
1. RepeatingTimerによる定期実行スケジュール管理
2. 登録された複数のPeriodicWorkerを順次非同期実行
3. 古いイベントデータの削除
4. スケジュールされたイベントの送信

**前後の処理との関連**：EventPlatformClientWorkerなどのPeriodicWorkerプロトコル準拠オブジェクトを管理します。アプリライフサイクルと連動してstart/stopが制御されます。

**影響範囲**：イベント分析データ、ローカルストレージのイベントキューに影響します。

## バッチ種別

定期実行処理 / オーケストレーション

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 設定間隔による（interval） |
| 実行時刻 | 初期遅延後（initialDelay）から開始 |
| 実行曜日 | 毎日（アプリ起動中） |
| 実行日 | 毎日（アプリ起動中） |
| トリガー | RepeatingTimer |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| アプリがフォアグラウンド | start()が呼ばれていること |
| ワーカーが登録済み | add()メソッドでワーカーが追加されていること |
| タイマーが開始済み | start()でresumeされていること |

### 実行可否判定

start()メソッド呼び出しでタイマーがresume状態になると、initialDelay経過後に最初の実行が行われ、以降はinterval間隔で繰り返し実行されます。stop()でタイマーがpause状態になると実行が停止します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| interval | TimeInterval | Yes | - | 実行間隔（秒） |
| initialDelay | TimeInterval | Yes | - | 初期遅延（秒） |
| leeway | TimeInterval | Yes | - | タイマー許容誤差（秒） |
| workers | [PeriodicWorker] | Yes | [] | 実行するワーカーの配列 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 各PeriodicWorker | プロトコル | 個別の定期処理を実行 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| WorkerControllerDelegate | デリゲート | 開始・終了通知 |
| completion callback | () -> Void | 処理完了通知（オプション） |

### 出力ファイル仕様

ファイル出力はありません。各ワーカーが個別に処理を行います。

## 処理フロー

### 処理シーケンス

```
1. init(interval:initialDelay:leeway:)
   └─ パラメータを保持
2. add(worker:)
   └─ ワーカーを配列に追加
3. start()
   └─ workTimer.resume()
4. RepeatingTimerがトリガー
   └─ doPeriodicWork()を呼び出し
5. doPeriodicWork実行
   └─ UUIDでワーク識別子を生成
6. delegate通知（開始）
   └─ workerControllerWillStart
7. 全ワーカーの順次非同期実行
   └─ asyncForEachで順次実行
8. 全ワーカー完了
   └─ completionコールバック実行
9. delegate通知（終了）
   └─ workerControllerDidEnd
10. 次回タイマー待機
    └─ interval秒後に再実行
```

### フローチャート

```mermaid
flowchart TD
    A[init] --> B[add workers]
    B --> C[start]
    C --> D[workTimer.resume]
    D --> E[initialDelay待機]
    E --> F[RepeatingTimerトリガー]
    F --> G[doPeriodicWork]
    G --> H[UUID生成]
    H --> I[delegate.workerControllerWillStart]
    I --> J[workers.asyncForEach]
    J --> K[各Worker順次実行]
    K --> L[全Worker完了]
    L --> M[completion呼び出し]
    M --> N[delegate.workerControllerDidEnd]
    N --> O[interval待機]
    O --> F

    P[stop] --> Q[workTimer.pause]
```

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

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

PeriodicWorkerController自体はデータベース操作を行いません。各ワーカーが個別にデータベース操作を行います。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | 直接的なDB操作なし |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | - | - | 各ワーカーに委任 |

### リトライ仕様

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

### 障害時対応

各ワーカーのエラーはワーカー内で処理されます。コントローラーレベルではエラー処理を行わず、次回の定期実行で再度処理されます。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（各ワーカーに委任） |
| コミットタイミング | 各ワーカーに委任 |
| ロールバック条件 | 各ワーカーに委任 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | ワーカー数（通常1-3個） |
| 目標処理時間 | intervalより短い時間 |
| メモリ使用量上限 | 各ワーカーの合計 |

## 排他制御

- 同時実行は許可される（識別子で区別）
- タイマー実行中に新たな実行は待機しない（前回実行が完了前でも次回実行が開始される可能性）

## ログ出力

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

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | 各ワーカーに委任 |

## 備考

- WorkerControllerを継承
- RepeatingTimerはメインスレッドでのみ使用（Thread.isMainThreadアサーション）
- asyncForEachはArray拡張メソッドで順次非同期処理を実現
- Weakセルフキャプチャでメモリリーク防止
- doPeriodicWorkはcompletion付きで手動実行も可能
