# バッチ設計書 19-stats.ts

## 概要

本ドキュメントは、GitHubリリースとnpmからダウンロード統計を収集するスクリプトの設計書です。PostHogにイベントを送信し、STATS.mdファイルを更新します。

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

このスクリプトは、OpenCodeのダウンロード統計を複数のソースから収集し、統合的にトラッキングします。GitHubリリースのアセットダウンロード数とnpmパッケージのダウンロード数を取得し、日次の統計レポートを生成します。

**業務上の目的・背景**：プロジェクトの成長指標としてダウンロード数は重要なKPIです。GitHub Releases、npmなど複数の配布チャネルからのダウンロード数を一元管理し、トレンド分析やレポーティングに活用します。このスクリプトにより、日次の自動統計収集と可視化を実現します。

**バッチの実行タイミング**：stats.ymlワークフローにより日次（12:00 UTC）で自動実行されます。手動実行も可能です。

**主要な処理内容**：
1. GitHubリリース一覧のページネーション取得
2. 各リリースのアセットダウンロード数集計
3. npm APIからオールタイムダウンロード数取得
4. STATS.mdファイルへの統計追記（前日比付き）
5. PostHogへのイベント送信（分析用）
6. コンソールへの統計サマリー出力

**前後の処理との関連**：stats.ymlワークフローから呼び出されます。STATS.mdファイルはリポジトリにコミットされ、ダウンロード推移を可視化します。

**影響範囲**：STATS.mdファイル、PostHog分析システム

## バッチ種別

統計収集 / レポート生成 / 分析連携

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 日次 |
| 実行時刻 | 12:00 UTC |
| 実行曜日 | 毎日 |
| 実行日 | - |
| トリガー | cron (0 12 * * *) / 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Bunランタイム | Bunがインストールされていること |
| POSTHOG_KEY | PostHog APIキー（オプション、未設定時はスキップ） |
| インターネット接続 | GitHub API、npm API、PostHog APIへのアクセス |

### 実行可否判定

前提条件が満たされていれば常に実行可能です。POSTHOG_KEYが未設定の場合、PostHog送信はスキップされます。

## 入力仕様

### 入力パラメータ

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

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| GitHub Releases API | JSON | リリースとアセット情報 |
| npm Downloads API | JSON | パッケージダウンロード数 |
| STATS.md | Markdown | 既存の統計データ |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| STATS.md | Markdown | 日次統計行を追記 |
| PostHog | Event | ダウンロード数イベント |
| 標準出力 | テキスト | 統計サマリー |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | STATS.md |
| 形式 | Markdownテーブル |
| 文字コード | UTF-8 |
| 内容 | 日付、GitHubダウンロード数（前日比）、npmダウンロード数（前日比）、合計（前日比） |

## 処理フロー

### 処理シーケンス

```
1. GitHubリリース取得
   └─ ページネーションで全リリースを取得
2. ダウンロード数集計
   └─ 各リリースのアセットダウンロード数を合計
3. npmダウンロード取得
   └─ 2020年から現在+5年までの全期間ダウンロード数
4. STATS.md更新
   └─ 前日データと比較、差分を計算、行を追記
5. Prettierフォーマット
   └─ bunx prettier --write STATS.md
6. PostHog送信
   └─ GitHubとnpmのダウンロードイベント送信
7. サマリー出力
   └─ コンソールに統計サマリー表示
```

### フローチャート

```mermaid
flowchart TD
    A[スクリプト開始] --> B[GitHubリリース取得]
    B --> C[ページネーション処理]
    C --> D[アセットダウンロード集計]
    D --> E[npmダウンロード取得]
    E --> F[STATS.md読み込み]
    F --> G[前日データ抽出]
    G --> H[差分計算]
    H --> I[新行追記]
    I --> J[Prettierフォーマット]
    J --> K{POSTHOG_KEY?}
    K -->|あり| L[PostHog送信]
    K -->|なし| M[スキップ]
    L --> N[サマリー出力]
    M --> N
    N --> O[終了]
```

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

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

本スクリプトはデータベースを操作しません。

| 処理 | 対象 | 操作種別 | 概要 |
|-----|------|---------|------|
| ファイル更新 | STATS.md | APPEND | 統計行の追記 |
| イベント送信 | PostHog | INSERT | ダウンロードイベント |

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | GitHub APIエラー | レート制限超過 | 1秒間隔でリトライ |
| - | npm APIエラー | サービス障害 | 警告出力、0を返す |
| - | PostHogエラー | 認証失敗 | 警告出力、続行 |
| - | ファイルエラー | STATS.md不在 | 新規作成 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | GitHub API: ページネーション時に1秒待機 |
| リトライ間隔 | 1000ms |
| リトライ対象エラー | レート制限 |

### 障害時対応

1. エラーメッセージを確認
2. API接続を確認
3. 再実行

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ファイル書き込み単位 |
| コミットタイミング | Bun.write完了時 |
| ロールバック条件 | Gitによる復元が必要 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 数百リリース |
| 目標処理時間 | 60秒以内 |
| メモリ使用量上限 | 標準的なNode.jsプロセス |

## 排他制御

同時実行は推奨されません。STATS.mdへの同時書き込みが発生する可能性があります。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | ページ取得時 | ページ番号、リリース数 |
| 結果ログ | 処理完了時 | 統計サマリー（区切り線付き） |
| 警告ログ | エラー発生時 | APIエラー詳細 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ワークフロー失敗 | 1回 | GitHub Actions通知 |

## 備考

- shebang行（`#!/usr/bin/env bun`）により直接実行可能
- GitHub API: anomalyco/opencodeリポジトリを対象
- npm API: opencode-aiパッケージを対象（2020年〜現在+5年の範囲）
- STATS.mdフォーマット: `| 日付 | GitHub Downloads (変化) | npm Downloads (変化) | Total (変化) |`
- ファイル未存在時はヘッダー行を含めて新規作成
- 前日比は`(+N)`または`(-N)`形式で表示
- PostHogイベントは`distinct_id: "download"`で送信
