Include freebuff prop in chat completions events

Author: jahooma

cli/src/hooks/use-auth-state.ts

@@ -15,7 +15,7 @@ import type { User } from '../utils/auth'
 const setAuthLoggerContext = (params: { userId: string; email: string }) => {
   loggerContext.userId = params.userId
   loggerContext.userEmail = params.email
-  identifyUser(params.userId, { email: params.email, is_freebuff: IS_FREEBUFF })
+  identifyUser(params.userId, { email: params.email, freebuff: IS_FREEBUFF })
 }
 
 const clearAuthLoggerContext = () => {

common/src/analytics.ts

@@ -3,6 +3,7 @@ import { env, DEBUG_ANALYTICS } from '@codebuff/common/env'
 import { createPostHogClient, type AnalyticsClient } from './analytics-core'
 import { AnalyticsEvent } from './constants/analytics-events'
 
+import type { TrackEventFn } from '@codebuff/common/types/contracts/analytics'
 import type { Logger } from '@codebuff/common/types/contracts/logger'
 
 let client: AnalyticsClient | undefined
@@ -32,6 +33,18 @@ export async function flushAnalytics(logger?: Logger) {
   }
 }
 
+export function withDefaultProperties(
+  trackEventFn: TrackEventFn,
+  defaultProperties: Record<string, unknown>,
+): TrackEventFn {
+  return (params) => {
+    trackEventFn({
+      ...params,
+      properties: { ...defaultProperties, ...params.properties },
+    })
+  }
+}
+
 export function trackEvent({
   event,
   userId,

web/src/app/api/v1/chat/completions/_post.ts

@@ -65,6 +65,7 @@ import {
   OpenRouterError,
 } from '@/llm-api/openrouter'
 import { extractApiKeyFromHeader } from '@/util/auth'
+import { withDefaultProperties } from '@codebuff/common/analytics'
 import { checkFreeModeRateLimit } from './free-mode-rate-limiter'
 
 const FREE_MODE_ALLOWED_COUNTRIES = new Set([
@@ -148,7 +149,6 @@ export async function postChatCompletions(params: {
     req,
     getUserInfoFromApiKey,
     loggerWithContext,
-    trackEvent,
     getUserUsageData,
     getAgentRunFromId,
     fetch,
@@ -157,6 +157,7 @@ export async function postChatCompletions(params: {
     getUserPreferences,
   } = params
   let { logger } = params
+  let { trackEvent } = params
 
   try {
     // Parse request body
@@ -182,6 +183,12 @@ export async function postChatCompletions(params: {
     const bodyStream = typedBody.stream ?? false
     const runId = typedBody.codebuff_metadata?.run_id
 
+    // Check if the request is in FREE mode (costs 0 credits for allowed agent+model combos)
+    const costMode = typedBody.codebuff_metadata?.cost_mode
+    const isFreeModeRequest = isFreeMode(costMode)
+
+    trackEvent = withDefaultProperties(trackEvent, { freebuff: isFreeModeRequest })
+
     // Extract and validate API key
     const apiKey = extractApiKeyFromHeader(req)
     if (!apiKey) {
@@ -249,10 +256,6 @@ export async function postChatCompletions(params: {
       logger,
     })
 
-    // Check if the request is in FREE mode (costs 0 credits for allowed agent+model combos)
-    const costMode = typedBody.codebuff_metadata?.cost_mode
-    const isFreeModeRequest = isFreeMode(costMode)
-
     // For free mode requests, check if user is in US or Canada
     if (isFreeModeRequest) {
       const countryCode = getCountryCode(req)
@@ -288,35 +291,6 @@ export async function postChatCompletions(params: {
         )
       }
 
-      // Rate limit free mode requests
-      const rateLimitResult = checkFreeModeRateLimit(userId)
-      if (rateLimitResult.limited) {
-        const retryAfterSeconds = Math.ceil(rateLimitResult.retryAfterMs / 1000)
-        const resetTime = new Date(Date.now() + rateLimitResult.retryAfterMs).toISOString()
-        const resetCountdown = formatQuotaResetCountdown(resetTime)
-
-        trackEvent({
-          event: AnalyticsEvent.CHAT_COMPLETIONS_VALIDATION_ERROR,
-          userId,
-          properties: {
-            error: 'free_mode_rate_limited',
-            windowName: rateLimitResult.windowName,
-            retryAfterSeconds,
-          },
-          logger,
-        })
-
-        return NextResponse.json(
-          {
-            error: 'free_mode_rate_limited',
-            message: `Free mode rate limit exceeded (${rateLimitResult.windowName} limit). Try again ${resetCountdown}.`,
-          },
-          {
-            status: 429,
-            headers: { 'Retry-After': String(retryAfterSeconds) },
-          },
-        )
-      }
     }
 
     // Extract and validate agent run ID
@@ -377,6 +351,38 @@ export async function postChatCompletions(params: {
       )
     }
 
+    // Rate limit free mode requests (after validation so invalid requests don't consume quota)
+    if (isFreeModeRequest) {
+      const rateLimitResult = checkFreeModeRateLimit(userId)
+      if (rateLimitResult.limited) {
+        const retryAfterSeconds = Math.ceil(rateLimitResult.retryAfterMs / 1000)
+        const resetTime = new Date(Date.now() + rateLimitResult.retryAfterMs).toISOString()
+        const resetCountdown = formatQuotaResetCountdown(resetTime)
+
+        trackEvent({
+          event: AnalyticsEvent.CHAT_COMPLETIONS_VALIDATION_ERROR,
+          userId,
+          properties: {
+            error: 'free_mode_rate_limited',
+            windowName: rateLimitResult.windowName,
+            retryAfterSeconds,
+          },
+          logger,
+        })
+
+        return NextResponse.json(
+          {
+            error: 'free_mode_rate_limited',
+            message: `Free mode rate limit exceeded (${rateLimitResult.windowName} limit). Try again ${resetCountdown}.`,
+          },
+          {
+            status: 429,
+            headers: { 'Retry-After': String(retryAfterSeconds) },
+          },
+        )
+      }
+    }
+
     // For subscribers, ensure a block grant exists before processing the request.
     // This is done AFTER validation so malformed requests don't start a new 5-hour block.
     // When the function is provided, always include subscription credits in the balance: