[Fleet] Enable per policy outputs #126692
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
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
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,181 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { createFleetTestRendererMock } from '../../../../../../mock'; | ||
| import type { MockedFleetStartServices } from '../../../../../../mock'; | ||
| import { useLicense } from '../../../../../../hooks/use_license'; | ||
| import type { LicenseService } from '../../../../services'; | ||
|
|
||
| import { useOutputOptions } from './hooks'; | ||
|
|
||
| jest.mock('../../../../../../hooks/use_license'); | ||
|
|
||
| const mockedUseLicence = useLicense as jest.MockedFunction<typeof useLicense>; | ||
|
|
||
| function defaultHttpClientGetImplementation(path: any) { | ||
| if (typeof path !== 'string') { | ||
| throw new Error('Invalid request'); | ||
| } | ||
| const err = new Error(`API [GET ${path}] is not MOCKED!`); | ||
| // eslint-disable-next-line no-console | ||
| console.log(err); | ||
| throw err; | ||
| } | ||
|
|
||
| const mockApiCallsWithOutputs = (http: MockedFleetStartServices['http']) => { | ||
| http.get.mockImplementation(async (path) => { | ||
| if (typeof path !== 'string') { | ||
| throw new Error('Invalid request'); | ||
| } | ||
| if (path === '/api/fleet/outputs') { | ||
| return { | ||
| data: { | ||
| items: [ | ||
| { | ||
| id: 'output1', | ||
| name: 'Output 1', | ||
| is_default: true, | ||
| is_default_monitoring: true, | ||
| }, | ||
| { | ||
| id: 'output2', | ||
| name: 'Output 2', | ||
| is_default: true, | ||
| is_default_monitoring: true, | ||
| }, | ||
| { | ||
| id: 'output3', | ||
| name: 'Output 3', | ||
| is_default: true, | ||
| is_default_monitoring: true, | ||
| }, | ||
| ], | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| return defaultHttpClientGetImplementation(path); | ||
| }); | ||
| }; | ||
|
|
||
| describe('useOutputOptions', () => { | ||
| it('should generate enabled options if the licence is platinium', async () => { | ||
| const testRenderer = createFleetTestRendererMock(); | ||
| mockedUseLicence.mockReturnValue({ | ||
| hasAtLeast: () => true, | ||
| } as unknown as LicenseService); | ||
| mockApiCallsWithOutputs(testRenderer.startServices.http); | ||
| const { result, waitForNextUpdate } = testRenderer.renderHook(() => useOutputOptions()); | ||
| expect(result.current.isLoading).toBeTruthy(); | ||
|
|
||
| await waitForNextUpdate(); | ||
| expect(result.current.dataOutputOptions).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "inputDisplay": "Default (currently Output 1)", | ||
| "value": "@@##DEFAULT_OUTPUT_VALUE##@@", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 1", | ||
| "value": "output1", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 2", | ||
| "value": "output2", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 3", | ||
| "value": "output3", | ||
| }, | ||
| ] | ||
| `); | ||
| expect(result.current.monitoringOutputOptions).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "inputDisplay": "Default (currently Output 1)", | ||
| "value": "@@##DEFAULT_OUTPUT_VALUE##@@", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 1", | ||
| "value": "output1", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 2", | ||
| "value": "output2", | ||
| }, | ||
| Object { | ||
| "disabled": false, | ||
| "inputDisplay": "Output 3", | ||
| "value": "output3", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
|
|
||
| it('should only enable the default options if the licence is not platinium', async () => { | ||
| const testRenderer = createFleetTestRendererMock(); | ||
| mockedUseLicence.mockReturnValue({ | ||
| hasAtLeast: () => false, | ||
| } as unknown as LicenseService); | ||
| mockApiCallsWithOutputs(testRenderer.startServices.http); | ||
| const { result, waitForNextUpdate } = testRenderer.renderHook(() => useOutputOptions()); | ||
| expect(result.current.isLoading).toBeTruthy(); | ||
|
|
||
| await waitForNextUpdate(); | ||
| expect(result.current.dataOutputOptions).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "inputDisplay": "Default (currently Output 1)", | ||
| "value": "@@##DEFAULT_OUTPUT_VALUE##@@", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 1", | ||
| "value": "output1", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 2", | ||
| "value": "output2", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 3", | ||
| "value": "output3", | ||
| }, | ||
| ] | ||
| `); | ||
| expect(result.current.monitoringOutputOptions).toMatchInlineSnapshot(` | ||
| Array [ | ||
| Object { | ||
| "inputDisplay": "Default (currently Output 1)", | ||
| "value": "@@##DEFAULT_OUTPUT_VALUE##@@", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 1", | ||
| "value": "output1", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 2", | ||
| "value": "output2", | ||
| }, | ||
| Object { | ||
| "disabled": true, | ||
| "inputDisplay": "Output 3", | ||
| "value": "output3", | ||
| }, | ||
| ] | ||
| `); | ||
| }); | ||
| }); |
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,74 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { useMemo } from 'react'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import type { EuiSuperSelectOption } from '@elastic/eui'; | ||
|
|
||
| import { useGetOutputs, useLicense } from '../../../../hooks'; | ||
| import { LICENCE_FOR_PER_POLICY_OUTPUT } from '../../../../../../../common'; | ||
|
|
||
| // The super select component do not support null or '' as a value | ||
| export const DEFAULT_OUTPUT_VALUE = '@@##DEFAULT_OUTPUT_VALUE##@@'; | ||
|
There was a problem hiding this comment. the super select component do not support null or '' as a value so I come with that not super elegant solution |
||
|
|
||
| function getDefaultOutput(defaultOutputName?: string) { | ||
| return { | ||
| inputDisplay: i18n.translate('xpack.fleet.agentPolicy.outputOptions.defaultOutputText', { | ||
| defaultMessage: 'Default (currently {defaultOutputName})', | ||
| values: { defaultOutputName }, | ||
| }), | ||
| value: DEFAULT_OUTPUT_VALUE, | ||
| }; | ||
| } | ||
|
|
||
| export function useOutputOptions() { | ||
| const outputsRequest = useGetOutputs(); | ||
| const licenseService = useLicense(); | ||
|
|
||
| const isLicenceAllowingPolicyPerOutput = licenseService.hasAtLeast(LICENCE_FOR_PER_POLICY_OUTPUT); | ||
|
|
||
| const outputOptions: Array<EuiSuperSelectOption<string>> = useMemo(() => { | ||
| if (outputsRequest.isLoading || !outputsRequest.data) { | ||
| return []; | ||
| } | ||
|
|
||
| return outputsRequest.data.items.map((item) => ({ | ||
| value: item.id, | ||
| inputDisplay: item.name, | ||
| disabled: !isLicenceAllowingPolicyPerOutput, | ||
| })); | ||
| }, [outputsRequest, isLicenceAllowingPolicyPerOutput]); | ||
|
|
||
| const dataOutputOptions = useMemo(() => { | ||
| if (outputsRequest.isLoading || !outputsRequest.data) { | ||
| return []; | ||
| } | ||
|
|
||
| const defaultOutputName = outputsRequest.data.items.find((item) => item.is_default)?.name; | ||
| return [getDefaultOutput(defaultOutputName), ...outputOptions]; | ||
| }, [outputsRequest, outputOptions]); | ||
|
|
||
| const monitoringOutputOptions = useMemo(() => { | ||
| if (outputsRequest.isLoading || !outputsRequest.data) { | ||
| return []; | ||
| } | ||
|
|
||
| const defaultOutputName = outputsRequest.data.items.find( | ||
| (item) => item.is_default_monitoring | ||
| )?.name; | ||
| return [getDefaultOutput(defaultOutputName), ...outputOptions]; | ||
| }, [outputsRequest, outputOptions]); | ||
|
|
||
| return useMemo( | ||
| () => ({ | ||
| dataOutputOptions, | ||
| monitoringOutputOptions, | ||
| isLoading: outputsRequest.isLoading, | ||
| }), | ||
| [dataOutputOptions, monitoringOutputOptions, outputsRequest.isLoading] | ||
| ); | ||
| } | ||
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.
These fields are nullable to allow to clear them to use the default output
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.
Good note. Would you mind adding that as a comment directly in the code?