Suggest questions in the current space context (#3514)

Author: taranvohra

.changeset/curly-eagles-arrive.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Suggest questions in the current space context

bun.lock

@@ -246,7 +246,7 @@
     "react-dom": "^19.0.0",
   },
   "catalog": {
-    "@gitbook/api": "^0.129.0",
+    "@gitbook/api": "^0.130.0",
   },
   "packages": {
     "@ai-sdk/provider": ["@ai-sdk/[email protected]", "", { "dependencies": { "json-schema": "^0.4.0" } }, "sha512-0M+qjp+clUD0R1E5eWQFhxEvWLNaOtGQRUaBn8CUABnSKredagq92hUS9VjOzGsTm37xLfpaxl97AVtbeOsHew=="],
@@ -609,7 +609,7 @@
 
     "@fortawesome/fontawesome-svg-core": ["@fortawesome/[email protected]", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
 
-    "@gitbook/api": ["@gitbook/api@0.129.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-Uh+k/BiDgdXj5a8BIlvwfEXdZNNlQMFDlGKmivUYH1gvFySqrTO6PjR/HtUOZEdNauAeWZmGoB8CLuwrVZS+YA=="],
+    "@gitbook/api": ["@gitbook/api@0.130.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-nfAPfTISUou+hJPZLrBsuUSSaHEeWB6eZ4adapWAagmaeeA3CpfopDROXcqGJPBHYPfvfLZIGdgyYhyYC3Objw=="],
 
     "@gitbook/cache-tags": ["@gitbook/cache-tags@workspace:packages/cache-tags"],
 

package.json

@@ -34,7 +34,7 @@
     "workspaces": {
         "packages": ["packages/*"],
         "catalog": {
-            "@gitbook/api": "^0.129.0"
+            "@gitbook/api": "^0.130.0"
         }
     },
     "patchedDependencies": {

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

@@ -26,7 +26,11 @@ export async function ReusableContent(props: BlockProps<DocumentBlockReusableCon
     }
 
     const { reusableContent } = resolved;
-    if (!reusableContent || !reusableContent.revisionReusableContent.document) {
+    if (
+        !reusableContent ||
+        !('document' in reusableContent.revisionReusableContent) ||
+        !reusableContent.revisionReusableContent.document
+    ) {
         return null;
     }
 

packages/gitbook/src/components/Search/SearchContainer.tsx

@@ -16,6 +16,7 @@ import { SearchScopeToggle } from './SearchScopeToggle';
 import { useSearch } from './useSearch';
 
 interface SearchContainerProps {
+    spaceId: string;
     spaceTitle: string;
     isMultiVariants: boolean;
     aiMode: CustomizationAIMode;
@@ -26,7 +27,7 @@ interface SearchContainerProps {
  * Client component to render the search input and results.
  */
 export function SearchContainer(props: SearchContainerProps) {
-    const { spaceTitle, isMultiVariants, aiMode, className } = props;
+    const { spaceId, spaceTitle, isMultiVariants, aiMode, className } = props;
 
     const withAIChat = aiMode === CustomizationAIMode.Assistant;
     const [state, setSearchState] = useSearch(withAIChat);
@@ -146,6 +147,7 @@ export function SearchContainer(props: SearchContainerProps) {
                                     query={normalizedQuery}
                                     global={state?.global ?? false}
                                     aiMode={aiMode}
+                                    spaceId={spaceId}
                                 />
                             ) : null}
                             {normalizedAsk ? <SearchAskAnswer query={normalizedAsk} /> : null}

packages/gitbook/src/components/Search/SearchResults.tsx

@@ -8,6 +8,7 @@ import { t, useLanguage } from '@/intl/client';
 import { tcls } from '@/lib/tailwind';
 
 import { CustomizationAIMode } from '@gitbook/api';
+import { assert } from 'ts-essentials';
 import { useTrackEvent } from '../Insights';
 import { Loading } from '../primitives';
 import { SearchPageResultItem } from './SearchPageResultItem';
@@ -33,9 +34,11 @@ type ResultType =
 
 /**
  * We cache the recommended questions globally to avoid calling the API multiple times
- * when re-opening the search modal.
+ * when re-opening the search modal. The cache is per space, so that we can
+ * have different recommended questions for different spaces of the same site.
+ * It should not be used outside of an useEffect.
  */
-let cachedRecommendedQuestions: null | ResultType[] = null;
+const cachedRecommendedQuestions: Map<string, ResultType[]> = new Map();
 
 /**
  * Fetch the results of the keyboard navigable elements to display for a query:
@@ -49,10 +52,11 @@ export const SearchResults = React.forwardRef(function SearchResults(
         query: string;
         global: boolean;
         aiMode: CustomizationAIMode;
+        spaceId: string;
     },
     ref: React.Ref<SearchResultsRef>
 ) {
-    const { children, query, aiMode, global } = props;
+    const { children, query, aiMode, global, spaceId } = props;
 
     const language = useLanguage();
     const trackEvent = useTrackEvent();
@@ -73,8 +77,10 @@ export const SearchResults = React.forwardRef(function SearchResults(
                 return;
             }
 
-            if (cachedRecommendedQuestions) {
-                setResultsState({ results: cachedRecommendedQuestions, fetching: false });
+            if (cachedRecommendedQuestions.has(spaceId)) {
+                const results = cachedRecommendedQuestions.get(spaceId);
+                assert(results, `Cached recommended questions should be set for space ${spaceId}`);
+                setResultsState({ results, fetching: false });
                 return;
             }
 
@@ -92,7 +98,7 @@ export const SearchResults = React.forwardRef(function SearchResults(
                     return;
                 }
 
-                const response = await streamRecommendedQuestions();
+                const response = await streamRecommendedQuestions(spaceId);
                 for await (const entry of readStreamableValue(response.stream)) {
                     if (!entry) {
                         continue;
@@ -109,7 +115,7 @@ export const SearchResults = React.forwardRef(function SearchResults(
                         id: question,
                         question,
                     });
-                    cachedRecommendedQuestions = recommendedQuestions;
+                    cachedRecommendedQuestions.set(spaceId, recommendedQuestions);
 
                     if (!cancelled) {
                         setResultsState({ results: [...recommendedQuestions], fetching: false });

packages/gitbook/src/components/Search/server-actions.tsx

@@ -185,8 +185,9 @@ export async function streamAskQuestion({
 
 /**
  * Stream a list of suggested questions for the site.
+ * Optionally scoped to a specific space.
  */
-export async function streamRecommendedQuestions() {
+export async function streamRecommendedQuestions(spaceId?: string) {
     const siteURLData = await getSiteURLDataFromMiddleware();
     const context = await getServerActionBaseContext();
 
@@ -196,7 +197,10 @@ export async function streamRecommendedQuestions() {
         const apiClient = await context.dataFetcher.api();
         const apiStream = apiClient.orgs.streamRecommendedQuestionsInSite(
             siteURLData.organization,
-            siteURLData.site
+            siteURLData.site,
+            {
+                spaceId,
+            }
         );
 
         for await (const chunk of apiStream) {

packages/gitbook/src/components/SpaceLayout/SpaceLayout.tsx

@@ -58,6 +58,7 @@ export function SpaceLayout(props: {
                     aiMode={aiMode}
                     isMultiVariants={siteSpaces.length > 1}
                     spaceTitle={siteSpace.title}
+                    spaceId={siteSpace.space.id}
                 />
             </React.Suspense>
             {aiMode === CustomizationAIMode.Assistant ? (