[Discuss] Trigger context interface

[streamich]

Currently user passes context object to trigger.exec() method and that object is passed to actions as-is. I would like to propose to augment data passed to trigger.exec() and pass to actions an augmented/standartize Context object.

Now user passes context directly:

const context = { embeddable };
plugins.uiActions.getTrigger(...).exec(context)

Instead user would pass in data and augmented context would be created by ui_actions internally:

const data = { embeddable };
plugins.uiActions.getTrigger().exec({ data });

Initial implementation of Context class would have user supplied data and two extra fields: trigger and disabledActions.

class Context<Data> {
  public readonly data: Data;

  // Trigger which cased the action to execute. Useful to report it, because an
  // action can be attached to multiple triggers.
  public readonly trigger: Trigger;

  // A list of action that should be disabled (usually in embeddable). Having this
  // list on `Context` would allow `ActionInternal` automatically disable all 
  // `disabledActions` by automatically enhancing the `.isCompatible` method
  // of `ActionDefinition`.
  public readonly disabledActions: string[];

  constructor(trigger: Trigger, params: { data: Data; disabledActions?: string[] }) {
    this.trigger = trigger;
    this.data = data;
    this.disabledActions = disabledActions;
  } 
}

class Trigger {
  exec({ data, disabledActiosn? }) {
    const context = new Context(this, { data, disabledActions });
    this.uiActionsService.executeActions(context);
  }
}

• Having trigger on Context interface would be useful because an action can be attached to multiple triggers, this would let action know which trigger executed it.

• Having disabledActions field on Context would allow us to move disabledActions logic out of embeddable panels, which currently uses disabledActions only for three triggers CONTEXT_MENU_TRIGGER, PANEL_BADGE_TRIGGER, and PANEL_NOTIFICATION_TRIGGER. Having moved disabledActions out of the panel would make this flag work everywhere in ui_actions, not just embeddable panel, and not just for the above 3 triggers.

• Having Context class would allow us in the future add more features to it. An embeddable specific context could have:

  context.isEmbeddableAContainer()
  context.isEmbeddableEditable
  context.embeddableEditUrl

---

Alternative design could be to allow user to create the context object themselves.

const context = new Context('VALUE_CLICK_TRIGGER', { embeddable, disabledActions });

And make custom data available immediately on context. object instead of context.data..

context.embeddable
// instead of
context.data.embeddable

This would allow users to create their contexts using inheritance.

class VisEmbeddableContext extends Context {
  constructor(embeddable, filters) {
    super('VALUE_CLICK_TRIGGER', { embeddable, filters });
  }
}

---

P.S. The idea is basically taken from DOM Event API and CustomEvent, where browser's Event has predefined functionality, like .preventDefault(), .bubble etc. and you can specify custom "data" when creating a browser event.

cc @stacey-gammon @elastic/kibana-app-arch

Part of #71854

[Dosant]

@streamich, as you know we implemented #74363 which solved immediate problem and allowed us to passed trigger with action context. This worked out fine for URL drilldown.
We didn't follow the path proposed in this issue, as at that moment we agreed that it would be a significant change in bunch of places.

Do you think we could close this issue and as we need add more props (like disabledActions) we would just follow similar approach, or would you like to still leave it open in case we want to revise current solution?

[vadimkibana]

Thank you for contributing to this issue, however, we are closing this issue due to inactivity as part of a backlog grooming effort. If you believe this feature/bug should still be considered, please reopen with a comment.