[SecuritySolution][Detections] Adds UI for new Rule Fields: Related Integrations, Required Fields, and Setup #131475
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 | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { EuiLink } from '@elastic/eui'; | ||
| import { capitalize } from 'lodash'; | ||
| import React from 'react'; | ||
| import semver from 'semver'; | ||
| import { | ||
| RelatedIntegration, | ||
| RelatedIntegrationArray, | ||
| } from '../../../../common/detection_engine/schemas/common'; | ||
|
|
||
| /** | ||
| * Returns an `EuiLink` that will link to a given package/integration/version page within fleet | ||
| * @param integration | ||
| * @param basePath | ||
| */ | ||
| export const getIntegrationLink = (integration: RelatedIntegration, basePath: string) => { | ||
| const integrationURL = `${basePath}/app/integrations/detail/${integration.package}-${ | ||
| integration.version | ||
| }/overview${integration.integration ? `?integration=${integration.integration}` : ''}`; | ||
| return ( | ||
| <EuiLink href={integrationURL} target="_blank"> | ||
| {`${capitalize(integration.package)} ${capitalize(integration.integration)}`} | ||
| </EuiLink> | ||
| ); | ||
| }; | ||
|
|
||
| export interface InstalledIntegration extends RelatedIntegration { | ||
| targetVersion: string; | ||
| versionSatisfied?: boolean; | ||
| } | ||
|
|
||
| /** | ||
| * Given an array of integrations and an array of installed integrations this will return which | ||
| * integrations are `available`/`uninstalled` and which are `installed`, and also augmented with | ||
| * `targetVersion` and `versionSatisfied` | ||
| * @param integrations | ||
| * @param installedIntegrations | ||
| */ | ||
| export const getInstalledRelatedIntegrations = ( | ||
| integrations: RelatedIntegrationArray, | ||
| installedIntegrations: RelatedIntegrationArray | ||
| ): { | ||
| availableIntegrations: RelatedIntegrationArray; | ||
| installedRelatedIntegrations: InstalledIntegration[]; | ||
| } => { | ||
| const availableIntegrations: RelatedIntegrationArray = []; | ||
| const installedRelatedIntegrations: InstalledIntegration[] = []; | ||
|
|
||
| integrations.forEach((i: RelatedIntegration) => { | ||
| const match = installedIntegrations.find( | ||
| (installed) => installed.package === i.package && installed?.integration === i?.integration | ||
| ); | ||
| if (match != null) { | ||
| // Version check e.g. fleet match `1.2.3` satisfies rule dependency `~1.2.1` | ||
| const versionSatisfied = semver.satisfies(match.version, i.version); | ||
| installedRelatedIntegrations.push({ ...match, targetVersion: i.version, versionSatisfied }); | ||
| } else { | ||
| availableIntegrations.push(i); | ||
| } | ||
| }); | ||
|
|
||
| return { | ||
| availableIntegrations, | ||
| installedRelatedIntegrations, | ||
| }; | ||
| }; |
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,143 @@ | ||
| /* | ||
| * 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 React, { useState } from 'react'; | ||
| import { | ||
| EuiPopover, | ||
| EuiBadge, | ||
| EuiPopoverTitle, | ||
| EuiFlexGroup, | ||
| EuiText, | ||
| EuiIconTip, | ||
| } from '@elastic/eui'; | ||
| import styled from 'styled-components'; | ||
| import { useBasePath } from '../../lib/kibana'; | ||
| import { getInstalledRelatedIntegrations, getIntegrationLink } from './helpers'; | ||
| import { useInstalledIntegrations } from '../../../detections/containers/detection_engine/rules/use_installed_integrations'; | ||
| import type { RelatedIntegrationArray } from '../../../../common/detection_engine/schemas/common'; | ||
|
|
||
| import * as i18n from '../../../detections/pages/detection_engine/rules/translations'; | ||
|
|
||
| export interface IntegrationsPopoverProps { | ||
| integrations: RelatedIntegrationArray; | ||
| } | ||
|
|
||
| const IntegrationsPopoverWrapper = styled(EuiFlexGroup)` | ||
| width: 100%; | ||
| `; | ||
|
|
||
| const PopoverContentWrapper = styled('div')` | ||
| max-height: 400px; | ||
| max-width: 368px; | ||
| overflow: auto; | ||
| line-height: ${({ theme }) => theme.eui.euiLineHeight}; | ||
| `; | ||
|
|
||
| const IntegrationListItem = styled('li')` | ||
| list-style-type: disc; | ||
| margin-left: 25px; | ||
| `; | ||
| /** | ||
| * Component to render installed and available integrations | ||
| * @param integrations - array of integrations to display | ||
| */ | ||
| const IntegrationsPopoverComponent = ({ integrations }: IntegrationsPopoverProps) => { | ||
| const [isPopoverOpen, setPopoverOpen] = useState(false); | ||
| const { data } = useInstalledIntegrations({ packages: [] }); | ||
| const basePath = useBasePath(); | ||
|
|
||
| const allInstalledIntegrations: RelatedIntegrationArray = data ?? []; | ||
| const { availableIntegrations, installedRelatedIntegrations } = getInstalledRelatedIntegrations( | ||
| integrations, | ||
| allInstalledIntegrations | ||
| ); | ||
|
|
||
| const badgeTitle = | ||
| data != null | ||
| ? `${installedRelatedIntegrations.length}/${integrations.length} ${i18n.INTEGRATIONS_BADGE}` | ||
| : `${integrations.length} ${i18n.INTEGRATIONS_BADGE}`; | ||
|
|
||
| return ( | ||
| <IntegrationsPopoverWrapper | ||
| alignItems="center" | ||
| gutterSize="s" | ||
| data-test-subj={'IntegrationsWrapper'} | ||
| > | ||
| <EuiPopover | ||
| ownFocus | ||
| data-test-subj={'IntegrationsDisplayPopover'} | ||
| button={ | ||
| <EuiBadge | ||
| iconType={'tag'} | ||
| color="hollow" | ||
| data-test-subj={'IntegrationsDisplayPopoverButton'} | ||
| onClick={() => setPopoverOpen(!isPopoverOpen)} | ||
| onClickAriaLabel={badgeTitle} | ||
| > | ||
| {badgeTitle} | ||
| </EuiBadge> | ||
| } | ||
| isOpen={isPopoverOpen} | ||
| closePopover={() => setPopoverOpen(!isPopoverOpen)} | ||
| repositionOnScroll | ||
| > | ||
| <EuiPopoverTitle data-test-subj={'IntegrationsPopoverTitle'}> | ||
| {i18n.INTEGRATIONS_POPOVER_TITLE(integrations.length)} | ||
| </EuiPopoverTitle> | ||
|
|
||
| <PopoverContentWrapper data-test-subj={'IntegrationsPopoverContentWrapper'}> | ||
| {data != null && ( | ||
| <> | ||
| <EuiText size={'s'}> | ||
| {i18n.INTEGRATIONS_POPOVER_DESCRIPTION_INSTALLED( | ||
| installedRelatedIntegrations.length | ||
| )} | ||
| </EuiText> | ||
| <ul> | ||
| {installedRelatedIntegrations.map((integration, index) => ( | ||
| <IntegrationListItem key={index}> | ||
| {getIntegrationLink(integration, basePath)} | ||
| {!integration?.versionSatisfied && ( | ||
| <EuiIconTip | ||
| type="alert" | ||
| content={i18n.INTEGRATIONS_INSTALLED_VERSION_TOOLTIP( | ||
| integration.version, | ||
| integration.targetVersion | ||
| )} | ||
| position="right" | ||
| /> | ||
| )} | ||
| </IntegrationListItem> | ||
| ))} | ||
| </ul> | ||
| </> | ||
| )} | ||
| {availableIntegrations.length > 0 && ( | ||
| <> | ||
| <EuiText size={'s'}> | ||
| {i18n.INTEGRATIONS_POPOVER_DESCRIPTION_UNINSTALLED(availableIntegrations.length)} | ||
| </EuiText> | ||
| <ul> | ||
| {availableIntegrations.map((integration, index) => ( | ||
| <IntegrationListItem key={index}> | ||
| {getIntegrationLink(integration, basePath)} | ||
| </IntegrationListItem> | ||
| ))} | ||
| </ul> | ||
| </> | ||
| )} | ||
| </PopoverContentWrapper> | ||
| </EuiPopover> | ||
| </IntegrationsPopoverWrapper> | ||
| ); | ||
| }; | ||
|
|
||
| const MemoizedIntegrationsPopover = React.memo(IntegrationsPopoverComponent); | ||
| MemoizedIntegrationsPopover.displayName = 'IntegrationsPopover'; | ||
|
|
||
| export const IntegrationsPopover = | ||
| MemoizedIntegrationsPopover as typeof IntegrationsPopoverComponent; |
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.
Don't mind this... 😅
I was testing #131166 the other day and had it with the badge overflow. Since in doing this PR I learned of the
PopoverItemscomponent I figured there was a nice quick fix here:cc @randomuserid