Dynamic actions to xpack (#62647)

* feat: 🎸 set up sample action factory provider * feat: 🎸 create dashboard_enhanced plugin * feat: 🎸 add EnhancedEmbeddable interface * refactor: 💡 move DynamicActionManager to x-pack * feat: 🎸 connect dynamic action manager to embeddable life-cycle * test: 💍 fix Jest tests after refactor * fix: 🐛 fix type error Co-authored-by: Elastic Machine <[email protected]>
elastic · Apr 9, 2020 · 57ddccf · 57ddccf
1 parent c2ea2e3
commit 57ddccf
Show file tree

Hide file tree

Showing 34 changed files with 524 additions and 315 deletions.
diff --git a/src/plugins/embeddable/public/index.ts b/src/plugins/embeddable/public/index.ts
@@ -23,23 +23,24 @@ import { PluginInitializerContext } from 'src/core/public';
 import { EmbeddablePublicPlugin } from './plugin';
 
 export {
-  Adapters,
   ACTION_ADD_PANEL,
-  AddPanelAction,
   ACTION_APPLY_FILTER,
+  ACTION_EDIT_PANEL,
+  Adapters,
+  AddPanelAction,
   Container,
   ContainerInput,
   ContainerOutput,
   CONTEXT_MENU_TRIGGER,
   contextMenuTrigger,
-  ACTION_EDIT_PANEL,
+  defaultEmbeddableFactoryProvider,
   EditPanelAction,
   Embeddable,
   EmbeddableChildPanel,
   EmbeddableChildPanelProps,
   EmbeddableContext,
-  EmbeddableFactoryDefinition,
   EmbeddableFactory,
+  EmbeddableFactoryDefinition,
   EmbeddableFactoryNotFoundError,
   EmbeddableFactoryRenderer,
   EmbeddableInput,

diff --git a/src/plugins/embeddable/public/lib/embeddables/embeddable.tsx b/src/plugins/embeddable/public/lib/embeddables/embeddable.tsx
@@ -22,12 +22,7 @@ import { Adapters, ViewMode } from '../types';
 import { IContainer } from '../containers';
 import { EmbeddableInput, EmbeddableOutput, IEmbeddable } from './i_embeddable';
 import { TriggerContextMapping } from '../ui_actions';
-import { EmbeddableActionStorage } from './embeddable_action_storage';
-import {
-  UiActionsDynamicActionManager,
-  UiActionsStart,
-} from '../../../../../plugins/ui_actions/public';
-import { EmbeddableContext } from '../triggers';
+import { UiActionsStart } from '../../../../../plugins/ui_actions/public';
 
 function getPanelTitle(input: EmbeddableInput, output: EmbeddableOutput) {
   return input.hidePanelTitles ? '' : input.title === undefined ? output.defaultTitle : input.title;
@@ -60,28 +55,9 @@ export abstract class Embeddable<
   // to update input when the parent changes.
   private parentSubscription?: Rx.Subscription;
 
-  private storageSubscription?: Rx.Subscription;
-
   // TODO: Rename to destroyed.
   private destoyed: boolean = false;
 
-  private storage = new EmbeddableActionStorage((this as unknown) as Embeddable);
-
-  private cachedDynamicActions?: UiActionsDynamicActionManager;
-  public get dynamicActions(): UiActionsDynamicActionManager | undefined {
-    if (!this.params.uiActions) return undefined;
-    if (!this.cachedDynamicActions) {
-      this.cachedDynamicActions = new UiActionsDynamicActionManager({
-        isCompatible: async (context: unknown) =>
-          (context as EmbeddableContext).embeddable.runtimeId === this.runtimeId,
-        storage: this.storage,
-        uiActions: this.params.uiActions,
-      });
-    }
-
-    return this.cachedDynamicActions;
-  }
-
   constructor(
     input: TEmbeddableInput,
     output: TEmbeddableOutput,
@@ -111,18 +87,6 @@ export abstract class Embeddable<
         this.onResetInput(newInput);
       });
     }
-
-    if (this.dynamicActions) {
-      this.dynamicActions.start().catch(error => {
-        /* eslint-disable */
-        console.log('Failed to start embeddable dynamic actions', this);
-        console.error(error);
-        /* eslint-enable */
-      });
-      this.storageSubscription = this.input$.subscribe(() => {
-        this.storage.reload$.next();
-      });
-    }
   }
 
   public getIsContainer(): this is IContainer {
@@ -202,19 +166,6 @@ export abstract class Embeddable<
   public destroy(): void {
     this.destoyed = true;
 
-    if (this.dynamicActions) {
-      this.dynamicActions.stop().catch(error => {
-        /* eslint-disable */
-        console.log('Failed to stop embeddable dynamic actions', this);
-        console.error(error);
-        /* eslint-enable */
-      });
-    }
-
-    if (this.storageSubscription) {
-      this.storageSubscription.unsubscribe();
-    }
-
     this.input$.complete();
     this.output$.complete();
 

diff --git a/src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts b/src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts
@@ -18,7 +18,6 @@
  */
 
 import { Observable } from 'rxjs';
-import { UiActionsDynamicActionManager } from '../../../../../plugins/ui_actions/public';
 import { Adapters } from '../types';
 import { IContainer } from '../containers/i_container';
 import { ViewMode } from '../types';
@@ -92,9 +91,9 @@ export interface IEmbeddable<
   readonly runtimeId?: number;
 
   /**
-   * Default implementation of dynamic action API for embeddables.
+   * Extra abilities added to Embeddable by `*_enhanced` plugins.
    */
-  dynamicActions?: UiActionsDynamicActionManager;
+  enhancements?: object;
 
   /**
    * A functional representation of the isContainer variable, but helpful for typescript to

diff --git a/src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx b/src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx
@@ -203,13 +203,15 @@ export class EmbeddablePanel extends React.Component<Props, State> {
       this.props.embeddable.render(this.embeddableRoot.current);
     }
 
-    const dynamicActions = this.props.embeddable.dynamicActions;
+    const dynamicActions = (this.props.embeddable.enhancements as any)?.dynamicActions;
     if (dynamicActions) {
       this.setState({ eventCount: dynamicActions.state.get().events.length });
-      this.eventCountSubscription = dynamicActions.state.state$.subscribe(({ events }) => {
-        if (!this.mounted) return;
-        this.setState({ eventCount: events.length });
-      });
+      this.eventCountSubscription = dynamicActions.state.state$.subscribe(
+        ({ events }: { events: unknown[] }) => {
+          if (!this.mounted) return;
+          this.setState({ eventCount: events.length });
+        }
+      );
     }
   }
 

diff --git a/src/plugins/ui_actions/public/actions/index.ts b/src/plugins/ui_actions/public/actions/index.ts
@@ -23,6 +23,4 @@ export * from './action_factory_definition';
 export * from './action_factory';
 export * from './create_action';
 export * from './incompatible_action_error';
-export * from './dynamic_action_storage';
-export * from './dynamic_action_manager';
 export * from './types';
diff --git a/src/plugins/ui_actions/public/actions/types.ts b/src/plugins/ui_actions/public/actions/types.ts
@@ -22,3 +22,9 @@ export interface SerializedAction<Config> {
   readonly name: string;
   readonly config: Config;
 }
+
+export interface SerializedEvent {
+  eventId: string;
+  triggers: string[];
+  action: SerializedAction<unknown>;
+}
diff --git a/src/plugins/ui_actions/public/index.ts b/src/plugins/ui_actions/public/index.ts
@@ -31,11 +31,7 @@ export {
   ActionDefinition as UiActionsActionDefinition,
   ActionFactoryDefinition as UiActionsActionFactoryDefinition,
   ActionInternal as UiActionsActionInternal,
-  ActionStorage as UiActionsActionStorage,
-  AbstractActionStorage as UiActionsAbstractActionStorage,
   createAction,
-  DynamicActionManager,
-  DynamicActionManagerState,
   IncompatibleActionError,
   SerializedAction as UiActionsSerializedAction,
   SerializedEvent as UiActionsSerializedEvent,
@@ -57,4 +53,4 @@ export {
   applyFilterTrigger,
 } from './triggers';
 export { TriggerContextMapping, TriggerId, ActionContextMapping, ActionType } from './types';
-export { ActionByType, DynamicActionManager as UiActionsDynamicActionManager } from './actions';
+export { ActionByType } from './actions';
diff --git a/...ic/actions/dynamic_action_manager.test.ts → ...ic_actions/dynamic_action_manager.test.ts b/...ic/actions/dynamic_action_manager.test.ts → ...ic_actions/dynamic_action_manager.test.ts
@@ -1,29 +1,18 @@
 /*
- * 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.
+ * 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 { DynamicActionManager } from './dynamic_action_manager';
 import { ActionStorage, MemoryActionStorage, SerializedEvent } from './dynamic_action_storage';
-import { UiActionsService } from '../service';
-import { ActionFactoryDefinition } from './action_factory_definition';
-import { ActionRegistry } from '../types';
-import { SerializedAction } from './types';
-import { of } from '../../../kibana_utils';
+import {
+  UiActionsService,
+  UiActionsActionFactoryDefinition as ActionFactoryDefinition,
+  UiActionsSerializedAction as SerializedAction,
+  UiActionsActionInternal as ActionInternal,
+} from '../../../../../src/plugins/ui_actions/public';
+import { of } from '../../../../../src/plugins/kibana_utils';
 
 const actionFactoryDefinition1: ActionFactoryDefinition = {
   id: 'ACTION_FACTORY_1',
@@ -82,7 +71,7 @@ const event3: SerializedEvent = {
 const setup = (events: readonly SerializedEvent[] = []) => {
   const isCompatible = async () => true;
   const storage: ActionStorage = new MemoryActionStorage(events);
-  const actions: ActionRegistry = new Map();
+  const actions = new Map<string, ActionInternal>();
   const uiActions = new UiActionsService({
     actions,
   });

diff --git a/.../public/actions/dynamic_action_manager.ts → ...dynamic_actions/dynamic_action_manager.ts b/.../public/actions/dynamic_action_manager.ts → ...dynamic_actions/dynamic_action_manager.ts
@@ -1,31 +1,20 @@
 /*
- * 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.
+ * 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 { v4 as uuidv4 } from 'uuid';
 import { Subscription } from 'rxjs';
 import { ActionStorage, SerializedEvent } from './dynamic_action_storage';
-import { UiActionsService } from '../service';
-import { SerializedAction } from './types';
-import { TriggerContextMapping } from '../types';
-import { ActionDefinition } from './action';
+import {
+  UiActionsService,
+  UiActionsSerializedAction as SerializedAction,
+  TriggerContextMapping,
+  UiActionsActionDefinition as ActionDefinition,
+} from '../../../../../src/plugins/ui_actions/public';
 import { defaultState, transitions, selectors, State } from './dynamic_action_manager_state';
-import { StateContainer, createStateContainer } from '../../../kibana_utils';
+import { StateContainer, createStateContainer } from '../../../../../src/plugins/kibana_utils';
 
 const compareEvents = (
   a: ReadonlyArray<{ eventId: string }>,

diff --git a/...c/actions/dynamic_action_manager_state.ts → ...c_actions/dynamic_action_manager_state.ts b/...c/actions/dynamic_action_manager_state.ts → ...c_actions/dynamic_action_manager_state.ts
@@ -1,20 +1,7 @@
 /*
- * 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.
+ * 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 { SerializedEvent } from './dynamic_action_storage';

diff --git a/.../public/actions/dynamic_action_storage.ts → ...dynamic_actions/dynamic_action_storage.ts b/.../public/actions/dynamic_action_storage.ts → ...dynamic_actions/dynamic_action_storage.ts
@@ -1,26 +1,13 @@
 /*
- * 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.
+ * 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.
  */
 
 /* eslint-disable max-classes-per-file */
 
 import { Observable, Subject } from 'rxjs';
-import { SerializedAction } from './types';
+import { UiActionsSerializedAction as SerializedAction } from '../../../../../src/plugins/ui_actions/public';
 
 /**
  * Serialized representation of event-action pair, used to persist in storage.

diff --git a/x-pack/plugins/advanced_ui_actions/public/dynamic_actions/index.ts b/x-pack/plugins/advanced_ui_actions/public/dynamic_actions/index.ts
@@ -0,0 +1,9 @@
+/*
+ * 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 * from './dynamic_action_storage';
+export * from './dynamic_action_manager_state';
+export * from './dynamic_action_manager';
diff --git a/x-pack/plugins/advanced_ui_actions/public/index.ts b/x-pack/plugins/advanced_ui_actions/public/index.ts
@@ -26,3 +26,11 @@ export {
   Configurable as AdvancedUiActionsConfigurable,
   CollectConfigProps as AdvancedUiActionsCollectConfigProps,
 } from './util';
+
+export {
+  AbstractActionStorage as UiActionsEnhancedAbstractActionStorage,
+  DynamicActionManager as UiActionsEnhancedDynamicActionManager,
+  DynamicActionManagerParams as UiActionsEnhancedDynamicActionManagerParams,
+  DynamicActionManagerState as UiActionsEnhancedDynamicActionManagerState,
+  MemoryActionStorage as UiActionsEnhancedMemoryActionStorage,
+} from './dynamic_actions';
diff --git a/x-pack/plugins/dashboard_enhanced/public/plugin.ts b/x-pack/plugins/dashboard_enhanced/public/plugin.ts
@@ -6,17 +6,20 @@
 
 import { CoreStart, CoreSetup, Plugin, PluginInitializerContext } from 'src/core/public';
 import { UiActionsSetup, UiActionsStart } from '../../../../src/plugins/ui_actions/public';
+import { EmbeddableSetup, EmbeddableStart } from '../../../../src/plugins/embeddable/public';
 import { DashboardDrilldownsService } from './services';
 import { DrilldownsSetup, DrilldownsStart } from '../../drilldowns/public';
 
 export interface SetupDependencies {
-  uiActions: UiActionsSetup;
   drilldowns: DrilldownsSetup;
+  embeddable: EmbeddableSetup;
+  uiActions: UiActionsSetup;
 }
 
 export interface StartDependencies {
-  uiActions: UiActionsStart;
   drilldowns: DrilldownsStart;
+  embeddable: EmbeddableStart;
+  uiActions: UiActionsStart;
 }
 
 // eslint-disable-next-line
@@ -36,7 +39,7 @@ export class DashboardEnhancedPlugin
 
   public setup(core: CoreSetup<StartDependencies>, plugins: SetupDependencies): SetupContract {
     this.drilldowns.bootstrap(core, plugins, {
-      enableDrilldowns: this.config.drilldowns.enabled,
+      enableDrilldowns: true,
     });
 
     return {};