[Vega] Filter bar in Vega is not usable with non default index pattern. (#84090) (#86476)

* [Vega] Filtering is not working

Closes: #81738

* fix CI

* some work

* some work

* add tests for extract_index_pattern

* simplify extract_index_pattern

* fix type error

* cleanup

* Update vega_base_view.js

* Update extract_index_pattern.test.ts

* fix PR comments

* fix some comments

* findByTitle -> getByTitle

* remove getByTitle

* fix vega_base_view

* fix jest

* allow to set multiple indexes from top_nav

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
# Conflicts:
#	src/plugins/vis_type_vega/public/vega_type.ts
#	src/plugins/vis_type_vega/public/vega_visualization.test.js
#	src/plugins/vis_type_vega/public/vega_visualization.ts

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

Author: alexwizp

src/plugins/data/common/index_patterns/utils.ts

@@ -17,8 +17,8 @@
  * under the License.
  */
 
-import { find } from 'lodash';
-import { SavedObjectsClientCommon, SavedObject } from '..';
+import type { IndexPatternSavedObjectAttrs } from './index_patterns';
+import type { SavedObjectsClientCommon } from '../types';
 
 /**
  * Returns an object matching a given title
@@ -27,24 +27,16 @@ import { SavedObjectsClientCommon, SavedObject } from '..';
  * @param title {string}
  * @returns {Promise<SavedObject|undefined>}
  */
-export async function findByTitle(
-  client: SavedObjectsClientCommon,
-  title: string
-): Promise<SavedObject<any> | void> {
-  if (!title) {
-    return Promise.resolve();
-  }
-
-  const savedObjects = await client.find({
-    type: 'index-pattern',
-    perPage: 10,
-    search: `"${title}"`,
-    searchFields: ['title'],
-    fields: ['title'],
-  });
+export async function findByTitle(client: SavedObjectsClientCommon, title: string) {
+  if (title) {
+    const savedObjects = await client.find<IndexPatternSavedObjectAttrs>({
+      type: 'index-pattern',
+      perPage: 10,
+      search: `"${title}"`,
+      searchFields: ['title'],
+      fields: ['title'],
+    });
 
-  return find(
-    savedObjects,
-    (obj: SavedObject<any>) => obj.attributes.title.toLowerCase() === title.toLowerCase()
-  );
+    return savedObjects.find((obj) => obj.attributes.title.toLowerCase() === title.toLowerCase());
+  }
 }

src/plugins/data/public/mocks.ts

@@ -64,6 +64,7 @@ const createStartContract = (): Start => {
       SearchBar: jest.fn().mockReturnValue(null),
     },
     indexPatterns: ({
+      find: jest.fn((search) => [{ id: search, title: search }]),
       createField: jest.fn(() => {}),
       createFieldList: jest.fn(() => []),
       ensureDefaultIndexPattern: jest.fn(),

src/plugins/vis_type_vega/public/data_model/es_query_parser.ts

@@ -226,6 +226,7 @@ export class EsQueryParser {
       const requestObject = requests.find((item) => getRequestName(item, index) === data.name);
 
       if (requestObject) {
+        requestObject.dataObject.url = requestObject.url;
         requestObject.dataObject.values = data.rawResponse;
       }
     });

src/plugins/vis_type_vega/public/data_model/types.ts

@@ -82,8 +82,9 @@ interface Projection {
   name: string;
 }
 
-interface RequestDataObject {
+interface RequestDataObject<TUrlData = UrlObject> {
   name?: string;
+  url?: TUrlData;
   values: SearchResponse<unknown>;
 }
 
@@ -186,7 +187,7 @@ export interface CacheBounds {
   max: number;
 }
 
-interface Requests<TUrlData = UrlObject, TRequestDataObject = RequestDataObject> {
+interface Requests<TUrlData = UrlObject, TRequestDataObject = RequestDataObject<TUrlData>> {
   url: TUrlData;
   name: string;
   dataObject: TRequestDataObject;

src/plugins/vis_type_vega/public/data_model/vega_parser.test.js

@@ -185,21 +185,21 @@ describe('VegaParser._resolveEsQueries', () => {
     'es',
     check(
       { data: { name: 'requestId', url: { index: 'a' }, x: 1 } },
-      { data: { name: 'requestId', values: [42], x: 1 } }
+      { data: { name: 'requestId', url: { index: 'a', body: {} }, values: [42], x: 1 } }
     )
   );
   test(
     'es 2',
     check(
       { data: { name: 'requestId', url: { '%type%': 'elasticsearch', index: 'a' } } },
-      { data: { name: 'requestId', values: [42] } }
+      { data: { name: 'requestId', url: { index: 'a', body: {} }, values: [42] } }
     )
   );
   test(
     'es arr',
     check(
       { arr: [{ data: { name: 'requestId', url: { index: 'a' }, x: 1 } }] },
-      { arr: [{ data: { name: 'requestId', values: [42], x: 1 } }] }
+      { arr: [{ data: { name: 'requestId', url: { index: 'a', body: {} }, values: [42], x: 1 } }] }
     )
   );
   test(

src/plugins/vis_type_vega/public/lib/extract_index_pattern.test.ts

@@ -0,0 +1,125 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { dataPluginMock } from '../../../data/public/mocks';
+import { extractIndexPatternsFromSpec } from './extract_index_pattern';
+import { setData } from '../services';
+
+import type { VegaSpec } from '../data_model/types';
+
+const getMockedSpec = (mockedObj: any) => (mockedObj as unknown) as VegaSpec;
+
+describe('extractIndexPatternsFromSpec', () => {
+  const dataStart = dataPluginMock.createStartContract();
+
+  beforeAll(() => {
+    setData(dataStart);
+  });
+
+  test('should not throw errors if no index is specified', async () => {
+    const spec = getMockedSpec({
+      data: {},
+    });
+
+    const indexes = await extractIndexPatternsFromSpec(spec);
+
+    expect(indexes).toMatchInlineSnapshot(`Array []`);
+  });
+
+  test('should extract single index pattern', async () => {
+    const spec = getMockedSpec({
+      data: {
+        url: {
+          index: 'test',
+        },
+      },
+    });
+
+    const indexes = await extractIndexPatternsFromSpec(spec);
+
+    expect(indexes).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "id": "test",
+          "title": "test",
+        },
+      ]
+    `);
+  });
+
+  test('should extract multiple index patterns', async () => {
+    const spec = getMockedSpec({
+      data: [
+        {
+          url: {
+            index: 'test1',
+          },
+        },
+        {
+          url: {
+            index: 'test2',
+          },
+        },
+      ],
+    });
+
+    const indexes = await extractIndexPatternsFromSpec(spec);
+
+    expect(indexes).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "id": "test1",
+          "title": "test1",
+        },
+        Object {
+          "id": "test2",
+          "title": "test2",
+        },
+      ]
+    `);
+  });
+
+  test('should filter empty values', async () => {
+    const spec = getMockedSpec({
+      data: [
+        {
+          url: {
+            wrong: 'wrong',
+          },
+        },
+        {
+          url: {
+            index: 'ok',
+          },
+        },
+      ],
+    });
+
+    const indexes = await extractIndexPatternsFromSpec(spec);
+
+    expect(indexes).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "id": "ok",
+          "title": "ok",
+        },
+      ]
+    `);
+  });
+});

src/plugins/vis_type_vega/public/lib/extract_index_pattern.ts

@@ -0,0 +1,47 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { flatten } from 'lodash';
+import { getData } from '../services';
+
+import type { Data, VegaSpec } from '../data_model/types';
+import type { IndexPattern } from '../../../data/public';
+
+export const extractIndexPatternsFromSpec = async (spec: VegaSpec) => {
+  const { indexPatterns } = getData();
+  let data: Data[] = [];
+
+  if (Array.isArray(spec.data)) {
+    data = spec.data;
+  } else if (spec.data) {
+    data = [spec.data];
+  }
+
+  return flatten<IndexPattern>(
+    await Promise.all(
+      data.reduce<Array<Promise<IndexPattern[]>>>((accumulator, currentValue) => {
+        if (currentValue.url?.index) {
+          accumulator.push(indexPatterns.find(currentValue.url.index));
+        }
+
+        return accumulator;
+      }, [])
+    )
+  );
+};

src/plugins/vis_type_vega/public/plugin.ts

@@ -25,7 +25,6 @@ import { Setup as InspectorSetup } from '../../inspector/public';
 import {
   setNotifications,
   setData,
-  setSavedObjects,
   setInjectedVars,
   setUISettings,
   setMapsLegacyConfig,
@@ -99,7 +98,6 @@ export class VegaPlugin implements Plugin<Promise<void>, void> {
 
   public start(core: CoreStart, { data }: VegaPluginStartDependencies) {
     setNotifications(core.notifications);
-    setSavedObjects(core.savedObjects);
     setData(data);
     setInjectedMetadata(core.injectedMetadata);
   }

src/plugins/vis_type_vega/public/services.ts

@@ -17,12 +17,7 @@
  * under the License.
  */
 
-import {
-  CoreStart,
-  SavedObjectsStart,
-  NotificationsStart,
-  IUiSettingsClient,
-} from 'src/core/public';
+import { CoreStart, NotificationsStart, IUiSettingsClient } from 'src/core/public';
 
 import { DataPublicPluginStart } from '../../data/public';
 import { createGetterSetter } from '../../kibana_utils/public';
@@ -40,10 +35,6 @@ export const [getInjectedMetadata, setInjectedMetadata] = createGetterSetter<
   CoreStart['injectedMetadata']
 >('InjectedMetadata');
 
-export const [getSavedObjects, setSavedObjects] = createGetterSetter<SavedObjectsStart>(
-  'SavedObjects'
-);
-
 export const [getInjectedVars, setInjectedVars] = createGetterSetter<{
   enableExternalUrls: boolean;
   emsTileLayerId: unknown;

src/plugins/vis_type_vega/public/vega_type.ts

@@ -18,11 +18,15 @@
  */
 
 import { i18n } from '@kbn/i18n';
+import { parse } from 'hjson';
 import { BaseVisTypeOptions } from 'src/plugins/visualizations/public';
 import { DefaultEditorSize } from '../../vis_default_editor/public';
 import { VegaVisualizationDependencies } from './plugin';
 import { VegaVisEditor } from './components';
 
+import type { VegaSpec } from './data_model/types';
+
+import { extractIndexPatternsFromSpec } from './lib/extract_index_pattern';
 import { createVegaRequestHandler } from './vega_request_handler';
 // @ts-expect-error
 import { createVegaVisualization } from './vega_visualization';
@@ -64,6 +68,16 @@ export const createVegaTypeDefinition = (
     getSupportedTriggers: () => {
       return [VIS_EVENT_TO_TRIGGER.applyFilter];
     },
+    getUsedIndexPattern: async (visParams) => {
+      try {
+        const spec = parse(visParams.spec, { legacyRoot: false, keepWsc: true });
+
+        return extractIndexPatternsFromSpec(spec as VegaSpec);
+      } catch (e) {
+        // spec is invalid
+      }
+      return [];
+    },
     inspectorAdapters: createInspectorAdapters,
   };
 };