Skip to content

Commit

Permalink
Refactor SeverityFilterGroup to use EuiSelectable instead of EuiFilte…
Browse files Browse the repository at this point in the history
…rSelectItem

EuiFilterSelectItem is deprecated by the EUI team
  • Loading branch information
machadoum committed Jan 16, 2024
1 parent e49aee0 commit a7509a8
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import React from 'react';

import { EuiHealth, transparentize } from '@elastic/eui';
import { EuiHealth, EuiTextColor, transparentize } from '@elastic/eui';

import styled, { css } from 'styled-components';
import { euiLightVars } from '@kbn/ui-theme';
Expand Down Expand Up @@ -38,17 +38,25 @@ export const RiskScoreLevel: React.FC<{
severity: RiskSeverity;
hideBackgroundColor?: boolean;
toolTipContent?: JSX.Element;
}> = ({ severity, hideBackgroundColor = false, toolTipContent }) => {
['data-test-subj']?: string;
}> = ({
severity,
hideBackgroundColor = false,
toolTipContent,
'data-test-subj': dataTestSubj,
}) => {
const badge = (
<RiskBadge
color={euiLightVars.euiColorDanger}
$severity={severity}
$hideBackgroundColor={hideBackgroundColor}
data-test-subj="risk-score"
data-test-subj={dataTestSubj ?? 'risk-score'}
>
<EuiHealth className="eui-alignMiddle" color={RISK_SEVERITY_COLOUR[severity]}>
{severity}
</EuiHealth>
<EuiTextColor color="default">
<EuiHealth className="eui-alignMiddle" color={RISK_SEVERITY_COLOUR[severity]}>
{severity}
</EuiHealth>
</EuiTextColor>
</RiskBadge>
);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ describe('SeverityFilterGroup', () => {
});

it('preserves sort order when severityCount is out of order', () => {
const { getByTestId, getAllByTestId } = render(
const { getByTestId } = render(
<TestProviders>
<SeverityFilterGroup
selectedSeverities={[]}
Expand All @@ -47,17 +47,13 @@ describe('SeverityFilterGroup', () => {

fireEvent.click(getByTestId('risk-filter-button'));

expect(getAllByTestId('risk-score').map((ele) => ele.textContent)).toEqual([
'Unknown',
'Low',
'Moderate',
'High',
'Critical',
]);
expect(getByTestId('risk-filter-selectable').textContent).toEqual(
['Unknown', 'Low', 'Moderate', 'High', 'Critical'].join('')
);
});

it('sends telemetry when selecting a classification', () => {
const { getByTestId, getAllByTestId } = render(
const { getByTestId } = render(
<TestProviders>
<SeverityFilterGroup
selectedSeverities={[]}
Expand All @@ -76,12 +72,12 @@ describe('SeverityFilterGroup', () => {

fireEvent.click(getByTestId('risk-filter-button'));

fireEvent.click(getAllByTestId('risk-score').at(0)!);
fireEvent.click(getByTestId('risk-filter-item-Unknown'));
expect(mockedTelemetry.reportEntityRiskFiltered).toHaveBeenCalledTimes(1);
});

it('does not send telemetry when deselecting a classification', () => {
const { getByTestId, getAllByTestId } = render(
const { getByTestId } = render(
<TestProviders>
<SeverityFilterGroup
selectedSeverities={[
Expand All @@ -106,7 +102,7 @@ describe('SeverityFilterGroup', () => {

fireEvent.click(getByTestId('risk-filter-button'));

fireEvent.click(getAllByTestId('risk-score').at(0)!);
fireEvent.click(getByTestId('risk-filter-item-Unknown'));
expect(mockedTelemetry.reportEntityRiskFiltered).toHaveBeenCalledTimes(0);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,11 @@ import type { FilterChecked } from '@elastic/eui';
import {
EuiFilterButton,
EuiFilterGroup,
EuiFilterSelectItem,
EuiPopover,
useGeneratedHtmlId,
useEuiTheme,
EuiSelectable,
} from '@elastic/eui';

import { i18n } from '@kbn/i18n';
import { SEVERITY_UI_SORT_ORDER } from '../../common/utils';
import type { RiskScoreEntity, RiskSeverity } from '../../../../common/search_strategy';
import type { SeverityCount } from './types';
Expand All @@ -27,14 +26,22 @@ interface SeverityItems {
risk: RiskSeverity;
count: number;
checked?: FilterChecked;
label: string;
}

const SEVERITY_FILTER_ARIA_LABEL = i18n.translate(
'xpack.securitySolution.entityAnalytics.severityFilter.ariaLabel',
{
defaultMessage: 'Select the severity level to filter by',
}
);

export const SeverityFilterGroup: React.FC<{
severityCount: SeverityCount;
selectedSeverities: RiskSeverity[];
onSelect: (newSelection: RiskSeverity[]) => void;
riskEntity: RiskScoreEntity;
}> = ({ severityCount, selectedSeverities, onSelect, riskEntity }) => {
const { euiTheme } = useEuiTheme();
const { telemetry } = useKibana().services;
const [isPopoverOpen, setIsPopoverOpen] = useState(false);

Expand All @@ -55,26 +62,27 @@ export const SeverityFilterGroup: React.FC<{
return SEVERITY_UI_SORT_ORDER.map((severity) => ({
risk: severity,
count: severityCount[severity],
label: severity,
checked: selectedSeverities.includes(severity) ? checked : undefined,
}));
}, [severityCount, selectedSeverities]);

const updateSeverityFilter = useCallback(
(selectedSeverity: RiskSeverity) => {
const currentSelection = selectedSeverities ?? [];
const isAddingSeverity = !currentSelection.includes(selectedSeverity);

const newSelection = isAddingSeverity
? [...currentSelection, selectedSeverity]
: currentSelection.filter((s) => s !== selectedSeverity);

if (isAddingSeverity) {
telemetry.reportEntityRiskFiltered({ entity: riskEntity, selectedSeverity });
(newSelection: SeverityItems[], _, changedSeverity: SeverityItems) => {
if (changedSeverity.checked === 'on') {
telemetry.reportEntityRiskFiltered({
entity: riskEntity,
selectedSeverity: changedSeverity.risk,
});
}

onSelect(newSelection);
const newSelectedSeverities = newSelection
.filter((item) => item.checked === 'on')
.map((item) => item.risk);

onSelect(newSelectedSeverities);
},
[selectedSeverities, onSelect, telemetry, riskEntity]
[onSelect, riskEntity, telemetry]
);

const totalActiveItem = useMemo(
Expand Down Expand Up @@ -107,21 +115,17 @@ export const SeverityFilterGroup: React.FC<{
closePopover={closePopover}
panelPaddingSize="none"
>
{/* EUI NOTE: Please use EuiSelectable (which already has height/scrolling built in)
instead of EuiFilterSelectItem (which is pending deprecation).
@see https://elastic.github.io/eui/#/forms/filter-group#multi-select */}
<div className="eui-yScroll" css={{ maxHeight: euiTheme.base * 30 }}>
{items.map((item, index) => (
<EuiFilterSelectItem
data-test-subj={`risk-filter-item-${item.risk}`}
checked={item.checked}
key={index + item.risk}
onClick={() => updateSeverityFilter(item.risk)}
>
<RiskScoreLevel severity={item.risk} />
</EuiFilterSelectItem>
))}
</div>
<EuiSelectable
aria-label={SEVERITY_FILTER_ARIA_LABEL}
options={items}
onChange={updateSeverityFilter}
data-test-subj="risk-filter-selectable"
renderOption={(item) => (
<RiskScoreLevel data-test-subj={`risk-filter-item-${item.risk}`} severity={item.risk} />
)}
>
{(list) => <div style={{ width: 150 }}>{list}</div>}
</EuiSelectable>
</EuiPopover>
</EuiFilterGroup>
);
Expand Down

0 comments on commit a7509a8

Please sign in to comment.