Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SecuritySolution] Update severity colors for Borealis theme #206276

Merged
merged 23 commits into from
Jan 25, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const AlertsPreview = ({
const alertStats = Array.from(severityMap, ([key, count]) => ({
key: capitalize(key),
count,
color: getSeverityColor(key),
color: getSeverityColor(key, euiTheme),
}));

const totalAlertsCount = alertStats.reduce((total, item) => total + item.count, 0);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,15 @@ import React, { memo, useCallback, useEffect, useState } from 'react';
import { encode } from '@kbn/rison';
import { capitalize } from 'lodash';
import type { Criteria, EuiBasicTableColumn, EuiTableSortingType } from '@elastic/eui';
import { EuiSpacer, EuiPanel, EuiText, EuiBasicTable, EuiIcon, EuiLink } from '@elastic/eui';
import {
EuiSpacer,
EuiPanel,
EuiText,
EuiBasicTable,
EuiIcon,
EuiLink,
useEuiTheme,
} from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { DistributionBar } from '@kbn/security-solution-distribution-bar';
import {
Expand Down Expand Up @@ -77,6 +85,7 @@ interface AlertsDetailsFields {

export const AlertsDetailsTable = memo(
({ field, value }: { field: 'host.name' | 'user.name'; value: string }) => {
const { euiTheme } = useEuiTheme();
useEffect(() => {
uiMetricService.trackUiMetric(
METRIC_TYPE.COUNT,
Expand Down Expand Up @@ -163,7 +172,7 @@ export const AlertsDetailsTable = memo(
const alertStats = Array.from(severityMap, ([key, count]) => ({
key: capitalize(key),
count,
color: getSeverityColor(key),
color: getSeverityColor(key, euiTheme),
filter: () => {
setCurrentFilter(key);
setQuery(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/
import type { EuiThemeComputed } from '@elastic/eui';
import { useEuiTheme } from '@elastic/eui';
import { css } from '@emotion/react';
import React from 'react';
Expand All @@ -15,12 +14,10 @@ interface DonutChartEmptyProps {
}

/*
** @deprecated use getEmptyDonutColor instead
** @deprecated
*/
export const emptyDonutColor = '#FAFBFD';

export const getEmptyDonutColor = (euiTheme: EuiThemeComputed) => euiTheme.colors.textSubdued;

const EmptyDonutChartComponent: React.FC<DonutChartEmptyProps> = ({
size = 90,
donutWidth = 20,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,11 @@

import React from 'react';
import { upperFirst } from 'lodash/fp';
import { euiLightVars } from '@kbn/ui-theme';
import type { Severity } from '@kbn/securitysolution-io-ts-alerting-types';

import { useEuiTheme } from '@elastic/eui';
import { HealthTruncateText } from '../health_truncate_text';

const { euiColorVis0, euiColorVis5, euiColorVis7, euiColorVis9 } = euiLightVars;
const severityToColorMap: Record<Severity, string> = {
low: euiColorVis0,
medium: euiColorVis5,
high: euiColorVis7,
critical: euiColorVis9,
};
import { useRiskSeverityColors } from '../../utils/risk_color_palette';

interface Props {
value: Severity;
Expand All @@ -29,8 +22,10 @@ const SeverityBadgeComponent: React.FC<Props> = ({
value,
'data-test-subj': dataTestSubj = 'severity',
}) => {
const { euiTheme } = useEuiTheme();
const displayValue = upperFirst(value);
const color = severityToColorMap[value] ?? 'subdued';
const severityToColorMap = useRiskSeverityColors();
const color = severityToColorMap[value] ?? euiTheme.colors.textSubdued;

return (
<HealthTruncateText
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,6 @@
* 2.0.
*/

import { euiLightVars } from '@kbn/ui-theme';

export const RISK_COLOR_LOW = euiLightVars.euiColorVis0;
export const RISK_COLOR_MEDIUM = euiLightVars.euiColorVis5;
export const RISK_COLOR_HIGH = euiLightVars.euiColorVis7;
export const RISK_COLOR_CRITICAL = euiLightVars.euiColorVis9;

export const RISK_SCORE_LOW = 21;
export const RISK_SCORE_MEDIUM = 47;
export const RISK_SCORE_HIGH = 73;
Expand Down
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be worth writing some uni tests, even though this is basic, it is used in a few places. As least if someone makes a change by mistake, they will be reminded...

Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*
* 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 type { EuiThemeComputed } from '@elastic/eui';
import { useEuiTheme } from '@elastic/eui';
import type { Severity } from '@kbn/securitysolution-io-ts-alerting-types';
import { useMemo } from 'react';

export const getRiskSeverityColors = (euiTheme: EuiThemeComputed) => {
if (euiTheme.flags.hasVisColorAdjustment) {
angorayc marked this conversation as resolved.
Show resolved Hide resolved
// Amsterdam
return {
low: euiTheme.colors.vis.euiColorVis0,
medium: euiTheme.colors.vis.euiColorVis5,
high: euiTheme.colors.vis.euiColorVis7,
critical: euiTheme.colors.vis.euiColorVis9,
};
}

// Borealis
return {
low: euiTheme.colors.vis.euiColorVisSuccess0,
medium: euiTheme.colors.vis.euiColorSeverity7,
high: euiTheme.colors.vis.euiColorSeverity10,
critical: euiTheme.colors.vis.euiColorSeverity14,
};
};

export const useRiskSeverityColors = (): Record<Severity, string> => {
const { euiTheme } = useEuiTheme();

return useMemo(() => getRiskSeverityColors(euiTheme), [euiTheme]);
};
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import React from 'react';
import { mount, shallow } from 'enzyme';
import { EuiProgress, EuiButtonGroup } from '@elastic/eui';
import { EuiProgress, EuiButtonGroup, useEuiTheme } from '@elastic/eui';
import { ThemeProvider } from 'styled-components';

import { StepAboutRuleToggleDetails } from '.';
Expand All @@ -19,6 +19,7 @@ import { HeaderSection } from '../../../../common/components/header_section';
import { StepAboutRule } from '../../../rule_creation_ui/components/step_about_rule';
import type { AboutStepRule } from '../../../../detections/pages/detection_engine/rules/types';
import { getMockTheme } from '../../../../common/lib/kibana/kibana_react.mock';
import { renderHook } from '@testing-library/react';

jest.mock('../../../../common/lib/kibana');

Expand All @@ -30,7 +31,9 @@ describe('StepAboutRuleToggleDetails', () => {
let stepDataMock: AboutStepRule;

beforeEach(() => {
stepDataMock = mockAboutStepRule();
const { result } = renderHook(() => useEuiTheme());
const euiTheme = result.current.euiTheme;
stepDataMock = mockAboutStepRule(euiTheme);
});

test('it renders loading component when "loading" is true', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ import { TestProviders } from '../../../../common/mock';
import { StepRuleActions, stepActionsDefaultValue } from '.';
import {
defaultSchedule,
stepAboutDefaultValue,
getStepAboutDefaultValue,
stepDefineDefaultValue,
} from '../../../../detections/pages/detection_engine/rules/utils';
import { useRuleForms } from '../../../rule_creation_ui/pages/form';
import type { FormHook } from '../../../../shared_imports';
import type { ActionsStepRule } from '../../../../detections/pages/detection_engine/rules/types';
import { FrequencyDescription } from './notification_action';
import type { EuiThemeComputed } from '@elastic/eui';

jest.mock('../../../../common/lib/kibana', () => ({
useKibana: jest.fn().mockReturnValue({
Expand Down Expand Up @@ -61,7 +62,7 @@ describe('StepRuleActions', () => {
}) => {
const { actionsStepForm } = useRuleForms({
defineStepDefault: stepDefineDefaultValue,
aboutStepDefault: stepAboutDefaultValue,
aboutStepDefault: getStepAboutDefaultValue({} as unknown as EuiThemeComputed),
scheduleStepDefault: defaultSchedule,
actionsStepDefault: stepActionsDefaultValue,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

import React from 'react';
import { shallow, mount } from 'enzyme';
import { render } from '@testing-library/react';
import { render, renderHook } from '@testing-library/react';

import {
StepRuleDescription,
Expand Down Expand Up @@ -40,6 +40,7 @@ import {
ALERT_SUPPRESSION_MISSING_FIELDS_FIELD_NAME,
} from '../../../rule_creation/components/alert_suppression_edit';
import { THRESHOLD_ALERT_SUPPRESSION_ENABLED } from '../../../rule_creation/components/threshold_alert_suppression_edit';
import { useEuiTheme } from '@elastic/eui';

jest.mock('../../../../common/lib/kibana');

Expand All @@ -60,7 +61,9 @@ describe('description_step', () => {
beforeEach(() => {
setupMock.uiSettings.get.mockImplementation(uiSettingsMock(true));
mockFilterManager = new FilterManager(setupMock.uiSettings);
mockAboutStep = mockAboutStepRule();
const { result } = renderHook(() => useEuiTheme());
const euiTheme = result.current.euiTheme;
mockAboutStep = mockAboutStepRule(euiTheme);
angorayc marked this conversation as resolved.
Show resolved Hide resolved
});

describe('StepRuleDescription', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import { usePreviewRoute } from './use_preview_route';
import { DataSourceType } from '../../../../detections/pages/detection_engine/rules/types';
import {
getStepScheduleDefaultValue,
stepAboutDefaultValue,
getStepAboutDefaultValue,
stepDefineDefaultValue,
} from '../../../../detections/pages/detection_engine/rules/utils';
import { usePreviewInvocationCount } from './use_preview_invocation_count';
import type { EuiThemeComputed } from '@elastic/eui';

jest.mock('../../../../common/lib/kibana');
jest.mock('./use_preview_route');
Expand Down Expand Up @@ -95,7 +96,7 @@ const defaultProps: RulePreviewProps = {
newTermsFields: ['host.ip'],
historyWindowSize: '7d',
},
aboutRuleData: stepAboutDefaultValue,
aboutRuleData: getStepAboutDefaultValue({} as unknown as EuiThemeComputed),
scheduleRuleData: getStepScheduleDefaultValue('threat_match'),
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ import {
EuiFlexItem,
EuiSpacer,
EuiSuperSelect,
useEuiTheme,
} from '@elastic/eui';
import React from 'react';
import type { Severity } from '../../../../../common/api/detection_engine/model/rule_schema/common_attributes.gen';
import { severityOptions } from '../step_about_rule/data';
import { getSeverityOptions } from '../step_about_rule/data';
import * as i18n from './translations';

const describedByIds = ['detectionEngineStepAboutRuleSeverity'];
Expand All @@ -26,6 +27,8 @@ interface DefaultSeverityProps {
}

export function DefaultSeverity({ value, onChange }: DefaultSeverityProps) {
const { euiTheme } = useEuiTheme();
const severityOptions = getSeverityOptions(euiTheme);
angorayc marked this conversation as resolved.
Show resolved Hide resolved
return (
<EuiFlexItem>
<EuiFormRow
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
EuiFormLabel,
EuiIcon,
EuiSpacer,
useEuiTheme,
} from '@elastic/eui';
import React, { useCallback, useMemo } from 'react';
import type { DataViewBase, DataViewFieldBase } from '@kbn/es-query';
Expand All @@ -22,7 +23,7 @@ import {
AutocompleteFieldMatchComponent,
} from '@kbn/securitysolution-autocomplete';
import type { Severity, SeverityMappingItem } from '@kbn/securitysolution-io-ts-alerting-types';
import { severityOptions } from '../step_about_rule/data';
import { getSeverityOptions } from '../step_about_rule/data';
import { useKibana } from '../../../../common/lib/kibana';
import * as styles from './styles';
import * as i18n from './translations';
Expand Down Expand Up @@ -158,6 +159,9 @@ function SeverityMappingRow({
[index, severityMappingItem.severity, onFieldMatchValueChange]
);

const { euiTheme } = useEuiTheme();
const severityOptions = useMemo(() => getSeverityOptions(euiTheme), [euiTheme]);

return (
<EuiFlexItem key={`${severityMappingItem.severity}-${index}`}>
<EuiFlexGroup data-test-subj="severityOverrideRow" alignItems="center" gutterSize="s">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,18 @@

import React from 'react';
import styled from 'styled-components';
import type { EuiThemeComputed } from '@elastic/eui';
import { EuiHealth } from '@elastic/eui';
import type { Severity } from '@kbn/securitysolution-io-ts-alerting-types';
import * as I18n from './translations';

import {
RISK_COLOR_LOW,
RISK_COLOR_MEDIUM,
RISK_COLOR_HIGH,
RISK_COLOR_CRITICAL,
RISK_SCORE_LOW,
RISK_SCORE_MEDIUM,
RISK_SCORE_HIGH,
RISK_SCORE_CRITICAL,
} from '../../../../common/constants';
import { getRiskSeverityColors } from '../../../../common/utils/risk_color_palette';

export interface SeverityOptionItem {
value: Severity;
Expand All @@ -31,24 +29,36 @@ const StyledEuiHealth = styled(EuiHealth)`
line-height: inherit;
`;

export const severityOptions: SeverityOptionItem[] = [
{
value: 'low',
inputDisplay: <StyledEuiHealth color={RISK_COLOR_LOW}>{I18n.LOW}</StyledEuiHealth>,
},
{
value: 'medium',
inputDisplay: <StyledEuiHealth color={RISK_COLOR_MEDIUM}>{I18n.MEDIUM}</StyledEuiHealth>,
},
{
value: 'high',
inputDisplay: <StyledEuiHealth color={RISK_COLOR_HIGH}>{I18n.HIGH}</StyledEuiHealth>,
},
{
value: 'critical',
inputDisplay: <StyledEuiHealth color={RISK_COLOR_CRITICAL}>{I18n.CRITICAL}</StyledEuiHealth>,
},
];
export enum SeverityLevel {
low = 'low',
medium = 'medium',
high = 'high',
critical = 'critical',
}

export const getSeverityOptions: (euiTheme: EuiThemeComputed) => SeverityOptionItem[] = (
euiTheme
) => {
const palette = getRiskSeverityColors(euiTheme);
return [
{
value: SeverityLevel.low,
inputDisplay: <StyledEuiHealth color={palette.low}>{I18n.LOW}</StyledEuiHealth>,
},
{
value: SeverityLevel.medium,
inputDisplay: <StyledEuiHealth color={palette.medium}>{I18n.MEDIUM}</StyledEuiHealth>,
},
{
value: SeverityLevel.high,
inputDisplay: <StyledEuiHealth color={palette.high}>{I18n.HIGH}</StyledEuiHealth>,
},
{
value: SeverityLevel.critical,
inputDisplay: <StyledEuiHealth color={palette.critical}>{I18n.CRITICAL}</StyledEuiHealth>,
},
];
};

export const defaultRiskScoreBySeverity: Record<Severity, number> = {
low: RISK_SCORE_LOW,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@ export const stepAboutDefaultValue: AboutStepRule = {
description: '',
isAssociatedToEndpointList: false,
isBuildingBlock: false,
severity: { value: 'low', mapping: fillEmptySeverityMappings([]), isMappingChecked: false },
severity: {
value: 'low',
mapping: fillEmptySeverityMappings([]),
isMappingChecked: false,
},
riskScore: { value: 21, mapping: [], isMappingChecked: false },
references: [''],
falsePositives: [''],
Expand Down
Loading