Initial URL state implementation

Author: davismcphee

src/platform/plugins/shared/discover/common/app_locator.ts

@@ -19,6 +19,8 @@ import type { VIEW_MODE, NEW_TAB_ID } from './constants';
 
 export const DISCOVER_APP_LOCATOR = 'DISCOVER_APP_LOCATOR';
 
+export type DiscoverProfileUrlState = Record<string, SerializableRecord>;
+
 export interface DiscoverAppLocatorParams extends SerializableRecord {
   /**
    * Optionally set saved search ID.
@@ -75,6 +77,11 @@ export interface DiscoverAppLocatorParams extends SerializableRecord {
    */
   tab?: { id: typeof NEW_TAB_ID | string; label?: string };
 
+  /**
+   * Optionally set URL-synced profile state.
+   */
+  profileUrlState?: DiscoverProfileUrlState;
+
   /**
    * Columns displayed in the table
    */

src/platform/plugins/shared/discover/common/app_locator_get_location.ts

@@ -11,13 +11,19 @@ import type { GlobalQueryStateFromUrl } from '@kbn/data-plugin/public';
 import { isFilterPinned, isOfAggregateQueryType } from '@kbn/es-query';
 import type { setStateToKbnUrl as setStateToKbnUrlCommon } from '@kbn/kibana-utils-plugin/common';
 import type {
+  DiscoverProfileUrlState,
   DiscoverAppLocatorGetLocation,
   DiscoverAppLocatorParams,
   MainHistoryLocationState,
 } from './app_locator';
 import type { DiscoverAppState } from '../public';
 import { createDataViewDataSource, createEsqlDataSource } from './data_sources';
-import { APP_STATE_URL_KEY, GLOBAL_STATE_URL_KEY, TAB_STATE_URL_KEY } from './constants';
+import {
+  APP_STATE_URL_KEY,
+  GLOBAL_STATE_URL_KEY,
+  PROFILE_STATE_URL_KEY,
+  TAB_STATE_URL_KEY,
+} from './constants';
 
 export const appLocatorGetLocationCommon = async (
   {
@@ -38,7 +44,7 @@ export const appLocatorGetLocationCommon = async (
     path = `${path}?searchSessionId=${searchSessionId}`;
   }
 
-  const { appState, globalState, state } = parseAppLocatorParams(params);
+  const { appState, globalState, profileUrlState, state } = parseAppLocatorParams(params);
 
   if (Object.keys(globalState).length) {
     path = setStateToKbnUrl<GlobalQueryStateFromUrl>(
@@ -53,6 +59,10 @@ export const appLocatorGetLocationCommon = async (
     path = setStateToKbnUrl(APP_STATE_URL_KEY, appState, { useHash }, path);
   }
 
+  if (profileUrlState && Object.keys(profileUrlState).length) {
+    path = setStateToKbnUrl(PROFILE_STATE_URL_KEY, profileUrlState, { useHash }, path);
+  }
+
   if (tab?.id) {
     path = setStateToKbnUrl(
       TAB_STATE_URL_KEY,
@@ -91,10 +101,13 @@ export const parseAppLocatorParams = (params: DiscoverAppLocatorParams) => {
     sampleSize,
     isAlertResults,
     esqlControls,
+    profileUrlState,
   } = params;
 
   const appState: Partial<DiscoverAppState> = {};
   const globalState: GlobalQueryStateFromUrl = {};
+  const parsedProfileUrlState: DiscoverProfileUrlState | undefined =
+    profileUrlState && Object.keys(profileUrlState).length > 0 ? profileUrlState : undefined;
 
   if (query) appState.query = query;
   if (filters && filters.length) appState.filters = filters?.filter((f) => !isFilterPinned(f));
@@ -123,5 +136,5 @@ export const parseAppLocatorParams = (params: DiscoverAppLocatorParams) => {
   if (isAlertResults) state.isAlertResults = isAlertResults;
   if (esqlControls) state.esqlControls = esqlControls;
 
-  return { appState, globalState, state };
+  return { appState, globalState, profileUrlState: parsedProfileUrlState, state };
 };

src/platform/plugins/shared/discover/common/constants.ts

@@ -41,6 +41,7 @@ export const NEW_TAB_ID = 'new' as const;
  */
 export const APP_STATE_URL_KEY = '_a';
 export const GLOBAL_STATE_URL_KEY = '_g';
+export const PROFILE_STATE_URL_KEY = '_p';
 export const TAB_STATE_URL_KEY = '_tab'; // `_t` is already used by Kibana for time, so we use `_tab` here
 
 /**

src/platform/plugins/shared/discover/common/index.ts

@@ -10,11 +10,16 @@
 export const PLUGIN_ID = 'discover';
 export const APP_ICON = 'discoverApp';
 
-export { APP_STATE_URL_KEY, EMBEDDABLE_TRANSFORMS_FEATURE_FLAG_KEY } from './constants';
+export {
+  APP_STATE_URL_KEY,
+  EMBEDDABLE_TRANSFORMS_FEATURE_FLAG_KEY,
+  PROFILE_STATE_URL_KEY,
+} from './constants';
 export { DISCOVER_APP_LOCATOR } from './app_locator';
 export type {
   DiscoverAppLocator,
   DiscoverAppLocatorParams,
+  DiscoverProfileUrlState,
   MainHistoryLocationState,
 } from './app_locator';
 

src/platform/plugins/shared/discover/public/application/main/components/top_nav/app_menu_actions/get_share.tsx

@@ -33,6 +33,7 @@ interface BuildShareOptionsParams {
   discoverParams: AppMenuDiscoverParams;
   services: DiscoverServices;
   currentTab: TabState;
+  profileUrlState?: DiscoverAppLocatorParams['profileUrlState'];
   persistedDiscoverSession: DiscoverSession | undefined;
   totalHitsState: DataTotalHitsMsg;
   hasUnsavedChanges: boolean;
@@ -50,6 +51,7 @@ export const buildShareOptions = async ({
   discoverParams,
   services,
   currentTab,
+  profileUrlState,
   persistedDiscoverSession,
   totalHitsState,
   hasUnsavedChanges,
@@ -84,6 +86,7 @@ export const buildShareOptions = async ({
     ...(dataView?.isPersisted()
       ? { dataViewId: dataView?.id }
       : { dataViewSpec: dataView?.toMinimalSpec() }),
+    ...(profileUrlState ? { profileUrlState } : {}),
     filters,
     timeRange,
     refreshInterval,
@@ -256,6 +259,7 @@ export const getShareAppMenuItem = ({
   hasIntegrations,
   hasUnsavedChanges,
   currentTab,
+  profileUrlState,
   persistedDiscoverSession,
   totalHitsState,
   intl,
@@ -265,6 +269,7 @@ export const getShareAppMenuItem = ({
   hasIntegrations: boolean;
   hasUnsavedChanges: boolean;
   currentTab: TabState;
+  profileUrlState?: DiscoverAppLocatorParams['profileUrlState'];
   persistedDiscoverSession: DiscoverSession | undefined;
   totalHitsState: DataTotalHitsMsg;
   intl: IntlShape;
@@ -278,6 +283,7 @@ export const getShareAppMenuItem = ({
       discoverParams,
       services,
       currentTab,
+      profileUrlState,
       persistedDiscoverSession,
       totalHitsState,
       hasUnsavedChanges,
@@ -306,6 +312,7 @@ export const getShareAppMenuItem = ({
         discoverParams,
         services,
         currentTab,
+        profileUrlState,
         persistedDiscoverSession,
         totalHitsState,
         hasUnsavedChanges,

src/platform/plugins/shared/discover/public/application/main/components/top_nav/use_top_nav_links.tsx

@@ -42,6 +42,7 @@ import {
 import { useProfileAccessor } from '../../../../context_awareness';
 import {
   internalStateActions,
+  selectTabRuntimeState,
   selectTabSavedSearchByValueAttributes,
   useCurrentDataView,
   useCurrentTabSelector,
@@ -52,6 +53,7 @@ import {
   useRuntimeStateManager,
 } from '../../state_management/redux';
 import type { DiscoverAppState } from '../../state_management/redux';
+import { getProfileUrlState } from '../../state_management/utils/get_profile_url_state';
 import { useCurrentTabMenuActions } from '../../hooks/use_current_tab_menu_actions';
 import { useDataState } from '../../hooks/use_data_state';
 import { TransferAction } from '../../../../plugin_imports/embeddable_editor_service';
@@ -146,6 +148,16 @@ export const useTopNavLinks = ({
 
   const canCreateESQLRule = !!services.capabilities.alertingVTwo;
   const showCreateRuleV2 = isEsqlMode && canCreateESQLRule;
+  const activeProfileStateDefinition = selectTabRuntimeState(runtimeStateManager, currentTab.id)
+    .scopedProfilesManager$.getValue()
+    .getContexts().dataSourceContext.profileState;
+  const profileUrlState = activeProfileStateDefinition
+    ? getProfileUrlState({
+        definition: activeProfileStateDefinition,
+        profileState: currentTab.profileState,
+        profileStateRegistry: services.profileStateRegistry,
+      })
+    : undefined;
 
   const appMenuItems: DiscoverAppMenuItemType[] = useMemo(() => {
     const items: DiscoverAppMenuItemType[] = [];
@@ -227,6 +239,7 @@ export const useTopNavLinks = ({
       hasIntegrations: hasShareIntegration,
       hasUnsavedChanges,
       currentTab,
+      profileUrlState,
       persistedDiscoverSession,
       totalHitsState,
       intl,
@@ -288,6 +301,7 @@ export const useTopNavLinks = ({
     currentDataView,
     currentTab,
     isDataViewMode,
+    profileUrlState,
     openInspector,
     persistedDiscoverSession,
     hasShareIntegration,

src/platform/plugins/shared/discover/public/application/main/state_management/discover_data_state_container.ts

@@ -45,6 +45,7 @@ import { fetchAll, type CommonFetchParams, fetchMoreDocuments } from '../data_fe
 import { sendResetMsg } from '../hooks/use_saved_search_messages';
 import { getFetch$ } from '../data_fetching/get_fetch_observable';
 import { getDefaultProfileState, getProfileStateSnapshot } from './utils/default_profile_state';
+import { getRestoredProfileUrlState } from './utils/get_profile_url_state';
 import type { InternalStateStore, RuntimeStateManager, TabActionInjector, TabState } from './redux';
 import { internalStateActions, selectTabRuntimeState } from './redux';
 import { buildEsqlFetchSubscribe } from './utils/build_esql_fetch_subscribe';
@@ -383,7 +384,39 @@ export function getDataStateContainer({
 
           // If the data source profile changed, we may need to restore previous profile state
           if (didProfileChange) {
-            const profileId = scopedProfilesManager.getContexts().dataSourceContext.profileId;
+            const { dataSourceContext } = scopedProfilesManager.getContexts();
+            const profileId = dataSourceContext.profileId;
+            const activeProfileStateDefinition = dataSourceContext.profileState;
+            const initialProfileUrlState = getCurrentTab().initialProfileUrlState;
+
+            if (isFirstResolution && initialProfileUrlState) {
+              if (activeProfileStateDefinition) {
+                const restoredProfileUrlState = getRestoredProfileUrlState({
+                  definition: activeProfileStateDefinition,
+                  profileStateRegistry: services.profileStateRegistry,
+                  profileUrlState: initialProfileUrlState,
+                });
+
+                if (restoredProfileUrlState) {
+                  internalState.dispatch(
+                    injectCurrentTab(internalStateActions.setProfileState)({
+                      key: activeProfileStateDefinition.key,
+                      profileState: {
+                        ...(getCurrentTab().profileState[activeProfileStateDefinition.key] ?? {}),
+                        ...restoredProfileUrlState,
+                      },
+                    })
+                  );
+                }
+              }
+
+              internalState.dispatch(
+                injectCurrentTab(internalStateActions.setInitialProfileUrlState)({
+                  initialProfileUrlState: undefined,
+                })
+              );
+            }
+
             const profileStateSnapshot =
               getCurrentTab().defaultProfileState.snapshotsByProfileId[profileId];
             const profileStateUpdate = getProfileStateSnapshot(
@@ -428,6 +461,10 @@ export function getDataStateContainer({
                 injectCurrentTab(internalStateActions.syncProfileStateSnapshot)({})
               );
             }
+
+            await internalState.dispatch(
+              injectCurrentTab(internalStateActions.updateProfileUrlStateAndReplaceUrl)()
+            );
           }
 
           const dataView = currentDataView$.getValue();

src/platform/plugins/shared/discover/public/application/main/state_management/redux/actions/initialize_single_tab.ts

@@ -25,12 +25,12 @@ import { loadAndResolveDataView } from '../../utils/resolve_data_view';
 import { isDataViewSource } from '../../../../../../common/data_sources';
 import { isRefreshIntervalValid, isTimeRangeValid } from '../../../../../utils/validate_time';
 import { getValidFilters } from '../../../../../utils/get_valid_filters';
-import { APP_STATE_URL_KEY } from '../../../../../../common';
+import { APP_STATE_URL_KEY, type DiscoverProfileUrlState } from '../../../../../../common';
 import { selectTabRuntimeState } from '../runtime_state';
 import type { ConnectedCustomizationService } from '../../../../../customizations';
 import { selectTab } from '../selectors';
 import type { TabState, TabStateGlobalState } from '../types';
-import { GLOBAL_STATE_URL_KEY } from '../../../../../../common/constants';
+import { GLOBAL_STATE_URL_KEY, PROFILE_STATE_URL_KEY } from '../../../../../../common/constants';
 import { fromSavedObjectTabToSearchSource } from '../tab_mapping_utils';
 import { createInternalStateAsyncThunk, extractEsqlVariables } from '../utils';
 import { fetchData, updateAttributes } from './tab_state';
@@ -111,12 +111,21 @@ export const initializeSingleTab = createInternalStateAsyncThunk(
     // to avoid race conditions if the URL changes during tab initialization,
     // e.g. if the user quickly switches tabs
     const urlGlobalState = urlStateStorage.get<GlobalQueryStateFromUrl>(GLOBAL_STATE_URL_KEY);
+    const urlProfileState =
+      urlStateStorage.get<DiscoverProfileUrlState>(PROFILE_STATE_URL_KEY) ?? undefined;
     const urlAppState = {
       ...tabInitialAppState,
       ...(defaultUrlState ??
         cleanupUrlState(urlStateStorage.get<AppStateUrl>(APP_STATE_URL_KEY), services.uiSettings)),
     };
 
+    dispatch(
+      internalStateSlice.actions.setInitialProfileUrlState({
+        tabId,
+        initialProfileUrlState: urlProfileState,
+      })
+    );
+
     const discoverTabLoadTracker = scopedEbtManager$
       .getValue()
       .trackPerformanceEvent('discoverLoadSavedSearch');

src/platform/plugins/shared/discover/public/application/main/state_management/redux/actions/tab_state.ts

@@ -18,10 +18,11 @@ import {
   isOfQueryType,
 } from '@kbn/es-query';
 import { getInitialESQLQuery } from '@kbn/esql-utils';
-import { GLOBAL_STATE_URL_KEY } from '../../../../../../common/constants';
+import { GLOBAL_STATE_URL_KEY, PROFILE_STATE_URL_KEY } from '../../../../../../common/constants';
 import { APP_STATE_URL_KEY } from '../../../../../../common';
 import { DataSourceType } from '../../../../../../common/data_sources';
 import { isEqualState } from '../../utils/state_comparators';
+import { getCurrentTabProfileUrlState } from '../../utils/get_profile_url_state';
 import {
   internalStateSlice,
   type InternalStateThunkActionCreator,
@@ -213,9 +214,36 @@ export const pushCurrentTabStateToUrl: InternalStateThunkActionCreator<
     await Promise.all([
       dispatch(updateGlobalStateAndReplaceUrl({ tabId, globalState: {} })),
       dispatch(updateAppStateAndReplaceUrl({ tabId, appState: {} })),
+      dispatch(updateProfileUrlStateAndReplaceUrl({ tabId })),
     ]);
   };
 
+export const updateProfileUrlStateAndReplaceUrl: InternalStateThunkActionCreator<
+  [TabActionPayload],
+  Promise<void>
+> = ({ tabId }) =>
+  async function updateProfileUrlStateAndReplaceUrlThunkFn(
+    _dispatch,
+    getState,
+    { runtimeStateManager, services, urlStateStorage }
+  ) {
+    const currentState = getState();
+
+    if (currentState.tabs.unsafeCurrentId !== tabId) {
+      return;
+    }
+
+    const profileUrlState =
+      getCurrentTabProfileUrlState({
+        getState,
+        runtimeStateManager,
+        profileStateRegistry: services.profileStateRegistry,
+        tabId,
+      }) ?? null;
+
+    await urlStateStorage.set(PROFILE_STATE_URL_KEY, profileUrlState, { replace: true });
+  };
+
 /**
  * Triggered when transitioning from ESQL to Dataview
  * Clean ups the ES|QL query and moves to the dataview mode