# バッチ設計書 2-clean

## 概要

本ドキュメントは、InvenTreeモバイルアプリのFlutterビルドキャッシュをクリーンアップするPythonビルドタスク「clean」の設計仕様を記載します。

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

本バッチは、flutter cleanコマンドを実行してFlutterのビルドキャッシュや生成ファイルを削除し、クリーンな状態からビルドを開始できるようにする処理を実行します。

**業務上の目的・背景**：Flutterアプリケーションの開発中、ビルドキャッシュが古くなったり破損したりすることでビルドエラーが発生する場合があります。また、依存関係の更新後やブランチ切り替え後にクリーンビルドが必要になることがあります。本バッチを実行することで、これらの問題を解決し、安定したビルド環境を維持します。

**バッチの実行タイミング**：開発者が手動でinvoke cleanコマンドを実行した際に随時実行されます。また、ios/androidビルドタスクの前提タスクとして自動実行されます。

**主要な処理内容**：
1. fvm（Flutter Version Manager）を使用してflutter cleanコマンドを実行
2. build/ディレクトリの削除（iOSビルド、Androidビルドの中間ファイル）
3. .dart_tool/ディレクトリの削除
4. 生成されたファイルのクリーンアップ

**前後の処理との関連**：本バッチはios/androidビルドタスクの前提タスク（pre=[clean, update, translate]）として定義されています。リリースビルド前に必ず実行されます。

**影響範囲**：プロジェクトのbuild/ディレクトリ、.dart_tool/ディレクトリ、その他Flutterが生成する中間ファイルが削除されます。

## バッチ種別

ビルドキャッシュクリーンアップ処理（ビルドサポートタスク）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | なし（手動実行または前提タスクとして自動実行） |
| 実行曜日 | なし |
| 実行日 | なし |
| トリガー | 手動（invoke cleanコマンド）/ ios・androidタスクの前提タスク |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| FVMインストール済み | Flutter Version Managerがインストールされていること |
| Flutter SDKインストール済み | FVMで管理されたFlutter SDKが利用可能であること |
| プロジェクトルートディレクトリ | プロジェクトのルートディレクトリで実行すること |

### 実行可否判定

Flutterプロジェクトとして認識されるディレクトリ（pubspec.yamlが存在）で実行可能です。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | パラメータ不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| build/ | ディレクトリ | Flutterビルド出力ディレクトリ |
| .dart_tool/ | ディレクトリ | Dart開発ツールのキャッシュディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| なし | - | ファイル・ディレクトリの削除のみ |

### 出力ファイル仕様

ファイル出力はありません。キャッシュファイル・ディレクトリの削除処理のみです。

## 処理フロー

### 処理シーケンス

```
1. invokeコマンド実行
   └─ tasks.pyのclean関数が呼び出される
2. flutter cleanコマンド実行
   └─ fvm flutter cleanが実行される
3. キャッシュ削除処理
   └─ build/、.dart_tool/等の中間ファイルが削除される
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[fvm flutter clean 実行]
    B --> C[build/ ディレクトリ削除]
    C --> D[.dart_tool/ ディレクトリ削除]
    D --> E[その他キャッシュファイル削除]
    E --> F[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | データベース操作なし |

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | FVM未インストール | fvmコマンドが見つからない | FVMをインストールする |
| - | Flutter SDK未設定 | FVMでFlutter SDKが設定されていない | fvm installを実行する |
| - | 権限エラー | ファイル削除権限がない | 適切な権限でコマンドを実行する |

### リトライ仕様

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

### 障害時対応

権限エラーが発生した場合、手動でbuild/ディレクトリを削除するか、適切な権限で再実行してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイルシステム操作） |
| コミットタイミング | 各ファイル削除時 |
| ロールバック条件 | なし（削除済みファイルは復元不可） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千ファイル（キャッシュサイズによる） |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

ビルド実行中にcleanを実行しないでください。ビルドプロセスとの競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | クリーン実行時 | 削除対象ディレクトリ情報 |
| エラー出力 | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- 本バッチ実行後はflutter pub getを実行して依存関係を再取得する必要があります
- ios/androidタスクでは自動的にupdateタスク（flutter pub get）が後続で実行されます
