Consolidate environment constants (IS_DEV, IS_TEST, IS_PROD, IS_CI) in common/env

Author: brandonkachen

cli/src/utils/analytics.ts

@@ -1,4 +1,4 @@
-import { env } from '@codebuff/common/env'
+import { env, IS_PROD } from '@codebuff/common/env'
 import { PostHog } from 'posthog-node'
 
 import type { AnalyticsEvent } from '@codebuff/common/constants/analytics-events'
@@ -59,7 +59,7 @@ export function initAnalytics() {
   try {
     client = new PostHog(env.NEXT_PUBLIC_POSTHOG_API_KEY, {
       host: env.NEXT_PUBLIC_POSTHOG_HOST_URL,
-      enableExceptionAutocapture: env.NEXT_PUBLIC_CB_ENVIRONMENT === 'prod',
+      enableExceptionAutocapture: IS_PROD,
     })
   } catch (error) {
     logAnalyticsError(error, { stage: AnalyticsErrorStage.Init })
@@ -89,7 +89,7 @@ export function trackEvent(
     return
   }
   if (!client) {
-    if (env.NEXT_PUBLIC_CB_ENVIRONMENT === 'prod') {
+    if (IS_PROD) {
       const error = new Error('Analytics client not initialized')
       logAnalyticsError(error, {
         stage: AnalyticsErrorStage.Track,
@@ -101,7 +101,7 @@ export function trackEvent(
     return
   }
 
-  if (env.NEXT_PUBLIC_CB_ENVIRONMENT !== 'prod') {
+  if (!IS_PROD) {
     if (DEBUG_DEV_EVENTS) {
       console.log('Analytics event sent', {
         event,
@@ -139,7 +139,7 @@ export function identifyUser(userId: string, properties?: Record<string, any>) {
     throw error
   }
 
-  if (env.NEXT_PUBLIC_CB_ENVIRONMENT !== 'prod') {
+  if (!IS_PROD) {
     if (DEBUG_DEV_EVENTS) {
       console.log('Identify event sent', {
         userId,

cli/src/utils/logger.ts

@@ -2,7 +2,7 @@ import { appendFileSync, existsSync, mkdirSync, unlinkSync } from 'fs'
 import path, { dirname } from 'path'
 import { format as stringFormat } from 'util'
 
-import { env } from '@codebuff/common/env'
+import { env, IS_DEV, IS_TEST, IS_CI } from '@codebuff/common/env'
 import { createAnalyticsDispatcher } from '@codebuff/common/util/analytics-dispatcher'
 import { pino } from 'pino'
 
@@ -101,16 +101,11 @@ function sendAnalyticsAndLog(
   msg?: string,
   ...args: any[]
 ): void {
-  const envName = env.NEXT_PUBLIC_CB_ENVIRONMENT
-  const isDevEnv = envName === 'dev'
-  const isTestEnv = envName === 'test'
-  const isCi = process.env.CODEBUFF_GITHUB_ACTIONS === 'true'
-
-  if (!isCi && !isTestEnv) {
+  if (!IS_CI && !IS_TEST) {
     const projectRoot = getProjectRoot()
 
     const logTarget =
-      isDevEnv
+      IS_DEV
         ? path.join(projectRoot, 'debug', 'cli.jsonl')
         : path.join(getCurrentChatDir(), 'log.jsonl')
 
@@ -131,7 +126,7 @@ function sendAnalyticsAndLog(
 
   logAsErrorIfNeeded(toTrack)
 
-  if (!isDevEnv && includeData && typeof normalizedData === 'object') {
+  if (!IS_DEV && includeData && typeof normalizedData === 'object') {
     const analyticsPayloads = analyticsDispatcher.process({
       data: normalizedData,
       level,
@@ -146,7 +141,7 @@ function sendAnalyticsAndLog(
 
   // In dev mode, use appendFileSync for real-time logging (Bun has issues with pino sync)
   // In prod mode, use pino for better performance
-  if (isDevEnv && logPath) {
+  if (IS_DEV && logPath) {
     const logEntry = JSON.stringify({
       level: level.toUpperCase(),
       timestamp: new Date().toISOString(),

common/src/analytics.ts

@@ -1,6 +1,6 @@
 import { PostHog } from 'posthog-node'
 
-import { env } from '@codebuff/common/env'
+import { env, IS_PROD } from '@codebuff/common/env'
 
 import type { AnalyticsEvent } from './constants/analytics-events'
 import type { Logger } from '@codebuff/common/types/contracts/logger'
@@ -46,7 +46,7 @@ export function trackEvent({
   properties?: Record<string, any>
   logger: Logger
 }) {
-  if (env.NEXT_PUBLIC_CB_ENVIRONMENT !== 'prod') {
+  if (!IS_PROD) {
     // Note (James): This log was too noisy. Reenable it as you need to test something.
     // logger.info({ payload: { event, properties } }, event)
     return

common/src/env.ts

@@ -6,3 +6,9 @@ if (process.env.NEXT_PUBLIC_CB_ENVIRONMENT !== 'prod') {
 }
 
 export const env = clientEnvSchema.parse(clientProcessEnv)
+
+// Derived environment constants for convenience
+export const IS_DEV = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'dev'
+export const IS_TEST = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'test'
+export const IS_PROD = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'prod'
+export const IS_CI = process.env.CODEBUFF_GITHUB_ACTIONS === 'true'

evals/logger.ts

@@ -1,7 +1,7 @@
 import { mkdirSync } from 'fs'
 import path, { dirname } from 'path'
 
-import { env } from '@codebuff/common/env'
+import { IS_CI, IS_TEST } from '@codebuff/common/env'
 import { pino } from 'pino'
 
 let logPath: string | undefined = undefined
@@ -38,10 +38,7 @@ function initPinoLoggerWithPath(path: string): void {
 }
 
 function log(level: LogLevel, data: any, msg?: string, ...args: any[]): void {
-  if (
-    process.env.CODEBUFF_GITHUB_ACTIONS !== 'true' &&
-    env.NEXT_PUBLIC_CB_ENVIRONMENT !== 'test'
-  ) {
+  if (!IS_CI && !IS_TEST) {
     const projectRoot = path.join(__dirname, '..')
     const logTarget = path.join(projectRoot, 'debug', 'evals.log')
 

packages/bigquery/src/client.ts

@@ -1,4 +1,4 @@
-import { env } from '@codebuff/common/env'
+import { IS_PROD } from '@codebuff/common/env'
 import { getErrorObject } from '@codebuff/common/util/error'
 import { BigQuery } from '@google-cloud/bigquery'
 
@@ -8,10 +8,7 @@ import type { BaseTrace, GetRelevantFilesTrace, Relabel, Trace } from './schema'
 import type { MessageRow } from '@codebuff/common/types/contracts/bigquery'
 import type { Logger } from '@codebuff/common/types/contracts/logger'
 
-const DATASET =
-  env.NEXT_PUBLIC_CB_ENVIRONMENT === 'prod'
-    ? 'codebuff_data'
-    : 'codebuff_data_dev'
+const DATASET = IS_PROD ? 'codebuff_data' : 'codebuff_data_dev'
 
 const TRACES_TABLE = 'traces'
 const RELABELS_TABLE = 'relabels'

sdk/src/constants.ts

@@ -1,10 +1,8 @@
-import { env } from '@codebuff/common/env'
+import { env, IS_DEV, IS_TEST, IS_PROD } from '@codebuff/common/env'
 
-export const CODEBUFF_BINARY = 'codebuff'
+export { IS_DEV, IS_TEST, IS_PROD }
 
-export const IS_DEV = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'dev'
-export const IS_TEST = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'test'
-export const IS_PROD = !IS_DEV && !IS_TEST
+export const CODEBUFF_BINARY = 'codebuff'
 
 export const WEBSITE_URL = env.NEXT_PUBLIC_CODEBUFF_APP_URL
 

web/src/util/logger.ts

@@ -3,7 +3,7 @@ import path from 'path'
 import { format } from 'util'
 
 import { trackEvent } from '@codebuff/common/analytics'
-import { env } from '@codebuff/common/env'
+import { env, IS_DEV, IS_CI } from '@codebuff/common/env'
 import { createAnalyticsDispatcher } from '@codebuff/common/util/analytics-dispatcher'
 import { splitData } from '@codebuff/common/util/split-data'
 import pino from 'pino'
@@ -36,10 +36,7 @@ function getDebugDir(): string | null {
 }
 
 // Initialize debug directory in dev environment
-if (
-  env.NEXT_PUBLIC_CB_ENVIRONMENT === 'dev' &&
-  process.env.CODEBUFF_GITHUB_ACTIONS !== 'true'
-) {
+if (IS_DEV && !IS_CI) {
   const dir = getDebugDir()
   if (dir) {
     try {
@@ -107,9 +104,7 @@ function splitAndLog(
 // Also output to console via pinoLogger so logs remain visible in the terminal
 function logWithSync(level: LogLevel, data: any, msg?: string, ...args: any[]): void {
   const formattedMsg = format(msg ?? '', ...args)
-  const isDevEnv = env.NEXT_PUBLIC_CB_ENVIRONMENT === 'dev'
-
-  if (isDevEnv) {
+  if (IS_DEV) {
     // Write to file for real-time logging
     if (debugDir) {
       const logEntry = JSON.stringify({