# バッチ設計書 28-clean_settings

## 概要

本ドキュメントは、未定義の古い設定をデータベースからクリーンアップするDjango管理コマンド「clean_settings」の設計仕様を定義する。

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

このコマンドは、InvenTreeシステムのデータベースに保存されている設定値のうち、現在のコードベースで定義されていない古い設定を検出し削除することで、データベースの整合性を維持する。

**業務上の目的・背景**：InvenTreeのバージョンアップに伴い、設定項目が追加・削除・変更されることがある。データベースには過去のバージョンで使用されていた設定が残存し、これらの未定義設定はシステムの混乱や予期しない動作の原因となる可能性がある。本コマンドは、現在のコードベースで定義されていない設定を自動的に検出・削除し、設定テーブルをクリーンな状態に保つ。

**バッチの実行タイミング**：手動実行（CLI）。システムアップデート後やバージョンアップ後に実行することを推奨。

**主要な処理内容**：
1. InvenTreeSettingモデルの全レコードを取得
2. 各レコードのkeyがSETTINGS定義に存在するか確認
3. 存在しないkeyを持つレコードを削除
4. 同様の処理をInvenTreeUserSettingに対しても実行

**前後の処理との関連**：システムアップデート（invokeタスクのupdate）の一部として実行されることがある。他のバッチとの直接的な依存関係はない。

**影響範囲**：common_inventreesetting、common_inventreeusersettingテーブルの削除操作に影響する。

## バッチ種別

データクレンジング / 設定管理 / CLIコマンド

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動） |
| 実行時刻 | システムアップデート後 |
| 実行曜日 | 不定 |
| 実行日 | 不定 |
| トリガー | CLIコマンド: `python manage.py clean_settings` |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| データベース接続 | InvenTreeデータベースに正常に接続できること |
| 設定モデル定義 | InvenTreeSetting, InvenTreeUserSettingのSETTINGS定義が最新であること |

### 実行可否判定

特別な実行可否判定はなく、コマンド実行時に即座に処理を開始する。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| common_inventreesetting | DB | グローバル設定テーブル |
| common_inventreeusersetting | DB | ユーザー設定テーブル |
| InvenTreeSetting.SETTINGS | Python | 定義済みグローバル設定キー |
| InvenTreeUserSetting.SETTINGS | Python | 定義済みユーザー設定キー |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| common_inventreesetting | DB | 未定義設定の削除 |
| common_inventreeusersetting | DB | 未定義ユーザー設定の削除 |
| ログ | Log | 削除された設定のログ |

### 出力ファイル仕様

本コマンドはファイル出力を行わない。

## 処理フロー

### 処理シーケンス

```
1. 設定収集開始
   └─ logger.info('Collecting settings')
2. グローバル設定の処理
   └─ InvenTreeSetting.objects.all() で全レコード取得
   └─ InvenTreeSetting.SETTINGS で定義済みキーを取得
3. 未定義グローバル設定の削除
   └─ 各設定のkeyがSETTINGSに存在しない場合、削除してログ出力
4. ユーザー設定の処理
   └─ InvenTreeUserSetting.objects.all() で全レコード取得
   └─ InvenTreeUserSetting.SETTINGS で定義済みキーを取得
5. 未定義ユーザー設定の削除
   └─ 各設定のkeyがSETTINGSに存在しない場合、削除してログ出力
6. 完了ログ出力
   └─ logger.info('checked all settings')
```

### フローチャート

```mermaid
flowchart TD
    A[コマンド開始] --> B[Collecting settings ログ出力]
    B --> C[グローバル設定を全件取得]
    C --> D[定義済みキーを取得]
    D --> E{次の設定あり?}
    E -->|Yes| F{keyが定義に存在?}
    F -->|Yes| E
    F -->|No| G[設定を削除]
    G --> H[削除ログ出力]
    H --> E
    E -->|No| I[ユーザー設定を全件取得]
    I --> J[定義済みキーを取得]
    J --> K{次の設定あり?}
    K -->|Yes| L{keyが定義に存在?}
    L -->|Yes| K
    L -->|No| M[設定を削除]
    M --> N[削除ログ出力]
    N --> K
    K -->|No| O[checked all settings ログ出力]
    O --> P[コマンド終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 設定取得 | common_inventreesetting | SELECT | 全グローバル設定を取得 |
| 設定削除 | common_inventreesetting | DELETE | 未定義設定を削除 |
| 設定取得 | common_inventreeusersetting | SELECT | 全ユーザー設定を取得 |
| 設定削除 | common_inventreeusersetting | DELETE | 未定義ユーザー設定を削除 |

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

#### common_inventreesetting

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | - | 全件 | 全グローバル設定を取得 |
| DELETE | key | NOT IN SETTINGS | 定義に存在しないkeyを持つレコード |

#### common_inventreeusersetting

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | - | 全件 | 全ユーザー設定を取得 |
| DELETE | key | NOT IN SETTINGS | 定義に存在しないkeyを持つレコード |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | DatabaseError | データベース操作エラー | エラーログ出力、処理中断 |

### リトライ仕様

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

### 障害時対応

処理中断時は部分的にクリーンアップが完了している可能性がある。再度コマンドを実行することで、残りの未定義設定をクリーンアップ可能。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 各設定の削除ごと |
| コミットタイミング | 各削除後に自動コミット |
| ロールバック条件 | 個別削除処理でのエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数十件〜数百件の設定 |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 最小限 |

## 排他制御

排他制御は特に実装されていない。実行中に設定が変更された場合、一貫性が保証されない可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | 処理開始時 | "Collecting settings" |
| 情報ログ | 設定削除時 | "deleted setting '{key}'" |
| 情報ログ | ユーザー設定削除時 | "deleted user setting '{key}'" |
| 終了ログ | 処理完了時 | "checked all settings" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 削除件数 | 多数の場合は確認推奨 | システム管理者 |

## 備考

- 本コマンドはDjango管理コマンド（BaseCommand）として実装されている
- 実行方法: `python manage.py clean_settings`
- InvenTreeSetting.SETTINGSはクラス変数として定義された設定キーのディクショナリ
- 各設定モデルのkeyフィールドとSETTINGS定義を比較して未定義を判定
- structlogを使用したログ出力
- システムアップデート後やバージョンアップ後に実行することを推奨
- invokeタスク「update」の一部として自動実行されることがある
