[ML] Add embedded map to geo_point fields for Data Visualizer (#88880)

Author: qn895

x-pack/plugins/maps/public/embeddable/map_embeddable.tsx

@@ -68,7 +68,7 @@ import {
   MapEmbeddableInput,
   MapEmbeddableOutput,
 } from './types';
-export { MapEmbeddableInput };
+export { MapEmbeddableInput, MapEmbeddableOutput };
 
 export class MapEmbeddable
   extends Embeddable<MapEmbeddableInput, MapEmbeddableOutput>

x-pack/plugins/ml/kibana.json

@@ -24,7 +24,8 @@
     "security",
     "spaces",
     "management",
-    "licenseManagement"
+    "licenseManagement",
+    "maps"
   ],
   "server": true,
   "ui": true,
@@ -35,7 +36,8 @@
     "dashboard",
     "savedObjects",
     "home",
-    "spaces"
+    "spaces",
+    "maps"
   ],
   "extraPublicDirs": [
     "common"

x-pack/plugins/ml/public/application/_index.scss

@@ -30,6 +30,7 @@
   @import 'components/navigation_menu/index';
   @import 'components/rule_editor/index'; // SASSTODO: This file overwrites EUI directly
   @import 'components/stats_bar/index';
+  @import 'components/ml_embedded_map/index';
 
   // Hacks are last so they can overwrite anything above if needed
   @import 'hacks';

x-pack/plugins/ml/public/application/app.tsx

@@ -77,6 +77,8 @@ const App: FC<AppProps> = ({ coreStart, deps, appMountParams }) => {
     security: deps.security,
     licenseManagement: deps.licenseManagement,
     storage: localStorage,
+    embeddable: deps.embeddable,
+    maps: deps.maps,
     ...coreStart,
   };
 
@@ -118,6 +120,7 @@ export const renderApp = (
     http: coreStart.http,
     security: deps.security,
     urlGenerators: deps.share.urlGenerators,
+    maps: deps.maps,
   });
 
   appMountParams.onAppLeave((actions) => actions.default());

x-pack/plugins/ml/public/application/components/ml_embedded_map/_index.scss

@@ -0,0 +1 @@
+@import 'ml_embedded_map';

x-pack/plugins/ml/public/application/components/ml_embedded_map/_ml_embedded_map.scss

@@ -0,0 +1,8 @@
+.mlEmbeddedMapContent {
+  width: 100%;
+  height: 100%;
+  display: flex;
+  flex: 1 1 100%;
+  z-index: 1;
+  min-height: 0; // Absolute must for Firefox to scroll contents
+}

x-pack/plugins/ml/public/application/components/ml_embedded_map/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+export { MlEmbeddedMapComponent } from './ml_embedded_map';

x-pack/plugins/ml/public/application/components/ml_embedded_map/ml_embedded_map.tsx

@@ -0,0 +1,160 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import React, { useEffect, useRef, useState } from 'react';
+
+import { htmlIdGenerator } from '@elastic/eui';
+import { LayerDescriptor } from '../../../../../maps/common/descriptor_types';
+import {
+  MapEmbeddable,
+  MapEmbeddableInput,
+  MapEmbeddableOutput,
+  // eslint-disable-next-line @kbn/eslint/no-restricted-paths
+} from '../../../../../maps/public/embeddable';
+import { MAP_SAVED_OBJECT_TYPE, RenderTooltipContentParams } from '../../../../../maps/public';
+import {
+  EmbeddableFactory,
+  ErrorEmbeddable,
+  isErrorEmbeddable,
+  ViewMode,
+} from '../../../../../../../src/plugins/embeddable/public';
+import { useMlKibana } from '../../contexts/kibana';
+
+export function MlEmbeddedMapComponent({
+  layerList,
+  mapEmbeddableInput,
+  renderTooltipContent,
+}: {
+  layerList: LayerDescriptor[];
+  mapEmbeddableInput?: MapEmbeddableInput;
+  renderTooltipContent?: (params: RenderTooltipContentParams) => JSX.Element;
+}) {
+  const [embeddable, setEmbeddable] = useState<ErrorEmbeddable | MapEmbeddable | undefined>();
+
+  const embeddableRoot: React.RefObject<HTMLDivElement> = useRef<HTMLDivElement>(null);
+  const baseLayers = useRef<LayerDescriptor[]>();
+
+  const {
+    services: { embeddable: embeddablePlugin, maps: mapsPlugin },
+  } = useMlKibana();
+
+  const factory:
+    | EmbeddableFactory<MapEmbeddableInput, MapEmbeddableOutput, MapEmbeddable>
+    | undefined = embeddablePlugin
+    ? embeddablePlugin.getEmbeddableFactory(MAP_SAVED_OBJECT_TYPE)
+    : undefined;
+
+  // Update the layer list  with updated geo points upon refresh
+  useEffect(() => {
+    async function updateIndexPatternSearchLayer() {
+      if (
+        embeddable &&
+        !isErrorEmbeddable(embeddable) &&
+        Array.isArray(layerList) &&
+        Array.isArray(baseLayers.current)
+      ) {
+        embeddable.setLayerList([...baseLayers.current, ...layerList]);
+      }
+    }
+    updateIndexPatternSearchLayer();
+  }, [embeddable, layerList]);
+
+  useEffect(() => {
+    async function setupEmbeddable() {
+      if (!factory) {
+        // eslint-disable-next-line no-console
+        console.error('Map embeddable not found.');
+        return;
+      }
+      const input: MapEmbeddableInput = {
+        id: htmlIdGenerator()(),
+        attributes: { title: '' },
+        filters: [],
+        hidePanelTitles: true,
+        refreshConfig: {
+          value: 0,
+          pause: false,
+        },
+        viewMode: ViewMode.VIEW,
+        isLayerTOCOpen: false,
+        hideFilterActions: true,
+        // Zoom Lat/Lon values are set to make sure map is in center in the panel
+        // It will also omit Greenland/Antarctica etc. NOTE: Can be removed when initialLocation is set
+        mapCenter: {
+          lon: 11,
+          lat: 20,
+          zoom: 1,
+        },
+        // can use mapSettings to center map on anomalies
+        mapSettings: {
+          disableInteractive: false,
+          hideToolbarOverlay: false,
+          hideLayerControl: false,
+          hideViewControl: false,
+          // Doesn't currently work with GEO_JSON. Will uncomment when https://github.com/elastic/kibana/pull/88294 is in
+          // initialLocation: INITIAL_LOCATION.AUTO_FIT_TO_BOUNDS, // this will startup based on data-extent
+          autoFitToDataBounds: true, // this will auto-fit when there are changes to the filter and/or query
+        },
+      };
+
+      const embeddableObject = await factory.create(input);
+
+      if (embeddableObject && !isErrorEmbeddable(embeddableObject)) {
+        const basemapLayerDescriptor = mapsPlugin
+          ? await mapsPlugin.createLayerDescriptors.createBasemapLayerDescriptor()
+          : null;
+
+        if (basemapLayerDescriptor) {
+          baseLayers.current = [basemapLayerDescriptor];
+          await embeddableObject.setLayerList(baseLayers.current);
+        }
+      }
+
+      setEmbeddable(embeddableObject);
+    }
+
+    setupEmbeddable();
+    // we want this effect to execute exactly once after the component mounts
+  }, []);
+
+  useEffect(() => {
+    if (embeddable && !isErrorEmbeddable(embeddable) && mapEmbeddableInput !== undefined) {
+      embeddable.updateInput(mapEmbeddableInput);
+    }
+  }, [embeddable, mapEmbeddableInput]);
+
+  useEffect(() => {
+    if (embeddable && !isErrorEmbeddable(embeddable) && renderTooltipContent !== undefined) {
+      embeddable.setRenderTooltipContent(renderTooltipContent);
+    }
+  }, [embeddable, renderTooltipContent]);
+
+  // We can only render after embeddable has already initialized
+  useEffect(() => {
+    if (embeddableRoot.current && embeddable) {
+      embeddable.render(embeddableRoot.current);
+    }
+  }, [embeddable, embeddableRoot]);
+
+  if (!embeddablePlugin) {
+    // eslint-disable-next-line no-console
+    console.error('Embeddable start plugin not found');
+    return null;
+  }
+  if (!mapsPlugin) {
+    // eslint-disable-next-line no-console
+    console.error('Maps start plugin not found');
+    return null;
+  }
+
+  return (
+    <div
+      data-test-subj="mlEmbeddedMapContent"
+      className="mlEmbeddedMapContent"
+      ref={embeddableRoot}
+    />
+  );
+}

x-pack/plugins/ml/public/application/contexts/kibana/kibana_context.ts

@@ -15,12 +15,16 @@ import { LicenseManagementUIPluginSetup } from '../../../../../license_managemen
 import { SharePluginStart } from '../../../../../../../src/plugins/share/public';
 import { MlServicesContext } from '../../app';
 import { IStorageWrapper } from '../../../../../../../src/plugins/kibana_utils/public';
+import type { EmbeddableStart } from '../../../../../../../src/plugins/embeddable/public';
+import { MapsStartApi } from '../../../../../maps/public';
 
 interface StartPlugins {
   data: DataPublicPluginStart;
   security?: SecurityPluginSetup;
   licenseManagement?: LicenseManagementUIPluginSetup;
   share: SharePluginStart;
+  embeddable: EmbeddableStart;
+  maps?: MapsStartApi;
 }
 export type StartServices = CoreStart &
   StartPlugins & {

x-pack/plugins/ml/public/application/datavisualizer/file_based/components/expanded_row/file_based_expanded_row.tsx

@@ -8,13 +8,13 @@ import React from 'react';
 import {
   BooleanContent,
   DateContent,
-  GeoPointContent,
   IpContent,
   KeywordContent,
   OtherContent,
   TextContent,
   NumberContent,
 } from '../../../stats_table/components/field_data_expanded_row';
+import { GeoPointContent } from './geo_point_content/geo_point_content';
 import { ML_JOB_FIELD_TYPES } from '../../../../../../common/constants/field_types';
 import type { FileBasedFieldVisConfig } from '../../../stats_table/types/field_vis_config';