# バッチ設計書 1-Internal::CheckNewVersionsJob

## 概要

本ドキュメントは、Chatwootアプリケーションにおける`Internal::CheckNewVersionsJob`バッチの設計仕様を記載したものである。

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

このバッチは、Chatwootの最新バージョン情報をChatwoot Hubサーバーと同期し、取得したバージョン情報をRedisに保存するジョブである。

**業務上の目的・背景**：Chatwoot運用者が自身のインスタンスが最新バージョンであるかを確認できるようにするため、定期的に公式Hubサーバーから最新バージョン情報を取得する必要がある。これにより、セキュリティアップデートや新機能の提供状況を把握し、適切なタイミングでアップデートを実施できる。また、Enterprise版ではプラン情報やサポート設定の同期も行われる。

**バッチの実行タイミング**：日次で12:00 UTC（毎日正午）に実行される。本番環境（production）でのみ動作する。

**主要な処理内容**：
1. 本番環境かどうかを確認し、本番環境以外では処理をスキップ
2. ChatwootHubクラスを使用してHubサーバーと同期（インスタンス情報とメトリクスを送信）
3. 取得したレスポンスからバージョン情報を抽出
4. バージョン情報をRedis（`LATEST_CHATWOOT_VERSION`キー）に保存
5. Enterprise版では追加でプラン情報の更新とプレミアム機能の調整を実施

**前後の処理との関連**：本バッチは独立して動作し、前提となるバッチは存在しない。取得されたバージョン情報は、管理画面でのバージョン表示に利用される（`AccountsController`にて参照）。

**影響範囲**：Redis（バージョン情報の保存）、InstallationConfig（Enterprise版でのプラン情報保存）

## バッチ種別

データ連携 / 外部API同期

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | 12:00 UTC |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（sidekiq-cron） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| 本番環境であること | `Rails.env.production?`がtrueの場合のみ実行 |
| Hubサーバーへの接続 | Chatwoot Hub（hub.2.chatwoot.com）へのHTTPS接続が可能であること |

### 実行可否判定

本番環境（production）でない場合は、`perform`メソッド冒頭で`return`により即座に終了する。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| InstallationConfig | DB | インストール識別子（INSTALLATION_IDENTIFIER）の取得 |
| Chatwoot.config | 設定 | 現在のインストールバージョン取得 |
| Account, User, Inbox, Conversation, Message | DB | メトリクス情報の収集（telemetry有効時） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| Redis（LATEST_CHATWOOT_VERSION） | 文字列 | 最新のChatwootバージョン番号 |
| InstallationConfig（Enterprise版） | DB | プラン情報、サポート設定などの保存 |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 本番環境チェック
   └─ production環境でなければ即座にreturn
2. Hubサーバーとの同期
   └─ ChatwootHub.sync_with_hubを呼び出し
   └─ インスタンス情報（識別子、バージョン、ホスト名等）を送信
   └─ メトリクス情報（アカウント数、ユーザー数等）を送信（telemetry有効時）
3. バージョン情報の保存
   └─ レスポンスからversionを抽出
   └─ Redis::Alfred.setでLATEST_CHATWOOT_VERSIONキーに保存
4. Enterprise版追加処理
   └─ プラン情報の更新（INSTALLATION_PRICING_PLAN等）
   └─ プレミアム機能の調整（ReconcilePlanConfigService）
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{本番環境?}
    B -->|No| C[処理終了]
    B -->|Yes| D[Hubサーバーと同期]
    D --> E{バージョン情報あり?}
    E -->|No| F[スキップ]
    E -->|Yes| G[Redisにバージョン保存]
    G --> H{Enterprise版?}
    H -->|No| I[バッチ終了]
    H -->|Yes| J[プラン情報更新]
    J --> K[プレミアム機能調整]
    K --> I
    F --> I
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| インスタンス識別子取得 | installation_configs | SELECT | INSTALLATION_IDENTIFIERの取得 |
| メトリクス収集 | accounts, users, inboxes, conversations, messages | SELECT | 各テーブルの最終IDを取得（件数代用） |
| プラン情報更新（Enterprise） | installation_configs | INSERT/UPDATE | プラン関連設定の保存 |

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

#### installation_configs

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name, value | name = 'INSTALLATION_IDENTIFIER' | インスタンス識別子の取得 |
| INSERT/UPDATE（Enterprise） | name, value, locked | INSTALLATION_PRICING_PLAN, INSTALLATION_PRICING_PLAN_QUANTITY等 | locked=trueで保存 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | RestClient::Exception | Hubサーバーへの接続失敗、タイムアウト等 | ログ出力のみ、次回実行時にリトライ |
| - | StandardError | 予期しないエラー | ChatwootExceptionTrackerで例外を記録 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Sidekiqのデフォルト設定に依存 |
| リトライ間隔 | Sidekiqのデフォルト設定に依存 |
| リトライ対象エラー | ジョブ実行時の例外全般 |

### 障害時対応

Hubサーバーへの接続失敗時は例外をログに記録し、バージョン情報の更新はスキップされる。既存のバージョン情報は保持される。次回の定期実行で自動的にリトライされる。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | Enterprise版のInstallationConfig更新時のみ個別トランザクション |
| コミットタイミング | 各InstallationConfig.save!時に即時コミット |
| ロールバック条件 | save!失敗時に該当レコードのみロールバック |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回/日 |
| 目標処理時間 | 数秒以内（外部API呼び出し含む） |
| メモリ使用量上限 | 最小限（大量データ処理なし） |

## 排他制御

同時実行の制御は特になし。日次1回のみの実行であり、競合の可能性は低い。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| エラーログ | RestClient例外発生時 | `Exception: #{e.message}` |
| エラーログ | その他例外発生時 | ChatwootExceptionTrackerに記録 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗 | 連続失敗 | Sidekiq監視 |
| バージョン情報未更新 | 数日間更新なし | 運用監視（任意） |

## 備考

- 環境変数`DISABLE_TELEMETRY`が設定されている場合、メトリクス情報は送信されない
- Enterprise版では`prepend_mod_with`によりOSS版の機能が拡張される
- Hubサーバーへの送信データには、インストール識別子、バージョン、ホスト名、環境種別、エディション情報が含まれる
