[Alerting UI][License] Disable alert types in UI when the license doesn't support it. #85496
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { AlertTypeModel } from '../../types'; | ||
| import { IsEnabledResult, IsDisabledResult } from './check_alert_type_enabled'; | ||
|
|
||
| export function alertTypeSolutionCompare( | ||
| a: [ | ||
| string, | ||
| Array<{ | ||
| id: string; | ||
| name: string; | ||
| checkEnabledResult: IsEnabledResult | IsDisabledResult; | ||
| alertTypeItem: AlertTypeModel; | ||
| }> | ||
| ], | ||
| b: [ | ||
| string, | ||
| Array<{ | ||
| id: string; | ||
| name: string; | ||
| checkEnabledResult: IsEnabledResult | IsDisabledResult; | ||
| alertTypeItem: AlertTypeModel; | ||
| }> | ||
| ], | ||
| solutions: Map<string, string> | undefined | ||
| ) { | ||
| // .sort(([a], [b]) => | ||
| // solutions ? solutions.get(a)!.localeCompare(solutions.get(b)!) : a.localeCompare(b) | ||
| // ) | ||
|
|
||
| const solutionA = a[0]; | ||
| const solutionB = b[0]; | ||
| const alertTypeItemsA = a[1].find((alertTypeItem) => alertTypeItem.checkEnabledResult.isEnabled); | ||
| const alertTypeItemsB = b[1].find((alertTypeItem) => alertTypeItem.checkEnabledResult.isEnabled); | ||
|
|
||
| if (!!alertTypeItemsA && !alertTypeItemsB) { | ||
| return -1; | ||
| } | ||
| if (!alertTypeItemsA && !!alertTypeItemsB) { | ||
| return 1; | ||
| } | ||
|
There was a problem hiding this comment. The mix of
Something like that? |
||
|
|
||
| return solutions | ||
| ? solutions.get(solutionA)!.localeCompare(solutions.get(solutionB)!) | ||
| : solutionA.localeCompare(solutionB); | ||
| } | ||
|
|
||
| export function alertTypeCompare( | ||
| a: { | ||
| id: string; | ||
| name: string; | ||
| checkEnabledResult: IsEnabledResult | IsDisabledResult; | ||
| alertTypeItem: AlertTypeModel; | ||
| }, | ||
| b: { | ||
| id: string; | ||
| name: string; | ||
| checkEnabledResult: IsEnabledResult | IsDisabledResult; | ||
| alertTypeItem: AlertTypeModel; | ||
| } | ||
| ) { | ||
| if (a.checkEnabledResult.isEnabled === true && b.checkEnabledResult.isEnabled === false) { | ||
| return -1; | ||
| } | ||
| if (a.checkEnabledResult.isEnabled === false && b.checkEnabledResult.isEnabled === true) { | ||
| return 1; | ||
| } | ||
| return a.name.localeCompare(b.name); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { AlertType } from '../../types'; | ||
| import { checkAlertTypeEnabled } from './check_alert_type_enabled'; | ||
|
|
||
| describe('checkAlertTypeEnabled', () => { | ||
| test(`returns isEnabled:true when alert type isn't provided`, async () => { | ||
| expect(checkAlertTypeEnabled()).toMatchInlineSnapshot(` | ||
| Object { | ||
| "isEnabled": true, | ||
| } | ||
| `); | ||
| }); | ||
|
|
||
| test('returns isEnabled:true when alert type is enabled', async () => { | ||
| const alertType: AlertType = { | ||
| id: 'test', | ||
| name: 'Test', | ||
| actionVariables: { | ||
| context: [{ name: 'var1', description: 'val1' }], | ||
| state: [{ name: 'var2', description: 'val2' }], | ||
| params: [{ name: 'var3', description: 'val3' }], | ||
| }, | ||
| producer: 'test', | ||
| actionGroups: [{ id: 'default', name: 'Default' }], | ||
| recoveryActionGroup: { id: 'recovered', name: 'Recovered' }, | ||
| defaultActionGroupId: 'default', | ||
| authorizedConsumers: {}, | ||
| minimumLicenseRequired: 'basic', | ||
| enabledInLicense: true, | ||
| }; | ||
| expect(checkAlertTypeEnabled(alertType)).toMatchInlineSnapshot(` | ||
| Object { | ||
| "isEnabled": true, | ||
| } | ||
| `); | ||
| }); | ||
|
|
||
| test('returns isEnabled:false when alert type is disabled by license', async () => { | ||
| const alertType: AlertType = { | ||
| id: 'test', | ||
| name: 'Test', | ||
| actionVariables: { | ||
| context: [{ name: 'var1', description: 'val1' }], | ||
| state: [{ name: 'var2', description: 'val2' }], | ||
| params: [{ name: 'var3', description: 'val3' }], | ||
| }, | ||
| producer: 'test', | ||
| actionGroups: [{ id: 'default', name: 'Default' }], | ||
| recoveryActionGroup: { id: 'recovered', name: 'Recovered' }, | ||
| defaultActionGroupId: 'default', | ||
| authorizedConsumers: {}, | ||
| minimumLicenseRequired: 'gold', | ||
| enabledInLicense: false, | ||
| }; | ||
| expect(checkAlertTypeEnabled(alertType)).toMatchInlineSnapshot(` | ||
| Object { | ||
| "isEnabled": false, | ||
| "message": "This alert type requires a Gold license.", | ||
| } | ||
| `); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import { upperFirst } from 'lodash'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { AlertType } from '../../types'; | ||
|
|
||
| export interface IsEnabledResult { | ||
| isEnabled: true; | ||
| } | ||
| export interface IsDisabledResult { | ||
| isEnabled: false; | ||
| message: string; | ||
| } | ||
|
|
||
| const getLicenseCheckResult = (alertType: AlertType) => { | ||
| return { | ||
| isEnabled: false, | ||
| message: i18n.translate( | ||
| 'xpack.triggersActionsUI.checkAlertTypeEnabled.alertTypeDisabledByLicenseMessage', | ||
| { | ||
| defaultMessage: 'This alert type requires a {minimumLicenseRequired} license.', | ||
| values: { | ||
| minimumLicenseRequired: upperFirst(alertType.minimumLicenseRequired), | ||
| }, | ||
| } | ||
| ), | ||
| }; | ||
| }; | ||
|
|
||
| export function checkAlertTypeEnabled(alertType?: AlertType): IsEnabledResult | IsDisabledResult { | ||
| if (alertType?.enabledInLicense === false) { | ||
| return getLicenseCheckResult(alertType); | ||
| } | ||
|
|
||
| return { isEnabled: true }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It isn't quite clear what a solution is.
Is there a more descriptive name we can use here?
Additionally, can we add some unit tests around this please?