[Search Sessions] Improve session restoration back button

docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.kbnurlcontrols.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-kibana\_utils-public-state\_sync](./kibana-plugin-plugins-kibana_utils-public-state_sync.md) &gt; [IKbnUrlStateStorage](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md) &gt; [kbnUrlControls](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.kbnurlcontrols.md)
+
+## IKbnUrlStateStorage.kbnUrlControls property
+
+Lower level wrapper around history library that handles batching multiple URL updates into one history change
+
+<b>Signature:</b>
+
+```typescript
+kbnUrlControls: IKbnUrlControls;
+```

docs/development/plugins/kibana_utils/public/state_sync/kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.md

@@ -20,9 +20,8 @@ export interface IKbnUrlStateStorage extends IStateStorage
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [cancel](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.cancel.md) | <code>() =&gt; void</code> | cancels any pending url updates |
 |  [change$](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.change_.md) | <code>&lt;State = unknown&gt;(key: string) =&gt; Observable&lt;State &#124; null&gt;</code> |  |
-|  [flush](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.flush.md) | <code>(opts?: {</code><br/><code>        replace?: boolean;</code><br/><code>    }) =&gt; boolean</code> | Synchronously runs any pending url updates, returned boolean indicates if change occurred. |
 |  [get](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.get.md) | <code>&lt;State = unknown&gt;(key: string) =&gt; State &#124; null</code> |  |
+|  [kbnUrlControls](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.kbnurlcontrols.md) | <code>IKbnUrlControls</code> | Lower level wrapper around history library that handles batching multiple URL updates into one history change |
 |  [set](./kibana-plugin-plugins-kibana_utils-public-state_sync.ikbnurlstatestorage.set.md) | <code>&lt;State&gt;(key: string, state: State, opts?: {</code><br/><code>        replace: boolean;</code><br/><code>    }) =&gt; Promise&lt;string &#124; undefined&gt;</code> |  |
 

src/plugins/dashboard/public/application/dashboard_app.tsx

@@ -41,11 +41,11 @@ import {
   useSavedDashboard,
 } from './hooks';
 
-import { removeQueryParam } from '../services/kibana_utils';
 import { IndexPattern } from '../services/data';
 import { EmbeddableRenderer } from '../services/embeddable';
 import { DashboardContainerInput } from '.';
 import { leaveConfirmStrings } from '../dashboard_strings';
+import { replaceUrlHashQuery } from '../../../kibana_utils/public';
 
 export interface DashboardAppProps {
   history: History;
@@ -111,19 +111,43 @@ export function DashboardApp({
         const shouldRefetch = Object.keys(changes).some(
           (changeKey) => !noRefetchKeys.includes(changeKey as keyof DashboardContainerInput)
         );
-        if (getSearchSessionIdFromURL(history)) {
-          // going away from a background search results
-          removeQueryParam(history, DashboardConstants.SEARCH_SESSION_ID, true);
-        }
+
+        const newSearchSessionId: string | undefined = (() => {
+          // do not update session id if this is irrelevant state change to prevent excessive searches
+          if (!shouldRefetch) return;
+
+          let searchSessionIdFromURL = getSearchSessionIdFromURL(history);
+          if (searchSessionIdFromURL) {
+            if (
+              data.search.session.isRestore() &&
+              data.search.session.getSessionId() === searchSessionIdFromURL
+            ) {
+              // navigating away from a restored session
+              dashboardStateManager.kbnUrlStateStorage.kbnUrlControls.updateAsync((nextUrl) => {
+                if (nextUrl.includes(DashboardConstants.SEARCH_SESSION_ID)) {
+                  return replaceUrlHashQuery(nextUrl, (query) => {
+                    delete query[DashboardConstants.SEARCH_SESSION_ID];
+                    return query;
+                  });
+                }
+                return nextUrl;
+              });
+              searchSessionIdFromURL = undefined;
+            } else {
+              data.search.session.restore(searchSessionIdFromURL);
+            }
+          }
+
+          return searchSessionIdFromURL ?? data.search.session.start();
+        })();
 
         if (changes.viewMode) {
           setViewMode(changes.viewMode);
         }
 
         dashboardContainer.updateInput({
           ...changes,
-          // do not start a new session if this is irrelevant state change to prevent excessive searches
-          ...(shouldRefetch && { searchSessionId: data.search.session.start() }),
+          ...(newSearchSessionId && { searchSessionId: newSearchSessionId }),
         });
       }
     },

src/plugins/dashboard/public/application/dashboard_state_manager.ts

@@ -83,7 +83,7 @@ export class DashboardStateManager {
   >;
   private readonly stateContainerChangeSub: Subscription;
   private readonly STATE_STORAGE_KEY = '_a';
-  private readonly kbnUrlStateStorage: IKbnUrlStateStorage;
+  public readonly kbnUrlStateStorage: IKbnUrlStateStorage;
   private readonly stateSyncRef: ISyncStateRef;
   private readonly history: History;
   private readonly usageCollection: UsageCollectionSetup | undefined;
@@ -599,7 +599,7 @@ export class DashboardStateManager {
       this.toUrlState(this.stateContainer.get())
     );
     // immediately forces scheduled updates and changes location
-    return this.kbnUrlStateStorage.flush({ replace });
+    return !!this.kbnUrlStateStorage.kbnUrlControls.flush(replace);
   }
 
   // TODO: find nicer solution for this

src/plugins/data/public/query/state_sync/sync_state_with_url.test.ts

@@ -99,7 +99,7 @@ describe('sync_query_state_with_url', () => {
   test('url is actually changed when data in services changes', () => {
     const { stop } = syncQueryStateWithUrl(queryServiceStart, kbnUrlStateStorage);
     filterManager.setFilters([gF, aF]);
-    kbnUrlStateStorage.flush(); // sync force location change
+    kbnUrlStateStorage.kbnUrlControls.flush(); // sync force location change
     expect(history.location.hash).toMatchInlineSnapshot(
       `"#?_g=(filters:!(('$state':(store:globalState),meta:(alias:!n,disabled:!t,index:'logstash-*',key:query,negate:!t,type:custom,value:'%7B%22match%22:%7B%22key1%22:%22value1%22%7D%7D'),query:(match:(key1:value1)))),refreshInterval:(pause:!t,value:0),time:(from:now-15m,to:now))"`
     );
@@ -135,7 +135,7 @@ describe('sync_query_state_with_url', () => {
 
   test('when url is changed, filters synced back to filterManager', () => {
     const { stop } = syncQueryStateWithUrl(queryServiceStart, kbnUrlStateStorage);
-    kbnUrlStateStorage.cancel(); // stop initial syncing pending update
+    kbnUrlStateStorage.kbnUrlControls.cancel(); // stop initial syncing pending update
     history.push(pathWithFilter);
     expect(filterManager.getGlobalFilters()).toHaveLength(1);
     stop();

src/plugins/discover/public/application/angular/context_state.ts

@@ -216,7 +216,7 @@ export function getState({
       }
     },
     // helper function just needed for testing
-    flushToUrl: (replace?: boolean) => stateStorage.flush({ replace }),
+    flushToUrl: (replace?: boolean) => stateStorage.kbnUrlControls.flush(replace),
   };
 }
 

src/plugins/discover/public/application/angular/discover.js

@@ -204,8 +204,6 @@ function discoverController($element, $route, $scope, $timeout, Promise, uiCapab
   };
 
   const history = getHistory();
-  // used for restoring a search session
-  let isInitialSearch = true;
 
   // search session requested a data refresh
   subscriptions.add(
@@ -577,18 +575,21 @@ function discoverController($element, $route, $scope, $timeout, Promise, uiCapab
     abortController = new AbortController();
 
     const searchSessionId = (() => {
-      const searchSessionIdFromURL = getSearchSessionIdFromURL(history);
+      let searchSessionIdFromURL = getSearchSessionIdFromURL(history);
       if (searchSessionIdFromURL) {
-        if (isInitialSearch) {
-          data.search.session.restore(searchSessionIdFromURL);
-          isInitialSearch = false;
-          return searchSessionIdFromURL;
-        } else {
-          // navigating away from background search
+        if (
+          data.search.session.isRestore() &&
+          data.search.session.getSessionId() === searchSessionIdFromURL
+        ) {
+          // navigating away from a restored session
           removeQueryParam(history, SEARCH_SESSION_ID_QUERY_PARAM);
+          searchSessionIdFromURL = undefined;
+        } else {
+          data.search.session.restore(searchSessionIdFromURL);
         }
       }
-      return data.search.session.start();
+
+      return searchSessionIdFromURL ?? data.search.session.start();
     })();
 
     $scope

src/plugins/discover/public/application/angular/discover_state.ts

@@ -208,7 +208,7 @@ export function getState({
       setState(appStateContainerModified, defaultState);
     },
     getPreviousAppState: () => previousAppState,
-    flushToUrl: () => stateStorage.flush(),
+    flushToUrl: () => stateStorage.kbnUrlControls.flush(),
     isAppStateDirty: () => !isEqualState(initialAppState, appStateContainer.getState()),
   };
 }

src/plugins/kibana_utils/docs/state_sync/storages/kbn_url_storage.md

@@ -96,11 +96,11 @@ setTimeout(() => {
 }, 0);
 ```
 
-For cases, where granular control over URL updates is needed, `kbnUrlStateStorage` provides these advanced apis:
+For cases, where granular control over URL updates is needed, `kbnUrlStateStorage` exposes `kbnUrlStateStorage.kbnUrlControls` that exposes these advanced apis:
 
-- `kbnUrlStateStorage.flush({replace: boolean})` - allows to synchronously apply any pending updates.
-  `replace` option allows to use `history.replace()` instead of `history.push()`. Returned boolean indicates if any update happened
-- `kbnUrlStateStorage.cancel()` - cancels any pending updates
+- `kbnUrlStateStorage.kbnUrlControls.flush({replace: boolean})` - allows to synchronously apply any pending updates.
+  `replace` option allows using `history.replace()` instead of `history.push()`.
+- `kbnUrlStateStorage.kbnUrlControls.cancel()` - cancels any pending updates.
 
 ### Sharing one `kbnUrlStateStorage` instance
 

src/plugins/kibana_utils/public/index.ts

@@ -62,6 +62,8 @@ export {
   getStatesFromKbnUrl,
   setStateToKbnUrl,
   withNotifyOnErrors,
+  replaceUrlHashQuery,
+  replaceUrlQuery,
 } from './state_management/url';
 export {
   syncState,

src/plugins/kibana_utils/public/state_management/url/index.ts

@@ -28,3 +28,4 @@ export {
 export { createKbnUrlTracker } from './kbn_url_tracker';
 export { createUrlTracker } from './url_tracker';
 export { withNotifyOnErrors, saveStateInUrlErrorTitle, restoreUrlErrorTitle } from './errors';
+export { replaceUrlHashQuery, replaceUrlQuery } from './format';

src/plugins/kibana_utils/public/state_sync/public.api.md

@@ -22,14 +22,12 @@ export const createSessionStorageStateStorage: (storage?: Storage) => ISessionSt
 
 // @public
 export interface IKbnUrlStateStorage extends IStateStorage {
-    cancel: () => void;
     // (undocumented)
     change$: <State = unknown>(key: string) => Observable<State | null>;
-    flush: (opts?: {
-        replace?: boolean;
-    }) => boolean;
     // (undocumented)
     get: <State = unknown>(key: string) => State | null;
+    // Warning: (ae-forgotten-export) The symbol "IKbnUrlControls" needs to be exported by the entry point index.d.ts
+    kbnUrlControls: IKbnUrlControls;
     // (undocumented)
     set: <State>(key: string, state: State, opts?: {
         replace: boolean;

src/plugins/kibana_utils/public/state_sync/state_sync.test.ts

@@ -266,7 +266,7 @@ describe('state_sync', () => {
       expect(history.length).toBe(startHistoryLength);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
 
-      urlSyncStrategy.flush();
+      urlSyncStrategy.kbnUrlControls.flush();
 
       expect(history.length).toBe(startHistoryLength + 1);
       expect(getCurrentUrl()).toMatchInlineSnapshot(
@@ -301,7 +301,7 @@ describe('state_sync', () => {
       expect(history.length).toBe(startHistoryLength);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);
 
-      urlSyncStrategy.cancel();
+      urlSyncStrategy.kbnUrlControls.cancel();
 
       expect(history.length).toBe(startHistoryLength);
       expect(getCurrentUrl()).toMatchInlineSnapshot(`"/"`);