Support dynamic expressions (#3295)

Author: SamyPesse

packages/gitbook-v2/src/lib/data/api.ts

@@ -113,6 +113,15 @@ export function createDataFetcher(
                 })
             );
         },
+        getRevisionPageDocument(params) {
+            return trace('getRevisionPageDocument', () =>
+                getRevisionPageDocument(input, {
+                    spaceId: params.spaceId,
+                    revisionId: params.revisionId,
+                    pageId: params.pageId,
+                })
+            );
+        },
         getReusableContent(params) {
             return trace('getReusableContent', () =>
                 getReusableContent(input, {
@@ -417,6 +426,42 @@ const getRevisionPageMarkdown = withCacheKey(
     )
 );
 
+const getRevisionPageDocument = withCacheKey(
+    withoutConcurrentExecution(
+        async (
+            _,
+            input: DataFetcherInput,
+            params: { spaceId: string; revisionId: string; pageId: string }
+        ) => {
+            'use cache';
+            return trace(
+                `getRevisionPageDocument(${params.spaceId}, ${params.revisionId}, ${params.pageId})`,
+                async () => {
+                    return wrapDataFetcherError(async () => {
+                        const api = apiClient(input);
+                        const res = await api.spaces.getPageDocumentInRevisionById(
+                            params.spaceId,
+                            params.revisionId,
+                            params.pageId,
+                            {
+                                evaluated: true,
+                            },
+                            {
+                                ...noCacheFetchOptions,
+                            }
+                        );
+
+                        cacheTag(...getCacheTagsFromResponse(res));
+                        cacheLife('max');
+
+                        return res.data;
+                    });
+                }
+            );
+        }
+    )
+);
+
 const getRevisionPageByPath = withCacheKey(
     withoutConcurrentExecution(
         async (

packages/gitbook-v2/src/lib/data/index.ts

@@ -1,7 +1,7 @@
 export * from './api';
 export * from './types';
-export * from './pages';
 export * from './urls';
 export * from './errors';
 export * from './lookup';
 export * from './visitor';
+export * from './pages';

packages/gitbook-v2/src/lib/data/pages.ts

@@ -1,15 +1,30 @@
-import type { JSONDocument, RevisionPageDocument, Space } from '@gitbook/api';
+import { waitUntil } from '@/lib/waitUntil';
+import type { JSONDocument, RevisionPageDocument } from '@gitbook/api';
+import type { GitBookSiteContext, GitBookSpaceContext } from '../context';
 import { getDataOrNull } from './errors';
-import type { GitBookDataFetcher } from './types';
 
 /**
  * Get the document for a page.
  */
 export async function getPageDocument(
-    dataFetcher: GitBookDataFetcher,
-    space: Space,
+    context: GitBookSpaceContext | GitBookSiteContext,
     page: RevisionPageDocument
 ): Promise<JSONDocument | null> {
+    const { dataFetcher, space } = context;
+
+    if (
+        'site' in context &&
+        (context.site.id === 'site_JOVzv' || context.site.id === 'site_IxAYj')
+    ) {
+        return getDataOrNull(
+            dataFetcher.getRevisionPageDocument({
+                spaceId: space.id,
+                revisionId: space.revision,
+                pageId: page.id,
+            })
+        );
+    }
+
     if (page.documentId) {
         return getDataOrNull(
             dataFetcher.getDocument({ spaceId: space.id, documentId: page.documentId })
@@ -26,5 +41,30 @@ export async function getPageDocument(
         );
     }
 
+    // Pre-fetch the document to start filling the cache before we migrate to this API.
+    if (isInPercentRollout(space.id, 10)) {
+        await waitUntil(
+            getDataOrNull(
+                dataFetcher.getRevisionPageDocument({
+                    spaceId: space.id,
+                    revisionId: space.revision,
+                    pageId: page.id,
+                })
+            )
+        );
+    }
+
     return null;
 }
+
+function isInPercentRollout(value: string, rollout: number) {
+    return getRandomPercent(value) < rollout;
+}
+
+function getRandomPercent(value: string) {
+    const hash = value.split('').reduce((acc, char) => {
+        return acc + char.charCodeAt(0);
+    }, 0);
+
+    return hash % 100;
+}

packages/gitbook-v2/src/lib/data/types.ts

@@ -106,6 +106,15 @@ export interface GitBookDataFetcher {
         pageId: string;
     }): Promise<DataFetcherResponse<string>>;
 
+    /**
+     * Get the document of a page by its path.
+     */
+    getRevisionPageDocument(params: {
+        spaceId: string;
+        revisionId: string;
+        pageId: string;
+    }): Promise<DataFetcherResponse<api.JSONDocument>>;
+
     /**
      * Get a document by its space ID and document ID.
      */

packages/gitbook/package.json

@@ -10,7 +10,7 @@
         "typecheck": "tsc --noEmit",
         "e2e": "playwright test e2e/internal.spec.ts",
         "e2e-customers": "playwright test e2e/customers.spec.ts",
-        "unit": "bun test {src,packages}",
+        "unit": "bun test {src,packages} --preload ./tests/preload-bun.ts",
         "generate": "gitbook-icons ./public/~gitbook/static/icons custom-icons && gitbook-math ./public/~gitbook/static/math",
         "copy:icons": "gitbook-icons ./public/~gitbook/static/icons",
         "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static/icons && rm -rf ./public/~gitbook/static/math"

packages/gitbook/src/components/PDF/PDFPage.tsx

@@ -9,7 +9,6 @@ import {
 } from '@gitbook/api';
 import { Icon } from '@gitbook/icons';
 import type { GitBookSiteContext, GitBookSpaceContext } from '@v2/lib/context';
-import { getPageDocument } from '@v2/lib/data';
 import type { GitBookLinker } from '@v2/lib/links';
 import type { Metadata } from 'next';
 import { notFound } from 'next/navigation';
@@ -29,6 +28,7 @@ import { PageControlButtons } from './PageControlButtons';
 import { PrintButton } from './PrintButton';
 import './pdf.css';
 import { sanitizeGitBookAppURL } from '@/lib/app';
+import { getPageDocument } from '@v2/lib/data';
 
 const DEFAULT_LIMIT = 100;
 
@@ -224,8 +224,7 @@ async function PDFPageDocument(props: {
     context: GitBookSpaceContext;
 }) {
     const { page, context } = props;
-    const { space } = context;
-    const document = await getPageDocument(context.dataFetcher, space, page);
+    const document = await getPageDocument(context, page);
 
     return (
         <PrintPage id={getPagePDFContainerId(page)}>

packages/gitbook/src/components/SitePage/SitePage.tsx

@@ -62,7 +62,7 @@ export async function SitePage(props: SitePageProps) {
     const withSections = Boolean(sections && sections.list.length > 0);
     const headerOffset = { sectionsHeader: withSections, topHeader: withTopHeader };
 
-    const document = await getPageDocument(context.dataFetcher, context.space, page);
+    const document = await getPageDocument(context, page);
 
     return (
         <PageContextProvider pageId={page.id} spaceId={context.space.id} title={page.title}>

packages/gitbook/src/lib/api.ts

@@ -493,6 +493,39 @@ export const getRevisionPageByPath = cache({
     },
 });
 
+/**
+ * Get a document from a page by its ID
+ */
+export const getRevisionPageDocument = cache({
+    name: 'api.getRevisionPageDocument.v1',
+    tag: (spaceId, revisionId) =>
+        getCacheTag({ tag: 'revision', space: spaceId, revision: revisionId }),
+    tagImmutable: true,
+    getKeySuffix: getAPIContextId,
+    get: async (
+        spaceId: string,
+        revisionId: string,
+        pageId: string,
+        options: CacheFunctionOptions
+    ) => {
+        const apiCtx = await api();
+        const response = await apiCtx.client.spaces.getPageDocumentInRevisionById(
+            spaceId,
+            revisionId,
+            pageId,
+            {
+                evaluated: true,
+            },
+            {
+                ...noCacheFetchOptions,
+                signal: options.signal,
+            }
+        );
+
+        return cacheResponse(response, cacheTtl_7days);
+    },
+});
+
 /**
  * Resolve a file by its ID.
  * It should not be used directly, use `getRevisionFile` instead.

packages/gitbook/src/lib/references.tsx

@@ -155,7 +155,7 @@ export async function resolveContentRef(
                 });
 
                 if (resolveAnchorText) {
-                    const document = await getPageDocument(dataFetcher, space, page);
+                    const document = await getPageDocument(context, page);
                     if (document) {
                         const block = getBlockById(document, anchor);
                         if (block) {

packages/gitbook/src/lib/v1.ts

@@ -25,6 +25,7 @@ import {
     getRevision,
     getRevisionFile,
     getRevisionPageByPath,
+    getRevisionPageDocument,
     getRevisionPages,
     getSiteRedirectBySource,
     getSpace,
@@ -241,6 +242,18 @@ function getDataFetcherV1(apiTokenOverride?: string): GitBookDataFetcher {
             );
         },
 
+        getRevisionPageDocument(params) {
+            return withAPI(() =>
+                wrapDataFetcherError(async () => {
+                    return getRevisionPageDocument(
+                        params.spaceId,
+                        params.revisionId,
+                        params.pageId
+                    );
+                })
+            );
+        },
+
         getRevisionPageByPath(params) {
             return withAPI(() =>
                 wrapDataFetcherError(async () => {