# バッチ設計書 31-collectplugins

## 概要

本ドキュメントは、InvenTreeシステムにおけるプラグイン静的ファイル収集バッチ（collectplugins）の設計仕様を定義する。

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

collectpluginsは、InvenTreeにインストールされた全てのプラグインの静的ファイル（CSS、JavaScript、画像など）を収集し、システムの静的ファイルディレクトリに配置するDjango管理コマンドである。

**業務上の目的・背景**：InvenTreeはプラグインアーキテクチャを採用しており、サードパーティ製プラグインがシステム機能を拡張できる。各プラグインは独自の静的ファイル（スタイルシート、JavaScriptライブラリ、アイコンなど）を持つ可能性がある。これらの静的ファイルをWebサーバーから効率的に配信するためには、事前に一箇所に収集しておく必要がある。本バッチは、プラグインのインストール・更新時や、システムデプロイメント時に実行され、全プラグインの静的ファイルを適切なディレクトリ構造で配置する。

**バッチの実行タイミング**：手動実行（CLIコマンド）。以下の場面で実行される：
- プラグインの新規インストール後
- プラグインのアップデート後
- `invoke plugins` コマンド実行時（自動的に呼び出される）
- `invoke static` コマンド実行時（skip_pluginsフラグが未設定の場合）

**主要な処理内容**：
1. プラグインレジストリから全インストール済みプラグインを取得
2. 各プラグインのstaticディレクトリから静的ファイルを収集
3. 収集したファイルを `plugins/{slug}/` ディレクトリ構造でコピー
4. アンインストールされたプラグインの古い静的ファイルをクリーンアップ

**前後の処理との関連**：
- 前提：プラグインがインストールされていること
- 後続：Webサーバーが静的ファイルを配信可能になる

**影響範囲**：
- 静的ファイルディレクトリ（`plugins/` 配下）
- プラグインのユーザーインターフェース表示

## バッチ種別

ファイル同期処理 / 静的ファイル管理

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動 / 他コマンドからの呼び出し |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django環境 | Django環境が正しく設定されていること |
| プラグインレジストリ | プラグインレジストリが初期化されていること |
| 静的ファイルストレージ | staticfiles_storageが設定されていること |

### 実行可否判定

特別な判定ロジックなし。コマンド実行時に常に処理を実行する。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本コマンドは引数を取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| plugin.registry | Pythonオブジェクト | インストール済みプラグインのレジストリ |
| plugin.path().joinpath('static') | ディレクトリ | 各プラグインの静的ファイルソースディレクトリ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| plugins/{slug}/ | ファイルシステム | プラグインごとの静的ファイルディレクトリ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | 元ファイル名を維持 |
| 出力先 | STATIC_ROOT/plugins/{plugin_slug}/ |
| 文字コード | 元ファイルを維持（バイナリコピー） |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. collect_plugins_static_files() 呼び出し
   └─ プラグインレジストリのリロードチェック
2. 全プラグインのループ処理
   └─ copy_plugin_static_files() を各プラグインに対して呼び出し
3. clear_plugins_static_files() 呼び出し
   └─ アンインストール済みプラグインの静的ファイルを削除
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[プラグインレジストリ確認]
    B --> C[全プラグイン取得]
    C --> D{プラグインあり?}
    D -->|あり| E[プラグインごとに静的ファイルコピー]
    E --> F[コピー先ディレクトリクリア]
    F --> G[静的ファイルをコピー]
    G --> H{次のプラグイン?}
    H -->|あり| E
    H -->|なし| I[不要な静的ファイルクリーンアップ]
    D -->|なし| I
    I --> J[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | 本バッチはDBを操作しない |

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

本バッチはデータベースへのアクセスは行わず、ファイルシステムのみを操作する。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | FileNotFoundError | プラグインのstaticディレクトリが存在しない | スキップして継続 |
| - | PermissionError | 出力先への書き込み権限がない | 権限を確認して再実行 |
| - | IOError | ディスク容量不足等 | ディスク容量を確保 |

### リトライ仕様

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

### 障害時対応

1. エラーログを確認
2. 原因（権限、容量など）を特定
3. 問題解決後に再実行

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

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

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | プラグイン数 x 平均静的ファイル数 |
| 目標処理時間 | 数秒〜数十秒（プラグイン数に依存） |
| メモリ使用量上限 | 最小限（ファイル単位でストリームコピー） |

## 排他制御

同時実行の制御は行わない。複数回の同時実行は避けることを推奨。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 処理開始時 | "Collecting static files for all installed plugins." |
| 進捗ログ | 各プラグイン処理時 | "Collecting static files for plugin '{slug}'" |
| 完了ログ | ファイルコピー完了時 | "Copied {n} static files for plugin '{slug}'." |
| クリーンアップログ | ディレクトリ削除時 | "Cleared static directory: {path}" |

## 監視・アラート

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

## 備考

- 本コマンドは `invoke plugins` や `invoke static` コマンドから自動的に呼び出される
- プラグインのstaticディレクトリが存在しない場合は、そのプラグインの処理はスキップされる
- アンインストールされたプラグインの静的ファイルは自動的にクリーンアップされる
