diff --git a/src/config/firebase.ts b/src/config/firebase.ts index 90ad7e92e2b..37f91bc5909 100644 --- a/src/config/firebase.ts +++ b/src/config/firebase.ts @@ -36,3 +36,11 @@ export function getFirebaseConfig(): FirebaseOptions { if (remoteConfig.value.firebase_env === 'dev') return DEV_CONFIG return BUILD_TIME_CONFIG } + +/** Whether {@link getFirebaseConfig} names the project from the server rather than the build. */ +export function hasServerFirebaseConfig(): boolean { + return ( + Boolean(remoteConfig.value.firebase_config) || + remoteConfig.value.firebase_env === 'dev' + ) +} diff --git a/src/main.ts b/src/main.ts index ffa6a59324e..222dace8454 100644 --- a/src/main.ts +++ b/src/main.ts @@ -44,9 +44,10 @@ const hasHostTelemetryBridge = Boolean(window.__comfyDesktop2?.Telemetry) async function loadRemoteConfigBeforeFirebase(): Promise { await bootstrapTracer.settle('startup/remote-config', async () => { - const { refreshRemoteConfig } = + const { loadRemoteConfigUntilReady, refreshRemoteConfig } = await import('@/platform/remoteConfig/refreshRemoteConfig') - await refreshRemoteConfig({ useAuth: false }) + if (isCloud) await loadRemoteConfigUntilReady() + else await refreshRemoteConfig({ useAuth: false }) }) } diff --git a/src/platform/remoteConfig/refreshRemoteConfig.test.ts b/src/platform/remoteConfig/refreshRemoteConfig.test.ts index e9bc5287da6..93adf878669 100644 --- a/src/platform/remoteConfig/refreshRemoteConfig.test.ts +++ b/src/platform/remoteConfig/refreshRemoteConfig.test.ts @@ -5,6 +5,7 @@ import { api } from '@/scripts/api' import { invalidateRemoteConfig, + loadRemoteConfigUntilReady, refreshRemoteConfig } from './refreshRemoteConfig' import { @@ -478,4 +479,100 @@ describe('refreshRemoteConfig', () => { expect(remoteConfigErrorStatus.value).toBeNull() }) }) + + describe('loadRemoteConfigUntilReady', () => { + const BOOTSTRAP_RELEASE_MS = 30_000 + + it('retries until /features loads instead of leaving startup on build-time defaults', async () => { + vi.useFakeTimers() + const serverConfig = { firebase_config: { projectId: 'dreamboothy' } } + vi.mocked(global.fetch) + .mockRejectedValueOnce(new DOMException('Aborted', 'AbortError')) + .mockResolvedValueOnce(mockErrorResponse(503, 'Service Unavailable')) + .mockResolvedValueOnce(mockSuccessResponse(serverConfig)) + + const loading = loadRemoteConfigUntilReady() + await vi.runAllTimersAsync() + await loading + + expect(global.fetch).toHaveBeenCalledTimes(3) + expect(remoteConfigState.value).toBe('anonymous') + expect(remoteConfig.value).toEqual(serverConfig) + vi.useRealTimers() + }) + + it('keeps retrying a 200 that omits firebase_config instead of booting on the build default', async () => { + vi.useFakeTimers() + const serverConfig = { firebase_config: { projectId: 'dreamboothy' } } + vi.mocked(global.fetch) + .mockResolvedValueOnce( + mockSuccessResponse({ subscription_required: true }) + ) + .mockResolvedValueOnce(mockSuccessResponse(serverConfig)) + + const loading = loadRemoteConfigUntilReady() + await vi.runAllTimersAsync() + await loading + + expect(global.fetch).toHaveBeenCalledTimes(2) + expect(remoteConfig.value).toEqual(serverConfig) + vi.useRealTimers() + }) + + it('stops waiting on a loopback host, whose server never names a project', async () => { + vi.useFakeTimers() + vi.stubGlobal('location', { hostname: '127.0.0.1' }) + vi.mocked(global.fetch).mockResolvedValue( + mockSuccessResponse({ subscription_required: true }) + ) + + const loading = loadRemoteConfigUntilReady() + await vi.runAllTimersAsync() + await loading + + expect(global.fetch).toHaveBeenCalledTimes(2) + vi.unstubAllGlobals() + vi.useRealTimers() + }) + + it('never reaches Firebase startup on deployed cloud that keeps answering without a project', async () => { + vi.useFakeTimers() + vi.stubGlobal('location', { hostname: 'cloud.comfy.org' }) + vi.mocked(global.fetch).mockResolvedValue( + mockSuccessResponse({ subscription_required: true }) + ) + const reachedFirebaseStartup = vi.fn() + + void loadRemoteConfigUntilReady().then(reachedFirebaseStartup) + await vi.advanceTimersByTimeAsync(5 * 60_000) + + expect(reachedFirebaseStartup).not.toHaveBeenCalled() + expect(vi.mocked(global.fetch).mock.calls.length).toBeGreaterThan(5) + + vi.mocked(global.fetch).mockResolvedValue( + mockSuccessResponse({ firebase_config: { projectId: 'dreamboothy' } }) + ) + await vi.advanceTimersByTimeAsync(BOOTSTRAP_RELEASE_MS) + expect(reachedFirebaseStartup).toHaveBeenCalledOnce() + + vi.unstubAllGlobals() + vi.useRealTimers() + }) + + it('accepts a 200 that names the dev project through firebase_env', async () => { + vi.useFakeTimers() + const serverConfig = { firebase_env: 'dev' as const } + vi.mocked(global.fetch).mockResolvedValue( + mockSuccessResponse(serverConfig) + ) + + const loading = loadRemoteConfigUntilReady() + await vi.runAllTimersAsync() + await loading + + expect(global.fetch).toHaveBeenCalledTimes(1) + expect(remoteConfig.value).toEqual(serverConfig) + vi.useRealTimers() + }) + }) }) diff --git a/src/platform/remoteConfig/refreshRemoteConfig.ts b/src/platform/remoteConfig/refreshRemoteConfig.ts index 1a437869e3c..d661e252632 100644 --- a/src/platform/remoteConfig/refreshRemoteConfig.ts +++ b/src/platform/remoteConfig/refreshRemoteConfig.ts @@ -1,6 +1,11 @@ +import { delay } from 'es-toolkit' + import { resolveUnifiedWebSession } from '@comfyorg/account-core/webSessionFlag' +import { hasServerFirebaseConfig } from '@/config/firebase' import { isCloud } from '@/platform/distribution/types' +import { reportError } from '@/platform/telemetry/reportError' +import { isLoopbackHost } from '@/utils/hostWhitelist' import { authenticatedRemoteConfigState, @@ -250,3 +255,47 @@ export async function refreshRemoteConfig( activeRefreshControllers.delete(controller) } } + +const BOOTSTRAP_RETRY_BASE_MS = 1_000 +const BOOTSTRAP_RETRY_MAX_MS = 10_000 +const BOOTSTRAP_UNNAMED_PROJECT_READS = 1 + +function servesLocalCloud(): boolean { + return isLoopbackHost(window.location.hostname) +} + +/** + * Blocks until the server names the Firebase project; a loopback harness, + * whose server never sends one, stops after a further read instead. + */ +export async function loadRemoteConfigUntilReady(): Promise { + let unnamedProjectReads = 0 + for (let attempt = 0; ; attempt++) { + await refreshRemoteConfig({ useAuth: false }) + if (remoteConfigState.value !== 'error') { + if (hasServerFirebaseConfig()) return + unnamedProjectReads++ + if (unnamedProjectReads === 1) { + reportError( + new Error( + 'Startup read answered without naming the Firebase project' + ), + { + surface: 'workspace', + errorType: 'startup_remote_config_without_firebase_project', + level: 'warning', + context: { localCloud: servesLocalCloud() } + } + ) + } + if ( + servesLocalCloud() && + unnamedProjectReads > BOOTSTRAP_UNNAMED_PROJECT_READS + ) + return + } + await delay( + Math.min(BOOTSTRAP_RETRY_BASE_MS * 2 ** attempt, BOOTSTRAP_RETRY_MAX_MS) + ) + } +}