# バッチ設計書 3-payment_token.cleanup

## 概要

本ドキュメントは、Shopwareシステムにおける支払いトークンのクリーンアップバッチ（payment_token.cleanup）の設計仕様を定義するものです。

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

このバッチは、有効期限が切れた支払いトークンをデータベースから削除し、セキュリティの維持とデータベースの効率的な管理を実現するためのクリーンアップタスクです。

**業務上の目的・背景**：支払い処理において、決済ゲートウェイとの連携のために一時的なトークンが生成されます。これらのトークンには有効期限が設定されており、期限切れ後は不要なデータとなります。セキュリティの観点から、期限切れトークンを速やかに削除することで、潜在的なセキュリティリスクを軽減します。また、不要なデータの削除によりデータベースのパフォーマンスとストレージ効率を維持します。

**バッチの実行タイミング**：日次実行（86400秒間隔）。システムのスケジュールタスク機能により自動的にトリガーされます。

**主要な処理内容**：
1. 現在日時（UTC）を取得
2. payment_tokenテーブルからexpiresカラムが現在日時より前のレコードを抽出
3. 該当レコードを一括削除

**前後の処理との関連**：本バッチは独立して動作し、他のバッチとの直接的な依存関係はありません。進行中の支払いフローには影響を与えません（有効なトークンは削除対象外）。

**影響範囲**：payment_tokenテーブルのデータ削除のみを行い、他のテーブルには影響を与えません。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | システムスケジューラーにより決定 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（ScheduledTask） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| スケジュールタスク登録 | CleanupPaymentTokenTaskがscheduled_taskテーブルに登録されていること |
| メッセージキュー稼働 | Symfony Messengerのワーカーが稼働していること |

### 実行可否判定

ScheduledTaskHandlerの基本機能によりタスクのステータスが"scheduled"の場合に実行されます。shouldRescheduleOnFailure()がtrueを返すため、失敗時は自動的に再スケジュールされます。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| - | - | - | - | 入力パラメータなし（現在日時を基準に処理） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| payment_token | DB | 支払いトークンデータを格納するテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| payment_token | DB | 削除処理の対象テーブル（レコード削除） |

### 出力ファイル仕様

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

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ ScheduledTaskHandlerによりrun()メソッドが呼び出される
2. 現在日時の取得
   └─ UTCタイムゾーンで現在日時を取得
3. 日時フォーマット変換
   └─ Defaults::STORAGE_DATE_TIME_FORMATで文字列変換
4. DELETE文実行
   └─ expires < 現在日時 の条件でレコード削除
5. バッチ終了
   └─ 正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[現在日時を取得 UTC]
    B --> C[日時を文字列フォーマット]
    C --> D[DELETE文実行 expires < now]
    D --> E[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| トークン削除 | payment_token | DELETE | 期限切れトークンの削除 |

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

#### payment_token

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | expires < :now（現在日時） | 期限切れトークン一括削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗時 | タスク再スケジュール |
| - | SQL実行エラー | DELETE文実行失敗時 | タスク再スケジュール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | ScheduledTaskHandler標準 |
| リトライ間隔 | ScheduledTaskHandler標準 |
| リトライ対象エラー | 一般的な例外 |

### 障害時対応

shouldRescheduleOnFailure()がtrueのため、失敗時は自動的に次回実行がスケジュールされます。繰り返し失敗する場合は、データベース接続設定やテーブルの状態を確認してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | DELETE文単位 |
| コミットタイミング | executeStatement()完了時（自動コミット） |
| ロールバック条件 | DELETE文失敗時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千件/日 |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 標準PHPメモリ制限内 |

## 排他制御

同時実行は許可されています。単一のDELETE文で処理を完了するため、ロック競合のリスクは低いです。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | タスク開始（ScheduledTaskHandler標準） |
| 終了ログ | バッチ終了時 | タスク完了（ScheduledTaskHandler標準） |
| エラーログ | エラー発生時 | 例外情報（ScheduledTaskHandler標準） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 5分 | システム管理者 |
| 連続失敗回数 | 3回 | システム管理者 |

## 備考

- Doctrine DBALのConnectionを直接使用してSQL実行
- タイムゾーンはUTCで統一
- Defaults::STORAGE_DATE_TIME_FORMATを使用して日時フォーマットを統一
- LIMIT句なしの一括削除のため、大量データ時は処理時間に注意
