Make the actions plugin support generics #71439

mikecote · 2020-07-13T13:24:50Z

Solves the actions portion of #64147

In this PR, I'm adding support for generics in the actions plugin to the following types:

ActionTypeExecutorOptions<Config, Secrets, Params>
ActionResult<Config> (optional type)
PreConfiguredAction<Config, Secrets> (optional types)
ActionTypeExecutorResult<Data> (optional type)
ExecutorType<Config, Secrets, Params>
ActionType<Config, Secrets, Params> (optional types)

Example

export type ServerLogActionTypeParams = { message: string };

const serverLogActionType: ActionType<{}, {}, ServerLogActionTypeParams> = {
  ...
  async executor(execOptions) {
    // Below is considered a string with the type pulled from ServerLogActionTypeParams['message']
    const { message } = execOptions.params;
  }
}

…ment-generics

apmmachine · 2020-07-21T14:32:40Z

💚 Build Succeeded

Expand to view the summary

Build stats

Build Cause: [Pull request #71439 updated]
Start Time: 2020-07-21T15:14:46.100+0000
Duration: 4 min 20 sec

…ment-generics

elasticmachine · 2020-07-21T19:18:39Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

gmmorris

LGTM 👏

So much better than before 😍

…ment-generics

cnasikas

From cases perspective LTGM!

YulNaumenko

LGTM

mikecote · 2020-07-22T16:18:32Z

@elasticmachine merge upstream

pmuellr

LGTM, made some comments

pmuellr · 2020-07-22T14:11:01Z

x-pack/plugins/actions/server/action_type_registry.ts

@@ -91,7 +101,7 @@ export class ActionTypeRegistry {
        )
      );
    }
-    this.actionTypes.set(actionType.id, { ...actionType });
+    this.actionTypes.set(actionType.id, { ...actionType } as ActionType);


maybe I haven't gotten to the point where this cast is needed, but I woulda thought we could just do

this.actionTypes.set(actionType.id, actionType);

I think it's to "cast" it to a generic, otherwise typescript complains that it can't convert Config, Secret and Params type to generics.

pmuellr · 2020-07-22T14:14:14Z

x-pack/plugins/actions/server/action_type_registry.ts

@@ -112,7 +122,11 @@ export class ActionTypeRegistry {
  /**
   * Returns an action type, throws if not registered
   */
-  public get(id: string): ActionType {
+  public get<


Haven't gotten to the point where this would be needed, but wondering what the real use case is to have get() parameterized like this. No harm, just seems like it would only be used in unit tests for actions :-)

@gmmorris would know more, he helped me come up with the design. From what I saw, it's the only way we could get it to work as I don't know if you can make an interface extend a generic while also having sub-generic types. (CustomActionType extends ActionType, then setting Config, Secrets, Params generics).

x-pack/plugins/actions/server/builtin_action_types/email.ts

…ment-generics

…na into actions/implement-generics

mikecote · 2020-07-23T15:51:44Z

well now I just feel bad/sad for having you add this typing, when it's mostly void and unknown 😭

This will be good for future work and eventually adding support to the existing ones :) We can eventually make the types explicit without providing default values for any of them. This will make new action types consider type safety.

…ment-generics

kibanamachine · 2020-08-04T19:45:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 394e360

Build metrics

‼️ unable to find a baseline build for [master@de22caa]. Try merging the upstream branch and trying again.

History

💚 Build #63897 succeeded 8106979
💔 Build #63668 failed 418af31
💔 Build #63633 failed 35f95f0
💚 Build #63372 succeeded 4c2602b
💔 Build #63317 failed 8d8e499

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

* Initial attempt at making the actions plugin support generics * Export WebhookMethods * Fix typings for registry * Usage of Record<string, unknown> * Apply feedback from Gidi * Cleanup * Fix validate_with_schema * Cleanup pt2 * Fix failing tests * Add generics to ActionType for ActionTypeExecutorResult Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* master: (74 commits) [Discover] Inline noWhiteSpace function (elastic#74331) [DOCS] Add Observability topic (elastic#73041) skip flaky suite (elastic#74327) [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317) [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250) Fixed Alert details does not update page title and breadcrumb (elastic#74214) [src/dev/build] build Kibana Platform bundles from source (elastic#73591) [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185) Fix TMS not loaded in legacy maps (elastic#73570) [Security Solution] styling for notes' panel (elastic#74274) [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues (elastic#74268) Make the actions plugin support generics (elastic#71439) [Security Solution] Keep original note creator (elastic#74203) [CI] Fix xpack kibana build dir in xpack visual regression script [CI] Fix baseline_capture job by adding parallel process number back [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127) [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169) [kbn/optimizer] remove unused modules (elastic#74195) [CI] Add pipeline task queue framework and merge workers into one (elastic#71268) Using msearch for tree api endpoint (elastic#73813) ...

* master: (115 commits) [Logs UI] Correct trial period duration in anomaly splash screen (elastic#74249) [Discover] Inline noWhiteSpace function (elastic#74331) [DOCS] Add Observability topic (elastic#73041) skip flaky suite (elastic#74327) [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317) [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250) Fixed Alert details does not update page title and breadcrumb (elastic#74214) [src/dev/build] build Kibana Platform bundles from source (elastic#73591) [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185) Fix TMS not loaded in legacy maps (elastic#73570) [Security Solution] styling for notes' panel (elastic#74274) [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues (elastic#74268) Make the actions plugin support generics (elastic#71439) [Security Solution] Keep original note creator (elastic#74203) [CI] Fix xpack kibana build dir in xpack visual regression script [CI] Fix baseline_capture job by adding parallel process number back [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127) [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169) [kbn/optimizer] remove unused modules (elastic#74195) [CI] Add pipeline task queue framework and merge workers into one (elastic#71268) ...

* Initial attempt at making the actions plugin support generics * Export WebhookMethods * Fix typings for registry * Usage of Record<string, unknown> * Apply feedback from Gidi * Cleanup * Fix validate_with_schema * Cleanup pt2 * Fix failing tests * Add generics to ActionType for ActionTypeExecutorResult Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* master: (154 commits) [ML] Fix initial plugin's bundle size (elastic#74047) [Ingest Manager] prevent crash on unhandled rejection from setupIngestManager (elastic#74300) [Logs UI] Correct trial period duration in anomaly splash screen (elastic#74249) [Discover] Inline noWhiteSpace function (elastic#74331) [DOCS] Add Observability topic (elastic#73041) skip flaky suite (elastic#74327) [Security Solution][Detections] Fixes Severity Override not matching for Elastic Endpoint Security rule (elastic#74317) [Security Solution][Exceptions] - Fixes exceptions builder nested deletion issue and adds unit tests (elastic#74250) Fixed Alert details does not update page title and breadcrumb (elastic#74214) [src/dev/build] build Kibana Platform bundles from source (elastic#73591) [Reporting] Shorten asset path to help CLI FS Watcher (elastic#74185) Fix TMS not loaded in legacy maps (elastic#73570) [Security Solution] styling for notes' panel (elastic#74274) [Security Solution][Tech Debt] cleans up ts-ignore issues and some smaller linter issues (elastic#74268) Make the actions plugin support generics (elastic#71439) [Security Solution] Keep original note creator (elastic#74203) [CI] Fix xpack kibana build dir in xpack visual regression script [CI] Fix baseline_capture job by adding parallel process number back [Monitoring] Ensure setup mode works on cloud but only for alerts (elastic#73127) [Maps] Custom color ramps should show correctly on the map for mvt layers (elastic#74169) ...

Initial attempt at making the actions plugin support generics

867c0b7

mikecote added Feature:Actions Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Jul 13, 2020

mikecote self-assigned this Jul 13, 2020

mikecote added 5 commits July 15, 2020 15:02

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

5959946

…ment-generics

Export WebhookMethods

bf29855

Fix typings for registry

bd86577

Usage of Record<string, unknown>

5a408f7

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

55aad5a

…ment-generics

gmmorris self-requested a review July 21, 2020 09:07

Apply feedback from Gidi

f9885a4

mikecote added 3 commits July 21, 2020 11:02

Cleanup

e162fe4

Fix validate_with_schema

350ee45

Cleanup pt2

8d8e499

mikecote added release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v8.0.0 labels Jul 21, 2020

mikecote added 2 commits July 21, 2020 13:38

Fix failing tests

03ff0e0

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

4c2602b

…ment-generics

mikecote marked this pull request as ready for review July 21, 2020 19:18

mikecote requested review from a team as code owners July 21, 2020 19:18

gmmorris approved these changes Jul 22, 2020

View reviewed changes

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

35f95f0

…ment-generics

cnasikas approved these changes Jul 22, 2020

View reviewed changes

YulNaumenko approved these changes Jul 22, 2020

View reviewed changes

Merge branch 'master' into actions/implement-generics

418af31

pmuellr approved these changes Jul 22, 2020

View reviewed changes

mikecote added 3 commits July 23, 2020 09:28

Add generics to ActionType for ActionTypeExecutorResult

ab64713

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

db68028

…ment-generics

Merge branch 'actions/implement-generics' of github.com:mikecote/kiba…

8106979

…na into actions/implement-generics

Merge branch 'master' of github.com:elastic/kibana into actions/imple…

394e360

…ment-generics

mikecote merged commit 54e13ad into elastic:master Aug 4, 2020

mikecote mentioned this pull request Aug 4, 2020

[7.x] Make the actions plugin support generics (#71439) #74294

Merged

mikecote linked an issue Aug 5, 2020 that may be closed by this pull request

[Alerting] Add Generics support to Alerting #64147

Closed

cnasikas mentioned this pull request Oct 5, 2020

[SIEM][CASE] Add generics to connector's types #64506

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make the actions plugin support generics #71439

Make the actions plugin support generics #71439

mikecote commented Jul 13, 2020 •

edited

Loading

apmmachine commented Jul 21, 2020 •

edited

Loading

Build stats

elasticmachine commented Jul 21, 2020

gmmorris left a comment

cnasikas left a comment

YulNaumenko left a comment

mikecote commented Jul 22, 2020

pmuellr left a comment

pmuellr Jul 22, 2020

mikecote Jul 22, 2020

pmuellr Jul 22, 2020

mikecote Jul 22, 2020

mikecote commented Jul 23, 2020

kibanamachine commented Aug 4, 2020

Make the actions plugin support generics #71439

Make the actions plugin support generics #71439

Conversation

mikecote commented Jul 13, 2020 • edited Loading

Example

apmmachine commented Jul 21, 2020 • edited Loading

💚 Build Succeeded

Build stats

elasticmachine commented Jul 21, 2020

gmmorris left a comment

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

YulNaumenko left a comment

Choose a reason for hiding this comment

mikecote commented Jul 22, 2020

pmuellr left a comment

Choose a reason for hiding this comment

pmuellr Jul 22, 2020

Choose a reason for hiding this comment

mikecote Jul 22, 2020

Choose a reason for hiding this comment

pmuellr Jul 22, 2020

Choose a reason for hiding this comment

mikecote Jul 22, 2020

Choose a reason for hiding this comment

mikecote commented Jul 23, 2020

kibanamachine commented Aug 4, 2020

💚 Build Succeeded

Build metrics

History

mikecote commented Jul 13, 2020 •

edited

Loading

apmmachine commented Jul 21, 2020 •

edited

Loading