diff --git a/.changeset/search-route-direct-api-call.md b/.changeset/search-route-direct-api-call.md new file mode 100644 index 000000000..059546c29 --- /dev/null +++ b/.changeset/search-route-direct-api-call.md @@ -0,0 +1,5 @@ +--- +"gitbook": patch +--- + +Stop caching site search results in the framework cache, so every search reaches the API. diff --git a/packages/gitbook/src/lib/data/api.test.ts b/packages/gitbook/src/lib/data/api.test.ts index bf2d2009d..0527e5d55 100644 --- a/packages/gitbook/src/lib/data/api.test.ts +++ b/packages/gitbook/src/lib/data/api.test.ts @@ -1,4 +1,4 @@ -import { afterAll, afterEach, beforeEach, describe, expect, it, mock } from 'bun:test'; +import { afterAll, afterEach, describe, expect, it, mock } from 'bun:test'; const cacheLife = mock((_profile: unknown) => {}); const cacheTag = mock((..._tags: string[]) => {}); @@ -6,6 +6,12 @@ const cacheTag = mock((..._tags: string[]) => {}); const realNextCache = await import('next/cache'); mock.module('next/cache', () => ({ ...realNextCache, cacheLife, cacheTag })); +const realGlobals = await import('@/lib/env/globals'); +mock.module('@/lib/env/globals', () => ({ + ...realGlobals, + GITBOOK_API_URL: 'https://api.example.com/cache/', +})); + const { createDataFetcher } = await import('./api'); const originalFetch = globalThis.fetch; @@ -13,75 +19,33 @@ const originalFetch = globalThis.fetch; afterAll(() => mock.restore()); describe('searchSiteContent', () => { - beforeEach(() => { - cacheLife.mockClear(); - cacheTag.mockClear(); - }); - afterEach(() => { globalThis.fetch = originalFetch; }); - function mockFetch(impl: () => Promise) { - globalThis.fetch = mock(impl); - } - - function search() { - return createDataFetcher().searchSiteContent({ + it('reaches the API through the gateway on every search, without caching', async () => { + const fetchMock = mock((_input: unknown, _init?: RequestInit) => + Promise.resolve(Response.json({ items: [] })) + ); + globalThis.fetch = fetchMock as unknown as typeof fetch; + const dataFetcher = createDataFetcher({ apiToken: 'site-token' }); + const params = { organizationId: 'org-1', siteId: 'site-1', query: 'test', - scope: { mode: 'all' }, - }); - } + scope: { mode: 'all' as const }, + }; - it('caches successful results for hours with the site and response tags', async () => { - mockFetch(async () => - Response.json( - { items: [] }, - { headers: { 'x-gitbook-cache-tag': 'space:space-1,space:space-2' } } - ) + expect(await dataFetcher.searchSiteContent(params)).toEqual({ data: [] }); + expect(await dataFetcher.searchSiteContent(params)).toEqual({ data: [] }); + + expect(fetchMock).toHaveBeenCalledTimes(2); + const [input, init] = fetchMock.mock.calls[0]!; + expect(String(input)).toBe( + 'https://api.example.com/cache/v1/orgs/org-1/sites/site-1/search' ); - - const result = await search(); - - expect(result).toEqual({ data: [] }); - expect(cacheLife.mock.calls).toEqual([['hours']]); - expect(cacheTag.mock.calls.flat()).toEqual([ - 'site:site-1', - 'space:space-1', - 'space:space-2', - ]); - }); - - it('does not cache a transient API error', async () => { - mockFetch(async () => - Response.json({ error: { code: 429, message: 'Namespace saturated' } }, { status: 429 }) - ); - - const result = await search(); - - expect(result.error?.code).toBe(429); - expect(cacheLife.mock.calls).toEqual([[{ stale: 0, revalidate: 0, expire: 0 }]]); - }); - - it('does not cache a network failure', async () => { - mockFetch(() => Promise.reject(new TypeError('fetch failed'))); - - const result = await search(); - - expect(result.error?.code).toBe(500); - expect(cacheLife.mock.calls).toEqual([[{ stale: 0, revalidate: 0, expire: 0 }]]); - }); - - it('keeps the default cache life for a stable 404', async () => { - mockFetch(async () => - Response.json({ error: { code: 404, message: 'Site not found' } }, { status: 404 }) - ); - - const result = await search(); - - expect(result.error?.code).toBe(404); + expect(new Headers(init?.headers).get('authorization')).toBe('Bearer site-token'); expect(cacheLife).not.toHaveBeenCalled(); + expect(cacheTag).not.toHaveBeenCalled(); }); }); diff --git a/packages/gitbook/src/lib/data/api.ts b/packages/gitbook/src/lib/data/api.ts index 17f1fdcf3..e8e9f3382 100644 --- a/packages/gitbook/src/lib/data/api.ts +++ b/packages/gitbook/src/lib/data/api.ts @@ -11,7 +11,7 @@ import { import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags'; import { cache } from '../cache'; -import { DataFetcherError, isTransientDataFetcherError, wrapDataFetcherError } from './errors'; +import { DataFetcherError, wrapDataFetcherError } from './errors'; import type { GitBookDataFetcher } from './types'; import { GITBOOK_API_TOKEN, GITBOOK_API_URL, GITBOOK_USER_AGENT } from '@/lib/env'; import { trace } from '@/lib/tracing'; @@ -785,64 +785,43 @@ const getEmbedByUrl = cache( } ); -// We don't use remote cache for this one because of the number of potential cache entry causing 429 on vercel runtime cache when revalidating -const searchSiteContent = cache( - async ( - input: DataFetcherInput, - params: Parameters[0] - ) => { - 'use cache'; - cacheTag( - getCacheTag({ - tag: 'site', - site: params.siteId, - }) +async function searchSiteContent( + input: DataFetcherInput, + params: Parameters[0] +) { + return wrapDataFetcherError(async () => { + return trace( + `searchSiteContent(${params.organizationId}, ${params.siteId}, ${params.query})`, + async () => { + const { organizationId, siteId, query, scope } = params; + const api = apiClient(input); + const res = await api.orgs.searchSiteContent( + organizationId, + siteId, + { + query, + ...(scope.mode === 'current' && scope.restrictTo + ? { + // `restrictTo` only exists in the newer `scope` request shape, + // and the published @gitbook/api types don't include it yet. + scope: { + mode: 'default', + currentSiteSpace: scope.siteSpaceId, + restrictTo: scope.restrictTo, + } as SiteSearchScope, + } + : scope), + }, + {}, + { + ...noCacheFetchOptions, + } + ); + return res.data.items; + } ); - - const result = await wrapDataFetcherError(async () => { - return trace( - `searchSiteContent(${params.organizationId}, ${params.siteId}, ${params.query})`, - async () => { - const { organizationId, siteId, query, scope } = params; - const api = apiClient(input); - const res = await api.orgs.searchSiteContent( - organizationId, - siteId, - { - query, - ...(scope.mode === 'current' && scope.restrictTo - ? { - // `restrictTo` only exists in the newer `scope` request shape, - // and the published @gitbook/api types don't include it yet. - scope: { - mode: 'default', - currentSiteSpace: scope.siteSpaceId, - restrictTo: scope.restrictTo, - } as SiteSearchScope, - } - : scope), - }, - {}, - { - ...noCacheFetchOptions, - } - ); - cacheTag(...getCacheTagsFromResponse(res)); - cacheLife('hours'); - return res.data.items; - } - ); - }); - - // Don't serve transient errors for the default 15 minutes. Only safe because search runs in - // request handlers: a page cache calling it would inherit this short life during API incidents. - if (result.error && isTransientDataFetcherError(result.error)) { - cacheLife({ stale: 0, revalidate: 0, expire: 0 }); - } - - return result; - } -); + }); +} const renderIntegrationUi = cache( async ( diff --git a/packages/gitbook/src/lib/data/errors.test.ts b/packages/gitbook/src/lib/data/errors.test.ts index 288b7af30..404245682 100644 --- a/packages/gitbook/src/lib/data/errors.test.ts +++ b/packages/gitbook/src/lib/data/errors.test.ts @@ -2,17 +2,7 @@ import { describe, expect, it } from 'bun:test'; import { GitBookAPIError } from '@gitbook/api'; -import { extractCacheControl, isTransientDataFetcherError } from './errors'; - -describe('isTransientDataFetcherError', () => { - it.each([408, 429, 500, 502, 503, 504])('should treat %i as transient', (code) => { - expect(isTransientDataFetcherError({ code, message: 'Error' })).toBe(true); - }); - - it.each([400, 401, 403, 404, 410])('should treat %i as stable', (code) => { - expect(isTransientDataFetcherError({ code, message: 'Error' })).toBe(false); - }); -}); +import { extractCacheControl } from './errors'; describe('extractCacheControl', () => { it('should return undefined when error has no response', () => { diff --git a/packages/gitbook/src/lib/data/errors.ts b/packages/gitbook/src/lib/data/errors.ts index 08a8ebd2f..4a1ae1f46 100644 --- a/packages/gitbook/src/lib/data/errors.ts +++ b/packages/gitbook/src/lib/data/errors.ts @@ -93,13 +93,6 @@ export async function wrapDataFetcherError( } } -/** - * Whether an error may go away on retry: timeouts, rate limits, server errors and network failures. - */ -export function isTransientDataFetcherError(error: DataFetcherErrorData): boolean { - return error.code === 408 || error.code === 429 || error.code >= 500; -} - /** * Ignore some data fetcher errors. */