feat: support running without a STATSIG_API_KEY

src/analytics/AppAnalytics.test.ts

@@ -2,6 +2,7 @@ import { createClient } from '@segment/analytics-react-native'
 import { PincodeType } from 'src/account/reducer'
 import AppAnalyticsModule from 'src/analytics/AppAnalytics'
 import { OnboardingEvents } from 'src/analytics/Events'
+import * as config from 'src/config'
 import { store } from 'src/redux/store'
 import { getDefaultStatsigUser, getFeatureGate, getMultichainFeatures } from 'src/statsig'
 import { NetworkId } from 'src/transactions/types'
@@ -25,10 +26,6 @@ jest.mock('@segment/analytics-react-native-plugin-clevertap')
 jest.mock('@segment/analytics-react-native-plugin-firebase')
 jest.mock('@sentry/react-native', () => ({ init: jest.fn() }))
 jest.mock('src/redux/store', () => ({ store: { getState: jest.fn() } }))
-jest.mock('src/config', () => ({
-  ...(jest.requireActual('src/config') as any),
-  STATSIG_API_KEY: 'statsig-key',
-}))
 jest.mock('statsig-react-native')
 jest.mock('src/statsig')
 jest.mock('src/web3/networkConfig', () => {
@@ -186,6 +183,7 @@ beforeAll(() => {
 
 describe('AppAnalytics', () => {
   let AppAnalytics: typeof AppAnalyticsModule
+  let mockConfig: jest.MockedObject<typeof config>
   const mockSegmentClient = {
     identify: jest.fn().mockResolvedValue(undefined),
     track: jest.fn().mockResolvedValue(undefined),
@@ -205,22 +203,45 @@ describe('AppAnalytics', () => {
     jest.unmock('src/analytics/AppAnalytics')
     jest.isolateModules(() => {
       AppAnalytics = require('src/analytics/AppAnalytics').default
+      mockConfig = require('src/config')
     })
+
+    mockConfig.STATSIG_API_KEY = 'statsig-key'
+    mockConfig.STATSIG_ENABLED = true
     mockStore.getState.mockImplementation(() => state)
     jest.mocked(getFeatureGate).mockReturnValue(true)
     jest.mocked(getMultichainFeatures).mockReturnValue({
       showBalances: [NetworkId['celo-alfajores']],
     })
   })
 
-  it('creates statsig client on initialization with default statsig user', async () => {
-    jest.mocked(getDefaultStatsigUser).mockReturnValue({ userID: 'someUserId' })
-    await AppAnalytics.init()
-    expect(Statsig.initialize).toHaveBeenCalledWith(
-      'statsig-key',
-      { userID: 'someUserId' },
-      { environment: { tier: 'development' }, overrideStableID: 'anonId', localMode: false }
-    )
+  describe('init', () => {
+    it('initializes segment', async () => {
+      await AppAnalytics.init()
+      expect(mockCreateSegmentClient).toHaveBeenCalled()
+    })
+
+    it('does not initialize segment if SEGMENT_API_KEY is not present', async () => {
+      mockConfig.SEGMENT_API_KEY = undefined
+      await AppAnalytics.init()
+      expect(mockCreateSegmentClient).not.toHaveBeenCalled()
+    })
+
+    it('creates statsig client on initialization with default statsig user', async () => {
+      jest.mocked(getDefaultStatsigUser).mockReturnValue({ userID: 'someUserId' })
+      await AppAnalytics.init()
+      expect(Statsig.initialize).toHaveBeenCalledWith(
+        'statsig-key',
+        { userID: 'someUserId' },
+        { environment: { tier: 'development' }, overrideStableID: 'anonId', localMode: false }
+      )
+    })
+
+    it('does not initialize statsig if STATSIG_ENABLED is false', async () => {
+      mockConfig.STATSIG_ENABLED = false
+      await AppAnalytics.init()
+      expect(Statsig.initialize).not.toHaveBeenCalled()
+    })
   })
 
   it('delays identify calls until async init has finished', async () => {

src/analytics/AppAnalytics.ts

@@ -14,11 +14,11 @@
 import { getCurrentUserTraits } from 'src/analytics/selectors'
 import {
   DEFAULT_TESTNET,
-  E2E_TEST_STATSIG_ID,
   FIREBASE_ENABLED,
   isE2EEnv,
   SEGMENT_API_KEY,
   STATSIG_API_KEY,
+  STATSIG_ENABLED,
   STATSIG_ENV,
 } from 'src/config'
 import { store } from 'src/redux/store'
@@ -101,60 +101,61 @@
 
   async init() {
     let uniqueID
-    try {
-      if (!SEGMENT_API_KEY) {
-        throw Error('API Key not present, likely due to environment. Skipping enabling')
-      }
-      this.segmentClient = createClient({
-        debug: __DEV__,
-        trackAppLifecycleEvents: true,
-        trackDeepLinks: true,
-        writeKey: SEGMENT_API_KEY,
-        storePersistor: AsyncStoragePersistor,
-      })
+    if (SEGMENT_API_KEY) {
+      try {
+        this.segmentClient = createClient({
+          debug: __DEV__,
+          trackAppLifecycleEvents: true,
+          trackDeepLinks: true,
+          writeKey: SEGMENT_API_KEY,
+          storePersistor: AsyncStoragePersistor,
+        })
 
-      this.segmentClient.add({ plugin: new DestinationFiltersPlugin() })
-      this.segmentClient.add({ plugin: new InjectTraits() })
-      this.segmentClient.add({ plugin: new AdjustPlugin() })
-      this.segmentClient.add({ plugin: new ClevertapPlugin() })
-      if (FIREBASE_ENABLED) {
-        this.segmentClient.add({ plugin: new FirebasePlugin() })
-      }
+        this.segmentClient.add({ plugin: new DestinationFiltersPlugin() })
+        this.segmentClient.add({ plugin: new InjectTraits() })
+        this.segmentClient.add({ plugin: new AdjustPlugin() })
+        this.segmentClient.add({ plugin: new ClevertapPlugin() })
+        if (FIREBASE_ENABLED) {
+          this.segmentClient.add({ plugin: new FirebasePlugin() })
+        }
 
-      try {
-        const deviceInfo = await getDeviceInfo()
-        this.deviceInfo = deviceInfo
-        uniqueID = deviceInfo.UniqueID
-        this.sessionId = sha256(Buffer.from(uniqueID + String(Date.now()))).slice(2)
-      } catch (error) {
-        Logger.error(TAG, 'getDeviceInfo error', error)
-      }
+        try {
+          const deviceInfo = await getDeviceInfo()
+          this.deviceInfo = deviceInfo
+          uniqueID = deviceInfo.UniqueID
+          this.sessionId = sha256(Buffer.from(uniqueID + String(Date.now()))).slice(2)
+        } catch (error) {
+          Logger.error(TAG, 'getDeviceInfo error', error)
+        }
 
-      Logger.info(TAG, 'Segment Analytics Integration initialized!')
-    } catch (err) {
-      const error = ensureError(err)
-      Logger.error(TAG, `Segment setup error: ${error.message}\n`, error)
+        Logger.info(TAG, 'Segment Analytics Integration initialized!')
+      } catch (err) {
+        const error = ensureError(err)
+        Logger.error(TAG, `Segment setup error: ${error.message}\n`, error)
+      }
+    } else {
+      Logger.info(TAG, 'Segment API key not present, skipping setup')
     }
 
-    try {
-      const statsigUser = getDefaultStatsigUser()
-      // getAnonymousId causes the e2e tests to fail
-      let overrideStableID: string = E2E_TEST_STATSIG_ID
-      if (!isE2EEnv) {
+    if (STATSIG_ENABLED) {
+      try {
+        const statsigUser = getDefaultStatsigUser()
         if (!this.segmentClient) {
           throw new Error('segmentClient is undefined, cannot get anonymous ID')
         }
-        overrideStableID = this.segmentClient.userInfo.get().anonymousId
+        const overrideStableID = this.segmentClient.userInfo.get().anonymousId
+        Logger.debug(TAG, 'Statsig stable ID', overrideStableID)
+        await Statsig.initialize(STATSIG_API_KEY, statsigUser, {
+          // StableID should match Segment anonymousId
+          overrideStableID,
+          environment: STATSIG_ENV,
+          localMode: isE2EEnv,
+        })
+      } catch (error) {
+        Logger.warn(TAG, `Statsig setup error`, error)
       }
-      Logger.debug(TAG, 'Statsig stable ID', overrideStableID)
-      await Statsig.initialize(STATSIG_API_KEY, statsigUser, {
-        // StableID should match Segment anonymousId
-        overrideStableID,
-        environment: STATSIG_ENV,
-        localMode: isE2EEnv,
-      })
-    } catch (error) {
-      Logger.warn(TAG, `Statsig setup error`, error)
+    } else {
+      Logger.info(TAG, 'Statsig is not enabled, skipping setup')
     }
   }
 

src/config.ts

@@ -79,7 +79,6 @@ export const FIATCONNECT_NETWORK =
 export const STATSIG_ENV = {
   tier: DEFAULT_TESTNET === 'mainnet' ? 'production' : 'development',
 }
-export const E2E_TEST_STATSIG_ID = 'e2e_test_statsig_id'
 
 // Keyless backup settings
 export const TORUS_NETWORK =
@@ -122,10 +121,8 @@ export const ALCHEMY_BASE_API_KEY = keyOrUndefined(
 )
 
 export const ZENDESK_API_KEY = keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'ZENDESK_API_KEY')
-export const STATSIG_API_KEY =
-  keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'STATSIG_API_KEY') ??
-  // dummy key as fallback for e2e tests, which use local mode
-  'client-key'
+export const STATSIG_API_KEY = keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'STATSIG_API_KEY')
+export const STATSIG_ENABLED = !isE2EEnv && !!STATSIG_API_KEY
 export const SEGMENT_API_KEY = keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'SEGMENT_API_KEY')
 export const SENTRY_CLIENT_URL = keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'SENTRY_CLIENT_URL')
 export const BIDALI_URL = keyOrUndefined(secretsFile, DEFAULT_TESTNET, 'BIDALI_URL')

src/navigator/SettingsMenu.test.tsx

@@ -23,6 +23,11 @@ jest.mock('statsig-react-native', () => ({
   },
 }))
 
+jest.mock('src/config', () => ({
+  ...jest.requireActual('src/config'),
+  STATSIG_ENABLED: true,
+}))
+
 describe('SettingsMenu', () => {
   beforeEach(() => {
     jest.clearAllMocks()

src/navigator/SettingsMenu.tsx

@@ -31,6 +31,7 @@ import ContactCircleSelf from 'src/components/ContactCircleSelf'
 import GradientBlock from 'src/components/GradientBlock'
 import { SettingsItemTextValue } from 'src/components/SettingsItem'
 import Touchable from 'src/components/Touchable'
+import { STATSIG_ENABLED } from 'src/config'
 import Envelope from 'src/icons/Envelope'
 import ForwardChevron from 'src/icons/ForwardChevron'
 import Lock from 'src/icons/Lock'
@@ -162,7 +163,7 @@ export default function SettingsMenu({ route }: Props) {
     if (!devModeActive) {
       return null
     } else {
-      const statsigStableId = Statsig.getStableID()
+      const statsigStableId = STATSIG_ENABLED ? Statsig.getStableID() : 'statsig-not-enabled'
       return (
         <View style={styles.devSettings}>
           <Touchable onPress={onCopyText(sessionId)} style={styles.devSettingsItem}>

src/statsig/index.test.ts

@@ -1,7 +1,9 @@
 import { LaunchArguments } from 'react-native-launch-arguments'
+import * as config from 'src/config'
 import { store } from 'src/redux/store'
 import { DynamicConfigs, ExperimentConfigs } from 'src/statsig/constants'
 import {
+  _getGateOverrides,
   getDynamicConfigParams,
   getExperimentParams,
   getFeatureGate,
@@ -25,6 +27,8 @@ jest.mock('src/redux/store', () => ({ store: { getState: jest.fn() } }))
 jest.mock('statsig-react-native')
 jest.mock('src/utils/Logger')
 
+const mockConfig = jest.mocked(config)
+
 const mockStore = jest.mocked(store)
 const MOCK_ACCOUNT = '0x000000000000000000000000000000000000000000'
 const MOCK_START_ONBOARDING_TIME = 1680563877
@@ -38,6 +42,10 @@ mockStore.getState.mockImplementation(() =>
 describe('Statsig helpers', () => {
   beforeEach(() => {
     jest.clearAllMocks()
+    mockConfig.STATSIG_ENABLED = true
+    // Reset gate overrides before each test
+    jest.mocked(LaunchArguments.value).mockReturnValue({ statsigGateOverrides: 'dummy=true' })
+    setupOverridesFromLaunchArgs()
   })
   describe('data validation', () => {
     it.each(Object.entries(ExperimentConfigs))(
@@ -110,6 +118,14 @@ describe('Statsig helpers', () => {
       expect(getMock).toHaveBeenCalledWith('param2', 'defaultValue2')
       expect(output).toEqual({ param1: 'statsigValue1', param2: 'statsigValue2' })
     })
+    it('returns default values if statsig is not enabled', () => {
+      mockConfig.STATSIG_ENABLED = false
+      const defaultValues = { param1: 'defaultValue1', param2: 'defaultValue2' }
+      const experimentName = 'mock_experiment_name' as StatsigExperiments
+      const output = getExperimentParams({ experimentName, defaultValues })
+      expect(output).toEqual(defaultValues)
+      expect(Logger.warn).not.toHaveBeenCalled()
+    })
   })
 
   describe('getFeatureGate', () => {
@@ -127,6 +143,20 @@ describe('Statsig helpers', () => {
       expect(Logger.warn).not.toHaveBeenCalled()
       expect(output).toEqual(true)
     })
+    it('returns gate overrides if set', () => {
+      jest.mocked(Statsig.checkGate).mockImplementation(() => true)
+      jest
+        .mocked(LaunchArguments.value)
+        .mockReturnValue({ statsigGateOverrides: 'app_review=false' })
+      setupOverridesFromLaunchArgs()
+      expect(getFeatureGate(StatsigFeatureGates.APP_REVIEW)).toEqual(false)
+    })
+    it('returns default values if statsig is not enabled', () => {
+      mockConfig.STATSIG_ENABLED = false
+      const output = getFeatureGate(StatsigFeatureGates.APP_REVIEW)
+      expect(output).toEqual(false)
+      expect(Logger.warn).not.toHaveBeenCalled()
+    })
   })
 
   describe('getMultichainFeatures', () => {
@@ -208,6 +238,14 @@ describe('Statsig helpers', () => {
         StatsigMultiNetworkDynamicConfig.MULTI_CHAIN_FEATURES
       )
     })
+    it('returns default values if statsig is not enabled', () => {
+      mockConfig.STATSIG_ENABLED = false
+      const output = getMultichainFeatures()
+      expect(output).toEqual(
+        DynamicConfigs[StatsigMultiNetworkDynamicConfig.MULTI_CHAIN_FEATURES].defaultValues
+      )
+      expect(Logger.warn).not.toHaveBeenCalled()
+    })
   })
 
   describe('getDynamicConfigParams', () => {
@@ -267,6 +305,14 @@ describe('Statsig helpers', () => {
       expect(getMock).toHaveBeenCalledWith('param2', 'defaultValue2')
       expect(output).toEqual({ param1: 'statsigValue1', param2: 'statsigValue2' })
     })
+    it('returns default values if statsig is not enabled', () => {
+      mockConfig.STATSIG_ENABLED = false
+      const defaultValues = { param1: 'defaultValue1', param2: 'defaultValue2' }
+      const configName = 'mock_config' as StatsigDynamicConfigs
+      const output = getDynamicConfigParams({ configName, defaultValues })
+      expect(output).toEqual(defaultValues)
+      expect(Logger.warn).not.toHaveBeenCalled()
+    })
   })
   describe('patchUpdateStatsigUser', () => {
     let mockDateNow: jest.SpyInstance
@@ -349,25 +395,26 @@ describe('Statsig helpers', () => {
         },
       })
     })
+    it('does not update user if statsig is not enabled', async () => {
+      mockConfig.STATSIG_ENABLED = false
+      await patchUpdateStatsigUser()
+      expect(Statsig.updateUser).not.toHaveBeenCalled()
+    })
   })
 
   describe('setupOverridesFromLaunchArgs', () => {
     it('cleans up overrides and skips setup if no override is set', () => {
-      jest.mocked(LaunchArguments.value).mockReturnValue({})
+      jest.mocked(LaunchArguments.value).mockReturnValue({ statsigGateOverrides: '' })
       setupOverridesFromLaunchArgs()
-      expect(Statsig.removeGateOverride).toHaveBeenCalledWith()
-      expect(Statsig.overrideGate).not.toHaveBeenCalled()
+      expect(_getGateOverrides()).toEqual({})
     })
 
     it('cleans up and sets up gate overrides if set', () => {
       jest
         .mocked(LaunchArguments.value)
         .mockReturnValue({ statsigGateOverrides: 'gate1=true,gate2=false' })
       setupOverridesFromLaunchArgs()
-      expect(Statsig.removeGateOverride).toHaveBeenCalledWith()
-      expect(Statsig.overrideGate).toHaveBeenCalledTimes(2)
-      expect(Statsig.overrideGate).toHaveBeenCalledWith('gate1', true)
-      expect(Statsig.overrideGate).toHaveBeenCalledWith('gate2', false)
+      expect(_getGateOverrides()).toEqual({ gate1: true, gate2: false })
     })
   })
 })