Add handling for saved map loading. First pass, functionality to be verified

Author: Aaron Caldwell

x-pack/plugins/maps/kibana.json

@@ -29,7 +29,8 @@
     "savedObjectsTagging",
     "charts",
     "security",
-    "usageCollection"
+    "usageCollection",
+    "spaces"
   ],
   "ui": true,
   "server": true,

x-pack/plugins/maps/public/embeddable/types.ts

@@ -22,6 +22,7 @@ export interface MapEmbeddableConfig {
 }
 
 interface MapEmbeddableState {
+  savedObjectId?: string;
   isLayerTOCOpen?: boolean;
   openTOCDetails?: string[];
   mapCenter?: MapCenterAndZoom;

x-pack/plugins/maps/public/lazy_load_bundle/index.ts

@@ -7,7 +7,7 @@
 
 // eslint-disable-next-line @kbn/eslint/no-restricted-paths
 import { IndexPatternsContract } from 'src/plugins/data/public/index_patterns';
-import { AppMountParameters } from 'kibana/public';
+import { AppMountParameters, HttpStart } from 'kibana/public';
 import { IContainer } from '../../../../../src/plugins/embeddable/public';
 import { LayerDescriptor } from '../../common/descriptor_types';
 import type {
@@ -21,6 +21,7 @@ import type { CreateLayerDescriptorParams } from '../classes/sources/es_search_s
 import type { EMSTermJoinConfig, SampleValuesConfig } from '../ems_autosuggest';
 import type { CreateTileMapLayerDescriptorParams } from '../classes/layers/create_tile_map_layer_descriptor';
 import type { CreateRegionMapLayerDescriptorParams } from '../classes/layers/create_region_map_layer_descriptor';
+import { SpacesPluginStart } from '../../../spaces/public';
 
 let loadModulesPromise: Promise<LazyLoadedMapModules>;
 
@@ -32,7 +33,12 @@ export interface LazyLoadedMapModules {
   ) => MapEmbeddableType;
   getIndexPatternService: () => IndexPatternsContract;
   getMapsCapabilities: () => any;
-  renderApp: (params: AppMountParameters, AppUsageTracker: React.FC) => Promise<() => void>;
+  renderApp: (
+    params: AppMountParameters,
+    AppUsageTracker: React.FC,
+    http: HttpStart,
+    spacesApi?: SpacesPluginStart
+  ) => Promise<() => void>;
   createSecurityLayerDescriptors: (
     indexPatternId: string,
     indexPatternTitle: string

x-pack/plugins/maps/public/map_attribute_service.ts

@@ -6,6 +6,7 @@
  */
 
 import { SavedObjectReference } from 'src/core/types';
+import { ResolvedSimpleSavedObject } from 'kibana/public';
 import { AttributeService } from '../../../../src/plugins/embeddable/public';
 import { MapSavedObjectAttributes } from '../common/map_saved_object_type';
 import { MAP_SAVED_OBJECT_TYPE } from '../common/constants';
@@ -15,11 +16,38 @@ import { getCoreOverlays, getEmbeddableService, getSavedObjectsClient } from './
 import { extractReferences, injectReferences } from '../common/migrations/references';
 import { MapByValueInput, MapByReferenceInput } from './embeddable/types';
 
-type MapDoc = MapSavedObjectAttributes & { references?: SavedObjectReference[] };
+type MapDoc = MapSavedObjectAttributes & {
+  references?: SavedObjectReference[];
+};
 
 export type MapAttributeService = AttributeService<MapDoc, MapByValueInput, MapByReferenceInput>;
 
 let mapAttributeService: MapAttributeService | null = null;
+let resolveResult: ResolvedSimpleSavedObject<MapSavedObjectAttributes> | undefined;
+export async function resolveSavedObject(
+  savedObjectId: string
+): Promise<{
+  mapDoc: MapDoc;
+  resolvedSavedObject: ResolvedSimpleSavedObject<MapSavedObjectAttributes>;
+}> {
+  if (!resolveResult || resolveResult.saved_object.id !== savedObjectId) {
+    resolveResult = await getSavedObjectsClient().resolve<MapSavedObjectAttributes>(
+      MAP_SAVED_OBJECT_TYPE,
+      savedObjectId
+    );
+  }
+  const savedObject = resolveResult.saved_object;
+
+  if (savedObject.error) {
+    throw savedObject.error;
+  }
+
+  const { attributes } = injectReferences(savedObject);
+  return {
+    mapDoc: { ...attributes, references: savedObject.references },
+    resolvedSavedObject: resolveResult,
+  };
+}
 
 export function getMapAttributeService(): MapAttributeService {
   if (mapAttributeService) {
@@ -58,17 +86,8 @@ export function getMapAttributeService(): MapAttributeService {
       return { id: savedObject.id };
     },
     unwrapMethod: async (savedObjectId: string): Promise<MapDoc> => {
-      const savedObject = await getSavedObjectsClient().get<MapSavedObjectAttributes>(
-        MAP_SAVED_OBJECT_TYPE,
-        savedObjectId
-      );
-
-      if (savedObject.error) {
-        throw savedObject.error;
-      }
-
-      const { attributes } = injectReferences(savedObject);
-      return { ...attributes, references: savedObject.references };
+      const { mapDoc } = await resolveSavedObject(savedObjectId);
+      return mapDoc;
     },
     checkForDuplicateTitle: (props: OnSaveProps) => {
       return checkForDuplicateTitle(

x-pack/plugins/maps/public/plugin.ts

@@ -83,6 +83,7 @@ import {
   tileMapVisType,
 } from './legacy_visualizations';
 import { SecurityPluginStart } from '../../security/public';
+import { SpacesPluginStart } from '../../spaces/public';
 
 export interface MapsPluginSetupDependencies {
   expressions: ReturnType<ExpressionsPublicPlugin['setup']>;
@@ -112,6 +113,7 @@ export interface MapsPluginStartDependencies {
   savedObjectsTagging?: SavedObjectTaggingPluginStart;
   presentationUtil: PresentationUtilPluginStart;
   security: SecurityPluginStart;
+  spaces?: SpacesPluginStart;
 }
 
 /**
@@ -179,10 +181,13 @@ export class MapsPlugin
       euiIconType: APP_ICON_SOLUTION,
       category: DEFAULT_APP_CATEGORIES.kibana,
       async mount(params: AppMountParameters) {
+        const [coreStart, pluginsStart] = await core.getStartServices();
+        const { http } = coreStart;
+        const { spaces: spacesApi } = pluginsStart as MapsPluginStartDependencies;
         const UsageTracker =
           plugins.usageCollection?.components.ApplicationUsageTrackingProvider ?? React.Fragment;
         const { renderApp } = await lazyLoadMapModules();
-        return renderApp(params, UsageTracker);
+        return renderApp(params, UsageTracker, http, spacesApi);
       },
     });
 

x-pack/plugins/maps/public/render_app.tsx

@@ -9,7 +9,7 @@ import React from 'react';
 import { render, unmountComponentAtNode } from 'react-dom';
 import { Router, Switch, Route, Redirect, RouteComponentProps } from 'react-router-dom';
 import { i18n } from '@kbn/i18n';
-import { AppMountParameters } from 'kibana/public';
+import { AppMountParameters, HttpStart } from 'kibana/public';
 import {
   getCoreChrome,
   getCoreI18n,
@@ -26,6 +26,7 @@ import {
 import { ListPage, MapPage } from './routes';
 import { MapByValueInput, MapByReferenceInput } from './embeddable/types';
 import { APP_ID } from '../common/constants';
+import { SpacesPluginStart } from '../../spaces/public';
 
 export let goToSpecifiedPath: (path: string) => void;
 export let kbnUrlStateStorage: IKbnUrlStateStorage;
@@ -63,7 +64,9 @@ function setAppChrome() {
 
 export async function renderApp(
   { element, history, onAppLeave, setHeaderActionMenu }: AppMountParameters,
-  AppUsageTracker: React.FC
+  AppUsageTracker: React.FC,
+  http: HttpStart,
+  spacesApi?: SpacesPluginStart
 ) {
   goToSpecifiedPath = (path) => history.push(path);
   kbnUrlStateStorage = createKbnUrlStateStorage({
@@ -98,6 +101,8 @@ export async function renderApp(
         setHeaderActionMenu={setHeaderActionMenu}
         stateTransfer={stateTransfer}
         originatingApp={originatingApp}
+        spacesApi={spacesApi}
+        http={http}
       />
     );
   }

x-pack/plugins/maps/public/routes/map_page/map_app/map_app.tsx

@@ -8,8 +8,9 @@
 import React from 'react';
 import _ from 'lodash';
 import { finalize, switchMap, tap } from 'rxjs/operators';
+import { EuiSpacer } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
-import { AppLeaveAction, AppMountParameters } from 'kibana/public';
+import { AppLeaveAction, AppMountParameters, HttpStart } from 'kibana/public';
 import { Adapters } from 'src/plugins/embeddable/public';
 import { Subscription } from 'rxjs';
 import {
@@ -54,13 +55,17 @@ import {
   unsavedChangesWarning,
 } from '../saved_map';
 import { waitUntilTimeLayersLoad$ } from './wait_until_time_layers_load';
+import { SpacesPluginStart } from '../../../../../spaces/public';
+import { resolveSavedObject } from '../../../map_attribute_service';
 
 interface MapRefreshConfig {
   isPaused: boolean;
   interval: number;
 }
 
 export interface Props {
+  spacesApi?: SpacesPluginStart;
+  http: HttpStart;
   savedMap: SavedMap;
   // saveCounter used to trigger MapApp render after SaveMap.save
   saveCounter: number;
@@ -97,6 +102,7 @@ export interface State {
   savedQuery?: SavedQuery;
   isRefreshPaused: boolean;
   refreshInterval: number;
+  savedObjectWarning: unknown;
 }
 
 export class MapApp extends React.Component<Props, State> {
@@ -115,6 +121,7 @@ export class MapApp extends React.Component<Props, State> {
       initialized: false,
       isRefreshPaused: true,
       refreshInterval: 0,
+      savedObjectWarning: null,
     };
   }
 
@@ -363,6 +370,7 @@ export class MapApp extends React.Component<Props, State> {
     }
 
     this._initMapAndLayerSettings(this.props.savedMap.getAttributes());
+    await this.getLegacyUrlConflictCallout(savedObjectId);
 
     this.setState({ initialized: true });
   }
@@ -434,6 +442,41 @@ export class MapApp extends React.Component<Props, State> {
     );
   }
 
+  async getLegacyUrlConflictCallout(savedObjectId: string | undefined) {
+    if (!savedObjectId) {
+      return;
+    }
+    await this.props.savedMap.whenReady();
+    const { resolvedSavedObject } = await resolveSavedObject(savedObjectId);
+    // This function returns a callout component *if* we have encountered a "legacy URL conflict" scenario
+    if (this.props.spacesApi && resolvedSavedObject) {
+      if (resolvedSavedObject.outcome === 'conflict') {
+        // We have resolved to one object, but another object has a legacy URL alias associated with this ID/page. We should display a
+        // callout with a warning for the user, and provide a way for them to navigate to the other object.
+        const currentObjectId = resolvedSavedObject.saved_object.id;
+        const otherObjectId = resolvedSavedObject.alias_target_id!; // This is always defined if outcome === 'conflict'
+        // const otherObjectPath = this.props.http.basePath.prepend(
+        //   `${VIEW_NOTE_PATH}/${otherObjectId}${window.location.hash}`
+        // );
+        const otherObjectPath = window.location.href.replace(currentObjectId, otherObjectId);
+        console.log(this.props.http.basePath);
+        this.setState({
+          savedObjectWarning: (
+            <>
+              {this.props.spacesApi.ui.components.getLegacyUrlConflict({
+                objectNoun: 'Saved map',
+                currentObjectId,
+                otherObjectId,
+                otherObjectPath,
+              })}
+              <EuiSpacer />
+            </>
+          ),
+        });
+      }
+    }
+  }
+
   _addFilter = async (newFilters: Filter[]) => {
     newFilters.forEach((filter) => {
       filter.$state = { store: esFilters.FilterStateStore.APP_STATE };
@@ -451,6 +494,7 @@ export class MapApp extends React.Component<Props, State> {
         {this._renderTopNav()}
         <h1 className="euiScreenReaderOnly">{`screenTitle placeholder`}</h1>
         <div id="react-maps-root">
+          {this.state.savedObjectWarning}
           <MapContainer
             addFilters={this._addFilter}
             title={this.props.savedMap.getAttributes().title}

x-pack/plugins/maps/public/routes/map_page/map_page.tsx

@@ -7,11 +7,13 @@
 
 import React, { Component } from 'react';
 import { Provider } from 'react-redux';
-import { AppMountParameters } from 'kibana/public';
+import { AppMountParameters, HttpStart } from 'kibana/public';
 import { EmbeddableStateTransfer } from 'src/plugins/embeddable/public';
 import { MapApp } from './map_app';
 import { SavedMap, getInitialLayersFromUrlParam } from './saved_map';
 import { MapEmbeddableInput } from '../../embeddable/types';
+import { SpacesPluginStart } from '../../../../spaces/public';
+import { resolveSavedObject } from '../../map_attribute_service';
 
 interface Props {
   mapEmbeddableInput?: MapEmbeddableInput;
@@ -20,6 +22,8 @@ interface Props {
   setHeaderActionMenu: AppMountParameters['setHeaderActionMenu'];
   stateTransfer: EmbeddableStateTransfer;
   originatingApp?: string;
+  spacesApi?: SpacesPluginStart;
+  http: HttpStart;
 }
 
 interface State {
@@ -69,6 +73,8 @@ export class MapPage extends Component<Props, State> {
     return (
       <Provider store={this.state.savedMap.getStore()}>
         <MapApp
+          spacesApi={this.props.spacesApi}
+          http={this.props.http}
           savedMap={this.state.savedMap}
           onAppLeave={this.props.onAppLeave}
           setHeaderActionMenu={this.props.setHeaderActionMenu}

x-pack/plugins/maps/tsconfig.json

@@ -36,6 +36,7 @@
     { "path": "../licensing/tsconfig.json" },
     { "path": "../file_upload/tsconfig.json" },
     { "path": "../saved_objects_tagging/tsconfig.json" },
-    { "path": "../security/tsconfig.json" }
+    { "path": "../security/tsconfig.json" },
+    { "path": "../spaces/tsconfig.json" }
   ]
 }