Improve SearchSource SearchRequest type

packages/kbn-discover-utils/src/__mocks__/data_view.ts

@@ -126,6 +126,7 @@ export const buildDataViewMock = ({
       return dataViewFields.find((field) => field.name === timeFieldName);
     },
     getRuntimeField: () => null,
+    getAllowHidden: () => false,
   } as unknown as DataView;
 
   dataView.isTimeBased = () => !!timeFieldName;

packages/kbn-generate-csv/src/lib/search_cursor_pit.ts

@@ -9,11 +9,7 @@
 import type { estypes } from '@elastic/elasticsearch';
 import type { Logger } from '@kbn/core/server';
 import { lastValueFrom } from 'rxjs';
-import {
-  ES_SEARCH_STRATEGY,
-  type ISearchSource,
-  type SearchRequest,
-} from '@kbn/data-plugin/common';
+import { ES_SEARCH_STRATEGY, type ISearchSource } from '@kbn/data-plugin/common';
 import { SearchCursor, type SearchCursorClients, type SearchCursorSettings } from './search_cursor';
 import { i18nTexts } from './i18n_texts';
 
@@ -74,7 +70,7 @@ export class SearchCursorPit extends SearchCursor {
     return pitId;
   }
 
-  protected async searchWithPit(searchBody: SearchRequest) {
+  protected async searchWithPit(searchBody: estypes.SearchRequest) {
     const { maxConcurrentShardRequests, scroll, taskInstanceFields } = this.settings;
 
     // maxConcurrentShardRequests=0 is not supported

packages/kbn-generate-csv/src/lib/search_cursor_scroll.ts

@@ -10,11 +10,7 @@ import type { estypes } from '@elastic/elasticsearch';
 import { lastValueFrom } from 'rxjs';
 import type { Logger } from '@kbn/core/server';
 import type { IEsSearchResponse } from '@kbn/search-types';
-import {
-  ES_SEARCH_STRATEGY,
-  type ISearchSource,
-  type SearchRequest,
-} from '@kbn/data-plugin/common';
+import { ES_SEARCH_STRATEGY, type ISearchSource } from '@kbn/data-plugin/common';
 import { SearchCursor, type SearchCursorClients, type SearchCursorSettings } from './search_cursor';
 import { i18nTexts } from './i18n_texts';
 
@@ -32,7 +28,7 @@ export class SearchCursorScroll extends SearchCursor {
   // The first search query begins the scroll context in ES
   public async initialize() {}
 
-  private async scan(searchBody: SearchRequest) {
+  private async scan(searchBody: estypes.SearchRequest) {
     const { includeFrozen, maxConcurrentShardRequests, scroll, taskInstanceFields } = this.settings;
 
     // maxConcurrentShardRequests=0 is not supported

src/plugins/controls/server/options_list/options_list_suggestions_route.ts

@@ -10,10 +10,10 @@ import { Observable } from 'rxjs';
 
 import { schema } from '@kbn/config-schema';
 import { CoreSetup, ElasticsearchClient } from '@kbn/core/server';
-import { SearchRequest } from '@kbn/data-plugin/common';
 import { getKbnServerError, reportServerError } from '@kbn/kibana-utils-plugin/server';
 import { PluginSetup as UnifiedSearchPluginSetup } from '@kbn/unified-search-plugin/server';
 
+import type { SearchRequest } from '@elastic/elasticsearch/lib/api/typesWithBodyKey';
 import { OptionsListRequestBody, OptionsListResponse } from '../../common/options_list/types';
 import { getValidationAggregationBuilder } from './options_list_validation_queries';
 import { getSuggestionAggregationBuilder } from './suggestion_queries';

src/plugins/data/common/search/search_source/fetch/get_search_params.ts

@@ -37,12 +37,15 @@ export function getSearchParamsFromRequest(
   const searchParams = getSearchParams(getConfig);
   // eslint-disable-next-line @typescript-eslint/naming-convention
   const { track_total_hits, ...body } = searchRequest.body;
+  const dataView = typeof searchRequest.index !== 'string' ? searchRequest.index : undefined;
+  const index = dataView?.title ?? `${searchRequest.index}`;
 
   return {
-    index: searchRequest.index.title || searchRequest.index,
+    index,
     body,
+    // @ts-ignore
     track_total_hits,
-    ...(searchRequest.index?.allowHidden && { expand_wildcards: 'all' }),
+    ...(dataView?.getAllowHidden() && { expand_wildcards: 'all' }),
     ...searchParams,
   };
 }

src/plugins/data/common/search/search_source/fetch/types.ts

@@ -6,6 +6,8 @@
  * Side Public License, v 1.
  */
 import type { IKibanaSearchResponse } from '@kbn/search-types';
+import type { DataView } from '@kbn/data-views-plugin/common';
+import type { AggregateQuery, Filter, Query } from '@kbn/es-query';
 import { SearchSourceSearchOptions } from '../../..';
 import { GetConfigFn } from '../../../types';
 
@@ -17,7 +19,11 @@ import { GetConfigFn } from '../../../types';
  * where `ISearchRequestParams` is used externally instead.
  * FIXME: replace with estypes.SearchRequest?
  */
-export type SearchRequest = Record<string, any>;
+export type SearchRequest<T extends Record<string, any> = Record<string, any>> = {
+  index?: DataView | string;
+  query?: Array<Query | AggregateQuery>;
+  filters?: Filter[] | (() => Filter[]);
+} & Omit<T, 'index' | 'query' | 'filters'>;
 
 export interface FetchHandlers {
   getConfig: GetConfigFn;

src/plugins/data/common/search/search_source/query_to_fields.ts

@@ -7,7 +7,7 @@
  */
 
 import { DataViewLazy } from '@kbn/data-views-plugin/common';
-import { fromKueryExpression, getKqlFieldNames } from '@kbn/es-query';
+import { fromKueryExpression, getKqlFieldNames, isFilter, isOfQueryType } from '@kbn/es-query';
 import type { SearchRequest } from './fetch';
 import { EsQuerySortValue } from '../..';
 
@@ -25,23 +25,20 @@ export async function queryToFields({
     const sortArr = Array.isArray(sort) ? sort : [sort];
     fields.push(...sortArr.flatMap((s) => Object.keys(s)));
   }
-  for (const query of request.query) {
+  for (const query of (request.query ?? []).filter(isOfQueryType)) {
     if (query.query && query.language === 'kuery') {
       const nodes = fromKueryExpression(query.query);
       const queryFields = getKqlFieldNames(nodes);
       fields = fields.concat(queryFields);
     }
   }
-  const filters = request.filters;
-  if (filters) {
-    const filtersArr = Array.isArray(filters) ? filters : [filters];
-    for (const f of filtersArr) {
-      // unified search bar filters have meta object and key (regular filters)
-      // unified search bar "custom" filters ("Edit as query DSL", where meta.key is not present but meta is)
-      // Any other Elasticsearch query DSL filter that gets passed in by consumers (not coming from unified search, and these probably won't have a meta key at all)
-      if (f?.meta?.key && f.meta.disabled !== true) {
-        fields.push(f.meta.key);
-      }
+  const { filters = [] } = request;
+  for (const f of typeof filters === 'function' ? filters() : filters) {
+    // unified search bar filters have meta object and key (regular filters)
+    // unified search bar "custom" filters ("Edit as query DSL", where meta.key is not present but meta is)
+    // Any other Elasticsearch query DSL filter that gets passed in by consumers (not coming from unified search, and these probably won't have a meta key at all)
+    if (isFilter(f) && f?.meta?.key && f.meta.disabled !== true) {
+      fields.push(f.meta.key);
     }
   }
 

src/plugins/data/common/search/search_source/search_source.test.ts

@@ -36,12 +36,14 @@ const indexPattern = {
   fields: [{ name: 'foo-bar' }, { name: 'field1' }, { name: 'field2' }, { name: '_id' }],
   getComputedFields,
   getSourceFiltering: () => mockSource,
+  getAllowHidden: jest.fn(),
 } as unknown as DataView;
 
 const indexPattern2 = {
   title: 'foo',
   getComputedFields,
   getSourceFiltering: () => mockSource2,
+  getAllowHidden: jest.fn(),
 } as unknown as DataView;
 
 const fields3 = [{ name: 'foo-bar' }, { name: 'field1' }, { name: 'field2' }];
@@ -1474,10 +1476,15 @@ describe('SearchSource', () => {
       return buildExpression(ast).toString();
     }
 
+    beforeEach(() => {
+      searchSource = new SearchSource({}, searchSourceDependencies);
+      searchSource.setField('index', indexPattern);
+    });
+
     test('should generate an expression AST', () => {
       expect(toString(searchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context
-        | esdsl dsl=\\"{}\\""
+        | esdsl dsl=\\"{}\\" index=\\"1234\\""
       `);
     });
 
@@ -1486,7 +1493,7 @@ describe('SearchSource', () => {
 
       expect(toString(searchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context q={kql q=\\"something\\"}
-        | esdsl dsl=\\"{}\\""
+        | esdsl dsl=\\"{}\\" index=\\"1234\\""
       `);
     });
 
@@ -1504,7 +1511,7 @@ describe('SearchSource', () => {
       expect(toString(searchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context filters={kibanaFilter query=\\"{\\\\\\"query_string\\\\\\":{\\\\\\"query\\\\\\":\\\\\\"query1\\\\\\"}}\\"}
           filters={kibanaFilter query=\\"{\\\\\\"query_string\\\\\\":{\\\\\\"query\\\\\\":\\\\\\"query2\\\\\\"}}\\"}
-        | esdsl dsl=\\"{}\\""
+        | esdsl dsl=\\"{}\\" index=\\"1234\\""
       `);
     });
 
@@ -1517,7 +1524,7 @@ describe('SearchSource', () => {
 
       expect(toString(searchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context filters={kibanaFilter query=\\"{\\\\\\"query_string\\\\\\":{\\\\\\"query\\\\\\":\\\\\\"query\\\\\\"}}\\"}
-        | esdsl dsl=\\"{}\\""
+        | esdsl dsl=\\"{}\\" index=\\"1234\\""
       `);
     });
 
@@ -1540,7 +1547,7 @@ describe('SearchSource', () => {
       expect(toString(childSearchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context q={kql q=\\"something2\\"} q={kql q=\\"something1\\"} filters={kibanaFilter query=\\"{\\\\\\"query_string\\\\\\":{\\\\\\"query\\\\\\":\\\\\\"query2\\\\\\"}}\\"}
           filters={kibanaFilter query=\\"{\\\\\\"query_string\\\\\\":{\\\\\\"query\\\\\\":\\\\\\"query1\\\\\\"}}\\"}
-        | esdsl dsl=\\"{}\\""
+        | esdsl dsl=\\"{}\\" index=\\"1234\\""
       `);
     });
 
@@ -1558,7 +1565,7 @@ describe('SearchSource', () => {
 
       expect(toString(searchSource.toExpressionAst())).toMatchInlineSnapshot(`
         "kibana_context
-        | esdsl size=1000 dsl=\\"{}\\""
+        | esdsl size=1000 dsl=\\"{}\\" index=\\"1234\\""
       `);
     });