[Discover] Persist query mode to local storage

.buildkite/ftr_platform_stateful_configs.yml

@@ -91,6 +91,7 @@ enabled:
   - src/platform/test/functional/apps/discover/group10/config.ts
   - src/platform/test/functional/apps/discover/context_awareness/config.ts
   - src/platform/test/functional/apps/discover/observability/config.ts
+  - src/platform/test/functional/apps/discover/query_mode/config.ts
   - src/platform/test/functional/apps/discover/tabs/config.ts
   - src/platform/test/functional/apps/discover/tabs2/config.ts
   - src/platform/test/functional/apps/discover/tabs3/config.ts

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

@@ -26,6 +26,9 @@ export const getDefaultRowsPerPage = (uiSettings: IUiSettingsClient): number =>
 // local storage key for the ES|QL to Dataviews transition modal
 export const ESQL_TRANSITION_MODAL_KEY = 'data.textLangTransitionModal';
 
+// local storage key for the query mode when starting a new discover session
+export const DISCOVER_QUERY_MODE_KEY = 'discover.defaultQueryMode';
+
 /**
  * The id value used to indicate that a link should open in a new Discover tab.
  * It will be used in the `_tab` URL param to indicate that a new tab should be created.

src/platform/plugins/shared/discover/public/application/main/components/tabs_view/use_app_menu_data.ts

@@ -23,7 +23,10 @@ import {
   selectAllTabs,
 } from '../../state_management/redux';
 import { useDiscoverServices } from '../../../../hooks/use_discover_services';
-import { ESQL_TRANSITION_MODAL_KEY } from '../../../../../common/constants';
+import {
+  DISCOVER_QUERY_MODE_KEY,
+  ESQL_TRANSITION_MODAL_KEY,
+} from '../../../../../common/constants';
 import { useTopNavMenuItems } from '../top_nav/use_top_nav_menu_items';
 import { isEsqlSource } from '../../../../../common/data_sources';
 
@@ -98,6 +101,7 @@ export const useAppMenuData = ({ currentDataView }: UseAppMenuDataParams): UseAp
             } else {
               dispatch(transitionFromESQLToDataView({ dataViewId: currentDataView?.id ?? '' }));
             }
+            services.storage.set(DISCOVER_QUERY_MODE_KEY, 'classic');
           },
         },
       ];

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

@@ -22,6 +22,7 @@ import { useGetRuleTypesPermissions } from '@kbn/alerts-ui-shared';
 import useObservable from 'react-use/lib/useObservable';
 import type { DiscoverSession } from '@kbn/saved-search-plugin/common';
 import { useI18n } from '@kbn/i18n-react';
+import { DISCOVER_QUERY_MODE_KEY } from '../../../../../common/constants';
 import type { DiscoverAppLocatorParams } from '../../../../../common';
 import { createDataViewDataSource } from '../../../../../common/data_sources';
 import type { DiscoverServices } from '../../../../build_services';
@@ -232,6 +233,7 @@ export const useTopNavLinks = ({
         }),
         run: () => {
           if (dataView) {
+            services.storage.set(DISCOVER_QUERY_MODE_KEY, 'esql');
             dispatch(transitionFromDataViewToESQL({ dataView }));
             services.trackUiMetric?.(METRIC_TYPE.CLICK, `esql:try_btn_clicked`);
           }

src/platform/plugins/shared/discover/public/application/main/state_management/utils/get_initial_app_state.test.ts

@@ -341,6 +341,111 @@ describe('getInitialAppState', () => {
     `);
   });
 
+  describe('when there is no persistedTab', () => {
+    describe('when there is a query in the url state', () => {
+      it('should use the query from the url state', () => {
+        // Given
+        const services = createDiscoverServicesMock();
+        const query = { language: 'kuery', query: 'url state query' };
+
+        // When
+        const appState = getInitialAppState({
+          initialUrlState: { query },
+          persistedTab: undefined,
+          dataView: dataViewMock,
+          services,
+        });
+
+        // Then
+        expect(appState).toEqual(
+          expect.objectContaining({
+            query,
+          })
+        );
+      });
+    });
+
+    describe('when there is no query in the url state', () => {
+      describe('when there is a data source in the url state', () => {
+        it('should use the default query', () => {
+          // Given
+          const services = createDiscoverServicesMock();
+          const dataSource = createDataViewDataSource({ dataViewId: 'some-data-view-id' });
+          services.data.query.queryString.getDefaultQuery = jest.fn().mockReturnValue(defaultQuery);
+
+          // When
+          const appState = getInitialAppState({
+            initialUrlState: { dataSource },
+            persistedTab: undefined,
+            dataView: dataViewMock,
+            services,
+          });
+
+          // Then
+          expect(appState).toEqual(
+            expect.objectContaining({
+              query: defaultQuery,
+            })
+          );
+        });
+      });
+
+      describe('when there is no data source in the url state', () => {
+        describe('when the query mode is esql', () => {
+          it('should return an esql initial query', () => {
+            // Given
+            const services = createDiscoverServicesMock();
+            services.storage.get = jest.fn().mockReturnValue('esql');
+
+            // When
+            const appState = getInitialAppState({
+              initialUrlState: undefined,
+              persistedTab: undefined,
+              dataView: dataViewMock,
+              services,
+            });
+
+            // Then
+            expect(appState).toEqual(
+              expect.objectContaining({
+                query: { esql: 'FROM the-data-view-title' },
+              })
+            );
+          });
+        });
+
+        describe.each([
+          { queryMode: 'classic', description: 'classic' },
+          { queryMode: undefined, description: 'unset' },
+        ])('when the query mode is $description', ({ queryMode }) => {
+          it('should return the default query', () => {
+            // Given
+            const services = createDiscoverServicesMock();
+            services.storage.get = jest.fn().mockReturnValue(queryMode);
+            services.data.query.queryString.getDefaultQuery = jest
+              .fn()
+              .mockReturnValue(defaultQuery);
+
+            // When
+            const appState = getInitialAppState({
+              initialUrlState: undefined,
+              persistedTab: undefined,
+              dataView: dataViewMock,
+              services,
+            });
+
+            // Then
+            expect(appState).toEqual(
+              expect.objectContaining({
+                query: defaultQuery,
+              })
+            );
+          });
+        });
+      });
+    });
+  });
+
   describe('default sort array', () => {
     test('should use persistedTab sort array if valid and data view is provided', () => {
       const services = createDiscoverServicesMock();

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

@@ -8,6 +8,7 @@
  */
 
 import type { DataView } from '@kbn/data-views-plugin/common';
+import type { AggregateQuery, Query } from '@kbn/es-query';
 import { isOfAggregateQueryType } from '@kbn/es-query';
 import type { DiscoverSessionTab } from '@kbn/saved-search-plugin/common';
 import type { IUiSettingsClient } from '@kbn/core/public';
@@ -20,6 +21,8 @@ import {
 } from '@kbn/discover-utils';
 import { getChartHidden } from '@kbn/unified-histogram';
 import { cloneDeep } from 'lodash';
+import { getInitialESQLQuery } from '@kbn/esql-utils';
+import { DISCOVER_QUERY_MODE_KEY } from '../../../../../common/constants';
 import type { DiscoverServices } from '../../../../build_services';
 import type { DiscoverAppState } from '../redux';
 import {
@@ -45,6 +48,7 @@ export function getInitialAppState({
     persistedTab,
     dataView,
     services,
+    initialUrlState,
   });
   const mergedState = { ...defaultAppState, ...initialUrlState };
 
@@ -77,18 +81,54 @@ function getDefaultColumns(
     : undefined;
 }
 
+function isDataView(dataView: unknown): dataView is DataView {
+  return !!dataView && typeof dataView === 'object' && 'getIndexPattern' in dataView;
+}
+
+function getDefaultQuery({
+  initialUrlState,
+  persistedTab,
+  storage,
+  data,
+  dataView,
+}: {
+  persistedTab: DiscoverSessionTab | undefined;
+  storage: DiscoverServices['storage'];
+  data: DiscoverServices['data'];
+  dataView: DataView | Pick<DataView, 'id' | 'timeFieldName'> | undefined;
+  initialUrlState: DiscoverAppState | undefined;
+}): Query | AggregateQuery | undefined {
+  if (persistedTab?.serializedSearchSource.query) return persistedTab.serializedSearchSource.query;
+
+  // This scenarios are used when we are adding a new tab:
+  //  1. We only have the query set if:
+  //    a. The tab is in ES|QL mode
+  //    b. The tab is in other mode but has some filter in place
+  // 2. We have no query set but we do have a data source if we are in classic mode with no filters
+  if (initialUrlState?.query) return initialUrlState.query;
+  if (initialUrlState?.dataSource) return data.query.queryString.getDefaultQuery();
+
+  // Fallback to last query mode for new sessions
+  const queryMode = storage.get(DISCOVER_QUERY_MODE_KEY);
+  if (queryMode === 'esql' && isDataView(dataView))
+    return { esql: getInitialESQLQuery(dataView, true) };
+
+  return data.query.queryString.getDefaultQuery();
+}
+
 function getDefaultAppState({
   persistedTab,
   dataView,
   services,
+  initialUrlState,
 }: {
   persistedTab: DiscoverSessionTab | undefined;
   dataView: DataView | Pick<DataView, 'id' | 'timeFieldName'> | undefined;
   services: DiscoverServices;
+  initialUrlState: DiscoverAppState | undefined;
 }) {
   const { data, uiSettings, storage } = services;
-  const query =
-    persistedTab?.serializedSearchSource.query || data.query.queryString.getDefaultQuery();
+  const query = getDefaultQuery({ persistedTab, storage, data, dataView, initialUrlState });
   const isEsqlQuery = isOfAggregateQueryType(query);
   // If the data view doesn't have a getFieldByName method (e.g. if it's a spec or list item),
   // we assume the sort array is valid since we can't know for sure

src/platform/test/functional/apps/discover/context_awareness/_telemetry.ts

@@ -433,6 +433,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
 
     describe('trackSubmittingQuery telemetry', () => {
       beforeEach(async () => {
+        await discover.resetQueryMode();
         await common.navigateToApp('discover');
         await discover.waitUntilTabIsLoaded();
         await ebtUIHelper.setOptIn(true);

src/platform/test/functional/apps/discover/group10/_lens_vis.ts

@@ -115,6 +115,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await discover.waitUntilSearchingHasFinished();
     });
 
+    afterEach(async function () {
+      await discover.resetQueryMode();
+    });
+
     it('should show histogram by default', async () => {
       await checkHistogramVis(defaultTimespan, defaultTotalCount);
 

src/platform/test/functional/apps/discover/group2_data_grid2/_data_grid_field_tokens.ts

@@ -94,6 +94,7 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
     beforeEach(async function () {
       await timePicker.setDefaultAbsoluteRangeViaUiSettings();
       await kibanaServer.uiSettings.update(defaultSettings);
+      await discover.resetQueryMode();
       await common.navigateToApp('discover');
       await discover.waitUntilSearchingHasFinished();
     });

src/platform/test/functional/apps/discover/group2_data_grid2/_data_grid_in_table_search.ts

@@ -59,6 +59,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await discover.waitUntilSearchingHasFinished();
     });
 
+    afterEach(async function () {
+      await discover.resetQueryMode();
+    });
+
     it('should show highlights for in-table search', async () => {
       expect(await dataGrid.getCurrentPageNumber()).to.be('1');
 

src/platform/test/functional/apps/discover/group8/_sidenav_link.ts

@@ -51,6 +51,10 @@ export default function ({ getService, getPageObjects }: FtrProviderContext) {
       await kibanaServer.savedObjects.cleanStandardList();
     });
 
+    beforeEach(async function () {
+      await discover.resetQueryMode();
+    });
+
     it('saves the last URL when in data view mode', async function () {
       await common.navigateToApp('discover');
       await header.waitUntilLoadingHasFinished();

src/platform/test/functional/apps/discover/query_mode/_default_query_mode.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import type { FtrProviderContext } from '../ftr_provider_context';
+
+export default function ({ getPageObjects, getService }: FtrProviderContext) {
+  const testSubjects = getService('testSubjects');
+
+  const { discover, common } = getPageObjects(['discover', 'common']);
+
+  describe('Default query mode', () => {
+    afterEach(async () => {
+      await discover.resetQueryMode();
+    });
+
+    beforeEach(async () => {
+      await common.navigateToApp('discover');
+    });
+
+    describe('when the default query mode is ES|QL', () => {
+      it('should open Discover in ES|QL mode', async () => {
+        await discover.setQueryMode('esql');
+        await common.navigateToApp('discover');
+        await discover.expectSourceViewerToExist();
+      });
+    });
+
+    describe('when the default query mode is classic', () => {
+      it('should open Discover in classic mode', async () => {
+        await discover.setQueryMode('classic');
+        await common.navigateToApp('discover');
+        await testSubjects.existOrFail('discover-dataView-switch-link');
+      });
+    });
+
+    describe('when the default query mode is unset', () => {
+      it('should open Discover in classic mode', async () => {
+        await discover.resetQueryMode();
+        await common.navigateToApp('discover');
+        await testSubjects.existOrFail('discover-dataView-switch-link');
+      });
+    });
+  });
+}

src/platform/test/functional/apps/discover/query_mode/_update_query_mode.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+import expect from '@kbn/expect';
+import type { FtrProviderContext } from '../ftr_provider_context';
+
+export default function ({ getPageObjects }: FtrProviderContext) {
+  const { discover, common } = getPageObjects(['discover', 'common']);
+
+  describe('Update query mode', () => {
+    afterEach(async () => {
+      await discover.resetQueryMode();
+    });
+
+    describe('when the user clicks ES|QL mode', () => {
+      it('should set the default mode to ES|QL', async () => {
+        await common.navigateToApp('discover');
+        await discover.selectTextBaseLang();
+        const queryMode = await discover.getQueryMode();
+        expect(queryMode).to.contain('esql');
+      });
+    });
+
+    describe('when the user clicks classic', () => {
+      it('should set the default mode to classic', async () => {
+        await common.navigateToApp('discover');
+        await discover.selectTextBaseLang();
+        await discover.selectDataViewMode();
+        const queryMode = await discover.getQueryMode();
+        expect(queryMode).to.contain('classic');
+      });
+    });
+  });
+}