refactor: 💡 move action factories to x-pack (#63190)

* refactor: 💡 move action factories to x-pack

* fix: 🐛 use correct plugin embeddable deps

* test: 💍 fix Jest test after refactor

src/plugins/embeddable/public/index.ts

@@ -68,4 +68,9 @@ export function plugin(initializerContext: PluginInitializerContext) {
   return new EmbeddablePublicPlugin(initializerContext);
 }
 
-export { EmbeddableSetup, EmbeddableStart } from './plugin';
+export {
+  EmbeddableSetup,
+  EmbeddableStart,
+  EmbeddableSetupDependencies,
+  EmbeddableStartDependencies,
+} from './plugin';

src/plugins/embeddable/public/mocks.ts

@@ -16,7 +16,12 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { EmbeddableStart, EmbeddableSetup } from '.';
+import {
+  EmbeddableStart,
+  EmbeddableSetup,
+  EmbeddableSetupDependencies,
+  EmbeddableStartDependencies,
+} from '.';
 import { EmbeddablePublicPlugin } from './plugin';
 import { coreMock } from '../../../core/public/mocks';
 
@@ -45,14 +50,14 @@ const createStartContract = (): Start => {
   return startContract;
 };
 
-const createInstance = () => {
+const createInstance = (setupPlugins: Partial<EmbeddableSetupDependencies> = {}) => {
   const plugin = new EmbeddablePublicPlugin({} as any);
   const setup = plugin.setup(coreMock.createSetup(), {
-    uiActions: uiActionsPluginMock.createSetupContract(),
+    uiActions: setupPlugins.uiActions || uiActionsPluginMock.createSetupContract(),
   });
-  const doStart = () =>
+  const doStart = (startPlugins: Partial<EmbeddableStartDependencies> = {}) =>
     plugin.start(coreMock.createStart(), {
-      uiActions: uiActionsPluginMock.createStartContract(),
+      uiActions: startPlugins.uiActions || uiActionsPluginMock.createStartContract(),
       inspector: inspectorPluginMock.createStartContract(),
     });
   return {

src/plugins/ui_actions/public/actions/index.ts

@@ -19,8 +19,5 @@
 
 export * from './action';
 export * from './action_internal';
-export * from './action_factory_definition';
-export * from './action_factory';
 export * from './create_action';
 export * from './incompatible_action_error';
-export * from './types';

src/plugins/ui_actions/public/index.ts

@@ -29,12 +29,9 @@ export { UiActionsServiceParams, UiActionsService } from './service';
 export {
   Action,
   ActionDefinition as UiActionsActionDefinition,
-  ActionFactoryDefinition as UiActionsActionFactoryDefinition,
   ActionInternal as UiActionsActionInternal,
   createAction,
   IncompatibleActionError,
-  SerializedAction as UiActionsSerializedAction,
-  SerializedEvent as UiActionsSerializedEvent,
 } from './actions';
 export { buildContextMenuForActions } from './context_menu';
 export {

src/plugins/ui_actions/public/mocks.ts

@@ -32,7 +32,6 @@ const createSetupContract = (): Setup => {
     attachAction: jest.fn(),
     detachAction: jest.fn(),
     registerAction: jest.fn(),
-    registerActionFactory: jest.fn(),
     registerTrigger: jest.fn(),
     unregisterAction: jest.fn(),
   };
@@ -49,13 +48,10 @@ const createStartContract = (): Start => {
     executeTriggerActions: jest.fn(),
     fork: jest.fn(),
     getAction: jest.fn(),
-    getActionFactories: jest.fn(),
-    getActionFactory: jest.fn(),
     getTrigger: jest.fn(),
     getTriggerActions: jest.fn((id: TriggerId) => []),
     getTriggerCompatibleActions: jest.fn(),
     registerAction: jest.fn(),
-    registerActionFactory: jest.fn(),
     registerTrigger: jest.fn(),
   };
 

src/plugins/ui_actions/public/plugin.ts

@@ -27,7 +27,6 @@ export type UiActionsSetup = Pick<
   | 'attachAction'
   | 'detachAction'
   | 'registerAction'
-  | 'registerActionFactory'
   | 'registerTrigger'
   | 'unregisterAction'
 >;

src/plugins/ui_actions/public/service/ui_actions_service.test.ts

@@ -18,13 +18,7 @@
  */
 
 import { UiActionsService } from './ui_actions_service';
-import {
-  Action,
-  ActionInternal,
-  createAction,
-  ActionFactoryDefinition,
-  ActionFactory,
-} from '../actions';
+import { Action, ActionInternal, createAction } from '../actions';
 import { createHelloWorldAction } from '../tests/test_samples';
 import { ActionRegistry, TriggerRegistry, TriggerId, ActionType } from '../types';
 import { Trigger } from '../triggers';
@@ -497,64 +491,4 @@ describe('UiActionsService', () => {
       );
     });
   });
-
-  describe('action factories', () => {
-    const factoryDefinition1: ActionFactoryDefinition = {
-      id: 'test-factory-1',
-      CollectConfig: {} as any,
-      createConfig: () => ({}),
-      isConfigValid: () => true,
-      create: () => ({} as any),
-    };
-    const factoryDefinition2: ActionFactoryDefinition = {
-      id: 'test-factory-2',
-      CollectConfig: {} as any,
-      createConfig: () => ({}),
-      isConfigValid: () => true,
-      create: () => ({} as any),
-    };
-
-    test('.getActionFactories() returns empty array if no action factories registered', () => {
-      const service = new UiActionsService();
-
-      const factories = service.getActionFactories();
-
-      expect(factories).toEqual([]);
-    });
-
-    test('can register and retrieve an action factory', () => {
-      const service = new UiActionsService();
-
-      service.registerActionFactory(factoryDefinition1);
-
-      const factory = service.getActionFactory(factoryDefinition1.id);
-
-      expect(factory).toBeInstanceOf(ActionFactory);
-      expect(factory.id).toBe(factoryDefinition1.id);
-    });
-
-    test('can retrieve all action factories', () => {
-      const service = new UiActionsService();
-
-      service.registerActionFactory(factoryDefinition1);
-      service.registerActionFactory(factoryDefinition2);
-
-      const factories = service.getActionFactories();
-      const factoriesSorted = [...factories].sort((f1, f2) => (f1.id > f2.id ? 1 : -1));
-
-      expect(factoriesSorted.length).toBe(2);
-      expect(factoriesSorted[0].id).toBe(factoryDefinition1.id);
-      expect(factoriesSorted[1].id).toBe(factoryDefinition2.id);
-    });
-
-    test('throws when retrieving action factory that does not exist', () => {
-      const service = new UiActionsService();
-
-      service.registerActionFactory(factoryDefinition1);
-
-      expect(() => service.getActionFactory('UNKNOWN_ID')).toThrowError(
-        'Action factory [actionFactoryId = UNKNOWN_ID] does not exist.'
-      );
-    });
-  });
 });

src/plugins/ui_actions/public/service/ui_actions_service.ts

@@ -24,17 +24,8 @@ import {
   TriggerId,
   TriggerContextMapping,
   ActionType,
-  ActionFactoryRegistry,
 } from '../types';
-import {
-  ActionInternal,
-  Action,
-  ActionByType,
-  ActionFactory,
-  ActionDefinition,
-  ActionFactoryDefinition,
-  ActionContext,
-} from '../actions';
+import { ActionInternal, Action, ActionByType, ActionDefinition, ActionContext } from '../actions';
 import { Trigger, TriggerContext } from '../triggers/trigger';
 import { TriggerInternal } from '../triggers/trigger_internal';
 import { TriggerContract } from '../triggers/trigger_contract';
@@ -47,25 +38,21 @@ export interface UiActionsServiceParams {
    * A 1-to-N mapping from `Trigger` to zero or more `Action`.
    */
   readonly triggerToActions?: TriggerToActionsRegistry;
-  readonly actionFactories?: ActionFactoryRegistry;
 }
 
 export class UiActionsService {
   protected readonly triggers: TriggerRegistry;
   protected readonly actions: ActionRegistry;
   protected readonly triggerToActions: TriggerToActionsRegistry;
-  protected readonly actionFactories: ActionFactoryRegistry;
 
   constructor({
     triggers = new Map(),
     actions = new Map(),
     triggerToActions = new Map(),
-    actionFactories = new Map(),
   }: UiActionsServiceParams = {}) {
     this.triggers = triggers;
     this.actions = actions;
     this.triggerToActions = triggerToActions;
-    this.actionFactories = actionFactories;
   }
 
   public readonly registerTrigger = (trigger: Trigger) => {
@@ -215,7 +202,6 @@ export class UiActionsService {
     this.actions.clear();
     this.triggers.clear();
     this.triggerToActions.clear();
-    this.actionFactories.clear();
   };
 
   /**
@@ -235,41 +221,4 @@ export class UiActionsService {
 
     return new UiActionsService({ triggers, actions, triggerToActions });
   };
-
-  /**
-   * Register an action factory. Action factories are used to configure and
-   * serialize/deserialize dynamic actions.
-   */
-  public readonly registerActionFactory = <
-    Config extends object = object,
-    FactoryContext extends object = object,
-    ActionContext extends object = object
-  >(
-    definition: ActionFactoryDefinition<Config, FactoryContext, ActionContext>
-  ) => {
-    if (this.actionFactories.has(definition.id)) {
-      throw new Error(`ActionFactory [actionFactory.id = ${definition.id}] already registered.`);
-    }
-
-    const actionFactory = new ActionFactory<Config, FactoryContext, ActionContext>(definition);
-
-    this.actionFactories.set(actionFactory.id, actionFactory as ActionFactory<any, any, any>);
-  };
-
-  public readonly getActionFactory = (actionFactoryId: string): ActionFactory => {
-    const actionFactory = this.actionFactories.get(actionFactoryId);
-
-    if (!actionFactory) {
-      throw new Error(`Action factory [actionFactoryId = ${actionFactoryId}] does not exist.`);
-    }
-
-    return actionFactory;
-  };
-
-  /**
-   * Returns an array of all action factories.
-   */
-  public readonly getActionFactories = (): ActionFactory[] => {
-    return [...this.actionFactories.values()];
-  };
 }

src/plugins/ui_actions/public/types.ts

@@ -19,15 +19,13 @@
 
 import { ActionInternal } from './actions/action_internal';
 import { TriggerInternal } from './triggers/trigger_internal';
-import { ActionFactory } from './actions';
 import { EmbeddableVisTriggerContext, IEmbeddable } from '../../embeddable/public';
 import { Filter } from '../../data/public';
 import { SELECT_RANGE_TRIGGER, VALUE_CLICK_TRIGGER, APPLY_FILTER_TRIGGER } from './triggers';
 
 export type TriggerRegistry = Map<TriggerId, TriggerInternal<any>>;
 export type ActionRegistry = Map<string, ActionInternal>;
 export type TriggerToActionsRegistry = Map<TriggerId, string[]>;
-export type ActionFactoryRegistry = Map<string, ActionFactory>;
 
 const DEFAULT_TRIGGER = '';
 

x-pack/plugins/advanced_ui_actions/public/components/action_wizard/action_wizard.tsx

@@ -16,7 +16,7 @@ import {
 } from '@elastic/eui';
 import { txtChangeButton } from './i18n';
 import './action_wizard.scss';
-import { ActionFactory } from '../../services';
+import { ActionFactory } from '../../dynamic_actions';
 
 type ActionBaseConfig = object;
 type ActionFactoryBaseContext = object;

x-pack/plugins/advanced_ui_actions/public/components/action_wizard/test_data.tsx

@@ -8,7 +8,7 @@ import React, { useState } from 'react';
 import { EuiFieldText, EuiFormRow, EuiSelect, EuiSwitch } from '@elastic/eui';
 import { reactToUiComponent } from '../../../../../../src/plugins/kibana_react/public';
 import { ActionWizard } from './action_wizard';
-import { ActionFactoryDefinition, ActionFactory } from '../../services';
+import { ActionFactoryDefinition, ActionFactory } from '../../dynamic_actions';
 import { CollectConfigProps } from '../../util';
 
 type ActionBaseConfig = object;