Skip to content

Fix cache revalidation for computed revisions #3134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 10, 2025
Merged

Fix cache revalidation for computed revisions #3134

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6694f55
Pass false to computed revision
SamyPesse Apr 9, 2025
f62d334
Dynamically set tags based on response
SamyPesse Apr 10, 2025
5866a88
Pass computed: true
SamyPesse Apr 10, 2025
3855f54
Merge branch 'main' into fix-computed-revision-cached
SamyPesse Apr 10, 2025
9f713e2
Use 'use cache' on Vercel
SamyPesse Apr 10, 2025
9f9d562
Fix
SamyPesse Apr 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions packages/gitbook-v2/src/lib/data/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
type ComputedContentSource,
GitBookAPI,
type GitBookAPIServiceBinding,
type HttpResponse,
type RenderIntegrationUI,
} from '@gitbook/api';
import { getCacheTag, getComputedContentSourceCacheTags } from '@gitbook/cache-tags';
Expand Down Expand Up @@ -234,6 +235,7 @@ const getUserByIdUncached = withoutConcurrentExecution(
return wrapDataFetcherError(async () => {
const api = apiClient(input);
const res = await api.users.getUserById(params.userId);
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -278,6 +280,7 @@ const getSpaceUncached = withoutConcurrentExecution(
const res = await api.spaces.getSpaceById(params.spaceId, {
shareKey: params.shareKey,
});
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -324,6 +327,7 @@ const getChangeRequestUncached = withoutConcurrentExecution(
params.spaceId,
params.changeRequestId
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -366,6 +370,7 @@ const getRevisionUncached = withoutConcurrentExecution(
const res = await api.spaces.getRevisionById(params.spaceId, params.revisionId, {
metadata: params.metadata,
});
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -413,6 +418,7 @@ const getRevisionPagesUncached = withoutConcurrentExecution(
metadata: params.metadata,
}
);
await setCacheTagsFromResponse(res);
return res.data.pages;
});
}
Expand Down Expand Up @@ -460,6 +466,7 @@ const getRevisionFileUncached = withoutConcurrentExecution(
params.fileId,
{}
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -509,6 +516,7 @@ const getRevisionPageMarkdownUncached = withoutConcurrentExecution(
format: 'markdown',
}
);
await setCacheTagsFromResponse(res);
if (!('markdown' in res.data)) {
throw new DataFetcherError('Page is not a document', 404);
}
Expand Down Expand Up @@ -560,6 +568,7 @@ const getRevisionPageByPathUncached = withoutConcurrentExecution(
encodedPath,
{}
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -596,6 +605,7 @@ const getDocumentUncached = withoutConcurrentExecution(
return wrapDataFetcherError(async () => {
const api = apiClient(input);
const res = await api.spaces.getDocumentById(params.spaceId, params.documentId, {});
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -652,6 +662,7 @@ const getComputedDocumentUncached = withoutConcurrentExecution(
source: params.source,
seed: params.seed,
});
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -698,6 +709,7 @@ const getReusableContentUncached = withoutConcurrentExecution(
params.revisionId,
params.reusableContentId
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -745,6 +757,7 @@ const getLatestOpenAPISpecVersionContentUncached = withoutConcurrentExecution(
params.organizationId,
params.slug
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -798,6 +811,7 @@ const getPublishedContentSiteUncached = withoutConcurrentExecution(
shareKey: params.siteShareKey,
}
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -858,6 +872,7 @@ const getSiteRedirectBySourceUncached = withoutConcurrentExecution(
source: params.source,
}
);
await setCacheTagsFromResponse(res);
return res.data;
});
}
Expand Down Expand Up @@ -896,6 +911,7 @@ const getEmbedByUrlUncached = withoutConcurrentExecution(
const res = await api.spaces.getEmbedByUrlInSpace(params.spaceId, {
url: params.url,
});
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -937,6 +953,7 @@ const searchSiteContentUncached = withoutConcurrentExecution(
query,
...scope,
});
await setCacheTagsFromResponse(res);
return res.data.items;
});
}
Expand Down Expand Up @@ -984,6 +1001,7 @@ const renderIntegrationUiUncached = withoutConcurrentExecution(
params.integrationName,
params.request
);
await setCacheTagsFromResponse(res);
return res.data;
});
});
Expand Down Expand Up @@ -1040,3 +1058,37 @@ export function apiClient(input: DataFetcherInput = { apiToken: null }) {

return api;
}

/**
* Set the cache tags using the ones generated by the API.
*/
async function setCacheTagsFromResponse(response: HttpResponse<unknown, unknown>) {
const cacheTagHeader = response.headers.get('x-gitbook-cache-tag');
const tags = !cacheTagHeader ? [] : cacheTagHeader.split(',');

if (tags.length > 0) {
await setCacheTags(tags);
}
}

/**
* HACK to dynamically set cache on unstable_cache based on a result within the callback.
* The approach is based on the fact that `unstable_cache` collects all the tags of functions called within the callback.
* https://github.com/vercel/next.js/blob/29836888857e3fd129d57df6ce975d0e8de5a134/packages/next/src/server/web/spec-extension/unstable-cache.ts#L182-L194
*
* Once we can migrate to `use cache`, it'll be better with the use of the `cacheTag` function.
*/
async function setCacheTags(tags: string[]) {
const callback = unstable_cache(
async () => {
console.log('set cache tags', tags);
return tags;
},
[],
{
tags,
}
);

await callback();
}