Fix computed revision cache in v1

Author: gregberge

packages/gitbook/src/lib/api.ts

@@ -26,6 +26,7 @@ import {
     type CacheFunctionOptions,
     cache,
     cacheResponse,
+    getResponseCacheTags,
     noCacheFetchOptions,
     parseCacheResponse,
 } from './cache';
@@ -370,6 +371,18 @@ interface GetRevisionOptions {
      * These options don't impact the cache key and it means revisions can be shared between different fetches with different metadata options.
      */
     metadata: boolean;
+
+    /**
+     * Whether to fetch the revision as a computed revision.
+     * @default true
+     */
+    computed?: boolean;
+
+    /**
+     * Additional tags to add to the cache entry.
+     * It's only used for v1, once in v2 we can get rid of it.
+     */
+    tags?: string[];
 }
 
 const getAPIContextId = async () => {
@@ -381,9 +394,15 @@ const getAPIContextId = async () => {
  * Get a revision by its ID.
  */
 export const getRevision = cache({
-    name: 'api.getRevision.v2',
-    tag: (spaceId, revisionId) =>
-        getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    name: 'api.getRevision.v3',
+    tag: (spaceId, revisionId, fetchOptions) =>
+        // Temporary hack to make it work with OpenAPI on v1
+        fetchOptions.tags?.[0] ??
+        getCacheTag({
+            tag: 'revision',
+            space: spaceId,
+            revision: revisionId,
+        }),
     tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
@@ -405,7 +424,13 @@ export const getRevision = cache({
             }
         );
 
-        return cacheResponse(response, fetchOptions.metadata ? cacheTtl_7days : cacheTtl_1day);
+        return cacheResponse(response, {
+            ...(fetchOptions.metadata ? cacheTtl_7days : cacheTtl_1day),
+            data: {
+                revision: response.data,
+                tags: getResponseCacheTags(response),
+            },
+        });
     },
     getKeyArgs: (args) => [args[0], args[1]],
 });
@@ -414,9 +439,15 @@ export const getRevision = cache({
  * Get all the pages in a revision of a space.
  */
 export const getRevisionPages = cache({
-    name: 'api.getRevisionPages.v4',
-    tag: (spaceId, revisionId) =>
-        getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    name: 'api.getRevisionPages.v5',
+    tag: (spaceId, revisionId, fetchOptions) =>
+        // Temporary hack to make it work with OpenAPI on v1
+        fetchOptions.tags?.[0] ??
+        getCacheTag({
+            tag: 'revision',
+            space: spaceId,
+            revision: revisionId,
+        }),
     tagImmutable: true,
     getKeySuffix: getAPIContextId,
     get: async (
@@ -440,7 +471,7 @@ export const getRevisionPages = cache({
 
         return cacheResponse(response, {
             ...(fetchOptions.metadata ? cacheTtl_7days : cacheTtl_1day),
-            data: response.data.pages,
+            data: { pages: response.data.pages, tags: getResponseCacheTags(response) },
         });
     },
     getKeyArgs: (args) => [args[0], args[1]],
@@ -632,7 +663,7 @@ export const getRevisionFile = batch<[string, string, string], RevisionFile | nu
             let files: Record<string, RevisionFile> = {};
 
             if (hasRevisionInMemory) {
-                const revision = await getRevision(spaceId, revisionId, { metadata: false });
+                const { revision } = await getRevision(spaceId, revisionId, { metadata: false });
                 files = {};
                 revision.files.forEach((file) => {
                     files[file.id] = file;
@@ -678,7 +709,7 @@ export const getReusableContent = async (
     });
 
     if (hasRevisionInMemory) {
-        const revision = await getRevision(spaceId, revisionId, { metadata: false });
+        const { revision } = await getRevision(spaceId, revisionId, { metadata: false });
         return (
             revision.reusableContents.find(
                 (reusableContent) => reusableContent.id === reusableContentId

packages/gitbook/src/lib/cache/http.ts

@@ -13,6 +13,14 @@ export const noCacheFetchOptions: Partial<RequestInit> = {
     },
 };
 
+/**
+ * Return the cache tags from the response.
+ */
+export function getResponseCacheTags(response: Response): string[] {
+    const cacheTagHeader = response.headers.get('x-gitbook-cache-tag');
+    return !cacheTagHeader ? [] : cacheTagHeader.split(',');
+}
+
 /**
  * Parse an HTTP response into a cache entry.
  */
@@ -26,8 +34,7 @@ export function parseCacheResponse(response: Response): {
     const cacheControlHeader = response.headers.get('cache-control');
     const cacheControl = cacheControlHeader ? parseCacheControl(cacheControlHeader) : null;
 
-    const cacheTagHeader = response.headers.get('x-gitbook-cache-tag');
-    const tags = !cacheTagHeader ? [] : cacheTagHeader.split(',');
+    const tags = getResponseCacheTags(response);
 
     const entry = {
         ttl: 60 * 60 * 24,
@@ -47,7 +54,7 @@ export function parseCacheResponse(response: Response): {
 export function cacheResponse<Result, DefaultData = Result>(
     response: Response & { data: Result },
     defaultEntry: Partial<CacheResult<DefaultData>> = {}
-): CacheResult<DefaultData extends Result ? Result : DefaultData> {
+): CacheResult<DefaultData extends undefined ? Result : DefaultData> {
     const parsed = parseCacheResponse(response);
 
     return {

packages/gitbook/src/lib/v1.ts

@@ -8,6 +8,7 @@ import type { GitBookDataFetcher } from '@v2/lib/data/types';
 import { createImageResizer } from '@v2/lib/images';
 import { createLinker } from '@v2/lib/links';
 
+import { RevisionPageType } from '@gitbook/api';
 import { DataFetcherError, wrapDataFetcherError } from '@v2/lib/data';
 import { headers } from 'next/headers';
 import {
@@ -134,9 +135,25 @@ async function getDataFetcherV1(): Promise<GitBookDataFetcher> {
 
         getRevision(params) {
             return wrapDataFetcherError(async () => {
-                return getRevision(params.spaceId, params.revisionId, {
+                const { revision, tags } = await getRevision(params.spaceId, params.revisionId, {
                     metadata: params.metadata,
+                    computed: false,
                 });
+
+                if (
+                    Object.values(revision.pages).some(
+                        (page) => page.type === RevisionPageType.Computed
+                    )
+                ) {
+                    const { revision } = await getRevision(params.spaceId, params.revisionId, {
+                        metadata: params.metadata,
+                        computed: true,
+                        tags,
+                    });
+                    return revision;
+                }
+
+                return revision;
             });
         },
 
@@ -183,9 +200,22 @@ async function getDataFetcherV1(): Promise<GitBookDataFetcher> {
 
         getRevisionPages(params) {
             return wrapDataFetcherError(async () => {
-                return getRevisionPages(params.spaceId, params.revisionId, {
+                const { pages, tags } = await getRevisionPages(params.spaceId, params.revisionId, {
                     metadata: params.metadata,
+                    computed: false,
                 });
+
+                if (pages.some((page) => page.type === RevisionPageType.Computed)) {
+                    const { pages } = await getRevisionPages(params.spaceId, params.revisionId, {
+                        metadata: params.metadata,
+                        computed: true,
+                        tags,
+                    });
+
+                    return pages;
+                }
+
+                return pages;
             });
         },