Create new rule HTTP APIs #93980

mikecote · 2021-03-08T18:13:02Z

⚠️ This PR merges into a feature branch

Adds new APIs using the new terminology. See Create new rule HTTP APIs that use the new terminology #90377 (comment) for the delta.
Fixes alerts client “create” function to return "SanitizedAlert” type instead of “Alert” (including stack monitoring and security solution impacts).
Adds “BASE_ALERTING_API_PATH” as the new const for new APIs.

Note: To keep this PR small, I left out the doc changes and the API integration tests. These two steps are noted in #93977 and will be done in follow-up PRs.

Note for reviewers

This PR is huge because it's mostly copy/paste from the legacy APIs, apply the new route/terminology, etc. The following guidelines will facilitate the review since most of the changes are from copy/paste in the routes folder.

Routes: The route files are a copy-paste from their equivalent in /legacy folder while renaming the file names to something more route specific. IF you copy the content of the file over the legacy equivalent, you will see the changes I've applied on top. (ex: copy contents from create_rule.ts into legacy/create,ts and the diff in git will show what I've changed).
Unit tests: The *.test.ts files are a copy-paste from their equivalent in /legacy folder. If you copy the content of the test file over the legacy equivalent, you will see the changes I've applied on top. (ex: copy contents from create_rule.test.ts into legacy/create.test.ts and the diff in git will show you what I've changed).

* Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files

…lerting/new-apis

elasticmachine · 2021-03-16T14:20:03Z

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

YulNaumenko

LGTM! As I understood the functional tests will be changed to use the new API when we remove the legacy API support.

mikecote · 2021-03-16T18:03:31Z

As I understood the functional tests will be changed to use the new API when we remove the legacy API support.

They will be done in a follow-up PR to the feature branch. We will have coverage for both sets of APIs by the time the feature branch is merged.

x-pack/plugins/alerting/server/routes/create_rule.ts

x-pack/plugins/alerting/server/routes/find_rules.ts

x-pack/plugins/alerting/server/routes/get_rule_alert_summary.ts

x-pack/plugins/alerting/server/routes/get_rule_state.ts

ymao1

LGTM!

kibanamachine · 2021-03-17T16:08:55Z

💛 Build succeeded, but was flaky

continuous-integration/kibana-ci/pull-request
Commit: 02bc392
Storybooks Preview
Flaky suites:
- xpack-securitySolutionCypressChrome

Test Failures

Kibana Pipeline / general / "before all" hook for "should open a modal".Open timeline Open timeline modal "before all" hook for "should open a modal"

Link to Jenkins

Stack Trace

Failed Tests Reporter:
  - Test has not failed recently on tracked branches

AssertionError: Timed out retrying after 60000ms: Expected to find element: `[data-test-subj="title-28bf4e40-8733-11eb-b32c-2515fed320e2"]`, but never found it.

Because this error occurred during a `before all` hook we are skipping the remaining tests in the current suite: `Open timeline`

Although you have test retries enabled, we do not retry tests when `before all` or `after all` hooks fail
    at Object.openTimelineById (http://localhost:6121/__cypress/tests?p=cypress/integration/timelines/open_timeline.spec.ts:16088:15)
    at Context.eval (http://localhost:6121/__cypress/tests?p=cypress/integration/timelines/open_timeline.spec.ts:15046:28)

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`alerting`	65.5KB	65.7KB	+232.0B

History

💚 Build #113500 succeeded f74c903
💔 Build #113490 failed de3e924
💚 Build #113274 succeeded b58749a
💔 Build #113093 failed fd7c83d
💔 Build #112827 failed 6e434d2

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

cc @mikecote

* Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: lcawl <[email protected]>

…3977) * Move current alert HTTP APIs to legacy folder (elastic#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (elastic#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (elastic#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]> * Create docs for new rule HTTP APIs, deprecate old docs (elastic#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]> * Make alerting tests use new rules APIs (elastic#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (elastic#95333) * Initial commit (elastic#95457) * Move some new alerting APIs to /internal (elastic#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: lcawl <[email protected]> # Conflicts: # api_docs/core.json

…95781) * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <[email protected]> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <[email protected]> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <[email protected]> Co-authored-by: Kibana Machine <[email protected]> Co-authored-by: lcawl <[email protected]> # Conflicts: # api_docs/core.json

mikecote added 6 commits March 8, 2021 09:11

Move current HTTP APIs to legacy folder

d66cf3d

Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH

d692495

Fix failing tests and extra files

2a17538

Move current alert HTTP APIs to legacy folder (elastic#93943)

8dcafde

* Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files

Add necessary files

daf7611

Merge w/ upstream

c2973b3

mikecote added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Mar 8, 2021

mikecote self-assigned this Mar 8, 2021

mikecote changed the base branch from master to alerting/http-api-terminology March 8, 2021 18:13

mikecote mentioned this pull request Mar 8, 2021

Create new alerting HTTP APIs that use the new terminology #93977

Merged

7 tasks

mikecote added 18 commits March 9, 2021 10:09

Create rule route

a26aacf

Get rule API

23e0043

Update rule API

cf71632

Delete rule route

f339d5f

Aggregate rules API

c2a6d9a

Disable rule API

4f2d61d

Enable rule API

28b5d0a

Find rules API

0fc70cd

Fix Update API

41e028c

Get rule alert summary API

1ab5baf

Get rule state API

15ee80d

Health API

137874b

Rule types API

759815e

Mute all API

e3fa20f

Mute alert API

834297c

Unmute all API

c262804

Unmute alert route

ecf2ce6

Update API key API

46e6ffa

mikecote added 2 commits March 15, 2021 10:52

Merge branch 'alerting/new-apis' of github.com:mikecote/kibana into a…

fd7c83d

…lerting/new-apis

Fixes

b58749a

mikecote marked this pull request as ready for review March 16, 2021 14:20

mikecote requested review from a team as code owners March 16, 2021 14:20

YulNaumenko approved these changes Mar 16, 2021

View reviewed changes

mikecote force-pushed the alerting/http-api-terminology branch from 3a69fd8 to 09e8a3b Compare March 16, 2021 18:47

Fix merge conflicts

de3e924

mikecote mentioned this pull request Mar 16, 2021

[8.0 only] Alert notifyWhen field should not be nullable #85639

Closed

Add back health route

f74c903