[9.2] [Background search] Fix race condition with sending to background & immediately canceling (elastic#238151) (elastic#240354)

kibanamachine · lukasolson · web-flow · commit d2c3246b5d24 · 2025-10-28T00:16:43.000+01:00
# Backport This will backport the following commits from `main` to `9.2`: - [[Background search] Fix race condition with sending to background & immediately canceling (elastic#238151)](elastic#238151)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Lukas Olson <lukas@elastic.co>
diff --git a/src/platform/plugins/shared/data/common/search/poll_search.ts b/src/platform/plugins/shared/data/common/search/poll_search.ts
@@ -62,7 +62,7 @@ export const pollSearch = <Response extends IKibanaSearchResponse>(
     return from(search()).pipe(
       expand(() => {
         const elapsedTime = Date.now() - startTime;
-        return timer(getPollInterval(elapsedTime)).pipe(switchMap(search));
+        return timer(getPollInterval(elapsedTime)).pipe(switchMap(() => search()));
       }),
       tap((response) => {
         if (isAbortResponse(response)) {
diff --git a/src/platform/plugins/shared/data/public/search/search_interceptor/search_interceptor.ts b/src/platform/plugins/shared/data/public/search/search_interceptor/search_interceptor.ts
@@ -292,7 +292,9 @@ export class SearchInterceptor {
   ) {
     const { sessionId, strategy } = options;
 
-    const search = () => {
+    const search = ({
+      abortSignal = searchAbortController.getSignal(),
+    }: Pick<ISearchOptions, 'abortSignal'> = {}) => {
       const [{ isSearchStored }, afterPoll] = searchTracker?.beforePoll() ?? [
         { isSearchStored: false },
         () => {},
@@ -302,7 +304,7 @@ export class SearchInterceptor {
         {
           ...options,
           ...this.deps.session.getSearchOptions(sessionId),
-          abortSignal: searchAbortController.getSignal(),
+          abortSignal,
           isSearchStored,
         }
       )
@@ -319,9 +321,9 @@ export class SearchInterceptor {
     const searchTracker = this.deps.session.isCurrentSession(sessionId)
       ? this.deps.session.trackSearch({
           abort: () => searchAbortController.abort(),
-          poll: async () => {
+          poll: async (abortSignal) => {
             if (id) {
-              await search();
+              await search({ abortSignal });
             }
           },
         })
@@ -330,7 +332,8 @@ export class SearchInterceptor {
     // track if this search's session will be send to background
     // if yes, then we don't need to cancel this search when it is aborted
     let isSavedToBackground =
-      this.deps.session.isCurrentSession(sessionId) && this.deps.session.isStored();
+      this.deps.session.isCurrentSession(sessionId) &&
+      (this.deps.session.isSaving() || this.deps.session.isStored());
     const savedToBackgroundSub =
       this.deps.session.isCurrentSession(sessionId) &&
       this.deps.session.state$
@@ -415,8 +418,11 @@ export class SearchInterceptor {
             })
           );
         } else {
-          searchTracker?.error();
-          cancel();
+          // Don't error out the search or cancel if it is being saved to the background
+          if (!isSavedToBackground) {
+            searchTracker?.error();
+            cancel();
+          }
           return throwError(e);
         }
       }),
diff --git a/src/platform/plugins/shared/data/public/search/session/mocks.ts b/src/platform/plugins/shared/data/public/search/session/mocks.ts
@@ -52,6 +52,7 @@ export function getSessionServiceMock(
     })),
     destroy: jest.fn(),
     cancel: jest.fn(),
+    isSaving: jest.fn(),
     isStored: jest.fn(),
     isRestore: jest.fn(),
     save: jest.fn(),
diff --git a/src/platform/plugins/shared/data/public/search/session/search_session_state.test.ts b/src/platform/plugins/shared/data/public/search/session/search_session_state.test.ts
@@ -132,5 +132,16 @@ describe('Session state container', () => {
       state.transitions.start({ appName });
       expect(state.selectors.getState()).toBe(SearchSessionState.None);
     });
+
+    test('save sets isSaving: true and store sets isSaving: false', () => {
+      state.transitions.start({ appName });
+      expect(state.get().isSaving).toBe(false);
+
+      state.transitions.save();
+      expect(state.get().isSaving).toBe(true);
+
+      state.transitions.store(mockSavedObject);
+      expect(state.get().isSaving).toBe(false);
+    });
   });
 });
diff --git a/src/platform/plugins/shared/data/public/search/session/search_session_state.ts b/src/platform/plugins/shared/data/public/search/session/search_session_state.ts
@@ -92,6 +92,11 @@ export interface SessionStateInternal<SearchDescriptor = unknown, SearchMeta ext
    */
   appName?: string;
 
+  /**
+   * Is the session in the process of being saved?
+   */
+  isSaving: boolean;
+
   /**
    * Has the session already been stored (i.e. "sent to background")?
    */
@@ -160,6 +165,7 @@ const createSessionDefaultState: <
   isRestore: false,
   isCanceled: false,
   isContinued: false,
+  isSaving: false,
   isStarted: false,
   trackedSearches: [],
 });
@@ -172,6 +178,7 @@ export interface SessionPureTransitions<
   start: (state: S) => ({ appName }: { appName: string }) => S;
   restore: (state: S) => (sessionId: string) => S;
   clear: (state: S) => () => S;
+  save: (state: S) => () => S;
   store: (state: S) => (searchSessionSavedObject: SearchSessionSavedObject) => S;
   trackSearch: (state: S) => (search: SearchDescriptor, meta?: SearchMeta) => S;
   removeSearch: (state: S) => (search: SearchDescriptor) => S;
@@ -201,12 +208,22 @@ export const sessionPureTransitions: SessionPureTransitions = {
     isStored: true,
   }),
   clear: (state) => () => createSessionDefaultState(),
-  store: (state) => (searchSessionSavedObject: SearchSessionSavedObject) => {
+  save: (state) => () => {
+    if (!state.sessionId) throw new Error("Can't save session. Missing sessionId");
+    if (state.isStored || state.isRestore)
+      throw new Error('Can\'t save because current session is already stored"');
+    return {
+      ...state,
+      isSaving: true,
+    };
+  },
+  store: (state) => (searchSessionSavedObject?: SearchSessionSavedObject) => {
     if (!state.sessionId) throw new Error("Can't store session. Missing sessionId");
     if (state.isStored || state.isRestore)
       throw new Error('Can\'t store because current session is already stored"');
     return {
       ...state,
+      isSaving: false,
       isStored: true,
       searchSessionSavedObject,
     };
@@ -357,6 +374,8 @@ export const sessionPureSelectors: SessionPureSelectors = {
         return pendingSearches.length > 0
           ? SearchSessionState.BackgroundLoading
           : SearchSessionState.Restored;
+      case state.isSaving:
+        return SearchSessionState.BackgroundLoading;
       case state.isStored:
         return pendingSearches.length > 0
           ? SearchSessionState.BackgroundLoading
diff --git a/src/platform/plugins/shared/data/public/search/session/session_service.ts b/src/platform/plugins/shared/data/public/search/session/session_service.ts
@@ -70,9 +70,11 @@ interface TrackSearchDescriptor {
   abort: () => void;
 
   /**
-   * Keep polling the search to keep it alive
+   * Used for polling after running in background (to ensure the search makes it into the background search saved
+   * object) and also to keep the search alive while other search requests in the session are still in progress
+   * @param abortSignal - signal that can be used to cancel the polling - otherwise the `searchAbortController.getSignal()` is used
    */
-  poll: () => Promise<void>;
+  poll: (abortSignal?: AbortSignal) => Promise<void>;
 
   /**
    * Notify search that session is being saved, could be used to restart the search with different params
@@ -447,6 +449,15 @@ export class SessionService {
     );
   }
 
+  /**
+   * Is current session in process of saving
+   */
+  public isSaving(
+    state: SessionStateContainer<TrackSearchDescriptor, TrackSearchMeta> = this.state
+  ) {
+    return state.get().isSaving;
+  }
+
   /**
    * Is current session already saved as SO (send to background)
    */
@@ -600,6 +611,8 @@ export class SessionService {
       appendStartTime: currentSessionInfoProvider.appendSessionStartTimeToName,
     });
 
+    this.state.transitions.save();
+
     const searchSessionSavedObject = await this.sessionsClient.create({
       name: formattedName,
       appId: currentSessionApp,
@@ -622,7 +635,7 @@ export class SessionService {
 
       const extendSearchesPromise = Promise.all(
         searchesToExtend.map((s) =>
-          s.searchDescriptor.poll().catch((e) => {
+          s.searchDescriptor.poll(new AbortController().signal).catch((e) => {
             // eslint-disable-next-line no-console
             console.warn('Failed to extend search after session was saved', e);
           })
