# バッチ設計書 11-run_oauth_maintenance

## 概要

本ドキュメントは、InvenTreeシステムにおけるOAuthトークンのメンテナンスバッチ処理について記述します。このバッチは、期限切れのOAuthアクセストークンおよびリフレッシュトークンをデータベースから定期的にクリーンアップし、システムのパフォーマンスとセキュリティを維持します。

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

**業務上の目的・背景**：InvenTreeはOAuth2認証をサポートしており、外部アプリケーションからのAPI連携が可能です。OAuth認証では、アクセストークンやリフレッシュトークンがデータベースに蓄積されますが、これらのトークンには有効期限があります。期限切れのトークンを放置すると、データベースの肥大化、認証処理のパフォーマンス低下、およびセキュリティリスクにつながります。本バッチは、これらの課題を自動的に解決するために存在します。

**バッチの実行タイミング**：日次（毎日1回）。Django-Qスケジューラによりスケジュールされ、バックグラウンドワーカーによって実行されます。

**主要な処理内容**：
1. oauth2_providerライブラリのclear_expired関数を呼び出す
2. 期限切れのアクセストークンをデータベースから削除
3. 期限切れのリフレッシュトークンをデータベースから削除
4. 関連する認可コードやグラントの期限切れエントリも削除

**前後の処理との関連**：本バッチは独立して動作し、他のバッチとの直接的な依存関係はありません。ただし、OAuth認証を利用するすべてのAPI連携機能の正常動作を支える基盤的な役割を担っています。

**影響範囲**：OAuth2関連テーブル（oauth2_provider_accesstoken、oauth2_provider_refreshtoken、oauth2_provider_grant等）に対して削除操作を行います。現在有効なトークンには影響しません。

## バッチ種別

データクレンジング

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | Django-Qスケジューラによる自動実行 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（Django-Qスケジューラ） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django-Qワーカー稼働中 | バックグラウンドワーカーが稼働している必要がある |
| データベース接続可能 | OAuth関連テーブルへのアクセスが可能であること |
| oauth2_providerインストール済み | django-oauth-toolkitがインストールされていること |

### 実行可否判定

- スケジューラに登録されたタイミングで自動実行
- 特別な実行可否判定ロジックは存在しない

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 本バッチはパラメータを取らない |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| oauth2_provider_accesstoken | DB | OAuth2アクセストークンテーブル |
| oauth2_provider_refreshtoken | DB | OAuth2リフレッシュトークンテーブル |
| oauth2_provider_grant | DB | OAuth2認可グラントテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| ログ出力 | テキスト | 処理開始・完了のログメッセージ |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ ログ出力: "Starting OAuth maintenance task"
2. clear_expired()関数呼び出し
   └─ oauth2_providerライブラリの組み込み関数で期限切れトークンを削除
3. バッチ終了
   └─ ログ出力: "Completed OAuth maintenance task"
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[ログ出力: 開始メッセージ]
    B --> C[clear_expired関数呼び出し]
    C --> D[期限切れトークン削除]
    D --> E[ログ出力: 完了メッセージ]
    E --> F[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| トークンクリーンアップ | oauth2_provider_accesstoken | DELETE | 期限切れアクセストークンの削除 |
| トークンクリーンアップ | oauth2_provider_refreshtoken | DELETE | 期限切れリフレッシュトークンの削除 |
| グラントクリーンアップ | oauth2_provider_grant | DELETE | 期限切れ認可グラントの削除 |

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

#### oauth2_provider_accesstoken

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | expires < now() | 有効期限切れのレコードを削除 |

#### oauth2_provider_refreshtoken

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | 関連するアクセストークンが期限切れ | アクセストークンに紐づく |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ImportError | oauth2_providerモジュールが見つからない | django-oauth-toolkitをインストール |
| - | OperationalError | データベース接続エラー | データベース接続を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Django-Qのデフォルト設定に依存 |
| リトライ間隔 | Django-Qのデフォルト設定に依存 |
| リトライ対象エラー | 一時的なデータベースエラー |

### 障害時対応

1. ログを確認してエラー原因を特定
2. データベース接続を確認
3. 必要に応じて手動で再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | clear_expired関数内部で管理 |
| コミットタイミング | 削除処理完了時 |
| ロールバック条件 | 削除処理中にエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 蓄積されたトークン数に依存（数百〜数千件/日） |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

- 同時実行可能（削除対象が明確に期限切れレコードに限定されるため）
- ただし、通常は日次1回の実行のため同時実行は想定しない

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | バッチ開始時 | "Starting OAuth maintenance task" |
| 終了ログ | バッチ終了時 | "Completed OAuth maintenance task" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| タスク失敗 | 1回 | システム管理者 |
| 処理時間 | 5分超過 | システム管理者 |

## 備考

- oauth2_provider（django-oauth-toolkit）の組み込み関数clear_expired()を使用
- 削除対象の詳細な制御はoauth2_providerライブラリの設定に依存
- OpenTelemetryによるトレーシングに対応
