# バッチ設計書 4-import_export_file.cleanup

## 概要

本ドキュメントは、Shopwareシステムにおけるインポート/エクスポートファイルのクリーンアップバッチ（import_export_file.cleanup）の設計仕様を定義するものです。

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

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

**業務上の目的・背景**：Shopwareのインポート/エクスポート機能では、商品データや顧客データなどの一括処理のために一時ファイルが生成されます。これらのファイルにはビジネス上重要な情報が含まれる可能性があり、長期間保持することはセキュリティリスクとなります。また、不要なファイルの蓄積はストレージコストの増加を招きます。本バッチは、有効期限を過ぎたファイルを自動的に削除することで、セキュリティ要件を満たしながらストレージを効率的に管理します。

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

**主要な処理内容**：
1. import_export_fileテーブルからexpireDateが30日以上前のレコードを検索
2. 該当ファイルのIDリストを取得
3. EntityRepositoryのdelete()メソッドでファイルレコードを削除

**前後の処理との関連**：本バッチは独立して動作します。ファイル削除時には関連するストレージ上の物理ファイルも削除されます（EntityRepository経由のカスケード処理）。

**影響範囲**：import_export_fileテーブルおよび関連する物理ファイルの削除。進行中のインポート/エクスポート処理には影響を与えません（有効期限内のファイルは削除対象外）。

## バッチ種別

データクレンジング

## 実行スケジュール

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

## 実行条件

### 前提条件

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

### 実行可否判定

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| import_export_file | DB | インポート/エクスポートファイル情報を格納するテーブル |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

ファイル出力はありません（ファイル削除処理）。

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ ScheduledTaskHandlerによりrun()メソッドが呼び出される
2. CLI Contextの作成
   └─ Context::createCLIContext()でコンテキスト生成
3. DeleteExpiredFilesServiceの呼び出し
   └─ deleteFiles()メソッド実行
4. 削除対象ファイルの検索
   └─ expireDate < 30日前 の条件で検索
5. ファイルID一覧の取得
   └─ searchIds()でIDリスト取得
6. ファイル削除実行
   └─ EntityRepositoryのdelete()でレコード削除
7. バッチ終了
   └─ 正常終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[CLI Context作成]
    B --> C[削除対象検索条件を構築]
    C --> D[expireDate < 30日前でフィルタ]
    D --> E[対象ファイルID取得]
    E --> F[ファイルレコード削除]
    F --> G[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| ファイル検索 | import_export_file | SELECT | 期限切れファイルIDの取得 |
| ファイル削除 | import_export_file | DELETE | 期限切れファイルレコードの削除 |

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

#### import_export_file

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | id | expireDate < 30日前（DATE_ATOM形式） | 削除対象ID取得 |
| DELETE | - | 上記条件に合致するレコード | EntityRepository経由 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | データベース接続エラー | DB接続失敗時 | タスク再スケジュール |
| - | ファイル削除エラー | 物理ファイル削除失敗時 | タスク再スケジュール |

### リトライ仕様

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

### 障害時対応

shouldRescheduleOnFailure()がtrueのため、失敗時は自動的に次回実行がスケジュールされます。繰り返し失敗する場合は、ファイルシステムの権限設定やストレージの状態を確認してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | EntityRepositoryのdelete()呼び出し単位 |
| コミットタイミング | delete()メソッド完了時 |
| ロールバック条件 | delete()処理中の例外発生時 |

## パフォーマンス要件

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

## 排他制御

同時実行は許可されています。EntityRepositoryを使用した標準的なDAL操作のため、フレームワークの排他制御機構が適用されます。

## ログ出力

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

## 監視・アラート

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

## 備考

- DeleteExpiredFilesServiceが実際の削除処理を担当
- 期限判定は30日前（ハードコード）
- DateTimeImmutableを使用して日時計算
- DATE_ATOMフォーマットで日時比較
- 削除対象がない場合は空の処理で正常終了
