# バッチ設計書 3-update

## 概要

本ドキュメントは、InvenTreeモバイルアプリのFlutter依存関係を更新するPythonビルドタスク「update」の設計仕様を記載します。

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

本バッチは、flutter pub getコマンドを実行してpubspec.yamlに定義された依存パッケージをダウンロード・更新し、プロジェクトの依存関係を最新状態に同期する処理を実行します。

**業務上の目的・背景**：Flutterプロジェクトでは、外部パッケージへの依存関係がpubspec.yamlで管理されています。新しい開発環境でのセットアップ時や、依存パッケージの更新時、ブランチ切り替え後などに依存関係の同期が必要となります。本バッチを実行することで、プロジェクトに必要な全てのパッケージが正しくインストールされた状態を確保します。

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

**主要な処理内容**：
1. flutter pub getコマンドを実行
2. pubspec.yamlの依存関係を解析
3. 必要なパッケージを.pub-cache/からプロジェクトにリンク
4. pubspec.lockファイルを更新（必要に応じて）

**前後の処理との関連**：本バッチはios/androidビルドタスクの前提タスク（pre=[clean, update, translate]）としてcleanの次に実行されます。cleanでキャッシュが削除された後、依存関係を再取得します。

**影響範囲**：.dart_tool/、.packages、pubspec.lock等の依存関係管理ファイルが更新されます。

## バッチ種別

依存関係更新処理（ビルドサポートタスク）

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Flutter SDKインストール済み | flutterコマンドが利用可能であること |
| pubspec.yaml存在 | プロジェクトルートにpubspec.yamlが存在すること |
| ネットワーク接続 | パッケージダウンロードのためインターネット接続が必要 |

### 実行可否判定

pubspec.yamlが存在し、インターネット接続が利用可能な場合に実行可能です。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| pubspec.yaml | YAML | プロジェクトの依存関係定義ファイル |
| pubspec.lock | YAML | 依存関係のロックファイル（存在する場合） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| .dart_tool/ | ディレクトリ | Dartツールのキャッシュ・設定 |
| pubspec.lock | YAML | 更新された依存関係ロックファイル |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | pubspec.lock |
| 出力先 | プロジェクトルート |
| 文字コード | UTF-8 |
| 区切り文字 | YAML形式 |

## 処理フロー

### 処理シーケンス

```
1. invokeコマンド実行
   └─ tasks.pyのupdate関数が呼び出される
2. flutter pub getコマンド実行
   └─ flutter pub getが実行される
3. 依存関係解析
   └─ pubspec.yamlの依存関係が解析される
4. パッケージ取得
   └─ 必要なパッケージがダウンロード・リンクされる
5. ロックファイル更新
   └─ pubspec.lockが更新される
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[flutter pub get 実行]
    B --> C[pubspec.yaml 解析]
    C --> D{パッケージ取得}
    D -->|成功| E[.dart_tool/ 更新]
    D -->|失敗| F[エラー出力]
    E --> G[pubspec.lock 更新]
    G --> H[バッチ終了]
    F --> H
```

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

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

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | Flutter未インストール | flutterコマンドが見つからない | Flutter SDKをインストールする |
| - | ネットワークエラー | インターネット接続がない | ネットワーク接続を確認する |
| - | パッケージ解決エラー | 依存関係の競合がある | pubspec.yamlを修正する |
| - | pubspec.yaml不正 | YAML構文エラー | pubspec.yamlの構文を修正する |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動で再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

ネットワークエラーの場合は接続を確認後再実行してください。依存関係の競合がある場合はpubspec.yamlを修正してください。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイルシステム操作） |
| コミットタイミング | パッケージ取得完了時 |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十パッケージ |
| 目標処理時間 | 数秒〜数分（ネットワーク状況による） |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

同時に複数のpub get処理を実行しないでください。ロックファイルの競合が発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | パッケージ取得時 | 取得パッケージ一覧 |
| 標準出力 | 処理完了時 | パッケージ取得結果サマリー |
| エラー出力 | エラー発生時 | エラー詳細 |

## 監視・アラート

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

## 備考

- 本バッチはFVMを使用せず直接flutterコマンドを実行します（tasks.pyの実装による）
- ios/androidタスクではclean後に実行され、translateタスクの前に依存関係を整えます
- オフライン環境では実行できません
