Add license checks within alerting / actions framework #59699

mikecote · 2020-03-09T19:34:30Z

⚠️ This PR merges into a feature branch

In this PR, I'm adding license checks within the alerting framework for the areas touched by non-HTTP API calls.

Calling the action plugin execute function (exposed by start contract) will now throw an error if the action type is disabled via config OR license
The action task runner will stop retrying failures caused by action type disabled via config OR license
Alerts will skip scheduling actions for action types that are disabled via config OR license

…cote/kibana into actions/alerting-verify-action-type

…to actions/ensure-action-type-function

…cote/kibana into actions/alerting-verify-action-type

…to actions/ensure-action-type-function

…cote/kibana into actions/alerting-verify-action-type

…to actions/ensure-action-type-function

…cote/kibana into actions/alerting-verify-action-type

elasticmachine · 2020-03-09T19:34:33Z

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

pmuellr

this is looking good, but made some notes; the FT in alerting/server/task_runner/create_execution_handler.test.ts seems wrong, so not approving just yet.

x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts

x-pack/plugins/alerting/server/task_runner/create_execution_handler.ts

x-pack/plugins/actions/server/lib/task_runner_factory.ts

pmuellr

LGTM, after Mike explained the test I was confused about - worth a short comment explaining what it's doing, since I didn't immediately figure it out, and it looked kinda wrong.

x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts

kibanamachine · 2020-03-10T17:41:32Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 4c20e4b

History

💚 Build #32115 succeeded b9c41f3
💛 Build #32096 was flaky a010126
💚 Build #31887 succeeded 06f327b

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

YulNaumenko

LGTM

* Define minimum license required for each action type (#58668) * Add minimum required license * Require at least gold license as a minimum license required on third party action types * Use strings for license references * Ensure license type is valid * Fix some tests * Add servicenow to gold * Add tests * Set license requirements on other built in action types * Use jest.Mocked<ActionType> instead * Change servicenow to platinum Co-authored-by: Elastic Machine <[email protected]> * Make actions config mock and license state mock use factory pattern and jest mocks (#59370) * Add license checks to action HTTP APIs (#59153) * Initial work * Handle errors in update action API * Add unit tests for APIs * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Add license checks within alerting / actions framework (#59699) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Fix confusing assertion * Add comment explaining double mock * Log warning when alert action isn't scheduled * Disable action types in UI when license doesn't support it (#59819) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Return enabledInConfig and enabledInLicense from actions get types API * Disable cards that have invalid license in create connector flyout * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Disable when creating alert action * Return minimumLicenseRequired in /types API * Disable row in connectors when action type is disabled * Fix failing jest test * Some refactoring * Card in edit alert flyout * Sort action types by name * Add tooltips to create connector action type selector * Add tooltips to alert flyout action type selector * Add get more actions link in alert flyout * Add callout when creating a connector * Typos * remove float right and use flexgroup * replace pixels with eui variables * turn on sass lint for triggers_actions_ui dir * trying to add padding around cards * Add callout in edit alert screen when some actions are disabled * improve card selection for Add Connector flyout * Fix cards for create connector * Add tests * ESLint issue * Cleanup * Cleanup pt2 * Fix type check errors * moving to 3-columns cards for connector selection * Change re-enable to enable terminology * Revert "Change re-enable to enable terminology" This reverts commit b497dfd. * Add re-enable comment * Remove unecessary fragment * Add type to actionTypeNodes * Fix EuiLink to not have opacity of 0.7 when not hovered * design cleanup in progress * updating classNames * using EuiIconTip * Remove label on icon tip * Fix failing jest test Co-authored-by: Andrea Del Rio <[email protected]> * Add index to .index action type test * PR feedback * Add isErrorThatHandlesItsOwnResponse Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Andrea Del Rio <[email protected]>

* Define minimum license required for each action type (elastic#58668) * Add minimum required license * Require at least gold license as a minimum license required on third party action types * Use strings for license references * Ensure license type is valid * Fix some tests * Add servicenow to gold * Add tests * Set license requirements on other built in action types * Use jest.Mocked<ActionType> instead * Change servicenow to platinum Co-authored-by: Elastic Machine <[email protected]> * Make actions config mock and license state mock use factory pattern and jest mocks (elastic#59370) * Add license checks to action HTTP APIs (elastic#59153) * Initial work * Handle errors in update action API * Add unit tests for APIs * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Add license checks within alerting / actions framework (elastic#59699) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Fix confusing assertion * Add comment explaining double mock * Log warning when alert action isn't scheduled * Disable action types in UI when license doesn't support it (elastic#59819) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Return enabledInConfig and enabledInLicense from actions get types API * Disable cards that have invalid license in create connector flyout * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Disable when creating alert action * Return minimumLicenseRequired in /types API * Disable row in connectors when action type is disabled * Fix failing jest test * Some refactoring * Card in edit alert flyout * Sort action types by name * Add tooltips to create connector action type selector * Add tooltips to alert flyout action type selector * Add get more actions link in alert flyout * Add callout when creating a connector * Typos * remove float right and use flexgroup * replace pixels with eui variables * turn on sass lint for triggers_actions_ui dir * trying to add padding around cards * Add callout in edit alert screen when some actions are disabled * improve card selection for Add Connector flyout * Fix cards for create connector * Add tests * ESLint issue * Cleanup * Cleanup pt2 * Fix type check errors * moving to 3-columns cards for connector selection * Change re-enable to enable terminology * Revert "Change re-enable to enable terminology" This reverts commit b497dfd. * Add re-enable comment * Remove unecessary fragment * Add type to actionTypeNodes * Fix EuiLink to not have opacity of 0.7 when not hovered * design cleanup in progress * updating classNames * using EuiIconTip * Remove label on icon tip * Fix failing jest test Co-authored-by: Andrea Del Rio <[email protected]> * Add index to .index action type test * PR feedback * Add isErrorThatHandlesItsOwnResponse Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Andrea Del Rio <[email protected]>

* Define minimum license required for each action type (#58668) * Add minimum required license * Require at least gold license as a minimum license required on third party action types * Use strings for license references * Ensure license type is valid * Fix some tests * Add servicenow to gold * Add tests * Set license requirements on other built in action types * Use jest.Mocked<ActionType> instead * Change servicenow to platinum Co-authored-by: Elastic Machine <[email protected]> * Make actions config mock and license state mock use factory pattern and jest mocks (#59370) * Add license checks to action HTTP APIs (#59153) * Initial work * Handle errors in update action API * Add unit tests for APIs * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Add license checks within alerting / actions framework (#59699) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Fix confusing assertion * Add comment explaining double mock * Log warning when alert action isn't scheduled * Disable action types in UI when license doesn't support it (#59819) * Initial work * Handle errors in update action API * Add unit tests for APIs * Verify action type before scheduling action task * Make actions plugin.execute throw error if action type is disabled * Bug fixes * Make action executor throw when action type isn't enabled * Add test suite for basic license * Fix ESLint errors * Stop action task from re-running when license check fails * Fix failing tests * Attempt 1 to fix CI * ESLint fixes * Return enabledInConfig and enabledInLicense from actions get types API * Disable cards that have invalid license in create connector flyout * Create sendResponse function on ActionTypeDisabledError * Make disabled action types by config return 403 * Remove switch case * Fix ESLint * Disable when creating alert action * Return minimumLicenseRequired in /types API * Disable row in connectors when action type is disabled * Fix failing jest test * Some refactoring * Card in edit alert flyout * Sort action types by name * Add tooltips to create connector action type selector * Add tooltips to alert flyout action type selector * Add get more actions link in alert flyout * Add callout when creating a connector * Typos * remove float right and use flexgroup * replace pixels with eui variables * turn on sass lint for triggers_actions_ui dir * trying to add padding around cards * Add callout in edit alert screen when some actions are disabled * improve card selection for Add Connector flyout * Fix cards for create connector * Add tests * ESLint issue * Cleanup * Cleanup pt2 * Fix type check errors * moving to 3-columns cards for connector selection * Change re-enable to enable terminology * Revert "Change re-enable to enable terminology" This reverts commit b497dfd. * Add re-enable comment * Remove unecessary fragment * Add type to actionTypeNodes * Fix EuiLink to not have opacity of 0.7 when not hovered * design cleanup in progress * updating classNames * using EuiIconTip * Remove label on icon tip * Fix failing jest test Co-authored-by: Andrea Del Rio <[email protected]> * Add index to .index action type test * PR feedback * Add isErrorThatHandlesItsOwnResponse Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Andrea Del Rio <[email protected]> Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Andrea Del Rio <[email protected]>

mikecote added 28 commits March 5, 2020 12:14

Initial work

bf35822

Handle errors in update action API

ea73855

Add unit tests for APIs

2088182

Verify action type before scheduling action task

3215084

Make actions plugin.execute throw error if action type is disabled

6564c8b

Bug fixes

fe4ea91

Make action executor throw when action type isn't enabled

a78c999

Add test suite for basic license

c5c7f1b

Merge branch 'actions/ensure-action-type-function' of github.com:mike…

988ab1f

…cote/kibana into actions/alerting-verify-action-type

Fix ESLint errors

b5e28f8

Merge branch 'actions/license-checks' of github.com:elastic/kibana in…

c10d719

…to actions/ensure-action-type-function

Merge branch 'actions/ensure-action-type-function' of github.com:mike…

4dfe082

…cote/kibana into actions/alerting-verify-action-type

Stop action task from re-running when license check fails

4401328

Fix failing tests

dfc787a

Attempt 1 to fix CI

6b54409

Merge with upstream branch

bb561f8

ESLint fixes

4152be8

Merge branch 'actions/ensure-action-type-function' of github.com:mike…

9f29e5f

…cote/kibana into actions/alerting-verify-action-type

Merge branch 'actions/license-checks' of github.com:elastic/kibana in…

5c66bf2

…to actions/ensure-action-type-function

Merge branch 'actions/ensure-action-type-function' of github.com:mike…

cfe33cf

…cote/kibana into actions/alerting-verify-action-type

Create sendResponse function on ActionTypeDisabledError

9af1336

Make disabled action types by config return 403

4c38702

Remove switch case

33235e1

Fix ESLint

da91d38

Merge branch 'actions/license-checks' of github.com:elastic/kibana in…

d5292e6

…to actions/ensure-action-type-function

Merge branch 'actions/license-checks' of github.com:elastic/kibana in…

e443fa0

…to actions/ensure-action-type-function

Merge branch 'actions/ensure-action-type-function' of github.com:mike…

f4c9a33

…cote/kibana into actions/alerting-verify-action-type

Merge with upstream

06f327b

mikecote added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes labels Mar 9, 2020

mikecote added the Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// label Mar 9, 2020

mikecote requested a review from a team as a code owner March 9, 2020 19:34

mikecote self-assigned this Mar 9, 2020

mikecote mentioned this pull request Mar 9, 2020

License checks for actions plugin #59070

Merged

pmuellr reviewed Mar 10, 2020

View reviewed changes

Fix confusing assertion

a010126

pmuellr approved these changes Mar 10, 2020

View reviewed changes

x-pack/plugins/alerting/server/task_runner/create_execution_handler.test.ts Show resolved Hide resolved

mikecote added 2 commits March 10, 2020 11:45

Add comment explaining double mock

b9c41f3

Log warning when alert action isn't scheduled

4c20e4b

YulNaumenko approved these changes Mar 10, 2020

View reviewed changes

mikecote merged commit 9c5952e into elastic:actions/license-checks Mar 10, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add license checks within alerting / actions framework #59699

Add license checks within alerting / actions framework #59699

Uh oh!

mikecote commented Mar 9, 2020 •

edited

Loading

Uh oh!

elasticmachine commented Mar 9, 2020

Uh oh!

pmuellr left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmuellr left a comment

Uh oh!

Uh oh!

kibanamachine commented Mar 10, 2020

Uh oh!

YulNaumenko left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Add license checks within alerting / actions framework #59699

Add license checks within alerting / actions framework #59699

Uh oh!

Conversation

mikecote commented Mar 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ This PR merges into a feature branch

Uh oh!

elasticmachine commented Mar 9, 2020

Uh oh!

pmuellr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pmuellr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kibanamachine commented Mar 10, 2020

💚 Build Succeeded

History

Uh oh!

YulNaumenko left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mikecote commented Mar 9, 2020 •

edited

Loading