Define minimum license required for each action type #58668

mikecote · 2020-02-26T21:54:48Z

⚠️ This PR merges into a feature branch

In this PR, I'm implementing step 1, 2 and 3 of my license check implementation proposal: #54946 (comment).

I'm adding a new minimumLicenseRequired attribute to each action type definition. Built-in action types can set a Basic+ license while non-built-in action types can only set a gold+ license.

…party action types

elasticmachine · 2020-02-26T21:54:50Z

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

mikecote · 2020-02-27T20:17:37Z

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

+        if (!(actionType.minimumLicenseRequired in LICENSE_TYPE)) {
+          throw new Error(`"${actionType.minimumLicenseRequired}" is not a valid license type`);
+        }
+        if (LICENSE_TYPE[actionType.minimumLicenseRequired] < LICENSE_TYPE.gold) {


@elastic/kibana-alerting-services @peterschretlen do we want to allow other plugins to register basic license action types? With the code I have now, only built-in action types can specify basic as their minimum license required.

@mikecote 👍 the way you have it is correct. Custom actions would be gold or higher.

pmuellr

LGTM, made some comments

pmuellr · 2020-02-28T01:46:40Z

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

@@ -31,6 +31,7 @@ describe('register()', () => {
    actionTypeRegistry.register({
      id: 'my-action-type',
      name: 'My action type',
+      minimumLicenseRequired: 'basic',


maybe there's an hook later, but this seems to violate "non-built-in action types can only set a gold+ license"

You can set anything here but it will be validated when you register. The registration validation exists here: https://github.com/elastic/kibana/pull/58668/files#diff-adc6606fd00ebc8b46eecefae314f1b5R187 and the built ins don't go through there, they register directly to the actionTypeRegistry.

x-pack/plugins/actions/server/lib/action_executor.test.ts

…to actions/initial-action-type-licenses

mikecote · 2020-03-02T15:05:44Z

@elasticmachine merge upstream

…e-licenses

mikecote · 2020-03-02T15:08:32Z

@elasticmachine merge upstream

…e-licenses

alexfrancoeur · 2020-03-02T16:40:34Z

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

@@ -89,6 +89,7 @@ export function getActionType({
 }): ActionType {
  return {
    id: '.servicenow',
+    minimumLicenseRequired: 'gold',


@mikecote @peterschretlen I just spoke with @MikePaquette, can we make this platinum. There is a good chance that's where it will land

Thanks, I went ahead and made it platinum here: 9669ebd.

peterschretlen

LGTM, though see Alex's comment on ServiceNow.

kibanamachine · 2020-03-02T19:16:30Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 9669ebd

History

💚 Build #30069 succeeded af432ef
💚 Build #29757 succeeded deb7621
💚 Build #29305 succeeded 44158c3
💚 Build #29293 succeeded 44fb539

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

* 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 8 commits February 25, 2020 09:54

Add minimum required license

81d08d7

Require at least gold license as a minimum license required on third …

902bdec

…party action types

Use strings for license references

76948d4

Ensure license type is valid

ac0d3e8

Fix some tests

db039f7

Add servicenow to gold

07e0d88

Add tests

a24caa0

Merge with master

44fb539

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 Feb 26, 2020

mikecote self-assigned this Feb 26, 2020

Set license requirements on other built in action types

44158c3

mikecote commented Feb 27, 2020

View reviewed changes

pmuellr approved these changes Feb 28, 2020

View reviewed changes

mikecote added 2 commits February 28, 2020 11:03

Use jest.Mocked<ActionType> instead

c87435b

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

deb7621

…to actions/initial-action-type-licenses

mikecote marked this pull request as ready for review March 2, 2020 14:59

mikecote requested a review from a team as a code owner March 2, 2020 14:59

Merge branch 'actions/license-checks' into actions/initial-action-typ…

b6d5c0e

…e-licenses

Merge branch 'actions/license-checks' into actions/initial-action-typ…

af432ef

…e-licenses

alexfrancoeur reviewed Mar 2, 2020

View reviewed changes

peterschretlen approved these changes Mar 2, 2020

View reviewed changes

Change servicenow to platinum

9669ebd

mikecote merged commit a28e6db into elastic:actions/license-checks Mar 2, 2020

mikecote mentioned this pull request Mar 4, 2020

License checks for actions plugin #59070

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Define minimum license required for each action type #58668

Define minimum license required for each action type #58668

mikecote commented Feb 26, 2020

elasticmachine commented Feb 26, 2020

mikecote Feb 27, 2020

peterschretlen Feb 27, 2020

pmuellr left a comment

pmuellr Feb 28, 2020

mikecote Feb 28, 2020

mikecote commented Mar 2, 2020

mikecote commented Mar 2, 2020

alexfrancoeur Mar 2, 2020

mikecote Mar 2, 2020

peterschretlen left a comment

kibanamachine commented Mar 2, 2020

Define minimum license required for each action type #58668

Define minimum license required for each action type #58668

Conversation

mikecote commented Feb 26, 2020

⚠️ This PR merges into a feature branch

elasticmachine commented Feb 26, 2020

mikecote Feb 27, 2020

Choose a reason for hiding this comment

peterschretlen Feb 27, 2020

Choose a reason for hiding this comment

pmuellr left a comment

Choose a reason for hiding this comment

pmuellr Feb 28, 2020

Choose a reason for hiding this comment

mikecote Feb 28, 2020

Choose a reason for hiding this comment

mikecote commented Mar 2, 2020

mikecote commented Mar 2, 2020

alexfrancoeur Mar 2, 2020

Choose a reason for hiding this comment

mikecote Mar 2, 2020

Choose a reason for hiding this comment

peterschretlen left a comment

Choose a reason for hiding this comment

kibanamachine commented Mar 2, 2020

💚 Build Succeeded

History