Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

refactor(common): drop ConfigCat proxy probe in favor of waitForReady (#45939)

Charis453c31da1630
diff --git a/packages/common/configcat.test.ts b/packages/common/configcat.test.ts
index 677fc8e02f7..bc3dacfed1e 100644
--- a/packages/common/configcat.test.ts
+++ b/packages/common/configcat.test.ts
@@ -1,52 +1,80 @@
import * as configcat from 'configcat-js'
import { beforeEach, describe, expect, it, vi } from 'vitest'
-import { getFlags } from './configcat'
-
-vi.mock('data/fetchers', () => ({
- fetchHandler: vi.fn(),
-}))
-
vi.mock('configcat-js', () => ({
getClient: vi.fn(),
PollingMode: {
AutoPoll: 'AutoPoll',
},
+ ClientCacheState: {
+ NoFlagData: 0,
+ HasLocalOverrideFlagDataOnly: 1,
+ HasCachedFlagDataOnly: 2,
+ HasUpToDateFlagData: 3,
+ },
User: vi.fn(),
}))
describe('configcat', () => {
const mockClient = {
getAllValuesAsync: vi.fn(),
+ waitForReady: vi.fn().mockResolvedValue(3), // HasUpToDateFlagData
+ dispose: vi.fn(),
}
beforeEach(() => {
vi.clearAllMocks()
+ vi.resetModules()
+ vi.unstubAllEnvs()
;(configcat.getClient as any).mockReturnValue(mockClient)
})
it('should return empty array when no email is provided', async () => {
+ const { getFlags } = await import('./configcat')
const result = await getFlags()
expect(result).toEqual([])
})
it('should call getAllValuesAsync with user when email is provided', async () => {
+ vi.stubEnv('NEXT_PUBLIC_CONFIGCAT_PROXY_URL', 'https://proxy.example.com')
+
+ const { getFlags } = await import('./configcat')
+
const email = '[email protected]'
const mockValues = { flag1: true, flag2: false }
mockClient.getAllValuesAsync.mockResolvedValue(mockValues)
- const { fetchHandler } = await import('./configcat')
- const mockFetchHandler = fetchHandler as unknown as ReturnType<typeof vi.fn>
- mockFetchHandler.mockResolvedValueOnce(
- new Response(JSON.stringify({}), {
- status: 200,
- })
- )
-
const result = await getFlags(email)
- expect(configcat.User).toHaveBeenCalledWith(email)
+ expect(configcat.User).toHaveBeenCalledWith(email, undefined, undefined, expect.any(Object))
expect(mockClient.getAllValuesAsync).toHaveBeenCalled()
expect(result).toEqual(mockValues)
})
+
+ it('should fall back to SDK key client when proxy returns NoFlagData', async () => {
+ vi.stubEnv('NEXT_PUBLIC_CONFIGCAT_PROXY_URL', 'https://proxy.example.com')
+ vi.stubEnv('NEXT_PUBLIC_CONFIGCAT_SDK_KEY', 'test-sdk-key')
+
+ const proxyClient = {
+ getAllValuesAsync: vi.fn(),
+ waitForReady: vi.fn().mockResolvedValue(0), // NoFlagData
+ dispose: vi.fn(),
+ }
+ const sdkClient = {
+ getAllValuesAsync: vi.fn().mockResolvedValue([]),
+ waitForReady: vi.fn().mockResolvedValue(3), // HasUpToDateFlagData
+ dispose: vi.fn(),
+ }
+
+ ;(configcat.getClient as any).mockReturnValueOnce(proxyClient).mockReturnValueOnce(sdkClient)
+
+ const { getFlags } = await import('./configcat')
+ await getFlags()
+
+ expect(configcat.getClient).toHaveBeenCalledTimes(2)
+ expect(proxyClient.dispose).toHaveBeenCalled()
+ expect(configcat.getClient).toHaveBeenNthCalledWith(2, 'test-sdk-key', 'AutoPoll', {
+ pollIntervalSeconds: 7 * 60,
+ })
+ })
})
diff --git a/packages/common/configcat.ts b/packages/common/configcat.ts
index a23d9defbf4..f1a2522bc73 100644
--- a/packages/common/configcat.ts
+++ b/packages/common/configcat.ts
@@ -1,7 +1,6 @@
import * as configcat from 'configcat-js'
let client: configcat.IConfigCatClient
-const endpoint = '/configuration-files/configcat-proxy/frontend-v2/config_v6.json'
/**
* To set up ConfigCat for another app
@@ -14,50 +13,43 @@ const endpoint = '/configuration-files/configcat-proxy/frontend-v2/config_v6.jso
* - Can now use ConfigCat feature flags with the `useFlag` hook
*/
-export const fetchHandler: typeof fetch = async (input, init) => {
- try {
- return await fetch(input, init)
- } catch (err: any) {
- if (err instanceof TypeError && err.message === 'Failed to fetch') {
- console.error(err)
- throw new Error('Unable to reach the server. Please check your network or try again later.')
- }
- throw err
- }
-}
-
async function getClient() {
if (client) return client
- if (!process.env.NEXT_PUBLIC_CONFIGCAT_SDK_KEY && !process.env.NEXT_PUBLIC_CONFIGCAT_PROXY_URL) {
+ const proxyUrl = process.env.NEXT_PUBLIC_CONFIGCAT_PROXY_URL
+ const sdkKey = process.env.NEXT_PUBLIC_CONFIGCAT_SDK_KEY
+
+ if (!sdkKey && !proxyUrl) {
console.log('Skipping ConfigCat set up as env vars are not present')
return undefined
}
+ const options = { pollIntervalSeconds: 7 * 60 } // 7 minutes
+
try {
- const response = await fetchHandler(process.env.NEXT_PUBLIC_CONFIGCAT_PROXY_URL + endpoint)
- const options = { pollIntervalSeconds: 7 * 60 } // 7 minutes
+ if (proxyUrl) {
+ const proxyClient = configcat.getClient(
+ 'configcat-proxy/frontend-v2',
+ configcat.PollingMode.AutoPoll,
+ { ...options, baseUrl: proxyUrl }
+ )
+ const cacheState = await proxyClient.waitForReady()
- if (response.status !== 200) {
- if (!process.env.NEXT_PUBLIC_CONFIGCAT_SDK_KEY) {
- console.error('Failed to set up ConfigCat: SDK Key is missing')
- return undefined
+ if (cacheState !== configcat.ClientCacheState.NoFlagData) {
+ client = proxyClient
+ return client
}
- // proxy is down, use default client
- client = configcat.getClient(
- process.env.NEXT_PUBLIC_CONFIGCAT_SDK_KEY ?? '',
- configcat.PollingMode.AutoPoll,
- options
- )
- } else {
- client = configcat.getClient('configcat-proxy/frontend-v2', configcat.PollingMode.AutoPoll, {
- ...options,
- baseUrl: process.env.NEXT_PUBLIC_CONFIGCAT_PROXY_URL,
- })
+ proxyClient.dispose()
}
- return client
+ if (sdkKey) {
+ client = configcat.getClient(sdkKey, configcat.PollingMode.AutoPoll, options)
+ return client
+ }
+
+ console.error('ConfigCat proxy unreachable and SDK key is missing')
+ return undefined
} catch (error: any) {
console.error(`Failed to get ConfigCat client: ${error.message}`)
return undefined