chore(headless-ssr): apply token fix to search (#6422)

Co-authored-by: Copilot <[email protected]>

Author: y-lakhdar

packages/headless/src/ssr-next/search/engine/search-engine.ssr.ts

@@ -1,6 +1,7 @@
 /**
  * Utility functions to be used for Server Side Rendering.
  */
+import {createAccessTokenManager} from '../../common/access-token-manager.js';
 import {defineSearchParameterManager} from '../controllers/search-parameter-manager/headless-search-parameter-manager.ssr.js';
 import {hydratedStaticStateFactory} from '../factories/hydrated-state-factory.js';
 import {fetchStaticStateFactory} from '../factories/static-state-factory.js';
@@ -43,13 +44,23 @@ export function defineSearchEngine<
 ): SearchEngineDefinition<SSRSearchEngine, TControllerDefinitions> {
   const {controllers: controllerDefinitions, ...engineOptions} = options;
 
-  const getOptions = () => engineOptions;
+  const tokenManager = createAccessTokenManager(
+    engineOptions.configuration.accessToken
+  );
+
+  const onAccessTokenUpdate = (
+    updateCallback: (accessToken: string) => void
+  ) => {
+    tokenManager.registerCallback(updateCallback);
+  };
+
+  const definitionOptions = {...engineOptions, onAccessTokenUpdate};
 
-  const getAccessToken = () => engineOptions.configuration.accessToken;
+  const getAccessToken = () => tokenManager.getAccessToken();
 
   const setAccessToken = (accessToken: string) => {
-    // TODO: KIT-5150 - Apply `setAccessToken` propagation fix for SSR search
     engineOptions.configuration.accessToken = accessToken;
+    tokenManager.setAccessToken(accessToken);
   };
 
   const augmentedControllerDefinition = {
@@ -59,12 +70,12 @@ export function defineSearchEngine<
 
   const fetchStaticState = fetchStaticStateFactory<TControllerDefinitions>(
     augmentedControllerDefinition,
-    getOptions()
+    definitionOptions
   );
 
   const hydrateStaticState = hydratedStaticStateFactory<TControllerDefinitions>(
     augmentedControllerDefinition,
-    getOptions()
+    definitionOptions
   );
 
   return {

packages/headless/src/ssr-next/search/factories/build-factory.ts

@@ -3,6 +3,7 @@ import {
   buildSearchEngine,
   type SearchEngineOptions,
 } from '../../../app/search-engine/search-engine.js';
+import {loadConfigurationActions} from '../../../features/configuration/configuration-actions-loader.js';
 import {createWaitForActionMiddleware} from '../../../utils/utils.js';
 import {buildControllerDefinitions} from '../controller-utils.js';
 import type {SearchCompletedAction, SSRSearchEngine} from '../types/build.js';
@@ -63,6 +64,19 @@ export const buildFactory =
 
     const engine = buildSSRSearchEngine(engineOptions);
 
+    const updateEngineConfiguration = (accessToken: string) => {
+      const {updateBasicConfiguration} = loadConfigurationActions(engine);
+      engine.dispatch(
+        updateBasicConfiguration({
+          accessToken,
+        })
+      );
+    };
+
+    if (options.onAccessTokenUpdate) {
+      options.onAccessTokenUpdate(updateEngineConfiguration);
+    }
+
     const controllers = buildControllerDefinitions({
       definitionsMap: controllerDefinitions,
       engine,

packages/headless/src/ssr-next/search/types/engine.ts

@@ -37,6 +37,10 @@ export type SearchEngineDefinitionOptions<
    * The controllers to initialize with the search engine.
    */
   controllers?: ValidateControllerNames<TControllers>;
+  /**
+   * Callback invoked when the access token changes.
+   */
+  onAccessTokenUpdate?: (updateCallback: (token: string) => void) => void;
 };
 
 export interface SearchEngineDefinition<

packages/headless/src/ssr/common/types/engine.ts

@@ -78,6 +78,17 @@ export interface EngineDefinition<
     InferControllersMapFromDefinition<TControllers>,
     InferControllerPropsMapFromDefinitions<TControllers>
   >;
+
+  /**
+   * Returns the access token.
+   */
+  getAccessToken: () => string;
+
+  /**
+   * Updates the access token.
+   * @param accessToken - The access token to update.
+   */
+  setAccessToken: (accessToken: string) => void;
 }
 
 /**

packages/headless/src/ssr/search/engine/search-engine.ssr.test.ts

@@ -293,5 +293,18 @@ describe('SSR', () => {
         });
       });
     });
+
+    describe('access token management', () => {
+      it('#getAccessToken should return the access token', () => {
+        expect(engineDefinition.getAccessToken()).toBe(
+          getSampleSearchEngineConfiguration().accessToken
+        );
+      });
+
+      it('#setAccessToken should update the access token', () => {
+        engineDefinition.setAccessToken('new-access-token');
+        expect(engineDefinition.getAccessToken()).toBe('new-access-token');
+      });
+    });
   });
 });

packages/headless/src/ssr/search/engine/search-engine.ssr.ts

@@ -11,7 +11,9 @@ import {
 } from '../../../app/search-engine/search-engine.js';
 import type {Controller} from '../../../controllers/controller/headless-controller.js';
 import type {LegacySearchAction} from '../../../features/analytics/analytics-utils.js';
+import {loadConfigurationActions} from '../../../features/configuration/configuration-actions-loader.js';
 import {createWaitForActionMiddleware} from '../../../utils/utils.js';
+import {createAccessTokenManager} from '../../common/access-token-manager.js';
 import {augmentPreprocessRequestWithForwardedFor} from '../../common/augment-preprocess-request.js';
 import {
   buildControllerDefinitions,
@@ -123,6 +125,10 @@ export function defineSearchEngine<
   type HydrateStaticStateFromBuildResultParameters =
     Parameters<HydrateStaticStateFromBuildResultFunction>;
 
+  const tokenManager = createAccessTokenManager(
+    engineOptions.configuration.accessToken
+  );
+
   const getOptions = () => {
     return engineOptions;
   };
@@ -133,6 +139,13 @@ export function defineSearchEngine<
     engineOptions.navigatorContextProvider = navigatorContextProvider;
   };
 
+  const getAccessToken = () => tokenManager.getAccessToken();
+
+  const setAccessToken = (accessToken: string) => {
+    engineOptions.configuration.accessToken = accessToken;
+    tokenManager.setAccessToken(accessToken);
+  };
+
   const build: BuildFunction = async (...[buildOptions]: BuildParameters) => {
     const logger = buildLogger(options.loggerOptions);
     if (!getOptions().navigatorContextProvider) {
@@ -145,6 +158,18 @@ export function defineSearchEngine<
         ? await buildOptions.extend(getOptions())
         : getOptions()
     );
+
+    const updateEngineConfiguration = (accessToken: string) => {
+      const {updateBasicConfiguration} = loadConfigurationActions(engine);
+      engine.dispatch(
+        updateBasicConfiguration({
+          accessToken,
+        })
+      );
+    };
+
+    tokenManager.registerCallback(updateEngineConfiguration);
+
     const controllers = buildControllerDefinitions({
       definitionsMap: (controllerDefinitions ?? {}) as TControllerDefinitions,
       engine,
@@ -226,5 +251,7 @@ export function defineSearchEngine<
     fetchStaticState,
     hydrateStaticState,
     setNavigatorContextProvider,
+    getAccessToken,
+    setAccessToken,
   };
 }