[8.x] [Security Solution] Integrate state and components for Prebuilt…

… Rule Update Workflow (#193531) (#194348) # Backport This will backport the following commits from `main` to `8.x`: - [[Security Solution] Integrate state and components for Prebuilt Rule Update Workflow (#193531)](#193531)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Maxim Palenov <maxim.palenov@elastic.co>
elastic · Sep 27, 2024 · 424886a · 424886a
1 parent d90b6a7
commit 424886a
Show file tree

Hide file tree

Showing 21 changed files with 538 additions and 141 deletions.
diff --git a/x-pack/plugins/security_solution/public/common/components/split_accordion/index.ts b/x-pack/plugins/security_solution/public/common/components/split_accordion/index.ts
@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export * from './split_accordion';
diff --git a/...ck/plugins/security_solution/public/common/components/split_accordion/split_accordion.tsx b/...ck/plugins/security_solution/public/common/components/split_accordion/split_accordion.tsx
@@ -0,0 +1,47 @@
+/*
+ * 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 from 'react';
+import { EuiAccordion, EuiSplitPanel, useEuiTheme, useGeneratedHtmlId } from '@elastic/eui';
+import { css } from '@emotion/css';
+import type { PropsWithChildren } from 'react';
+
+interface SplitAccordionProps {
+  header: React.ReactNode;
+  initialIsOpen?: boolean;
+  'data-test-subj'?: string;
+}
+
+export const SplitAccordion = ({
+  header,
+  initialIsOpen,
+  'data-test-subj': dataTestSubj,
+  children,
+}: PropsWithChildren<SplitAccordionProps>) => {
+  const accordionId = useGeneratedHtmlId();
+  const { euiTheme } = useEuiTheme();
+
+  return (
+    <EuiSplitPanel.Outer data-test-subj={`${dataTestSubj}Wrapper`} hasBorder>
+      <EuiAccordion
+        id={accordionId}
+        initialIsOpen={initialIsOpen}
+        css={css`
+          .euiAccordion__triggerWrapper {
+            background: ${euiTheme.colors.lightestShade};
+            padding: ${euiTheme.size.m};
+          }
+        `}
+        buttonContent={header}
+      >
+        <EuiSplitPanel.Inner data-test-subj={`${dataTestSubj}Content`} color="transparent">
+          {children}
+        </EuiSplitPanel.Inner>
+      </EuiAccordion>
+    </EuiSplitPanel.Outer>
+  );
+};
diff --git a/...c/detection_engine/rule_management/components/rule_details/diff_components/field_diff.tsx b/...c/detection_engine/rule_management/components/rule_details/diff_components/field_diff.tsx
@@ -8,8 +8,8 @@
 import { EuiFlexGroup, EuiHorizontalRule, EuiTitle } from '@elastic/eui';
 import { camelCase, startCase } from 'lodash';
 import React from 'react';
+import { SplitAccordion } from '../../../../../common/components/split_accordion';
 import { DiffView } from '../json_diff/diff_view';
-import { RuleDiffPanelWrapper } from './panel_wrapper';
 import type { FormattedFieldDiff, FieldDiff } from '../../../model/rule_details/rule_field_diff';
 import { fieldToDisplayNameMap } from './translations';
 
@@ -46,21 +46,31 @@ export const FieldGroupDiffComponent = ({
   fieldsGroupName,
 }: FieldDiffComponentProps) => {
   const { fieldDiffs, shouldShowSubtitles } = ruleDiffs;
+
   return (
-    <RuleDiffPanelWrapper fieldName={fieldsGroupName}>
+    <SplitAccordion
+      header={
+        <EuiTitle data-test-subj="ruleUpgradePerFieldDiffLabel" size="xs">
+          <h5>{fieldToDisplayNameMap[fieldsGroupName] ?? startCase(camelCase(fieldsGroupName))}</h5>
+        </EuiTitle>
+      }
+      initialIsOpen={true}
+      data-test-subj="ruleUpgradePerFieldDiff"
+    >
       {fieldDiffs.map(({ currentVersion, targetVersion, fieldName: specificFieldName }, index) => {
-        const shouldShowSeparator = index !== fieldDiffs.length - 1;
+        const isLast = index === fieldDiffs.length - 1;
+
         return (
           <SubFieldComponent
             key={specificFieldName}
-            shouldShowSeparator={shouldShowSeparator}
+            shouldShowSeparator={!isLast}
             shouldShowSubtitles={shouldShowSubtitles}
             currentVersion={currentVersion}
             targetVersion={targetVersion}
             fieldName={specificFieldName}
           />
         );
       })}
-    </RuleDiffPanelWrapper>
+    </SplitAccordion>
   );
 };
diff --git a/.../public/detection_engine/rule_management/components/rule_details/diff_components/index.ts b/.../public/detection_engine/rule_management/components/rule_details/diff_components/index.ts
@@ -7,5 +7,4 @@
 
 export * from './field_diff';
 export * from './header_bar';
-export * from './panel_wrapper';
 export * from './rule_diff_section';
diff --git a/...etection_engine/rule_management/components/rule_details/diff_components/panel_wrapper.tsx b/...etection_engine/rule_management/components/rule_details/diff_components/panel_wrapper.tsx
diff --git a/...ule_management/components/rule_details/three_way_diff/comparison_side/comparison_side.tsx b/...ule_management/components/rule_details/three_way_diff/comparison_side/comparison_side.tsx
@@ -6,7 +6,6 @@
  */
 
 import React, { useState } from 'react';
-import { EuiSpacer } from '@elastic/eui';
 import { VersionsPicker } from '../versions_picker/versions_picker';
 import type { Version } from '../versions_picker/constants';
 import { SelectedVersions } from '../versions_picker/constants';
@@ -17,6 +16,7 @@ import type {
 } from '../../../../../../../common/api/detection_engine';
 import { getSubfieldChanges } from './get_subfield_changes';
 import { SubfieldChanges } from './subfield_changes';
+import { SideHeader } from '../components/side_header';
 
 interface ComparisonSideProps<FieldName extends keyof DiffableAllFields> {
   fieldName: FieldName;
@@ -42,12 +42,13 @@ export function ComparisonSide<FieldName extends keyof DiffableAllFields>({
 
   return (
     <>
-      <VersionsPicker
-        hasBaseVersion={fieldThreeWayDiff.has_base_version}
-        selectedVersions={selectedVersions}
-        onChange={setSelectedVersions}
-      />
-      <EuiSpacer size="m" />
+      <SideHeader>
+        <VersionsPicker
+          hasBaseVersion={fieldThreeWayDiff.has_base_version}
+          selectedVersions={selectedVersions}
+          onChange={setSelectedVersions}
+        />
+      </SideHeader>
       <SubfieldChanges fieldName={fieldName} subfieldChanges={subfieldChanges} />
     </>
   );

diff --git a/...on_engine/rule_management/components/rule_details/three_way_diff/comparison_side/utils.ts b/...on_engine/rule_management/components/rule_details/three_way_diff/comparison_side/utils.ts
@@ -26,7 +26,7 @@ export function pickFieldValueForVersion<FieldName extends keyof DiffableAllFiel
   resolvedValue?: DiffableAllFields[FieldName]
 ): DiffableAllFields[FieldName] | undefined {
   if (version === Version.Final) {
-    return resolvedValue ?? fieldThreeWayDiff.merged_version;
+    return resolvedValue;
   }
 
   const versionFieldToPick = `${version}_version` as const;

diff --git a/...nt/components/rule_details/three_way_diff/components/field_upgrade_conflicts_resolver.tsx b/...nt/components/rule_details/three_way_diff/components/field_upgrade_conflicts_resolver.tsx
@@ -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
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+import { EuiFlexGroup, EuiFlexItem, EuiSpacer, useEuiTheme } from '@elastic/eui';
+import { css } from '@emotion/css';
+import { SplitAccordion } from '../../../../../../common/components/split_accordion';
+import type {
+  DiffableAllFields,
+  DiffableRule,
+  RuleFieldsDiff,
+  ThreeWayDiff,
+} from '../../../../../../../common/api/detection_engine';
+import { ThreeWayDiffConflict } from '../../../../../../../common/api/detection_engine';
+import { ComparisonSide } from '../comparison_side/comparison_side';
+import { FinalSide } from '../final_side/final_side';
+import { FieldUpgradeConflictsResolverHeader } from './field_upgrade_conflicts_resolver_header';
+
+interface FieldUpgradeConflictsResolverProps<FieldName extends keyof RuleFieldsDiff> {
+  fieldName: FieldName;
+  fieldThreeWayDiff: RuleFieldsDiff[FieldName];
+  finalDiffableRule: DiffableRule;
+}
+
+export function FieldUpgradeConflictsResolver<FieldName extends keyof RuleFieldsDiff>({
+  fieldName,
+  fieldThreeWayDiff,
+  finalDiffableRule,
+}: FieldUpgradeConflictsResolverProps<FieldName>): JSX.Element {
+  const { euiTheme } = useEuiTheme();
+  const hasConflict = fieldThreeWayDiff.conflict !== ThreeWayDiffConflict.NONE;
+
+  return (
+    <>
+      <SplitAccordion
+        header={<FieldUpgradeConflictsResolverHeader fieldName={fieldName} />}
+        initialIsOpen={hasConflict}
+        data-test-subj="ruleUpgradePerFieldDiff"
+      >
+        <EuiFlexGroup gutterSize="s" alignItems="flexStart">
+          <EuiFlexItem grow={1}>
+            <ComparisonSide
+              fieldName={fieldName}
+              fieldThreeWayDiff={fieldThreeWayDiff as ThreeWayDiff<DiffableAllFields[FieldName]>}
+              resolvedValue={finalDiffableRule[fieldName] as DiffableAllFields[FieldName]}
+            />
+          </EuiFlexItem>
+          <EuiFlexItem
+            grow={0}
+            css={css`
+              align-self: stretch;
+              border-right: ${euiTheme.border.thin};
+            `}
+          />
+          <EuiFlexItem grow={1}>
+            <FinalSide fieldName={fieldName} finalDiffableRule={finalDiffableRule} />
+          </EuiFlexItem>
+        </EuiFlexGroup>
+      </SplitAccordion>
+      <EuiSpacer size="s" />
+    </>
+  );
+}
diff --git a/...onents/rule_details/three_way_diff/components/field_upgrade_conflicts_resolver_header.tsx b/...onents/rule_details/three_way_diff/components/field_upgrade_conflicts_resolver_header.tsx
@@ -0,0 +1,25 @@
+/*
+ * 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 from 'react';
+import { camelCase, startCase } from 'lodash';
+import { EuiTitle } from '@elastic/eui';
+import { fieldToDisplayNameMap } from '../../diff_components/translations';
+
+interface FieldUpgradeConflictsResolverHeaderProps {
+  fieldName: string;
+}
+
+export function FieldUpgradeConflictsResolverHeader({
+  fieldName,
+}: FieldUpgradeConflictsResolverHeaderProps): JSX.Element {
+  return (
+    <EuiTitle data-test-subj="ruleUpgradeFieldDiffLabel" size="xs">
+      <h5>{fieldToDisplayNameMap[fieldName] ?? startCase(camelCase(fieldName))}</h5>
+    </EuiTitle>
+  );
+}
diff --git a/...ent/components/rule_details/three_way_diff/components/rule_upgrade_conflicts_resolver.tsx b/...ent/components/rule_details/three_way_diff/components/rule_upgrade_conflicts_resolver.tsx
@@ -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
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import React from 'react';
+import type {
+  RuleUpgradeState,
+  SetRuleFieldResolvedValueFn,
+} from '../../../../../rule_management_ui/components/rules_table/upgrade_prebuilt_rules_table/use_prebuilt_rules_upgrade_state';
+import { FieldUpgradeConflictsResolver } from './field_upgrade_conflicts_resolver';
+
+interface RuleUpgradeConflictsResolverProps {
+  ruleUpgradeState: RuleUpgradeState;
+  setRuleFieldResolvedValue: SetRuleFieldResolvedValueFn;
+}
+
+export function RuleUpgradeConflictsResolver({
+  ruleUpgradeState,
+  setRuleFieldResolvedValue,
+}: RuleUpgradeConflictsResolverProps): JSX.Element {
+  const fieldDiffEntries = Object.entries(ruleUpgradeState.diff.fields) as Array<
+    [
+      keyof typeof ruleUpgradeState.diff.fields,
+      Required<typeof ruleUpgradeState.diff.fields>[keyof typeof ruleUpgradeState.diff.fields]
+    ]
+  >;
+  const fields = fieldDiffEntries.map(([fieldName, fieldDiff]) => (
+    <FieldUpgradeConflictsResolver
+      key={fieldName}
+      fieldName={fieldName}
+      fieldThreeWayDiff={fieldDiff}
+      finalDiffableRule={ruleUpgradeState.finalRule}
+    />
+  ));
+
+  return <>{fields}</>;
+}
diff --git a/...le_management/components/rule_details/three_way_diff/components/rule_upgrade_info_bar.tsx b/...le_management/components/rule_details/three_way_diff/components/rule_upgrade_info_bar.tsx
@@ -0,0 +1,47 @@
+/*
+ * 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 from 'react';
+import type { RuleUpgradeState } from '../../../../../rule_management_ui/components/rules_table/upgrade_prebuilt_rules_table/use_prebuilt_rules_upgrade_state';
+import {
+  UtilityBar,
+  UtilityBarGroup,
+  UtilityBarSection,
+  UtilityBarText,
+} from '../../../../../../common/components/utility_bar';
+import * as i18n from './translations';
+
+interface UpgradeInfoBarProps {
+  ruleUpgradeState: RuleUpgradeState;
+}
+
+export function RuleUpgradeInfoBar({ ruleUpgradeState }: UpgradeInfoBarProps): JSX.Element {
+  const numOfFieldsWithUpdates = ruleUpgradeState.diff.num_fields_with_updates;
+  const numOfConflicts = ruleUpgradeState.diff.num_fields_with_conflicts;
+
+  return (
+    <UtilityBar>
+      <UtilityBarSection>
+        <UtilityBarGroup>
+          <UtilityBarText dataTestSubj="showingRules">
+            {i18n.NUM_OF_FIELDS_WITH_UPDATES(numOfFieldsWithUpdates)}
+          </UtilityBarText>
+        </UtilityBarGroup>
+        <UtilityBarGroup>
+          <UtilityBarText dataTestSubj="showingRules">
+            {i18n.NUM_OF_CONFLICTS(numOfConflicts)}
+          </UtilityBarText>
+        </UtilityBarGroup>
+      </UtilityBarSection>
+      <UtilityBarSection>
+        <UtilityBarGroup>
+          <i18n.RuleUpgradeHelper />
+        </UtilityBarGroup>
+      </UtilityBarSection>
+    </UtilityBar>
+  );
+}