# バッチ設計書 1-tmp:clear

## 概要

本ドキュメントは、Railsアプリケーションの一時ファイルを一括削除するRakeタスク「tmp:clear」のバッチ設計書です。

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

tmp:clearタスクは、Railsアプリケーションの`tmp/`ディレクトリ配下に蓄積された各種一時ファイルを一括で削除するバッチ処理です。

**業務上の目的・背景**：Railsアプリケーションは運用中に多くの一時ファイル（キャッシュ、ソケット、スクリーンショット、ストレージ）を生成します。これらのファイルが蓄積すると、ディスク容量を圧迫し、パフォーマンス低下やディスク枯渇を引き起こす可能性があります。本タスクは、これらの一時ファイルを安全に一括削除することで、システムの健全性を維持することを目的としています。

**バッチの実行タイミング**：定期的なメンテナンス時、デプロイ前後、ディスク容量警告発生時、または開発環境のクリーンアップ時に手動で実行されます。本番環境では通常、週次または月次のメンテナンスウィンドウで実行されることが多いです。

**主要な処理内容**：
1. tmp:cache:clearタスクを呼び出し、tmp/cache/ディレクトリ内のキャッシュファイルを削除
2. tmp:sockets:clearタスクを呼び出し、tmp/sockets/ディレクトリ内のソケットファイルを削除
3. tmp:screenshots:clearタスクを呼び出し、tmp/screenshots/ディレクトリ内のスクリーンショットファイルを削除
4. tmp:storage:clearタスクを呼び出し、tmp/storage/ディレクトリ内のストレージファイルを削除

**前後の処理との関連**：本タスクは他のtmp:*タスクの親タスクであり、4つのサブタスクを順次呼び出します。アプリケーション停止後やデプロイ前のクリーンアップとして実行されることが一般的です。

**影響範囲**：tmp/cache、tmp/sockets、tmp/screenshots、tmp/storageの各ディレクトリ内のファイルが削除されます。キャッシュ削除後は一時的にパフォーマンスが低下する可能性があります。

## バッチ種別

データクレンジング / ファイル削除

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（メンテナンス時） |
| 実行時刻 | 任意 |
| 実行曜日 | 該当なし |
| 実行日 | 該当なし |
| トリガー | 手動 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Railsアプリケーション環境 | Railsプロジェクトのルートディレクトリで実行する必要がある |
| ファイルシステム権限 | tmp/ディレクトリ配下への書き込み・削除権限が必要 |

### 実行可否判定

特別な判定ロジックはなく、タスクは常に実行可能です。対象ディレクトリ・ファイルが存在しない場合もエラーにはなりません。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本タスクは入力パラメータを受け取りません |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tmp/cache/ | ディレクトリ | キャッシュファイル格納ディレクトリ |
| tmp/sockets/ | ディレクトリ | ソケットファイル格納ディレクトリ |
| tmp/screenshots/ | ディレクトリ | スクリーンショットファイル格納ディレクトリ |
| tmp/storage/ | ディレクトリ | ストレージファイル格納ディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 処理結果（エラー時のみメッセージ出力） |

### 出力ファイル仕様

本タスクはファイル出力を行いません。

## 処理フロー

### 処理シーケンス

```
1. tmp:cache:clearタスク実行
   └─ tmp/cache/ディレクトリ内の全ファイル・ディレクトリを削除（rm_rf）
2. tmp:sockets:clearタスク実行
   └─ tmp/sockets/ディレクトリ内の全ファイルを削除（rm）
3. tmp:screenshots:clearタスク実行
   └─ tmp/screenshots/ディレクトリ内の全ファイルを削除（rm）
4. tmp:storage:clearタスク実行
   └─ tmp/storage/ディレクトリ内の全ファイル・ディレクトリを削除（rm_rf）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[tmp:cache:clear実行]
    B --> C[tmp/cache内ファイル削除]
    C --> D[tmp:sockets:clear実行]
    D --> E[tmp/sockets内ファイル削除]
    E --> F[tmp:screenshots:clear実行]
    F --> G[tmp/screenshots内ファイル削除]
    G --> H[tmp:storage:clear実行]
    H --> I[tmp/storage内ファイル削除]
    I --> J[バッチ終了]
```

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

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

本タスクはデータベース操作を行いません。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイルシステムエラー | 削除権限がない場合 | 実行ユーザーの権限を確認する |
| - | ファイルシステムエラー | ファイルが使用中の場合 | 対象ファイルを使用しているプロセスを終了する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

ファイル削除に失敗した場合は、手動で対象ファイルの状態を確認し、使用中のプロセスがあれば停止した後に再実行してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 該当なし（ファイルシステム操作のみ） |
| コミットタイミング | - |
| ロールバック条件 | - |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数件〜数千件のファイル |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行の制御は行われていません。複数のプロセスから同時に実行された場合、ファイル削除の競合が発生する可能性がありますが、実害はありません。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 処理ログ | なし | verbose: falseのため出力されない |
| エラーログ | エラー発生時 | ファイルシステムエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクは標準的な監視・アラート設定はありません。

## 備考

- 本タスクはtmp:cache:clear、tmp:sockets:clear、tmp:screenshots:clear、tmp:storage:clearの4つのサブタスクを依存関係として定義し、順次実行します。
- 各サブタスクは個別に実行することも可能です。
- 削除対象はドットファイル（隠しファイル）を除くすべてのファイル・ディレクトリです（`[^.]*`パターン）。
