Make the alerts plugin support generics #72716

mikecote · 2020-07-21T19:14:24Z

Solves the alerts portion of #64147.

Resolves #64147 now that all portions are complete after this PR.

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

AlertServices<InstanceState, InstanceContext>
AlertExecutorOptions<Params, State, InstanceState, InstanceContext>
AlertType<Params, State, InstanceState, InstanceContext>

Example

export type AlertTypeParams = { threshold: number; index: string };

const thresholdAlertType: AlertType<AlertTypeParams, {}, {}, {}> = {
  ...
  async executor(execOptions) {
    // Below is considered a number with the type pulled from AlertType['threshold']
    const { threshold } = execOptions.params;
  }
}

…ement-generics

mikecote · 2020-07-23T15:17:37Z

x-pack/plugins/alerts/server/alert_type_registry.ts

    this.taskManager.registerTaskDefinitions({
      [`alerting:${alertType.id}`]: {
        title: alertType.name,
        type: `alerting:${alertType.id}`,
        createTaskRunner: (context: RunContext) =>
-          this.taskRunnerFactory.create(alertType, context),
+          this.taskRunnerFactory.create({ ...alertType } as AlertType, context),


{ ...alertType } is a "while I'm here" for shallow clones that was missed in #65309.

…ement-generics

elasticmachine · 2020-08-05T21:12:52Z

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

chrisronline

LGTM for stack monitoring

mikecote · 2020-08-10T12:41:34Z

@elasticmachine merge upstream

YulNaumenko

LGTM

pmuellr

LGTM

pmuellr · 2020-08-11T21:57:53Z

x-pack/plugins/alerts/server/alert_instance/alert_instance.ts

 import { parseDuration } from '../lib';

-interface ScheduledExecutionOptions {


+1 on an interface removal - that's neat!

For sure, for this one here I had to move it within the AlertInstance class in order to use the generics passed to the class.

pmuellr · 2020-08-11T22:56:09Z

x-pack/test/alerting_api_integration/common/fixtures/plugins/alerts/server/alert_types.ts

+  return result;
+}
+
+function getPatternFiringAlertType() {


eh, we'll have a merge conflict here with https://github.com/elastic/kibana/pull/68437/files#diff-753fd9a204535630ddf989cebd2a4a76 - I had to make the patternFiring alert a little more interesting, to handle multiple instances.

Ah thanks for the heads up! If your PR merges soon, I'll wait until then as the changes I made aren't hard to redo.

gmmorris

LGTM 👍
Great work Mike!

gmmorris · 2020-08-12T17:08:02Z

x-pack/plugins/alerts/common/alert.ts

+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AlertTypeState = Record<string, any>;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AlertTypeParams = Record<string, any>;
+


Can't this be a generic type with a default of unknown instead of any?

Converting these types to Record<string, unknown> caused over 130 type check failures. Most of these were outside of the alerting team's code and would cause us to change a lot of external code. I'm thinking we enforce this at some other time and have created #74897 to track this.

…ana into alerting/implement-generics

spong

LGTM for Security changes!

shahzad31

Uptime changes LGTM !!

elasticmachine · 2020-08-14T14:49:49Z

Pinging @elastic/uptime (Team:uptime)

kibanamachine · 2020-08-14T16:30:37Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 2cf9ea0

Build metrics

page load bundle size

id	value	diff	baseline
alerts	89.3KB	+155.0B	89.1KB

History

💚 Build #67775 succeeded 2981fd1
💚 Build #67222 succeeded 67cd17a
💚 Build #66716 succeeded 44dafc0
💚 Build #66649 succeeded 8d4dde2
💔 Build #66646 failed 0b9bdea

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

* Initial work * Expand generic support to alert instances * Convert index threshold to use generics * Make fixture alert types use generics * Make alert instance related types use unknown * Fix typecheck failures * Cleanup + add instance generic support to registry.get API * Shallow clone * Rename some TS variables * Fix failing api integration tests * Change code for easier review and keep more history * Fix Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

* master: (24 commits) [ML] Functional tests - skip regression and classification tests [Ingest Manager] fix removing ingest pipelines from elasticsearch (elastic#75092) move tests for placeholder indices to setup (elastic#75096) [jest] temporarily extend default test timeout (elastic#75118) [cli] remove reference to removed --optimize flag (elastic#75083) skip flaky suite (elastic#75044) Adding /etc/rc.d/init.d/functions to the init script when present to … (elastic#22985) [jenkins] add pipeline for hourly security solution cypress tests (elastic#75087) [Reporting/Flaky Test] Skip test for paging list of reports (elastic#75075) remove .kbn-optimizer-cache upload (elastic#75086) skip flaky suite (elastic#74814) Actions add proxy support (elastic#74289) [ILM] TS conversion of Edit policy components (elastic#74747) [Resolver] simulator tests select elements directly instead of using descendant selectors. (elastic#75058) [Enterprise Search] Add Workplace Search side navigation (elastic#74894) [Security solution] Sourcerer: Kibana index pattern selector for security views (elastic#74706) [Logs UI] Remove apollo deps from log link-to routes (elastic#74502) [Maps] add map configurations to docker list (elastic#75035) [functional test][saved objects] update tests for additional copy saved objects to space (elastic#74907) Make the alerts plugin support generics (elastic#72716) ...

* Initial work * Expand generic support to alert instances * Convert index threshold to use generics * Make fixture alert types use generics * Make alert instance related types use unknown * Fix typecheck failures * Cleanup + add instance generic support to registry.get API * Shallow clone * Rename some TS variables * Fix failing api integration tests * Change code for easier review and keep more history * Fix Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Initial work

7ea56a0

mikecote added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.10.0 labels Jul 21, 2020

mikecote self-assigned this Jul 21, 2020

mikecote added 9 commits July 21, 2020 15:44

Expand generic support to alert instances

cfaef3a

Convert index threshold to use generics

25e433f

Merge with master

6f32aa4

Make fixture alert types use generics

1b53ddf

Make alert instance related types use unknown

03f0777

Merge branch 'master' of github.com:elastic/kibana into alerting/impl…

e36f3f2

…ement-generics

Fix typecheck failures

dbad87e

Cleanup + add instance generic support to registry.get API

5b9e64b

Shallow clone

ac688c2

mikecote commented Jul 23, 2020

View reviewed changes

mikecote added 8 commits July 23, 2020 11:24

Rename some TS variables

665d2b6

Merge with master

b92d847

Merge branch 'master' of github.com:elastic/kibana into alerting/impl…

5c63c94

…ement-generics

Fix failing api integration tests

dbfcea5

Change code for easier review and keep more history

17503fe

Fix

0b9bdea

Merge branch 'master' of github.com:elastic/kibana into alerting/impl…

8d4dde2

…ement-generics

Merge with master

44dafc0

mikecote marked this pull request as ready for review August 5, 2020 21:12

mikecote requested review from a team as code owners August 5, 2020 21:12

mikecote requested a review from a team August 5, 2020 21:12

chrisronline approved these changes Aug 6, 2020

View reviewed changes

Merge branch 'master' into alerting/implement-generics

67cd17a

YulNaumenko approved these changes Aug 11, 2020

View reviewed changes

pmuellr approved these changes Aug 11, 2020

View reviewed changes

gmmorris approved these changes Aug 12, 2020

View reviewed changes

mikecote added 2 commits August 12, 2020 15:03

Merge with master

f6b1272

Merge branch 'alerting/implement-generics' of github.com:mikecote/kib…

2981fd1

…ana into alerting/implement-generics

spong approved these changes Aug 13, 2020

View reviewed changes

Merge with master

2cf9ea0

mikecote requested a review from a team as a code owner August 14, 2020 14:39

shahzad31 approved these changes Aug 14, 2020

View reviewed changes

botelastic bot added the Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability label Aug 14, 2020

mikecote merged commit d56b792 into elastic:master Aug 14, 2020

mikecote mentioned this pull request Aug 14, 2020

[7.x] Make the alerts plugin support generics (#72716) #75078

Merged

gmmorris mentioned this pull request Jun 30, 2021

[Alerting] TypeScript checking for actionVariable definitions #62483

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make the alerts plugin support generics #72716

Make the alerts plugin support generics #72716

mikecote commented Jul 21, 2020 •

edited

Loading

mikecote Jul 23, 2020

elasticmachine commented Aug 5, 2020

chrisronline left a comment

mikecote commented Aug 10, 2020

YulNaumenko left a comment

pmuellr left a comment

pmuellr Aug 11, 2020

mikecote Aug 12, 2020

pmuellr Aug 11, 2020

mikecote Aug 12, 2020

gmmorris left a comment

gmmorris Aug 12, 2020

mikecote Aug 12, 2020

spong left a comment

shahzad31 left a comment

elasticmachine commented Aug 14, 2020

kibanamachine commented Aug 14, 2020

		import { parseDuration } from '../lib';

		interface ScheduledExecutionOptions {

Make the alerts plugin support generics #72716

Make the alerts plugin support generics #72716

Conversation

mikecote commented Jul 21, 2020 • edited Loading

Example

mikecote Jul 23, 2020

Choose a reason for hiding this comment

elasticmachine commented Aug 5, 2020

chrisronline left a comment

Choose a reason for hiding this comment

mikecote commented Aug 10, 2020

YulNaumenko left a comment

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

pmuellr Aug 11, 2020

Choose a reason for hiding this comment

mikecote Aug 12, 2020

Choose a reason for hiding this comment

pmuellr Aug 11, 2020

Choose a reason for hiding this comment

mikecote Aug 12, 2020

Choose a reason for hiding this comment

gmmorris left a comment

Choose a reason for hiding this comment

gmmorris Aug 12, 2020

Choose a reason for hiding this comment

mikecote Aug 12, 2020

Choose a reason for hiding this comment

spong left a comment

Choose a reason for hiding this comment

shahzad31 left a comment

Choose a reason for hiding this comment

elasticmachine commented Aug 14, 2020

kibanamachine commented Aug 14, 2020

💚 Build Succeeded

Build metrics

page load bundle size

History

mikecote commented Jul 21, 2020 •

edited

Loading