# バッチ設計書 16-usage_data.entity_data.collect

## 概要

本ドキュメントは、Shopwareプラットフォームにおける使用状況データ収集バッチの設計仕様を定義します。店舗のエンティティデータを収集し、Shopwareの使用状況分析のためにデータを送信準備します。

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

**業務上の目的・背景**：Shopwareは製品改善やユーザーサポートのために、匿名化された使用状況データを収集する機能を提供しています。店舗運営者が同意した場合、商品数、注文数、顧客数などの統計情報が定期的に収集され、Shopwareのゲートウェイサーバーに送信されます。このデータは製品の品質向上や、店舗運営者への適切なサポート提供に活用されます。本バッチはこのデータ収集プロセスを開始するトリガーとして機能します。

**バッチの実行タイミング**：日次（86400秒間隔）でスケジュール実行されます。ただし、12時間以内に既に実行されている場合はスキップされます。

**主要な処理内容**：
1. EntityDispatchServiceのdispatchCollectEntityDataMessageメソッドを呼び出し
2. コレクション機能が有効かを確認
3. CollectEntityDataMessageをメッセージキューにディスパッチ
4. メッセージハンドラーが各エンティティの反復処理メッセージを発行
5. 最終的にShopwareゲートウェイへデータを送信

**前後の処理との関連**：前提として、店舗運営者がデータ収集に同意している必要があります（ConsentService）。また、ゲートウェイサーバーがプッシュを許可している必要があります（GatewayStatusService）。

**影響範囲**：メッセージキューへのメッセージ発行と、各エンティティの読み取りアクセスを行います。データベースへの書き込みは最終実行日時の記録のみです。外部ゲートウェイサーバーへのHTTP通信が発生します。

## バッチ種別

データ連携（使用状況データ収集・送信）

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | スケジュールタスクランナーに依存 |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron（スケジュールタスク） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| collectionEnabled | コレクション機能が有効であること |
| 同意取得済み | ConsentServiceで同意日時が記録されていること |
| ゲートウェイ許可 | GatewayStatusServiceでプッシュが許可されていること |
| 最小実行間隔 | 前回実行から12時間以上経過していること |

### 実行可否判定

1. `collectionEnabled`フラグがfalseの場合は即座にリターン
2. `ConsentService.getLastConsentIsAcceptedDate()`で同意日時を確認
3. `hasMinimumTimeElapsed()`で前回実行から12時間以上経過しているか確認
4. `GatewayStatusService.isGatewayAllowsPush()`でゲートウェイの許可状態を確認

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 各エンティティテーブル | DB | 収集対象のエンティティデータ |
| system_config | DB | 最終同期実行日時 |
| app_config | KeyValue | エンティティ別最終実行日時 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| message_queue | Queue | CollectEntityDataMessage, IterateEntityMessage |
| system_config | DB | 最終同期実行日時の更新 |
| Shopwareゲートウェイ | HTTP | 使用状況データ送信 |

### 出力ファイル仕様

ファイル出力はありません。

## 処理フロー

### 処理シーケンス

```
1. タスクハンドラー実行
   └─ EntityDispatchService.dispatchCollectEntityDataMessage()呼び出し
2. コレクション有効性チェック
   └─ collectionEnabled確認
3. CollectEntityDataMessageディスパッチ
   └─ shopIdを含むメッセージをキューに投入
4. [非同期] メッセージハンドラー処理
   └─ dispatchIterateEntityMessages()でエンティティ別メッセージ発行
5. 同意確認
   └─ 最終同意日時を取得
6. 最小実行間隔チェック
   └─ 前回実行から12時間以上経過確認
7. ゲートウェイ状態確認
   └─ プッシュ許可状態を確認
8. エンティティ反復処理
   └─ 許可されたエンティティ定義ごとにIterateEntityMessageを発行
9. 最終実行日時更新
   └─ app_configとsystem_configに記録
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{collectionEnabled?}
    B -->|No| Z[スキップ終了]
    B -->|Yes| C[CollectEntityDataMessage発行]
    C --> D{同意あり?}
    D -->|No| Z
    D -->|Yes| E{12時間経過?}
    E -->|No| Z
    E -->|Yes| F{ゲートウェイ許可?}
    F -->|No| Z
    F -->|Yes| G[エンティティ定義取得]
    G --> H[エンティティループ]
    H --> I[IterateEntityMessage発行]
    I --> J[最終実行日時更新]
    J --> K{次のエンティティ?}
    K -->|Yes| H
    K -->|No| L[system_config更新]
    L --> M[バッチ終了]
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 最終同期日時取得 | system_config | SELECT | core.usageData.lastEntitySyncRunDate取得 |
| エンティティデータ読取 | 各エンティティテーブル | SELECT | 収集対象データの読み取り |
| 最終実行日時更新 | system_config | UPDATE | 同期実行日時の記録 |

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

#### system_config

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | configuration_value | configuration_key = 'core.usageData.lastEntitySyncRunDate' | 最終実行日時 |
| UPDATE | configuration_value | 現在日時 | 実行完了時に更新 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ネットワークエラー | 接続エラー | ゲートウェイへの接続失敗 | ネットワーク確認、再試行 |
| 同意なし | 設定エラー | データ収集同意が取得されていない | 同意設定を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 失敗時再スケジュール有効 |
| リトライ間隔 | 次回スケジュール実行時 |
| リトライ対象エラー | 全般的なエラー |

### 障害時対応

1. エラーログを確認し原因を特定
2. ゲートウェイサーバーへの接続を確認
3. 同意設定を確認
4. メッセージキューの状態を確認

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | メッセージ発行はトランザクション外 |
| コミットタイミング | 即座（メッセージキュー発行時） |
| ロールバック条件 | 特になし（非同期処理） |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | エンティティ定義数（数十件） |
| 目標処理時間 | タスクハンドラーは数秒（メッセージ発行のみ） |
| メモリ使用量上限 | 通常のPHP制限に準拠 |
| 最小実行間隔 | 12時間 |

## 排他制御

shopIdを使用してメッセージの重複処理を防止します。shopIdが変更された場合、古いメッセージは無視されます。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 開始ログ | タスク開始時 | タスク開始通知 |
| 進捗ログ | メッセージ発行時 | エンティティ名、操作種別 |
| 終了ログ | タスク終了時 | 処理完了通知 |
| エラーログ | エラー発生時 | エラー詳細、スタックトレース |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| 処理時間 | 300秒 | システム管理者 |
| エラー件数 | 1件以上 | システム管理者 |

## 備考

- 内部使用タスク（@internal）として定義されています
- data-servicesパッケージに属するタスクです
- MIN_LAST_ENTITY_SYNC_DIFFERENCE（12時間）の間隔を空けて実行されます
- 初回実行時はOperation::CREATEのみ、2回目以降は全Operationが処理されます
- shopIdはShopIdProviderから取得され、メッセージの整合性確認に使用されます
- 収集対象エンティティはEntityDefinitionServiceで管理されます
