Fix an issue with link resolution in cross-space reusable content. (#3392)

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Samy Pessé <samypesse@gmail.com>

Author: 3 people

packages/gitbook/src/components/DocumentView/ReusableContent.tsx

@@ -1,9 +1,7 @@
 import type { DocumentBlockReusableContent } from '@gitbook/api';
 
-import { resolveContentRef } from '@/lib/references';
-
-import type { GitBookSpaceContext } from '@/lib/context';
 import { getDataOrNull } from '@/lib/data';
+import { resolveContentRef } from '@/lib/references';
 import type { BlockProps } from './Block';
 import { UnwrappedBlocks } from './Blocks';
 
@@ -34,7 +32,7 @@ export async function ReusableContent(props: BlockProps<DocumentBlockReusableCon
 
     const document = await getDataOrNull(
         dataFetcher.getDocument({
-            spaceId: reusableContent.space.id,
+            spaceId: reusableContent.context.space.id,
             documentId: reusableContent.revisionReusableContent.document,
         })
     );
@@ -43,35 +41,14 @@ export async function ReusableContent(props: BlockProps<DocumentBlockReusableCon
         return null;
     }
 
-    // Create a new context for reusable content block, including
-    // the data fetcher with the token from the block meta and the correct
-    // space and revision pointers.
-    const reusableContentContext: GitBookSpaceContext =
-        context.contentContext.space.id === reusableContent.space.id
-            ? context.contentContext
-            : {
-                  ...context.contentContext,
-                  dataFetcher,
-                  space: reusableContent.space,
-                  // When the reusable content is in a different space, we don't resolve relative links to pages
-                  // as this space might not be part of the current site.
-                  // In the future, we might expand the logic to look up the space from the list of all spaces in the site
-                  // and adapt the relative links to point to the correct variant.
-                  revision: {
-                      ...reusableContent.revision,
-                      pages: [], // TODO: check with Steven
-                  },
-                  shareKey: undefined,
-              };
-
     return (
         <UnwrappedBlocks
             nodes={document.nodes}
             document={document}
             ancestorBlocks={[...ancestorBlocks, block]}
             context={{
                 ...context,
-                contentContext: reusableContentContext,
+                contentContext: reusableContent.context,
             }}
         />
     );

packages/gitbook/src/lib/links.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'bun:test';
-import { createLinker } from './links';
+import { createLinker, linkerWithAbsoluteURLs, linkerWithOtherSpaceBasePath } from './links';
 
 const root = createLinker({
     host: 'docs.company.com',
@@ -94,3 +94,24 @@ describe('toLinkForContent', () => {
         );
     });
 });
+
+describe('linkerWithAbsoluteURLs', () => {
+    it('should return a new linker that always returns absolute URLs', () => {
+        const absoluteLinker = linkerWithAbsoluteURLs(root);
+        expect(absoluteLinker.toPathInSpace('some/path')).toBe(
+            'https://docs.company.com/some/path'
+        );
+        expect(absoluteLinker.toPathInSite('some/path')).toBe('https://docs.company.com/some/path');
+    });
+});
+
+describe('linkerWithOtherSpaceBasePath', () => {
+    it('should return a new linker that resolves links relative to a new spaceBasePath in the current site', () => {
+        const otherSpaceBasePathLinker = linkerWithOtherSpaceBasePath(root, {
+            spaceBasePath: '/section/variant',
+        });
+        expect(otherSpaceBasePathLinker.toPathInSpace('some/path')).toBe(
+            '/section/variant/some/path'
+        );
+    });
+});

packages/gitbook/src/lib/links.ts

@@ -92,6 +92,10 @@ export function createLinker(
             return normalizedPath.slice(servedOn.siteBasePath.length);
         },
 
+        toPathForPage({ pages, page, anchor }) {
+            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
+        },
+
         toAbsoluteURL(absolutePath: string): string {
             // If the path is already a full URL, we return it as is.
             if (URL.canParse(absolutePath)) {
@@ -105,10 +109,6 @@ export function createLinker(
             return `${servedOn.protocol ?? 'https:'}//${joinPaths(servedOn.host, absolutePath)}`;
         },
 
-        toPathForPage({ pages, page, anchor }) {
-            return linker.toPathInSpace(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
-        },
-
         toLinkForContent(rawURL: string): string {
             const url = new URL(rawURL);
 
@@ -125,6 +125,38 @@ export function createLinker(
     return linker;
 }
 
+/**
+ * Create a new linker that always returns absolute URLs.
+ */
+export function linkerWithAbsoluteURLs(linker: GitBookLinker): GitBookLinker {
+    return {
+        ...linker,
+        toPathInSpace: (path) => linker.toAbsoluteURL(linker.toPathInSpace(path)),
+        toPathInSite: (path) => linker.toAbsoluteURL(linker.toPathInSite(path)),
+        toPathForPage: (input) => linker.toAbsoluteURL(linker.toPathForPage(input)),
+    };
+}
+
+/**
+ * Create a new linker that resolves links relative to a new spaceBasePath in the current site.
+ */
+export function linkerWithOtherSpaceBasePath(
+    linker: GitBookLinker,
+    { spaceBasePath }: { spaceBasePath: string }
+): GitBookLinker {
+    const newLinker: GitBookLinker = {
+        ...linker,
+        toPathInSpace(relativePath: string): string {
+            return joinPaths(spaceBasePath, relativePath);
+        },
+        toPathForPage({ pages, page, anchor }) {
+            return newLinker.toPathInSpace(getPagePath(pages, page)) + (anchor ? `#${anchor}` : '');
+        },
+    };
+
+    return newLinker;
+}
+
 function joinPaths(prefix: string, path: string): string {
     const prefixPath = prefix.endsWith('/') ? prefix : `${prefix}/`;
     const suffixPath = path.startsWith('/') ? path.slice(1) : path;