# 機能設計書 97-アナリティクス

## 概要

本ドキュメントは、Medusaコマースプラットフォームにおけるアナリティクス機能の設計仕様を記述する。アナリティクス機能は、ユーザー行動や販売データの追跡・分析を行うための基盤を提供する。

### 本機能の処理概要

アナリティクス機能は、プラットフォーム上でのユーザー行動（ページビュー、商品閲覧、カート操作など）やビジネスイベント（注文、支払いなど）を追跡し、外部アナリティクスプロバイダー（Segment、Google Analyticsなど）に送信するための抽象化レイヤーを提供する。track（イベント追跡）とidentify（ユーザー識別）の2つの主要機能を通じて、データ分析基盤との連携を実現する。

**業務上の目的・背景**：ECプラットフォームの運営において、ユーザー行動の分析は売上向上やユーザーエクスペリエンス改善に不可欠である。どの商品がよく閲覧されるか、カート離脱がどこで発生するか、どの顧客セグメントが高いコンバージョン率を持つかなどのインサイトを得るために、アナリティクス機能が必要となる。プロバイダー抽象化により、異なるアナリティクスツールへの切り替えやマルチプロバイダー対応が容易になる。

**機能の利用シーン**：
- 商品ページ閲覧イベントの追跡
- カートへの商品追加イベントの追跡
- 注文完了イベントの追跡
- ユーザーログイン時のユーザー識別
- 顧客グループへの所属情報の送信
- A/Bテストのバリアント割り当て追跡

**主要な処理内容**：
1. イベント追跡（track）- ユーザーアクションをアナリティクスプロバイダーに送信
2. ユーザー識別（identify）- ユーザー情報をアナリティクスプロバイダーに送信
3. プロバイダー管理 - アナリティクスプロバイダーの登録と取得
4. シャットダウン処理 - アプリケーション終了時のクリーンアップ

**関連システム・外部連携**：
- 外部アナリティクスプロバイダー（Segment、Google Analytics、Mixpanelなど）
- CDPプラットフォーム

**権限による制御**：アナリティクス機能自体には権限制御は設けられていない。イベント送信元のサービス層で適切なフィルタリングを実装する。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は直接UIを持たないバックエンド機能 |

## 機能種別

データ連携 / 分析基盤

## 入力仕様

### 入力パラメータ（track）

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| data | TrackAnalyticsEventDTO | Yes | 追跡イベントデータ | - |
| data.event | string | Yes | イベント名（例: "Product Viewed"） | - |
| data.actor_id | string | Yes | イベント実行者ID（ユーザーID等） | - |
| data.properties | Record<string, unknown> | No | イベントプロパティ | - |
| data.timestamp | Date | No | イベント発生時刻 | - |

### 入力パラメータ（identify）

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| data | IdentifyAnalyticsEventDTO | Yes | 識別イベントデータ | - |
| data.actor_id | string | Yes（groupなしの場合） | ユーザーID | - |
| data.group | object | Yes（actor_idなしの場合） | グループ情報 | - |
| data.group.id | string | Yes | グループID | - |
| data.group.type | string | No | グループ種別 | - |
| data.traits | Record<string, unknown> | No | ユーザー/グループ属性 | - |

### 入力データソース

- APIルートハンドラーからの呼び出し
- ワークフローステップからの呼び出し
- イベントハンドラーからの呼び出し

## 出力仕様

### 出力データ（track/identify）

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (void) | void | 非同期でプロバイダーに送信（戻り値なし） |

### 出力先

- 設定されたアナリティクスプロバイダーのAPI

## 処理フロー

### 処理シーケンス（track）

```
1. イベントデータ受信
   └─ TrackAnalyticsEventDTOを受け取る

2. プロバイダー呼び出し
   └─ analyticsProviderService_.track(data)

3. エラーハンドリング
   └─ 失敗時はUNEXPECTED_STATEエラーをスロー

4. 完了
```

### フローチャート

```mermaid
flowchart TD
    A[track/identify 呼び出し] --> B[プロバイダーサービス取得]
    B --> C{プロバイダー存在?}
    C -->|No| D[Error: No provider]
    C -->|Yes| E[provider.track/identify 呼び出し]
    E --> F{成功?}
    F -->|Yes| G[完了]
    F -->|No| H[MedusaError: UNEXPECTED_STATE]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-97-1 | 単一プロバイダー | アナリティクスモジュールは1つのプロバイダーのみで初期化 | モジュール初期化時 |
| BR-97-2 | エラーラップ | プロバイダーエラーはMedusaError.UNEXPECTED_STATEでラップ | エラー発生時 |
| BR-97-3 | シャットダウンフック | アプリケーション終了時にプロバイダーのshutdown()を呼び出し | アプリケーション終了時 |
| BR-97-4 | 識別子生成 | プロバイダークラスからの識別子は `{identifier}_{optionName}` 形式 | プロバイダー登録時 |

### 計算ロジック

プロバイダー登録識別子の生成：
```typescript
// プロバイダー識別子の生成
static getRegistrationIdentifier(
  providerClass: Constructor<IAnalyticsProvider>,
  optionName?: string
) {
  return `${(providerClass as any).identifier}_${optionName}`
}

// コンテナ登録キー
`aly_{identifier}`
```

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| - | - | - | データベース操作なし（外部API送信のみ） |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| INVALID_DATA | MedusaError | プロバイダーが1つでない | 1つのプロバイダーのみで初期化 |
| UNEXPECTED_STATE | MedusaError | track/identify処理中にエラー | プロバイダー設定を確認、ネットワークを確認 |

### リトライ仕様

- アナリティクスモジュール層でのリトライはなし
- プロバイダー実装でリトライを行う場合がある

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

アナリティクス送信はトランザクション外で行われる。イベント送信の失敗がビジネストランザクションに影響しない設計。

## パフォーマンス要件

- イベント送信は非同期で行われ、呼び出し元をブロックしない
- バッチ送信のサポートはプロバイダー実装による

## セキュリティ考慮事項

- 個人情報を含むプロパティの送信には注意が必要
- プロバイダーへの通信はHTTPS必須
- APIキーなどの認証情報は環境変数で管理

## 備考

- IAnalyticsProviderインターフェースを実装してカスタムプロバイダーを作成可能
- shutdown()メソッドはオプショナル
- プロバイダーは `aly_` プレフィックスで登録される

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: インターフェースを理解する

アナリティクスプロバイダーのインターフェースを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | IAnalyticsProvider | `packages/core/types/src/analytics/index.ts` | IAnalyticsProviderインターフェースの定義 |

**読解のコツ**: IAnalyticsProviderはtrack()とidentify()メソッドを定義し、オプションでshutdown()メソッドを持つ。

#### Step 2: アナリティクスサービスを理解する

メインのアナリティクスサービス実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | analytics-service.ts | `packages/modules/analytics/src/services/analytics-service.ts` | AnalyticsServiceの実装 |

**主要処理フロー**:
- **12-17行目**: コンストラクタでプロバイダーサービスを注入
- **19-23行目**: __hooksでonApplicationShutdownを定義
- **25-27行目**: getProvider()でプロバイダーを取得
- **29-38行目**: track()でイベントを追跡、エラー時はMedusaErrorをスロー
- **40-51行目**: identify()でユーザーを識別、エラー時はMedusaErrorをスロー

#### Step 3: プロバイダーサービスを理解する

プロバイダー管理サービスの実装を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | provider-service.ts | `packages/modules/analytics/src/services/provider-service.ts` | AnalyticsProviderServiceの実装 |

**主要処理フロー**:
- **20-36行目**: コンストラクタで単一プロバイダーを取得、複数の場合はエラー
- **38-43行目**: getRegistrationIdentifier()でプロバイダー識別子を生成
- **45-47行目**: track()をプロバイダーに委譲
- **49-51行目**: identify()をプロバイダーに委譲
- **53-55行目**: shutdown()をプロバイダーに委譲（オプショナル呼び出し）

### プログラム呼び出し階層図

```
AnalyticsService
    │
    ├─ track(data: TrackAnalyticsEventDTO)
    │      │
    │      ├─ try
    │      │    └─ analyticsProviderService_.track(data)
    │      │           └─ analyticsProvider_.track(data)
    │      │
    │      └─ catch
    │           └─ MedusaError(UNEXPECTED_STATE, message)
    │
    ├─ identify(data: IdentifyAnalyticsEventDTO)
    │      │
    │      ├─ try
    │      │    └─ analyticsProviderService_.identify(data)
    │      │           └─ analyticsProvider_.identify(data)
    │      │
    │      └─ catch
    │           └─ MedusaError(UNEXPECTED_STATE, message)
    │
    ├─ getProvider()
    │      └─ return analyticsProviderService_
    │
    └─ __hooks.onApplicationShutdown
           └─ analyticsProviderService_.shutdown()
                  └─ analyticsProvider_.shutdown?.()

AnalyticsProviderService
    │
    ├─ constructor(container)
    │      ├─ Object.keys(container).filter(k => k.startsWith("aly_"))
    │      │
    │      ├─ [keys.length !== 1]
    │      │      └─ MedusaError(INVALID_DATA)
    │      │
    │      └─ analyticsProvider_ = container[keys[0]]
    │
    └─ getRegistrationIdentifier(providerClass, optionName)
           └─ return `${providerClass.identifier}_${optionName}`
```

### データフロー図

```
[入力]                           [処理]                      [出力]

track({
  event: "Product Viewed",
  actor_id: "user_123",
  properties: {
    product_id: "prod_456"
  }
})
    │
    ▼
AnalyticsService.track()
    │
    ▼
AnalyticsProviderService.track()
    │
    ▼
IAnalyticsProvider.track() ────▶ [外部API]
                                 (Segment, GA等)
                                      │
                                      ▼
                                 [分析ダッシュボード]
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| analytics-service.ts | `packages/modules/analytics/src/services/analytics-service.ts` | ソース | メインアナリティクスサービス |
| provider-service.ts | `packages/modules/analytics/src/services/provider-service.ts` | ソース | プロバイダー管理サービス |
| IAnalyticsProvider | `packages/core/types/src/analytics/index.ts` | 型定義 | プロバイダーインターフェース |
| TrackAnalyticsEventDTO | `packages/core/types/src/analytics/index.ts` | 型定義 | 追跡イベントDTO |
| IdentifyAnalyticsEventDTO | `packages/core/types/src/analytics/index.ts` | 型定義 | 識別イベントDTO |
