Use site's share key as context while fetching site spaces (#2341)

Author: taranvohra

bun.lockb

@@ -20,7 +20,7 @@
     ],
     "dependencies": {
         "@geist-ui/icons": "^1.0.2",
-        "@gitbook/api": "^0.50.0",
+        "@gitbook/api": "^0.51.0",
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-popover": "^1.0.7",
         "@sentry/nextjs": "^7.94.1",

package.json

@@ -3,7 +3,7 @@
     "exports": "./src/index.ts",
     "dependencies": {
         "classnames": "^2.5.1",
-        "@gitbook/api": "^0.50.0",
+        "@gitbook/api": "^0.51.0",
         "assert-never": "^1.2.1"
     },
     "peerDependencies": {

packages/react-contentkit/package.json

@@ -40,7 +40,7 @@ export function getContentPointer(): ContentPointer | SiteContentPointer {
     if (siteId) {
         const organizationId = headerSet.get('x-gitbook-content-organization');
         const siteSpaceId = headerSet.get('x-gitbook-content-site-space');
-        const siteUrl = headerSet.get('x-gitbook-content-url');
+        const siteShareKey = headerSet.get('x-gitbook-content-site-share-key');
         if (!organizationId) {
             throw new Error('Missing site content headers');
         }
@@ -49,7 +49,7 @@ export function getContentPointer(): ContentPointer | SiteContentPointer {
             siteId,
             spaceId,
             siteSpaceId: siteSpaceId ?? undefined,
-            siteUrl: siteUrl ?? undefined,
+            siteShareKey: siteShareKey ?? undefined,
             organizationId,
             revisionId: headerSet.get('x-gitbook-content-revision') ?? undefined,
             changeRequestId: headerSet.get('x-gitbook-content-changerequest') ?? undefined,
@@ -75,7 +75,11 @@ export async function fetchSpaceData() {
         'siteId' in content
             ? [
                   getCurrentSiteData(content),
-                  fetchParentSite(content.organizationId, content.siteId, content.siteUrl),
+                  fetchParentSite({
+                      organizationId: content.organizationId,
+                      siteId: content.siteId,
+                      siteShareKey: content.siteShareKey,
+                  }),
               ]
             : [getSpaceData(content)],
     );
@@ -107,7 +111,11 @@ export async function fetchPageData(params: PagePathParams | PageIdParams) {
     const page = await resolvePage(contentTarget, pages, params);
     const [parent, document] = await Promise.all([
         'siteId' in content
-            ? fetchParentSite(content.organizationId, content.siteId, content.siteUrl)
+            ? fetchParentSite({
+                  organizationId: content.organizationId,
+                  siteId: content.siteId,
+                  siteShareKey: content.siteShareKey,
+              })
             : fetchParentCollection(space),
         page?.page.documentId ? getDocument(space.id, page.page.documentId) : null,
     ]);
@@ -178,14 +186,15 @@ async function fetchParentCollection(space: Space) {
     return { parent: collection, spaces };
 }
 
-async function fetchParentSite(
-    organizationId: string,
-    siteId: string,
-    siteUrl: string | undefined,
-) {
+async function fetchParentSite(args: {
+    organizationId: string;
+    siteId: string;
+    siteShareKey: string | undefined;
+}) {
+    const { organizationId, siteId, siteShareKey } = args;
     const [site, siteSpaces] = await Promise.all([
         getSite(organizationId, siteId),
-        getSiteSpaces(organizationId, siteId, siteUrl ?? null),
+        getSiteSpaces({ organizationId, siteId, siteShareKey }),
     ]);
 
     const spaces: Record<string, Space> = {};

src/app/(space)/fetch.ts

@@ -76,7 +76,11 @@ export async function searchParentContent(
         api.searchParentContent(parent.id, query),
         parent.object === 'collection' ? api.getCollectionSpaces(parent.id) : null,
         parent.object === 'site' && 'organizationId' in pointer
-            ? api.getSiteSpaces(pointer.organizationId, parent.id, pointer.siteUrl ?? null)
+            ? api.getSiteSpaces({
+                  organizationId: pointer.organizationId,
+                  siteId: parent.id,
+                  siteShareKey: pointer.siteShareKey,
+              })
             : null,
     ]);
 

src/components/Search/server-actions.tsx

@@ -48,10 +48,10 @@ export interface SiteContentPointer extends ContentPointer {
      */
     siteSpaceId: string | undefined;
     /**
-     * URL of the site content that was used for lookup. Only set for `multi` and `multi-path` modes
-     * where an URL is involved in the lookup/resolution
+     * Share key of the site that was used in lookup. Only set for `multi` and `multi-path` modes
+     * where an URL with the share-link key is involved in the lookup/resolution.
      */
-    siteUrl: string | undefined;
+    siteShareKey: string | undefined;
 }
 
 /**
@@ -131,8 +131,6 @@ export type PublishedContentWithCache =
     | ((PublishedContentLookup | PublishedSiteContentLookup) & {
           cacheMaxAge?: number;
           cacheTags?: string[];
-          /** Published content URL that was used for lookup */
-          contentUrl?: string;
       })
     | {
           error: {
@@ -242,7 +240,6 @@ export const getPublishedContentByUrl = cache(
                 ...response.data,
                 cacheMaxAge: parsed.ttl,
                 cacheTags: parsed.tags,
-                contentUrl: url,
             };
             return {
                 tags: [
@@ -745,21 +742,21 @@ export const getSite = cache(
 export const getSiteSpaces = cache(
     'api.getSiteSpaces',
     async (
-        organizationId: string,
-        siteId: string,
-        /**
-         * Additional site URL that can be used as context to resolve site space published urls
-         */
-        siteUrlContext: string | null,
+        args: {
+            organizationId: string;
+            siteId: string;
+            /** Site share key that can be used as context to resolve site space published urls */
+            siteShareKey: string | undefined;
+        },
         options: CacheFunctionOptions,
     ) => {
         const response = await getAll((params) =>
             api().orgs.listSiteSpaces(
-                organizationId,
-                siteId,
+                args.organizationId,
+                args.siteId,
                 {
                     ...params,
-                    context: siteUrlContext ?? undefined,
+                    ...(args.siteShareKey ? { shareKey: args.siteShareKey } : {}),
                 },
                 {
                     ...noCacheFetchOptions,
@@ -771,7 +768,7 @@ export const getSiteSpaces = cache(
         return cacheResponse(response, {
             revalidateBefore: 60 * 60,
             data: response.data.items.map((siteSpace) => siteSpace),
-            tags: [getAPICacheTag({ tag: 'site', site: siteId })],
+            tags: [getAPICacheTag({ tag: 'site', site: args.siteId })],
         });
     },
 );

src/lib/api.ts

@@ -208,10 +208,11 @@ export async function middleware(request: NextRequest) {
         if (resolved.siteSpace) {
             headers.set('x-gitbook-content-site-space', resolved.siteSpace);
         }
+        if (resolved.shareKey) {
+            headers.set('x-gitbook-content-site-share-key', resolved.shareKey);
+        }
     }
-    if (resolved.contentUrl) {
-        headers.set('x-gitbook-content-url', resolved.contentUrl);
-    }
+
     if (resolved.revision) {
         headers.set('x-gitbook-content-revision', resolved.revision);
     }
@@ -662,9 +663,13 @@ async function lookupSpaceByAPI(
             apiToken: data.apiToken,
             cacheMaxAge: data.cacheMaxAge,
             cacheTags: data.cacheTags,
-            contentUrl: data.contentUrl,
             ...('site' in data
-                ? { site: data.site, siteSpace: data.siteSpace, organization: data.organization }
+                ? {
+                      site: data.site,
+                      siteSpace: data.siteSpace,
+                      organization: data.organization,
+                      shareKey: data.shareKey,
+                  }
                 : {}),
         } as PublishedContentWithCache;
     });