[FEATURE] More validations on YAML rule editor (opensearch-project#279)

* yaml editor as custom form component Signed-off-by: Aleksandar Djindjic <[email protected]> * refactor file structure for rule editor Signed-off-by: Aleksandar Djindjic <[email protected]> * rename RuleEditorFormState to RuleEditorFormModel Signed-off-by: Aleksandar Djindjic <[email protected]> * refactor yaml rule editor custom form component Signed-off-by: Aleksandar Djindjic <[email protected]> * pr comments fixes and snapshot tests Signed-off-by: Aleksandar Djindjic <[email protected]> * more snapshot tests Signed-off-by: Aleksandar Djindjic <[email protected]> * align fields labels styling with create detector Signed-off-by: Aleksandar Djindjic <[email protected]> * aligne formik version with alerting plugin Signed-off-by: Aleksandar Djindjic <[email protected]> * addresing validation UX issues Signed-off-by: Aleksandar Djindjic <[email protected]> * validate tag format Signed-off-by: Aleksandar Djindjic <[email protected]> Signed-off-by: Aleksandar Djindjic <[email protected]>
riysaxen-amzn · Jan 9, 2023 · 6da7c82 · 6da7c82
1 parent 9072a4f
commit 6da7c82
Show file tree

Hide file tree

Showing 24 changed files with 878 additions and 995 deletions.
diff --git a/cypress/integration/2_rules.spec.js b/cypress/integration/2_rules.spec.js
@@ -84,12 +84,10 @@ describe('Rules', () => {
     );
 
     // Enter the reference
-    cy.get('[data-test-subj="rule_references_-_optional_field_0"]').type(SAMPLE_RULE.references);
+    cy.get('[data-test-subj="rule_references_field_0"]').type(SAMPLE_RULE.references);
 
     // Enter the false positive cases
-    cy.get('[data-test-subj="rule_false_positive_cases_-_optional_field_0"]').type(
-      SAMPLE_RULE.falsePositive
-    );
+    cy.get('[data-test-subj="rule_false_positives_field_0"]').type(SAMPLE_RULE.falsePositive);
 
     // Enter the author
     cy.get('[data-test-subj="rule_author_field"]').type(SAMPLE_RULE.author);

diff --git a/package.json b/package.json
@@ -67,6 +67,6 @@
     "yarn": "^1.21.1"
   },
   "dependencies": {
-    "formik": "^2.2.9"
+    "formik": "^2.2.6"
   }
 }
diff --git a/public/pages/Detectors/components/UpdateRules/UpdateRules.tsx b/public/pages/Detectors/components/UpdateRules/UpdateRules.tsx
@@ -217,7 +217,6 @@ export const UpdateDetectorRules: React.FC<UpdateDetectorRulesProps> = (props) =
   const ruleItems = prePackagedRuleItems.concat(customRuleItems);
 
   const onRuleDetails = (ruleItem: RuleItem) => {
-    console.log('onRuleDetails', ruleItem);
     setFlyoutData(() => ({
       title: ruleItem.name,
       level: ruleItem.severity,

diff --git a/public/pages/Rules/components/RuleEditor/FieldTextArray.tsx b/public/pages/Rules/components/RuleEditor/FieldTextArray.tsx
@@ -14,7 +14,8 @@ import {
 import React, { ChangeEvent } from 'react';
 
 export interface FieldTextArrayProps {
-  label: string;
+  label: string | React.ReactNode;
+  name: string;
   fields: string[];
   addButtonName: string;
   onFieldEdit: (value: string, fieldIndex: number) => void;
@@ -25,6 +26,7 @@ export interface FieldTextArrayProps {
 export const FieldTextArray: React.FC<FieldTextArrayProps> = ({
   addButtonName,
   label,
+  name,
   fields,
   onFieldEdit,
   onFieldRemove,
@@ -43,7 +45,7 @@ export const FieldTextArray: React.FC<FieldTextArrayProps> = ({
                     onChange={(e: ChangeEvent<HTMLInputElement>) => {
                       onFieldEdit(e.target.value, index);
                     }}
-                    data-test-subj={`rule_${label
+                    data-test-subj={`rule_${name
                       .toLowerCase()
                       .replaceAll(' ', '_')}_field_${index}`}
                   />

diff --git a/public/pages/Rules/components/RuleEditor/FormSubmitionErrorToastNotification.tsx b/public/pages/Rules/components/RuleEditor/FormSubmitionErrorToastNotification.tsx
@@ -7,7 +7,7 @@ import { useFormikContext } from 'formik';
 import { NotificationsStart } from 'opensearch-dashboards/public';
 import { errorNotificationToast } from '../../../../utils/helpers';
 
-export const FormSubmitionErrorToastNotification = ({
+export const FormSubmissionErrorToastNotification = ({
   notifications,
 }: {
   notifications?: NotificationsStart;

diff --git a/public/pages/Rules/components/RuleEditor/RuleEditor.tsx b/public/pages/Rules/components/RuleEditor/RuleEditor.tsx
diff --git a/public/pages/Rules/components/RuleEditor/RuleEditorContainer.tsx b/public/pages/Rules/components/RuleEditor/RuleEditorContainer.tsx
@@ -0,0 +1,92 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import React, { useCallback } from 'react';
+import { RouteComponentProps } from 'react-router-dom';
+import { NotificationsStart } from 'opensearch-dashboards/public';
+import { RuleService } from '../../../../services';
+import { ROUTES } from '../../../../utils/constants';
+import { EuiSpacer } from '@elastic/eui';
+import { Rule } from '../../../../../models/interfaces';
+import { RuleEditorFormModel, ruleEditorStateDefaultValue } from './RuleEditorFormModel';
+import { mapFormToRule, mapRuleToForm } from './mappers';
+import { RuleEditorForm } from './RuleEditorForm';
+import { validateRule } from '../../utils/helpers';
+import { errorNotificationToast } from '../../../../utils/helpers';
+
+export interface RuleEditorProps {
+  title: string;
+  rule?: Rule;
+  history: RouteComponentProps['history'];
+  notifications?: NotificationsStart;
+  ruleService: RuleService;
+  mode: 'create' | 'edit';
+}
+
+export interface VisualEditorFormErrorsState {
+  nameError: string | null;
+  descriptionError: string | null;
+  authorError: string | null;
+}
+
+export const RuleEditorContainer: React.FC<RuleEditorProps> = ({
+  history,
+  notifications,
+  title,
+  rule,
+  ruleService,
+  mode,
+}) => {
+  const initialRuleValue = rule
+    ? { ...mapRuleToForm(rule), id: ruleEditorStateDefaultValue.id }
+    : ruleEditorStateDefaultValue;
+
+  const onSubmit = async (values: RuleEditorFormModel) => {
+    const submitingRule = mapFormToRule(values);
+    if (!validateRule(submitingRule, notifications!, 'create')) {
+      return;
+    }
+
+    let result;
+    if (mode === 'edit') {
+      if (!rule) {
+        console.error('No rule id found');
+        return;
+      }
+      result = await ruleService.updateRule(rule?.id, submitingRule.category, submitingRule);
+    } else {
+      result = await ruleService.createRule(submitingRule);
+    }
+
+    if (!result.ok) {
+      errorNotificationToast(
+        notifications!,
+        mode === 'create' ? 'create' : 'save',
+        'rule',
+        result.error
+      );
+    } else {
+      history.replace(ROUTES.RULES);
+    }
+  };
+
+  const goToRulesList = useCallback(() => {
+    history.replace(ROUTES.RULES);
+  }, [history]);
+
+  return (
+    <>
+      <RuleEditorForm
+        title={title}
+        mode={mode}
+        notifications={notifications}
+        initialValue={initialRuleValue}
+        cancel={goToRulesList}
+        submit={onSubmit}
+      />
+      <EuiSpacer size="xl" />
+    </>
+  );
+};