Fix an issue where recommended questions werent using the current siteSpace context (#3559)

Author: taranvohra

bun.lock

@@ -246,7 +246,7 @@
     "react-dom": "^19.0.0",
   },
   "catalog": {
-    "@gitbook/api": "^0.133.0",
+    "@gitbook/api": "^0.134.0",
   },
   "packages": {
     "@ai-sdk/provider": ["@ai-sdk/[email protected]", "", { "dependencies": { "json-schema": "^0.4.0" } }, "sha512-0M+qjp+clUD0R1E5eWQFhxEvWLNaOtGQRUaBn8CUABnSKredagq92hUS9VjOzGsTm37xLfpaxl97AVtbeOsHew=="],
@@ -611,7 +611,7 @@
 
     "@fortawesome/fontawesome-svg-core": ["@fortawesome/[email protected]", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
 
-    "@gitbook/api": ["@gitbook/api@0.133.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-Xi/A8NROQIj1haDA2XYr9b2+suUviyEVjplSslmwA2HyZnFNlkTaB1W0CwpVrZF8FZsfi3fZekQECOF34RLDDA=="],
+    "@gitbook/api": ["@gitbook/api@0.134.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-WMdLsA0ZOTbOyoloevPs0qa/VR2xmfp+YB6T/a2o8fkFUv5fMXxDVfCAcIxB2q9NCmkriMSCohWKmxLfz44s6w=="],
 
     "@gitbook/cache-tags": ["@gitbook/cache-tags@workspace:packages/cache-tags"],
 

package.json

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

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

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

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

@@ -52,11 +52,11 @@ export const SearchResults = React.forwardRef(function SearchResults(
         query: string;
         global: boolean;
         aiMode: CustomizationAIMode;
-        spaceId: string;
+        siteSpaceId: string;
     },
     ref: React.Ref<SearchResultsRef>
 ) {
-    const { children, query, aiMode, global, spaceId } = props;
+    const { children, query, aiMode, global, siteSpaceId } = props;
 
     const language = useLanguage();
     const trackEvent = useTrackEvent();
@@ -77,9 +77,12 @@ export const SearchResults = React.forwardRef(function SearchResults(
                 return;
             }
 
-            if (cachedRecommendedQuestions.has(spaceId)) {
-                const results = cachedRecommendedQuestions.get(spaceId);
-                assert(results, `Cached recommended questions should be set for space ${spaceId}`);
+            if (cachedRecommendedQuestions.has(siteSpaceId)) {
+                const results = cachedRecommendedQuestions.get(siteSpaceId);
+                assert(
+                    results,
+                    `Cached recommended questions should be set for site-space ${siteSpaceId}`
+                );
                 setResultsState({ results, fetching: false });
                 return;
             }
@@ -98,7 +101,7 @@ export const SearchResults = React.forwardRef(function SearchResults(
                     return;
                 }
 
-                const response = await streamRecommendedQuestions(spaceId);
+                const response = await streamRecommendedQuestions({ siteSpaceId });
                 for await (const entry of readStreamableValue(response.stream)) {
                     if (!entry) {
                         continue;
@@ -115,7 +118,7 @@ export const SearchResults = React.forwardRef(function SearchResults(
                         id: question,
                         question,
                     });
-                    cachedRecommendedQuestions.set(spaceId, recommendedQuestions);
+                    cachedRecommendedQuestions.set(siteSpaceId, recommendedQuestions);
 
                     if (!cancelled) {
                         setResultsState({ results: [...recommendedQuestions], fetching: false });

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

@@ -194,7 +194,7 @@ export async function streamAskQuestion({
  * Stream a list of suggested questions for the site.
  * Optionally scoped to a specific space.
  */
-export async function streamRecommendedQuestions(spaceId?: string) {
+export async function streamRecommendedQuestions(args: { siteSpaceId?: string }) {
     return traceErrorOnly('Search.streamRecommendedQuestions', async () => {
         const siteURLData = await getSiteURLDataFromMiddleware();
         const context = await getServerActionBaseContext();
@@ -209,7 +209,7 @@ export async function streamRecommendedQuestions(spaceId?: string) {
                 siteURLData.organization,
                 siteURLData.site,
                 {
-                    spaceId,
+                    siteSpaceId: args.siteSpaceId,
                 }
             );
 

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

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