# バッチ設計書 13-delete_old_notifications_common

## 概要

本ドキュメントは、InvenTreeシステムのcommonモジュールにおける古い通知エントリの削除バッチ処理について記述します。このバッチは、90日（約3ヶ月）以上経過した古い通知エントリをデータベースから削除し、データベースの肥大化を防止します。

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

**業務上の目的・背景**：InvenTreeでは、様々なシステムイベント（在庫アラート、注文ステータス変更など）に対して通知が生成されます。これらの通知エントリはNotificationEntryテーブルに蓄積されますが、古い通知は業務上の参照価値が低下します。データベースの肥大化はクエリパフォーマンスに悪影響を与えるため、定期的なクリーンアップが必要です。本バッチは、90日以上前の通知を自動的に削除することでこの課題を解決します。

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

**主要な処理内容**：
1. 現在時刻から90日前のタイムスタンプを計算
2. NotificationEntryテーブルから更新日（updated）が90日以上前のレコードを検索
3. 該当するレコードを一括削除
4. 処理完了

**前後の処理との関連**：本バッチはInvenTree/tasks.pyにある同名バッチ（delete_old_notifications）とは異なるモジュールに存在します。InvenTreeモジュールの方は設定可能な保持期間を持ちますが、commonモジュールのこのバッチは90日固定です。両方が独立して実行されます。

**影響範囲**：common_notificationentryテーブルに対して削除操作を行います。90日以内の通知エントリには影響しません。

## バッチ種別

データクレンジング

## 実行スケジュール

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

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Django-Qワーカー稼働中 | バックグラウンドワーカーが稼働している必要がある |
| データベース接続可能 | NotificationEntryテーブルへのアクセスが可能であること |
| Appレジストリ準備完了 | Djangoアプリケーションが正常に起動していること |

### 実行可否判定

- スケジューラに登録されたタイミングで自動実行
- AppRegistryNotReady例外発生時はスキップしてログ出力

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| common_notificationentry | DB | 通知エントリテーブル |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| なし | - | ログ出力のみ（エラー時） |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. バッチ開始
   └─ 処理開始
2. NotificationEntryモデルのインポート確認
   └─ AppRegistryNotReady時は処理中断
3. 閾値日時計算
   └─ timezone.now() - 90日 = before
4. 対象レコード削除
   └─ NotificationEntry.objects.filter(updated__lte=before).delete()
5. バッチ終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{NotificationEntry<br/>インポート成功?}
    B -->|失敗| C[ログ出力して終了]
    B -->|成功| D[閾値日時計算: 現在-90日]
    D --> E[90日以上前の通知を検索]
    E --> F[該当レコードを一括削除]
    F --> G[バッチ終了]
    C --> G
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 古い通知削除 | common_notificationentry | DELETE | 90日以上経過したレコードの一括削除 |

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

#### common_notificationentry

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| DELETE | - | updated <= (now - 90日) | 一括削除 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | AppRegistryNotReady | Djangoアプリ未起動 | ログ出力後にスキップ |
| - | OperationalError | データベース接続エラー | データベース接続を確認 |

### リトライ仕様

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

### 障害時対応

1. ログを確認してエラー原因を特定
2. Djangoアプリケーションの状態を確認
3. 必要に応じて手動で再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | 一括削除処理全体 |
| コミットタイミング | 削除処理完了時 |
| ロールバック条件 | 削除処理中にエラー発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百〜数千件/日 |
| 目標処理時間 | 1分以内 |
| メモリ使用量上限 | 特に制限なし |

## 排他制御

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

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | App未準備時 | "Could not perform 'delete_old_notifications' - App registry not ready" |

## 監視・アラート

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

## 備考

- 保持期間90日はハードコードされており、設定変更不可
- InvenTree/tasks.pyにも同名の関数（delete_old_notifications）が存在するが、こちらは設定で保持期間を変更可能
- 本バッチはcommon/tasks.pyに定義されており、NotificationEntryのみを対象とする
- OpenTelemetryによるトレーシングに対応
