botrun-horse 2.29.2 → 2.30.0

package/botrun-c/admin/lib/rate-limit-detailed.ts

@@ -0,0 +1,355 @@
+/**
+ * Rate Limit 詳細查詢與管理模組
+ * 提供完整的 Rate Limit 資訊查詢、設定和匯出功能
+ */
+
+import { getFirestore, getAuth } from './firebase.js';
+import { FieldValue } from '@google-cloud/firestore';
+import type { PlanType } from '../../api/src/rate-limit/domain/entities/Plan.js';
+
+// Plan 預設限制（與 src/rate-limit/domain/entities/Plan.ts 保持一致）
+const PLAN_DEFAULTS = {
+  'Lite': { rpm: 6, tpm: 200_000, rpd: 32 },
+  'Max-1': { rpm: 6, tpm: 600_000, rpd: 111 },
+  'Max-2': { rpm: 6, tpm: 600_000, rpd: 450 },
+} as const;
+
+export interface CustomLimits {
+  rpm?: number;
+  tpm?: number;
+  rpd?: number;
+}
+
+export interface PlanLimits {
+  rpm: number;
+  tpm: number;
+  rpd: number;
+}
+
+export interface CurrentUsage {
+  rpm: number;
+  tpm: number;
+  rpd: number;
+}
+
+export interface DetailedRateLimitStatus {
+  email: string | null;
+  uid: string;
+  plan: PlanType;
+
+  // Plan 預設限制
+  planDefaults: PlanLimits;
+
+  // Custom Limits
+  hasCustomLimits: boolean;
+  customLimits: CustomLimits | null;
+
+  // 實際生效的限制（如果有 custom 就用 custom，否則用 plan 預設）
+  effectiveLimits: PlanLimits;
+
+  // 當前使用量
+  currentUsage: CurrentUsage;
+
+  // 使用率（百分比字串）
+  usagePercentage: {
+    rpd: string; // "50 / 1000 (5%)"
+    rpm: string;
+    tpm: string;
+  };
+}
+
+/**
+ * 取得使用者的 Plan 類型
+ */
+async function getUserPlan(userId: string): Promise<PlanType> {
+  const db = getFirestore();
+  try {
+    const userDoc = await db.collection('users').doc(userId).get();
+    if (userDoc.exists) {
+      const data = userDoc.data();
+      const plan = data?.plan as PlanType;
+      if (plan && (plan in PLAN_DEFAULTS)) {
+        return plan;
+      }
+    }
+  } catch (error) {
+    // 使用預設方案
+  }
+  return 'Lite';
+}
+
+/**
+ * 取得使用者的自訂限制
+ */
+async function getCustomLimits(userId: string): Promise<CustomLimits | null> {
+  const db = getFirestore();
+  try {
+    const userDoc = await db.collection('users').doc(userId).get();
+    if (userDoc.exists) {
+      const data = userDoc.data();
+      return data?.customLimits || null;
+    }
+  } catch (error) {
+    console.error('❌ 讀取 customLimits 失敗:', error);
+  }
+  return null;
+}
+
+/**
+ * 取得當前的計數器值
+ */
+async function getCurrentCounters(userId: string): Promise<CurrentUsage> {
+  const db = getFirestore();
+  const now = new Date();
+
+  // 計算 key
+  const minute = Math.floor(now.getTime() / 60000);
+  const dateStr = now.toISOString().split('T')[0]; // YYYY-MM-DD
+
+  const rpmKey = `rpm:${userId}:${minute}`;
+  const tpmKey = `tpm:${userId}:${minute}`;
+  const rpdKey = `rpd:${userId}:${dateStr}`;
+
+  const results: CurrentUsage = {
+    rpm: 0,
+    tpm: 0,
+    rpd: 0
+  };
+
+  try {
+    const [rpmDoc, tpmDoc, rpdDoc] = await Promise.all([
+      db.collection('rate_limit_counters').doc(rpmKey).get(),
+      db.collection('rate_limit_counters').doc(tpmKey).get(),
+      db.collection('rate_limit_counters').doc(rpdKey).get(),
+    ]);
+
+    if (rpmDoc.exists) results.rpm = rpmDoc.data()?.count || 0;
+    if (tpmDoc.exists) results.tpm = tpmDoc.data()?.count || 0;
+    if (rpdDoc.exists) results.rpd = rpdDoc.data()?.count || 0;
+  } catch (error) {
+    console.error('❌ 讀取當前計數器失敗:', error);
+  }
+
+  return results;
+}
+
+/**
+ * 計算使用率百分比字串
+ */
+function formatUsagePercentage(current: number, limit: number): string {
+  const percentage = limit > 0 ? ((current / limit) * 100).toFixed(1) : '0.0';
+  return `${current} / ${limit} (${percentage}%)`;
+}
+
+/**
+ * 取得使用者的詳細 Rate Limit 狀態
+ */
+export async function getDetailedRateLimitStatus(userId: string): Promise<DetailedRateLimitStatus> {
+  // 取得 email
+  let email: string | null = null;
+  try {
+    const auth = getAuth();
+    const userRecord = await auth.getUser(userId);
+    email = userRecord.email || null;
+  } catch (error) {
+    // 忽略錯誤
+  }
+
+  // 平行取得所有資訊
+  const [plan, customLimits, currentUsage] = await Promise.all([
+    getUserPlan(userId),
+    getCustomLimits(userId),
+    getCurrentCounters(userId),
+  ]);
+
+  // Plan 預設限制
+  const planDefaults = PLAN_DEFAULTS[plan];
+
+  // 有 custom limits 嗎？
+  const hasCustomLimits = customLimits !== null && Object.keys(customLimits).length > 0;
+
+  // 實際生效的限制（有 custom 就用 custom，否則用 plan 預設）
+  const effectiveLimits: PlanLimits = {
+    rpm: customLimits?.rpm ?? planDefaults.rpm,
+    tpm: customLimits?.tpm ?? planDefaults.tpm,
+    rpd: customLimits?.rpd ?? planDefaults.rpd,
+  };
+
+  // 使用率
+  const usagePercentage = {
+    rpd: formatUsagePercentage(currentUsage.rpd, effectiveLimits.rpd),
+    rpm: formatUsagePercentage(currentUsage.rpm, effectiveLimits.rpm),
+    tpm: formatUsagePercentage(currentUsage.tpm, effectiveLimits.tpm),
+  };
+
+  return {
+    email,
+    uid: userId,
+    plan,
+    planDefaults,
+    hasCustomLimits,
+    customLimits,
+    effectiveLimits,
+    currentUsage,
+    usagePercentage,
+  };
+}
+
+/**
+ * 顯示詳細的 Rate Limit 狀態（人類可讀格式）
+ */
+export function displayDetailedStatus(status: DetailedRateLimitStatus): void {
+  console.log('==================================================');
+  console.log(`👤 使用者: ${status.email || status.uid}`);
+  console.log('==================================================\n');
+
+  // Plan 資訊
+  console.log(`📋 方案類型: ${status.plan}`);
+  console.log(`   預設限制: RPM=${status.planDefaults.rpm}, TPM=${status.planDefaults.tpm}, RPD=${status.planDefaults.rpd}\n`);
+
+  // Custom Limits
+  if (status.hasCustomLimits && status.customLimits) {
+    console.log('⚙️  自訂限制 (Custom Limits):');
+    if (status.customLimits.rpm !== undefined) {
+      console.log(`   RPM: ${status.customLimits.rpm} ${status.customLimits.rpm !== status.planDefaults.rpm ? '(覆寫預設)' : ''}`);
+    }
+    if (status.customLimits.tpm !== undefined) {
+      console.log(`   TPM: ${status.customLimits.tpm} ${status.customLimits.tpm !== status.planDefaults.tpm ? '(覆寫預設)' : ''}`);
+    }
+    if (status.customLimits.rpd !== undefined) {
+      console.log(`   RPD: ${status.customLimits.rpd} ${status.customLimits.rpd !== status.planDefaults.rpd ? '(覆寫預設)' : ''}`);
+    }
+    console.log('');
+  } else {
+    console.log('✅ 無自訂限制（使用方案預設值）\n');
+  }
+
+  // 實際生效的限制
+  console.log('📊 實際生效限制:');
+  console.log(`   RPM: ${status.effectiveLimits.rpm}`);
+  console.log(`   TPM: ${status.effectiveLimits.tpm}`);
+  console.log(`   RPD: ${status.effectiveLimits.rpd}\n`);
+
+  // 當前使用量
+  console.log('📈 當前使用狀況:');
+  console.log(`   RPM: ${status.usagePercentage.rpm}`);
+  console.log(`   TPM: ${status.usagePercentage.tpm}`);
+  console.log(`   RPD: ${status.usagePercentage.rpd}\n`);
+
+  console.log('==================================================\n');
+}
+
+/**
+ * 取得所有使用者的詳細 Rate Limit 狀態
+ */
+export async function getAllDetailedStatuses(): Promise<DetailedRateLimitStatus[]> {
+  const auth = getAuth();
+  const listResult = await auth.listUsers(1000);
+
+  const statuses: DetailedRateLimitStatus[] = [];
+
+  for (const user of listResult.users) {
+    const status = await getDetailedRateLimitStatus(user.uid);
+    statuses.push(status);
+  }
+
+  return statuses;
+}
+
+/**
+ * 匯出為 CSV 格式
+ */
+export function exportToCSV(statuses: DetailedRateLimitStatus[]): string {
+  const headers = [
+    'Email',
+    'UID',
+    'Plan',
+    'Plan_Default_RPM',
+    'Plan_Default_TPM',
+    'Plan_Default_RPD',
+    'Has_Custom_Limits',
+    'Custom_RPM',
+    'Custom_TPM',
+    'Custom_RPD',
+    'Effective_RPM',
+    'Effective_TPM',
+    'Effective_RPD',
+    'Current_RPM',
+    'Current_TPM',
+    'Current_RPD',
+    'RPM_Usage',
+    'TPM_Usage',
+    'RPD_Usage',
+  ];
+
+  const rows = statuses.map(s => [
+    s.email || '',
+    s.uid,
+    s.plan,
+    s.planDefaults.rpm,
+    s.planDefaults.tpm,
+    s.planDefaults.rpd,
+    s.hasCustomLimits ? 'YES' : 'NO',
+    s.customLimits?.rpm ?? '',
+    s.customLimits?.tpm ?? '',
+    s.customLimits?.rpd ?? '',
+    s.effectiveLimits.rpm,
+    s.effectiveLimits.tpm,
+    s.effectiveLimits.rpd,
+    s.currentUsage.rpm,
+    s.currentUsage.tpm,
+    s.currentUsage.rpd,
+    s.usagePercentage.rpm,
+    s.usagePercentage.tpm,
+    s.usagePercentage.rpd,
+  ]);
+
+  return [headers, ...rows].map(row => row.join(',')).join('\n');
+}
+
+/**
+ * 設定自訂限制
+ */
+export async function setCustomLimits(userId: string, limits: CustomLimits): Promise<void> {
+  const db = getFirestore();
+  await db.collection('users').doc(userId).set(
+    { customLimits: limits },
+    { merge: true }
+  );
+}
+
+/**
+ * 移除自訂限制
+ */
+export async function removeCustomLimits(userId: string): Promise<void> {
+  const db = getFirestore();
+  await db.collection('users').doc(userId).update({
+    customLimits: FieldValue.delete()
+  });
+}
+
+/**
+ * 設定計數器值（危險操作！）
+ */
+export async function setCounterValue(
+  userId: string,
+  type: 'rpm' | 'tpm' | 'rpd',
+  value: number
+): Promise<void> {
+  const db = getFirestore();
+  const now = new Date();
+
+  let key: string;
+  if (type === 'rpm' || type === 'tpm') {
+    const minute = Math.floor(now.getTime() / 60000);
+    key = `${type}:${userId}:${minute}`;
+  } else {
+    const dateStr = now.toISOString().split('T')[0]; // YYYY-MM-DD
+    key = `${type}:${userId}:${dateStr}`;
+  }
+
+  await db.collection('rate_limit_counters').doc(key).set({
+    count: value,
+    updatedAt: now,
+  }, { merge: true });
+}

package/botrun-c/admin/lib/rate-limit.ts

@@ -0,0 +1,286 @@
+/**
+ * Rate Limit 管理功能
+ * 整合自 api/scripts/dump-rate-limits.ts
+ */
+
+import { getFirestore } from './firebase.js';
+
+// 引用 API 專案的 entities（透過相對路徑）
+import { Plan, type PlanType } from '../../api/src/rate-limit/domain/entities/Plan.js';
+import { CounterKey } from '../../api/src/rate-limit/domain/entities/UsageCounter.js';
+
+export interface UserStatus {
+  userId: string;
+  plan: PlanType;
+  rpm: {
+    current: number;
+    limit: number;
+    percentage: number;
+  };
+  tpm: {
+    current: number;
+    limit: number;
+    percentage: number;
+  };
+  rpd: {
+    current: number;
+    limit: number;
+    percentage: number;
+  };
+}
+
+/**
+ * 從 Firestore 取得使用者方案
+ */
+export async function getUserPlan(userId: string): Promise<PlanType> {
+  const db = getFirestore();
+  try {
+    const userDoc = await db.collection('users').doc(userId).get();
+    if (userDoc.exists) {
+      const data = userDoc.data();
+      const plan = data?.plan as PlanType;
+      if (plan && ['Lite', 'Max-1', 'Max-2'].includes(plan)) {
+        return plan;
+      }
+    }
+  } catch (error) {
+    // 忽略錯誤，使用預設方案
+  }
+  return 'Lite';
+}
+
+/**
+ * 取得指定使用者的當前計數
+ */
+export async function getCounterValue(
+  userId: string,
+  type: 'rpm' | 'tpm' | 'rpd'
+): Promise<number> {
+  const db = getFirestore();
+  const now = new Date();
+  const key = CounterKey.create(userId, type, now);
+
+  try {
+    const doc = await db.collection('rate_limit_counters').doc(key).get();
+    if (doc.exists) {
+      const data = doc.data();
+      return data?.count || 0;
+    }
+  } catch (error) {
+    console.error(`  ❌ 無法讀取 ${type} 計數器:`, error);
+  }
+
+  return 0;
+}
+
+/**
+ * 取得所有有計數器記錄的使用者 ID
+ */
+export async function getAllUserIds(): Promise<string[]> {
+  const db = getFirestore();
+  const userIds = new Set<string>();
+
+  try {
+    const countersSnapshot = await db.collection('rate_limit_counters').get();
+
+    countersSnapshot.forEach(doc => {
+      const key = doc.id;
+      const parsed = CounterKey.parse(key);
+      if (parsed) {
+        userIds.add(parsed.userId);
+      }
+    });
+  } catch (error) {
+    console.error('❌ 無法讀取計數器:', error);
+    throw error;
+  }
+
+  return Array.from(userIds);
+}
+
+/**
+ * 取得單一使用者的完整狀態
+ */
+export async function getUserStatus(userId: string): Promise<UserStatus> {
+  const planType = await getUserPlan(userId);
+  const plan = Plan.create(planType);
+
+  const rpm = await getCounterValue(userId, 'rpm');
+  const tpm = await getCounterValue(userId, 'tpm');
+  const rpd = await getCounterValue(userId, 'rpd');
+
+  return {
+    userId,
+    plan: planType,
+    rpm: {
+      current: rpm,
+      limit: plan.limits.rpm,
+      percentage: Math.round((rpm / plan.limits.rpm) * 100),
+    },
+    tpm: {
+      current: tpm,
+      limit: plan.limits.tpm,
+      percentage: Math.round((tpm / plan.limits.tpm) * 100),
+    },
+    rpd: {
+      current: rpd,
+      limit: plan.limits.rpd,
+      percentage: Math.round((rpd / plan.limits.rpd) * 100),
+    },
+  };
+}
+
+/**
+ * 格式化狀態列（帶顏色）
+ */
+export function formatStatusBar(current: number, limit: number, percentage: number): string {
+  const barLength = 20;
+  const filled = Math.round((current / limit) * barLength);
+  const empty = barLength - filled;
+
+  // 顏色選擇
+  let color = '\x1b[32m'; // 綠色 (0-50%)
+  if (percentage >= 80) {
+    color = '\x1b[31m'; // 紅色 (80-100%)
+  } else if (percentage >= 50) {
+    color = '\x1b[33m'; // 黃色 (50-80%)
+  }
+
+  const bar = color + '█'.repeat(filled) + '\x1b[0m' + '░'.repeat(empty);
+  return `${bar} ${percentage}%`;
+}
+
+/**
+ * 顯示單一使用者狀態
+ */
+export function displayUserStatus(status: UserStatus) {
+  console.log(`\n${'='.repeat(60)}`);
+  console.log(`👤 使用者: ${status.userId}`);
+  console.log(`📋 方案: ${status.plan}`);
+  console.log(`${'-'.repeat(60)}`);
+
+  // RPM
+  console.log(`\n🕐 RPM (每分鐘請求數)`);
+  console.log(`   當前: ${status.rpm.current} / ${status.rpm.limit}`);
+  console.log(`   ${formatStatusBar(status.rpm.current, status.rpm.limit, status.rpm.percentage)}`);
+
+  // TPM
+  console.log(`\n🪙 TPM (每分鐘 Token 數)`);
+  console.log(`   當前: ${status.tpm.current.toLocaleString()} / ${status.tpm.limit.toLocaleString()}`);
+  console.log(`   ${formatStatusBar(status.tpm.current, status.tpm.limit, status.tpm.percentage)}`);
+
+  // RPD
+  console.log(`\n📅 RPD (每日請求數)`);
+  console.log(`   當前: ${status.rpd.current} / ${status.rpd.limit}`);
+  console.log(`   ${formatStatusBar(status.rpd.current, status.rpd.limit, status.rpd.percentage)}`);
+
+  // 狀態摘要
+  const isBlocked =
+    status.rpm.current >= status.rpm.limit ||
+    status.tpm.current >= status.tpm.limit ||
+    status.rpd.current >= status.rpd.limit;
+
+  if (isBlocked) {
+    console.log(`\n⛔ 狀態: 已達限制`);
+  } else {
+    console.log(`\n✅ 狀態: 正常`);
+  }
+}
+
+/**
+ * 顯示統計摘要
+ */
+export function displaySummary(statuses: UserStatus[]) {
+  console.log(`\n${'='.repeat(60)}`);
+  console.log(`📊 統計摘要`);
+  console.log(`${'-'.repeat(60)}`);
+
+  const total = statuses.length;
+  const blocked = statuses.filter(
+    s =>
+      s.rpm.current >= s.rpm.limit ||
+      s.tpm.current >= s.tpm.limit ||
+      s.rpd.current >= s.rpd.limit
+  ).length;
+
+  const planCounts = statuses.reduce((acc, s) => {
+    acc[s.plan] = (acc[s.plan] || 0) + 1;
+    return acc;
+  }, {} as Record<string, number>);
+
+  console.log(`\n總使用者數: ${total}`);
+  console.log(`已達限制: ${blocked} (${Math.round((blocked / total) * 100)}%)`);
+  console.log(`\n方案分布:`);
+  Object.entries(planCounts).forEach(([plan, count]) => {
+    console.log(`  ${plan}: ${count} 位使用者`);
+  });
+}
+
+/**
+ * 產生 CSV 內容
+ */
+export function generateCSV(statuses: UserStatus[]): string {
+  // CSV 標題列
+  const headers = [
+    'User ID',
+    'Plan',
+    'Status',
+    'RPM Current',
+    'RPM Limit',
+    'RPM %',
+    'TPM Current',
+    'TPM Limit',
+    'TPM %',
+    'RPD Current',
+    'RPD Limit',
+    'RPD %',
+  ].join(',');
+
+  // CSV 資料列
+  const rows = statuses.map(s => {
+    const isBlocked =
+      s.rpm.current >= s.rpm.limit ||
+      s.tpm.current >= s.tpm.limit ||
+      s.rpd.current >= s.rpd.limit;
+
+    return [
+      s.userId,
+      s.plan,
+      isBlocked ? 'Blocked' : 'OK',
+      s.rpm.current,
+      s.rpm.limit,
+      s.rpm.percentage,
+      s.tpm.current,
+      s.tpm.limit,
+      s.tpm.percentage,
+      s.rpd.current,
+      s.rpd.limit,
+      s.rpd.percentage,
+    ].join(',');
+  });
+
+  return [headers, ...rows].join('\n');
+}
+
+/**
+ * 儲存 CSV 並開啟
+ */
+export async function saveAndOpenCSV(statuses: UserStatus[]) {
+  const fs = await import('fs/promises');
+  const { execSync } = await import('child_process');
+
+  const csvContent = generateCSV(statuses);
+  const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, -5);
+  const csvPath = `/tmp/rate-limit-report-${timestamp}.csv`;
+
+  await fs.writeFile(csvPath, csvContent, 'utf-8');
+
+  console.log(`\n✅ CSV 報表已儲存: ${csvPath}`);
+  console.log(`📊 正在開啟試算表...\n`);
+
+  try {
+    execSync(`open "${csvPath}"`, { stdio: 'inherit' });
+  } catch (error) {
+    console.error('⚠️  無法自動開啟檔案，請手動開啟:', csvPath);
+  }
+}