# バッチ設計書 11-advanceSchedulesService

## 概要

本ドキュメントは、スケジュールされた取引を自動的に処理するバックグラウンドサービス「advanceSchedulesService」のバッチ設計書です。定期取引の期日管理、自動取引投稿、スケジュール完了処理を行います。

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

本バッチは、家計簿アプリケーションにおける定期的な支払いや収入（例：家賃、給料、サブスクリプション）を自動的に管理するための中核的なバックグラウンドサービスです。

**業務上の目的・背景**：ユーザーが毎月の家賃や光熱費、サブスクリプション料金などの定期的な取引を手動で入力する手間を省き、期日到来時に自動的に取引を作成することで、入力忘れを防止し、正確な家計管理を支援します。また、支払い済みのスケジュールを次回期日に自動更新することで、繰り返し発生する取引の継続的な管理を実現します。

**バッチの実行タイミング**：同期（sync）処理完了イベント発生時にトリガーされ、1日1回のみ実行されます。`lastScheduleRun`プリファレンスで当日既に実行済みかを判定し、未実行の場合のみ処理を開始します。これにより、同期が複数回発生しても重複実行を防止します。

**主要な処理内容**：
1. 完了していないスケジュールを全件取得（クローズ済みアカウントは除外）
2. 各スケジュールについて既存取引の有無を確認し、ステータス（paid/due/missed/upcoming/scheduled）を判定
3. 「paid」ステータスのスケジュールは次回日付を計算して更新、または単発スケジュールの場合は完了フラグを設定
4. 「due」または「missed」ステータスで自動投稿が有効なスケジュールは、対応する取引を自動作成
5. 同期失敗時は取引投稿をスキップし、ユーザーにオフライン通知を送信

**前後の処理との関連**：同期処理（fullSync）の完了イベントをトリガーとして動作します。取引投稿時は`addTransactions`関数を呼び出し、投稿完了後は`sync-event`を発行してクライアントに取引更新を通知します。

**影響範囲**：スケジュールテーブル（schedules、schedules_next_date）と取引テーブル（transactions）に影響を与えます。ユーザープリファレンス（lastScheduleRun）も更新されます。

## バッチ種別

データ連携 / 自動取引生成

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次（1日1回） |
| 実行時刻 | 同期完了時（不定） |
| 実行曜日 | 毎日 |
| 実行日 | 毎日 |
| トリガー | イベント（sync完了イベント：success/error/unauthorized） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | データベースが利用可能であること（`db.getDatabase()`がnullでないこと） |
| プリファレンス読み込み | プリファレンスが読み込まれていること（`prefs.getPrefs()`がnullでないこと） |
| 当日未実行 | `lastScheduleRun`が本日の日付と異なること |

### 実行可否判定

```typescript
const completeEvent = type === 'success' || type === 'error' || type === 'unauthorized';

if (completeEvent && prefs.getPrefs()) {
  if (!db.getDatabase()) {
    // データベースが利用不可の場合はスキップ
    return;
  }

  const { lastScheduleRun } = prefs.getPrefs();
  if (lastScheduleRun !== currentDay()) {
    // 本日未実行の場合のみ実行
    runMutator(() => advanceSchedulesService(type === 'success'));
    prefs.savePrefs({ lastScheduleRun: currentDay() });
  }
}
```

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| syncSuccess | boolean | Yes | - | 同期が成功したかどうか。falseの場合、取引の自動投稿をスキップ |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| schedules | DB | スケジュール定義（完了フラグ、次回日付など） |
| schedules_next_date | DB | スケジュールの次回実行日情報 |
| transactions | DB | 既存取引（支払い済み判定用） |
| rules | DB | スケジュールに紐づくルール（条件情報） |
| preferences | DB | upcomingScheduledTransactionLength設定値 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| schedules_next_date | DB | 次回日付の更新 |
| schedules | DB | 完了フラグの更新（単発スケジュールの場合） |
| transactions | DB | 自動投稿された取引 |
| preferences | DB | lastScheduleRun（実行日の記録） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. スケジュール取得
   └─ 完了していないスケジュールを全件取得（クローズ済みアカウント除外）
2. 既存取引確認
   └─ 各スケジュールに対応する取引が存在するかクエリ実行
3. ステータス判定
   └─ next_date、completed、hasTrans、upcomingLengthからステータス算出
4. paid状態の処理
   ├─ 繰り返しスケジュール：setNextDateで次回日付を更新
   └─ 単発スケジュール：completedフラグをtrueに設定
5. due/missed状態の処理
   ├─ syncSuccess=true：取引を自動投稿（postTransactionForSchedule）
   └─ syncSuccess=false：投稿失敗リストに追加
6. 結果通知
   ├─ 投稿失敗あり：schedules-offlineイベント送信
   └─ 投稿成功あり：sync-eventイベント送信（トランザクション更新通知）
```

### フローチャート

```mermaid
flowchart TD
    A[syncイベント受信] --> B{completeEvent?}
    B -->|No| Z[終了]
    B -->|Yes| C{prefs取得可能?}
    C -->|No| Z
    C -->|Yes| D{DB接続可能?}
    D -->|No| Z
    D -->|Yes| E{lastScheduleRun != 今日?}
    E -->|No| Z
    E -->|Yes| F[スケジュール取得]
    F --> G[既存取引確認]
    G --> H{各スケジュール処理}
    H --> I{ステータス判定}
    I -->|paid| J{繰り返し?}
    J -->|Yes| K[次回日付更新]
    J -->|No| L{過去日付?}
    L -->|Yes| M[completed=true]
    L -->|No| N[スキップ]
    I -->|due/missed| O{posts_transaction?}
    O -->|Yes| P{syncSuccess?}
    P -->|Yes| Q[取引自動投稿]
    P -->|No| R[失敗リスト追加]
    O -->|No| N
    I -->|other| N
    K --> H
    M --> H
    Q --> H
    R --> H
    N --> H
    H -->|完了| S{投稿失敗あり?}
    S -->|Yes| T[schedules-offline通知]
    S -->|No| U{投稿あり?}
    U -->|Yes| V[sync-event通知]
    U -->|No| W[lastScheduleRun更新]
    T --> W
    V --> W
    W --> Z
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| スケジュール取得 | schedules | SELECT | 完了していないスケジュールを全件取得 |
| 既存取引確認 | transactions | SELECT | スケジュールに対応する取引の有無を確認 |
| 次回日付更新 | schedules_next_date | UPDATE | local_next_dateまたはbase_next_dateを更新 |
| スケジュール完了 | schedules | UPDATE | completedフラグをtrueに設定 |
| 取引投稿 | transactions | INSERT | 自動生成された取引を挿入 |
| 設定保存 | preferences | UPDATE | lastScheduleRunを更新 |

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

#### schedules

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | * | completed = false AND _account.closed = false | AQL経由で取得 |
| UPDATE | completed | true | 単発スケジュールで過去日付の場合 |

#### schedules_next_date

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| UPDATE | local_next_date | getNextDate()で算出した次回日付 | 繰り返しスケジュールの場合 |
| UPDATE | local_next_date_ts | base_next_date_ts（既存値を維持） | タイムスタンプ同期用 |

#### transactions

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | schedule, date | schedule IN (スケジュールIDリスト) | 支払い済み判定用 |
| INSERT | payee, account, amount, date, schedule, cleared | スケジュール情報から取得、cleared=false | 自動投稿 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | DB接続エラー | db.getDatabase()がnullを返す | 処理をスキップし、ログ出力 |
| - | ルール破損 | スケジュールに紐づくルールが見つからない | setNextDateをtry-catchで囲み、エラーをスキップ |
| - | 同期失敗 | syncSuccess=false | 取引投稿をスキップし、schedules-offline通知 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（次回同期時に再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

1. ルール破損エラーの場合、該当スケジュールの次回日付更新はスキップされますが、他のスケジュールの処理は継続します
2. 同期失敗時（オフライン）は取引投稿を行わず、次回オンライン時の同期で再処理されます
3. 障害によりlastScheduleRunが更新されなかった場合、次回同期時に再実行されます

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | mutator単位（runMutator内で実行） |
| コミットタイミング | 各スケジュール処理完了時 |
| ロールバック条件 | mutator内で例外発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数件〜数百件（ユーザーのスケジュール数に依存） |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同一日付内では`lastScheduleRun`による排他制御で重複実行を防止
- スケジュール更新は`runMutator`経由で実行され、他のミューテーションと排他される

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | DB接続不可時 | "database is not available, skipping schedule service" |
| - | - | 明示的なログ出力は最小限 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| オフライン状態 | 取引投稿失敗時 | クライアント（schedules-offlineイベント） |

## 備考

- 本サービスはイベント駆動型であり、syncイベント（success/error/unauthorized）をトリガーとして動作します
- `upcomingScheduledTransactionLength`プリファレンスにより、「upcoming」と判定される期間を設定可能です（デフォルト7日）
- スケジュールの`posts_transaction`フラグがtrueの場合のみ、自動取引投稿が行われます
- クローズ済みアカウントのスケジュールは処理対象外となります
