botrun-horse 2.29.2 → 2.30.0

package/botrun-c/api/scripts/rollback-plan-names-from-lite-max.ts

@@ -0,0 +1,139 @@
+#!/usr/bin/env tsx
+/**
+ * 訂閱方案名稱 Rollback 腳本
+ *
+ * 目的：將訂閱方案名稱從新格式回退到舊格式
+ * - Lite   → plan-free
+ * - Max-1  → plan-max-1
+ * - Max-2  → plan-max-2
+ *
+ * 執行方式：
+ * cd api
+ * npx tsx scripts/rollback-plan-names-from-lite-max.ts
+ *
+ * ⚠️ 警告：這會將所有新方案名稱改回舊格式
+ */
+
+import { Firestore } from '@google-cloud/firestore';
+
+const db = new Firestore();
+
+// Rollback 對應表（反向）
+const ROLLBACK_MAPPING = {
+  'Lite': 'plan-free',
+  'Max-1': 'plan-max-1',
+  'Max-2': 'plan-max-2',
+} as const;
+
+/**
+ * Rollback 單一使用者的訂閱方案名稱
+ */
+async function rollbackUserPlan(
+  userId: string,
+  currentPlan: string,
+  dryRun: boolean
+): Promise<{ status: 'success' | 'skipped' | 'error'; oldPlan?: string; error?: string }> {
+  // 檢查是否需要 rollback
+  if (!ROLLBACK_MAPPING[currentPlan as keyof typeof ROLLBACK_MAPPING]) {
+    return { status: 'skipped', error: `非新方案名稱: ${currentPlan}` };
+  }
+
+  const oldPlan = ROLLBACK_MAPPING[currentPlan as keyof typeof ROLLBACK_MAPPING];
+
+  // Dry run 模式
+  if (dryRun) {
+    console.log(`  [DRY RUN] ${userId}: ${currentPlan} → ${oldPlan}`);
+    return { status: 'success', oldPlan };
+  }
+
+  try {
+    await db.collection('user_subscriptions').doc(userId).update({
+      plan: oldPlan,
+      updatedAt: new Date(),
+    });
+
+    console.log(`  ✅ ${userId}: ${currentPlan} → ${oldPlan}`);
+    return { status: 'success', oldPlan };
+  } catch (error) {
+    const errorMsg = error instanceof Error ? error.message : '未知錯誤';
+    console.error(`  ❌ ${userId}: Rollback 失敗 - ${errorMsg}`);
+    return { status: 'error', error: errorMsg };
+  }
+}
+
+/**
+ * 執行 Rollback
+ */
+async function rollback(dryRun: boolean = false) {
+  console.log('==================================================');
+  console.log('  訂閱方案名稱 Rollback 工具');
+  console.log('==================================================\n');
+
+  if (dryRun) {
+    console.log('⚠️  DRY RUN 模式：只顯示會執行的操作\n');
+  } else {
+    console.log('🔙 正式 Rollback 模式：即將還原到舊方案名稱\n');
+    console.log('⚠️  警告: 這會將所有新方案名稱改回舊格式\n');
+  }
+
+  let updated = 0;
+  let skipped = 0;
+  let errors = 0;
+
+  try {
+    const snapshot = await db.collection('user_subscriptions').get();
+
+    if (snapshot.empty) {
+      console.log('📭 沒有找到任何訂閱記錄\n');
+      return;
+    }
+
+    console.log(`📊 找到 ${snapshot.size} 筆訂閱記錄\n`);
+
+    for (const doc of snapshot.docs) {
+      const data = doc.data();
+      const userId = doc.id;
+      const currentPlan = data.plan;
+
+      const result = await rollbackUserPlan(userId, currentPlan, dryRun);
+
+      if (result.status === 'success') updated++;
+      else if (result.status === 'skipped') skipped++;
+      else errors++;
+    }
+
+    console.log('\n==================================================');
+    console.log('  Rollback 報告');
+    console.log('==================================================\n');
+    console.log(`✅ 成功: ${updated}`);
+    console.log(`⚠️  跳過: ${skipped}`);
+    console.log(`❌ 錯誤: ${errors}`);
+
+    if (dryRun) {
+      console.log('\n⚠️  這是 DRY RUN 結果，資料庫未被修改');
+    } else {
+      console.log('\n✅ Rollback 完成！');
+    }
+
+    console.log('\n==================================================\n');
+  } catch (error) {
+    console.error('❌ Rollback 過程發生錯誤:', error);
+    throw error;
+  }
+}
+
+/**
+ * 主程式
+ */
+async function main() {
+  const args = process.argv.slice(2);
+  const dryRun = args.includes('--dry-run');
+
+  await rollback(dryRun);
+}
+
+// 執行
+main().catch(error => {
+  console.error('❌ 執行失敗:', error);
+  process.exit(1);
+});

package/botrun-c/api/scripts/seed-rate-limit-test-data.ts

@@ -0,0 +1,114 @@
+#!/usr/bin/env tsx
+/**
+ * Seed Test Data for Rate Limit
+ * 建立測試用的 Rate Limit 資料
+ */
+
+import { Firestore, FieldValue } from '@google-cloud/firestore';
+import { CounterKey } from '../src/rate-limit/domain/entities/UsageCounter.js';
+
+const db = new Firestore();
+
+interface TestUser {
+  userId: string;
+  plan: 'Lite' | 'Max-1' | 'Max-2';
+  rpm: number;  // 當前 RPM 值
+  tpm: number;  // 當前 TPM 值
+  rpd: number;  // 當前 RPD 值
+}
+
+const TEST_USERS: TestUser[] = [
+  {
+    userId: 'user-free-001',
+    plan: 'Lite',
+    rpm: 2,
+    tpm: 50000,
+    rpd: 3,
+  },
+  {
+    userId: 'user-free-002',
+    plan: 'Lite',
+    rpm: 6,  // 已達 RPM 限制
+    tpm: 150000,
+    rpd: 5,
+  },
+  {
+    userId: 'user-max1-001',
+    plan: 'Max-1',
+    rpm: 4,
+    tpm: 300000,
+    rpd: 50,
+  },
+  {
+    userId: 'user-max2-001',
+    plan: 'Max-2',
+    rpm: 5,
+    tpm: 550000,
+    rpd: 350,
+  },
+  {
+    userId: 'user-blocked-001',
+    plan: 'Lite',
+    rpm: 6,   // 已達 RPM 限制
+    tpm: 200000,  // 已達 TPM 限制
+    rpd: 16,   // 已達 RPD 限制
+  },
+];
+
+/**
+ * 建立使用者文件（設定方案）
+ */
+async function createUserDoc(userId: string, plan: string): Promise<void> {
+  await db.collection('users').doc(userId).set({
+    plan,
+    createdAt: FieldValue.serverTimestamp(),
+  }, { merge: true });
+}
+
+/**
+ * 建立計數器文件
+ */
+async function createCounter(userId: string, type: 'rpm' | 'tpm' | 'rpd', count: number): Promise<void> {
+  const now = new Date();
+  const key = CounterKey.create(userId, type, now);
+  const ttl = CounterKey.getTTL(type);
+  const expiresAt = new Date(now.getTime() + ttl * 1000);
+
+  await db.collection('rate_limit_counters').doc(key).set({
+    count,
+    createdAt: FieldValue.serverTimestamp(),
+    updatedAt: FieldValue.serverTimestamp(),
+    expiresAt,
+  });
+}
+
+/**
+ * 主程式
+ */
+async function main() {
+  console.log('🌱 開始建立 Rate Limit 測試資料...\n');
+
+  for (const user of TEST_USERS) {
+    console.log(`👤 建立使用者: ${user.userId} (${user.plan})`);
+
+    // 建立使用者文件
+    await createUserDoc(user.userId, user.plan);
+
+    // 建立計數器
+    await createCounter(user.userId, 'rpm', user.rpm);
+    await createCounter(user.userId, 'tpm', user.tpm);
+    await createCounter(user.userId, 'rpd', user.rpd);
+
+    console.log(`   ✅ RPM: ${user.rpm}, TPM: ${user.tpm}, RPD: ${user.rpd}\n`);
+  }
+
+  console.log('✅ 測試資料建立完成！');
+  console.log('\n執行以下指令查看狀態：');
+  console.log('  ./sh/rate-limit.sh\n');
+}
+
+// 執行
+main().catch(error => {
+  console.error('❌ 執行失敗:', error);
+  process.exit(1);
+});

package/botrun-c/api/scripts/seed-subscription-test-data.ts

@@ -0,0 +1,173 @@
+#!/usr/bin/env tsx
+/**
+ * Seed Subscription Test Data
+ * 建立測試用的訂閱資料（用於測試 sh/trial.sh）
+ */
+
+import { Firestore, Timestamp } from '@google-cloud/firestore';
+import { Subscription, SubscriptionStatus } from '../src/subscription/domain/entities/Subscription.js';
+
+const db = new Firestore();
+
+interface TestUser {
+  userId: string;
+  email: string;
+  scenario: string;
+}
+
+const testUsers: TestUser[] = [
+  {
+    userId: 'test-trial-safe',
+    email: 'trial-safe@test.com',
+    scenario: '安全試用（剩餘 10 天）',
+  },
+  {
+    userId: 'test-trial-warning',
+    email: 'trial-warning@test.com',
+    scenario: '警告試用（剩餘 3 天）',
+  },
+  {
+    userId: 'test-trial-critical',
+    email: 'trial-critical@test.com',
+    scenario: '緊急試用（剩餘 1 天）',
+  },
+  {
+    userId: 'test-trial-expired',
+    email: 'trial-expired@test.com',
+    scenario: '已過期試用（過期 5 天）',
+  },
+  {
+    userId: 'test-paid-active',
+    email: 'paid-active@test.com',
+    scenario: '付費方案啟用中',
+  },
+];
+
+async function seedTestData() {
+  console.log('🌱 開始建立測試訂閱資料...\n');
+
+  const now = new Date();
+
+  for (const user of testUsers) {
+    console.log(`📝 建立: ${user.scenario}`);
+    console.log(`   User ID: ${user.userId}`);
+    console.log(`   Email: ${user.email}`);
+
+    let subscription: Subscription;
+
+    switch (user.userId) {
+      case 'test-trial-safe':
+        // 剩餘 10 天（4 天前開始）
+        subscription = Subscription.createTrial(
+          user.userId,
+          'Lite',
+          new Date(now.getTime() - 4 * 24 * 60 * 60 * 1000)
+        );
+        break;
+
+      case 'test-trial-warning':
+        // 剩餘 3 天（11 天前開始）
+        subscription = Subscription.createTrial(
+          user.userId,
+          'Lite',
+          new Date(now.getTime() - 11 * 24 * 60 * 60 * 1000)
+        );
+        break;
+
+      case 'test-trial-critical':
+        // 剩餘 1 天（13 天前開始）
+        subscription = Subscription.createTrial(
+          user.userId,
+          'Lite',
+          new Date(now.getTime() - 13 * 24 * 60 * 60 * 1000)
+        );
+        break;
+
+      case 'test-trial-expired':
+        // 已過期 5 天（19 天前開始）
+        const expiredSubscription = Subscription.createTrial(
+          user.userId,
+          'Lite',
+          new Date(now.getTime() - 19 * 24 * 60 * 60 * 1000)
+        );
+        subscription = expiredSubscription.updateStatus(SubscriptionStatus.EXPIRED);
+        break;
+
+      case 'test-paid-active':
+        // 付費方案啟用中
+        subscription = Subscription.createActive(user.userId, 'Max-1');
+        break;
+
+      default:
+        continue;
+    }
+
+    // 儲存到 Firestore
+    const data = subscription.toData();
+    const firestoreData: any = {
+      userId: data.userId,
+      plan: data.plan,
+      status: data.status,
+      createdAt: Timestamp.fromDate(data.createdAt),
+      updatedAt: Timestamp.fromDate(data.updatedAt),
+    };
+
+    // 只加入非 undefined 的欄位
+    if (data.trialStartDate) {
+      firestoreData.trialStartDate = Timestamp.fromDate(data.trialStartDate);
+    }
+    if (data.trialEndDate) {
+      firestoreData.trialEndDate = Timestamp.fromDate(data.trialEndDate);
+    }
+    if (data.subscriptionStartDate) {
+      firestoreData.subscriptionStartDate = Timestamp.fromDate(data.subscriptionStartDate);
+    }
+    if (data.subscriptionEndDate) {
+      firestoreData.subscriptionEndDate = Timestamp.fromDate(data.subscriptionEndDate);
+    }
+
+    await db.collection('user_subscriptions').doc(user.userId).set(firestoreData);
+
+    // 同時建立 users collection 資料（供 Email 查詢）
+    await db.collection('users').doc(user.email).set({
+      uid: user.userId,
+      email: user.email,
+      displayName: user.scenario,
+      createdAt: Timestamp.now(),
+    });
+
+    console.log(`   ✅ 已建立\n`);
+  }
+
+  console.log('🎉 測試資料建立完成！');
+  console.log('\n執行以下指令查看結果：');
+  console.log('  ./sh/trial.sh\n');
+}
+
+async function cleanTestData() {
+  console.log('🧹 清理測試資料...\n');
+
+  for (const user of testUsers) {
+    await db.collection('user_subscriptions').doc(user.userId).delete();
+    await db.collection('users').doc(user.email).delete();
+    console.log(`   ✅ 已刪除: ${user.userId}`);
+  }
+
+  console.log('\n✅ 測試資料已清理\n');
+}
+
+// 主程式
+const args = process.argv.slice(2);
+const command = args[0];
+
+if (command === 'clean') {
+  cleanTestData().catch(error => {
+    console.error('❌ 清理失敗:', error);
+    process.exit(1);
+  });
+} else {
+  seedTestData().catch(error => {
+    console.error('❌ 建立失敗:', error);
+    process.exit(1);
+  });
+}

package/botrun-c/api/scripts/test-rate-limit-message.ts

@@ -0,0 +1,108 @@
+/**
+ * 測試 Rate Limit 錯誤訊息格式
+ * 驗證後端返回的完整錯誤訊息是否符合預期
+ */
+
+interface RateLimitCheckResult {
+  allowed: boolean;
+  limitType?: 'rpm' | 'tpm' | 'rpd';
+  current?: number;
+  limit?: number;
+  retryAfter?: number;
+  resetAt?: number;
+}
+
+/**
+ * 建立完整的使用者友善錯誤訊息
+ * 包含：限制類型、當前使用量、最大限制、重置時間、升級方案資訊
+ */
+function buildUserFriendlyMessage(result: {
+  limitType?: 'rpm' | 'tpm' | 'rpd';
+  current?: number;
+  limit?: number;
+  retryAfter?: number;
+  resetAt?: number;  // Unix timestamp
+}): string {
+  const { limitType, current, limit, retryAfter, resetAt } = result;
+
+  let message = '';
+
+  // 根據不同的限制類型組合訊息
+  if (limitType === 'rpm' && retryAfter) {
+    message = `❌ **您的請求過於頻繁，請等待 ${retryAfter} 秒後再試**\n\n`;
+    message += `_方案限制: RPM = ${limit}_`;
+  } else if (limitType === 'rpd' && resetAt) {
+    // 將 Unix timestamp 轉換為日期物件
+    const resetDate = new Date(resetAt);
+    const resetTime = resetDate.toLocaleTimeString('zh-TW', {
+      hour: '2-digit',
+      minute: '2-digit',
+      timeZone: 'Asia/Taipei'
+    });
+
+    message = `❌ **您今日的請求額度（${limit} 次）已用完**\n\n`;
+    message += `明天 ${resetTime} 將自動重置\n`;
+    message += `目前已使用：${current} 次\n\n`;
+    message += `_方案限制: RPD = ${limit}_`;
+  } else if (limitType === 'tpm') {
+    message = `❌ **您的 Token 使用量過高，請稍後再試**\n\n`;
+    message += `_方案限制: TPM = ${limit}_`;
+  } else {
+    // 預設訊息
+    message = `❌ **請求過於頻繁，請稍後再試**`;
+  }
+
+  // 新增升級方案資訊
+  message += `\n\n---\n\n`;
+  message += `💡 **升級方案**\n\n`;
+  message += `您可以考慮升級為 **Botrun Max-1** 訂閱版本或者 **Botrun Max-2** 訂閱版本\n\n`;
+  message += `請洽 **service@botrun.ai** 進行升級`;
+
+  return message;
+}
+
+// 測試案例
+console.log('========== 測試 Rate Limit 錯誤訊息 ==========\n');
+
+// 案例 1: RPD 超過限制
+console.log('【案例 1】RPD 超過限制 (Lite: 50 次/天)');
+console.log('---');
+const rpdResult: RateLimitCheckResult = {
+  allowed: false,
+  limitType: 'rpd',
+  current: 51,
+  limit: 50,
+  resetAt: new Date().setHours(24, 0, 0, 0), // 明天午夜
+};
+const rpdMessage = buildUserFriendlyMessage(rpdResult);
+console.log(rpdMessage);
+console.log('\n');
+
+// 案例 2: RPM 超過限制
+console.log('【案例 2】RPM 超過限制 (10 次/分鐘)');
+console.log('---');
+const rpmResult: RateLimitCheckResult = {
+  allowed: false,
+  limitType: 'rpm',
+  current: 11,
+  limit: 10,
+  retryAfter: 45,
+};
+const rpmMessage = buildUserFriendlyMessage(rpmResult);
+console.log(rpmMessage);
+console.log('\n');
+
+// 案例 3: TPM 超過限制
+console.log('【案例 3】TPM 超過限制 (50000 tokens/分鐘)');
+console.log('---');
+const tpmResult: RateLimitCheckResult = {
+  allowed: false,
+  limitType: 'tpm',
+  current: 51000,
+  limit: 50000,
+};
+const tpmMessage = buildUserFriendlyMessage(tpmResult);
+console.log(tpmMessage);
+console.log('\n');
+
+console.log('========== 測試完成 ==========');

package/botrun-c/api/test-billing-write.ts

@@ -0,0 +1,103 @@
+/**
+ * 測試 BillingService 寫入功能（不需要索引）
+ */
+import { Firestore } from '@google-cloud/firestore';
+import { BillingService } from './src/billing/index.js';
+
+async function testBillingWrite() {
+  console.log('🧪 開始測試 BillingService 寫入功能...\n');
+
+  // 初始化 Firestore
+  const firestore = new Firestore({
+    projectId: process.env.GOOGLE_CLOUD_PROJECT ||
+              process.env.GCP_PROJECT ||
+              process.env.FIREBASE_PROJECT_ID,
+  });
+
+  // 初始化 BillingService
+  const billingService = new BillingService(firestore);
+  console.log('✅ BillingService 初始化成功\n');
+
+  // 測試：記錄多筆測試資料
+  console.log('📝 測試: 記錄 3 筆測試資料...\n');
+
+  const testData = [
+    {
+      userId: 'test-user-456',
+      timestamp: new Date(),
+      endpoint: 'chat' as const,
+      model: 'claude-haiku-4-5',
+      inputTokens: 1250,
+      outputTokens: 850,
+      costUSD: 0.0084,
+      conversationId: 'conv-test-001',
+      planType: 'pro',
+    },
+    {
+      userId: 'test-user-456',
+      timestamp: new Date(),
+      endpoint: 'transcribe' as const,
+      model: 'gemini-2.5-pro',
+      inputTokens: 500,
+      outputTokens: 300,
+      costUSD: 0,
+      planType: 'free',
+    },
+    {
+      userId: 'test-user-456',
+      timestamp: new Date(),
+      endpoint: 'nchc-whisper' as const,
+      model: 'whisper-Breeze-ASR-25',
+      inputTokens: 800,
+      outputTokens: 800,
+      costUSD: 0,
+      planType: 'lite',
+    },
+  ];
+
+  let successCount = 0;
+  for (let i = 0; i < testData.length; i++) {
+    const data = testData[i];
+    try {
+      await billingService.recordUsage(data);
+      successCount++;
+      console.log(`✅ 第 ${i + 1} 筆: ${data.endpoint} (${data.model}) - ${data.inputTokens + data.outputTokens} tokens`);
+    } catch (error) {
+      console.error(`❌ 第 ${i + 1} 筆記錄失敗:`, error);
+    }
+  }
+
+  console.log(`\n📊 結果: ${successCount}/${testData.length} 筆成功寫入`);
+
+  // 直接查詢 Firestore 確認資料
+  console.log('\n🔍 直接查詢 Firestore 確認資料...');
+  try {
+    const snapshot = await firestore
+      .collection('billing-records')
+      .limit(5)
+      .get();
+
+    console.log(`✅ Firestore 中找到 ${snapshot.size} 筆記錄（最多顯示 5 筆）\n`);
+
+    snapshot.docs.forEach((doc, index) => {
+      const data = doc.data();
+      console.log(`記錄 ${index + 1}:`);
+      console.log(`  使用者: ${data.userId}`);
+      console.log(`  端點: ${data.endpoint}`);
+      console.log(`  模型: ${data.model}`);
+      console.log(`  Tokens: ${data.totalTokens} (輸入: ${data.inputTokens}, 輸出: ${data.outputTokens})`);
+      console.log(`  成本: $${data.costUSD}`);
+      console.log(`  時間: ${data.timestamp.toDate().toISOString()}`);
+      console.log('');
+    });
+  } catch (error) {
+    console.error('❌ 查詢 Firestore 失敗:', error);
+  }
+
+  console.log('🎉 寫入功能測試完成！');
+  console.log('⏳ 注意：Firestore 複合索引可能需要幾分鐘時間建立，查詢功能需等待索引完成。');
+
+  process.exit(0);
+}
+
+testBillingWrite();