From 261a831d5466776274103a4fbcce16a3204d4ea1 Mon Sep 17 00:00:00 2001 From: lukasIO Date: Fri, 20 Nov 2026 18:38:41 +0100 Subject: [PATCH] Fall back to the expired region cache when the refresh fails getNextBestRegionUrl threw when the cached region list had expired and the region settings endpoint was unreachable. The old list is still a better choice than a failed connection. A cancel or a rejected token (401) still throws. Co-Authored-By: Claude Opus 5.5 --- .changeset/stale-region-cache-fallback.md | 5 ++++ src/room/RegionUrlProvider.test.ts | 36 ++++++++++++++++++----- src/room/RegionUrlProvider.ts | 18 ++++++++++-- 3 files changed, 49 insertions(+), 10 deletions(-) create mode 100644 .changeset/stale-region-cache-fallback.md diff --git a/.changeset/stale-region-cache-fallback.md b/.changeset/stale-region-cache-fallback.md new file mode 100644 index 0000000000..818d6d3546 --- /dev/null +++ b/.changeset/stale-region-cache-fallback.md @@ -0,0 +1,5 @@ +--- +'livekit-client': patch +--- + +If the region settings endpoint is unreachable, use the expired region list instead of failing the connection. diff --git a/src/room/RegionUrlProvider.test.ts b/src/room/RegionUrlProvider.test.ts index ae5cc0af33..56efb79cb1 100644 --- a/src/room/RegionUrlProvider.test.ts +++ b/src/room/RegionUrlProvider.test.ts @@ -750,7 +750,7 @@ describe('RegionUrlProvider', () => { expect(region2).toBeTruthy(); }); - it('preserves cache when one instance fails to fetch', async () => { + it('falls back to the expired cache when the refresh fails', async () => { const mockSettings = createMockRegionSettings([ { region: 'us-west', url: 'wss://us-west.livekit.cloud' }, ]); @@ -759,21 +759,41 @@ describe('RegionUrlProvider', () => { .mockResolvedValueOnce( createMockResponse(200, mockSettings, { 'Cache-Control': 'max-age=3600' }), ) - .mockResolvedValueOnce(createMockResponse(500)); + .mockResolvedValueOnce(createMockResponse(500)) + .mockRejectedValueOnce(new TypeError('Failed to fetch')); - // First provider populates cache const provider1 = new RegionUrlProvider('wss://test.livekit.cloud', 'token1'); await provider1.getNextBestRegionUrl(); - // Advance time to expire cache vi.setSystemTime(Date.now() + 4000000); - // Second provider tries to fetch but fails const provider2 = new RegionUrlProvider('wss://test.livekit.cloud', 'token2'); - await expect(provider2.getNextBestRegionUrl()).rejects.toThrow(); + expect(await provider2.getNextBestRegionUrl()).toBe('wss://us-west.livekit.cloud'); - // Cache should still be accessible by a third instance if still valid - expect(fetchMock).toHaveBeenCalledTimes(2); + const provider3 = new RegionUrlProvider('wss://test.livekit.cloud', 'token3'); + expect(await provider3.getNextBestRegionUrl()).toBe('wss://us-west.livekit.cloud'); + expect(fetchMock).toHaveBeenCalledTimes(3); + }); + + it('does not fall back to the expired cache when the token is rejected', async () => { + const mockSettings = createMockRegionSettings([ + { region: 'us-west', url: 'wss://us-west.livekit.cloud' }, + ]); + + fetchMock + .mockResolvedValueOnce( + createMockResponse(200, mockSettings, { 'Cache-Control': 'max-age=3600' }), + ) + .mockResolvedValueOnce(createMockResponse(401)); + + await new RegionUrlProvider('wss://test.livekit.cloud', 'token1').getNextBestRegionUrl(); + + vi.setSystemTime(Date.now() + 4000000); + + const provider2 = new RegionUrlProvider('wss://test.livekit.cloud', 'token2'); + await expect(provider2.getNextBestRegionUrl()).rejects.toMatchObject({ + reason: ConnectionErrorReason.NotAllowed, + }); }); it('handles token update correctly', async () => { diff --git a/src/room/RegionUrlProvider.ts b/src/room/RegionUrlProvider.ts index aae8751834..1c0e6b1091 100644 --- a/src/room/RegionUrlProvider.ts +++ b/src/room/RegionUrlProvider.ts @@ -221,8 +221,22 @@ export class RegionUrlProvider { let cachedSettings = RegionUrlProvider.cache.get(this.serverUrl.hostname); if (!cachedSettings || Date.now() - cachedSettings.updatedAtInMs > cachedSettings.maxAgeInMs) { - cachedSettings = await this.fetchRegionSettings(abortSignal); - RegionUrlProvider.updateCachedRegionSettings(this.serverUrl, this.token, cachedSettings); + try { + const freshSettings = await this.fetchRegionSettings(abortSignal); + RegionUrlProvider.updateCachedRegionSettings(this.serverUrl, this.token, freshSettings); + cachedSettings = freshSettings; + } catch (error: unknown) { + // A stale region list beats no region list, but a cancel or a rejected token is final. + if ( + !cachedSettings || + (error instanceof ConnectionError && + (error.reason === ConnectionErrorReason.Cancelled || + error.reason === ConnectionErrorReason.NotAllowed)) + ) { + throw error; + } + log.warn('could not refresh region settings, using expired cache', { error }); + } } const regionsLeft = cachedSettings.regionSettings.regions.filter(