UI polish for correlations and custom log types (#683)

* fixed abbreviations Signed-off-by: Amardeepsingh Siglani <[email protected]> * fixed log type name validation Signed-off-by: Amardeepsingh Siglani <[email protected]> --------- Signed-off-by: Amardeepsingh Siglani <[email protected]> (cherry picked from commit b54bb36)
opensearch-project · Aug 2, 2023 · f284a2b · f284a2b
1 parent b8aa5d3
commit f284a2b
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 69 deletions.
diff --git a/public/pages/Correlations/components/FindingCard.tsx b/public/pages/Correlations/components/FindingCard.tsx
@@ -16,12 +16,7 @@ import {
   EuiToolTip,
   EuiDescriptionList,
 } from '@elastic/eui';
-import {
-  getAbbrFromLogType,
-  getSeverityLabel,
-  getSeverityColor,
-  getLabelFromLogType,
-} from '../utils/constants';
+import { getSeverityLabel, getSeverityColor, getLabelFromLogType } from '../utils/constants';
 import { DataStore } from '../../../store/DataStore';
 import { CorrelationFinding } from '../../../../types';
 
@@ -31,7 +26,6 @@ export interface FindingCardProps {
   timestamp: string;
   detectionRule: { name: string; severity: string };
   correlationData?: {
-    // ruleName: string;
     score: string;
     onInspect: (findingId: string, logType: string) => void;
   };
@@ -90,43 +84,20 @@ export const FindingCard: React.FC<FindingCardProps> = ({
   return (
     <EuiPanel>
       {correlationHeader}
-      <EuiFlexGroup justifyContent="flexStart" alignItems="center">
-        <EuiFlexItem grow={1} style={{ maxWidth: 120 }}>
-          <div style={{ position: 'relative' }}>
-            <div
-              style={{
-                width: '35px',
-                height: '35px',
-                border: '1px solid',
-                borderRadius: '50%',
-                position: 'relative',
-                fontSize: 10,
-                lineHeight: '35px',
-                textAlign: 'center',
-                borderColor: '#98A2B3',
-                color: '#98A2B3',
-              }}
+      <EuiFlexGroup justifyContent="spaceBetween" alignItems="center" gutterSize="s">
+        <EuiFlexItem grow={false}>
+          <div>
+            <EuiBadge
+              color={getSeverityColor(detectionRule.severity).background}
+              style={{ padding: '3px 10px' }}
             >
-              {getAbbrFromLogType(logType)}
-            </div>
-            {getSeverityLabel(detectionRule.severity) ? (
-              <EuiBadge
-                style={{
-                  position: 'absolute',
-                  transform: 'translateY(-100%)',
-                  left: '33px',
-                  color: getSeverityColor(detectionRule.severity).text,
-                }}
-                color={getSeverityColor(detectionRule.severity).background}
-              >
-                {getSeverityLabel(detectionRule.severity)}
-              </EuiBadge>
-            ) : null}
+              {getSeverityLabel(detectionRule.severity)}
+            </EuiBadge>
+            <EuiBadge color="hollow" style={{ padding: '3px 10px' }}>
+              {getLabelFromLogType(logType)}
+            </EuiBadge>
           </div>
         </EuiFlexItem>
-        <EuiFlexItem grow={1}>
-          <strong>{getLabelFromLogType(logType)}</strong>
-        </EuiFlexItem>
         {!correlationData && (
           <EuiFlexItem grow={false}>
             <EuiToolTip content={'View finding details'}>

diff --git a/public/pages/Correlations/containers/CorrelationsContainer.tsx b/public/pages/Correlations/containers/CorrelationsContainer.tsx
@@ -9,7 +9,6 @@ import {
   getDefaultLogTypeFilterItemOptions,
   defaultSeverityFilterItemOptions,
   emptyGraphData,
-  getAbbrFromLogType,
   getLabelFromLogType,
   getSeverityColor,
   getSeverityLabel,
@@ -255,12 +254,9 @@ export class Correlations extends React.Component<CorrelationsProps, Correlation
 
     nodes.push({
       id: finding.id,
-      label: `<b>${getAbbrFromLogType(
-        finding.logType
-      )}</b>\n<code>${finding.detectionRule.severity.slice(0, 4)}</code>`,
       title: this.createNodeTooltip(finding),
       color: {
-        background: 'white',
+        background: borderColor,
         border: borderColor,
         highlight: {
           background: '#e7f5ff',
@@ -272,7 +268,7 @@ export class Correlations extends React.Component<CorrelationsProps, Correlation
         },
       },
       widthConstraint: {
-        minimum: 50,
+        minimum: 40,
       },
       borderWidth: 2,
       font: {
@@ -291,6 +287,7 @@ export class Correlations extends React.Component<CorrelationsProps, Correlation
       chosen: false,
       color: '#98A2B3', //ouiColorMediumShade,
       label: f1.correlationScore || f2.correlationScore || '',
+      width: 2,
     });
   }
 

diff --git a/public/pages/Correlations/utils/constants.tsx b/public/pages/Correlations/utils/constants.tsx
@@ -76,12 +76,8 @@ export const emptyGraphData: CorrelationGraphData = {
   events: {},
 };
 
-export const getAbbrFromLogType = (logType: string) => {
-  return ruleTypes.find((ruleType) => ruleType.value === logType)?.abbr || '-';
-};
-
 export const getLabelFromLogType = (logType: string) => {
-  return ruleTypes.find((ruleType) => ruleType.value === logType)?.label || '-';
+  return ruleTypes.find((ruleType) => ruleType.value === logType)?.label || logType;
 };
 
 export const getSeverityLabel = (sev: string) => {

diff --git a/public/pages/LogTypes/components/LogTypeDetails.tsx b/public/pages/LogTypes/components/LogTypeDetails.tsx
@@ -10,6 +10,7 @@ import { LogTypeItem } from '../../../../types';
 import { DataStore } from '../../../store/DataStore';
 import { LogTypeForm } from './LogTypeForm';
 import { NotificationsStart } from 'opensearch-dashboards/public';
+import { successNotificationToast } from '../../../utils/helpers';
 
 export interface LogTypeDetailsProps {
   initialLogTypeDetails: LogTypeItem;
@@ -31,6 +32,7 @@ export const LogTypeDetails: React.FC<LogTypeDetailsProps> = ({
   const onUpdateLogType = async () => {
     const success = await DataStore.logTypes.updateLogType(logTypeDetails);
     if (success) {
+      successNotificationToast(notifications, 'updated', `log type ${logTypeDetails.name}`);
       setIsEditMode(false);
     }
   };

diff --git a/public/pages/LogTypes/components/LogTypeDetectionRules.tsx b/public/pages/LogTypes/components/LogTypeDetectionRules.tsx
@@ -7,7 +7,7 @@ import React from 'react';
 import { RulesTable } from '../../Rules/components/RulesTable/RulesTable';
 import { RuleTableItem } from '../../Rules/utils/helpers';
 import { ContentPanel } from '../../../components/ContentPanel';
-import { EuiButton } from '@elastic/eui';
+import { EuiButton, EuiFlexGroup, EuiFlexItem, EuiIcon, EuiSpacer, EuiText } from '@elastic/eui';
 
 export interface LogTypeDetectionRulesProps {
   rules: RuleTableItem[];
@@ -26,7 +26,28 @@ export const LogTypeDetectionRules: React.FC<LogTypeDetectionRulesProps> = ({
       hideHeaderBorder={true}
       actions={[<EuiButton onClick={refreshRules}>Refresh</EuiButton>]}
     >
-      <RulesTable loading={loadingRules} ruleItems={rules} showRuleDetails={() => {}} />
+      {rules.length === 0 ? (
+        <EuiFlexGroup justifyContent="center" alignItems="center" direction="column">
+          <EuiFlexItem grow={false}>
+            <EuiText color="subdued">
+              <p>There are no detection rules associated with this log type. </p>
+            </EuiText>
+          </EuiFlexItem>
+          <EuiFlexItem grow={false}>
+            <EuiButton
+              fill
+              href={`opensearch_security_analytics_dashboards#/create-rule`}
+              target="_blank"
+            >
+              Create detection rule&nbsp;
+              <EuiIcon type={'popout'} />
+            </EuiButton>
+            <EuiSpacer size="xl" />
+          </EuiFlexItem>
+        </EuiFlexGroup>
+      ) : (
+        <RulesTable loading={loadingRules} ruleItems={rules} showRuleDetails={() => {}} />
+      )}
     </ContentPanel>
   );
 };
diff --git a/public/pages/LogTypes/components/LogTypeForm.tsx b/public/pages/LogTypes/components/LogTypeForm.tsx
@@ -16,7 +16,7 @@ import {
 } from '@elastic/eui';
 import { LogTypeItem } from '../../../../types';
 import React from 'react';
-import { validateName } from '../../../utils/validation';
+import { LOG_TYPE_NAME_REGEX, validateName } from '../../../utils/validation';
 import { NotificationsStart } from 'opensearch-dashboards/public';
 import { useState } from 'react';
 
@@ -42,7 +42,7 @@ export const LogTypeForm: React.FC<LogTypeFormProps> = ({
   const [nameError, setNameError] = useState('');
 
   const updateErrors = (details = logTypeDetails) => {
-    const nameInvalid = !validateName(details.name);
+    const nameInvalid = !validateName(details.name, LOG_TYPE_NAME_REGEX, false /* shouldTrim */);
     setNameError(nameInvalid ? 'Invalid name' : '');
 
     return { nameInvalid };
@@ -68,7 +68,7 @@ export const LogTypeForm: React.FC<LogTypeFormProps> = ({
         label="Name"
         helpText={
           isEditMode &&
-          'Must contain 5-50 characters. Valid characters are a-z, A-Zm 0-9, hyphens, spaces, and underscores'
+          'Must contain 2-50 characters. Valid characters are a-z, 0-9, hyphens, and underscores'
         }
         isInvalid={!!nameError}
         error={nameError}

diff --git a/public/pages/LogTypes/containers/CreateLogType.tsx b/public/pages/LogTypes/containers/CreateLogType.tsx
@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { EuiLink } from '@elastic/eui';
 import { ContentPanel } from '../../../components/ContentPanel';
 import React, { useContext, useState } from 'react';
 import { LogTypeForm } from '../components/LogTypeForm';
@@ -38,12 +37,7 @@ export const CreateLogType: React.FC<CreateLogTypeProps> = ({ history, notificat
     <ContentPanel
       title={'Create log type'}
       subTitleText={
-        <p>
-          Create log type to categorize and identify detection rules for your data sources. &nbsp;{' '}
-          <EuiLink href={'#'} target="_blank">
-            Learn more
-          </EuiLink>
-        </p>
+        <p>Create log type to categorize and identify detection rules for your data sources.</p>
       }
       hideHeaderBorder={true}
     >

diff --git a/public/pages/Rules/utils/constants.ts b/public/pages/Rules/utils/constants.ts
@@ -5,7 +5,7 @@
 
 import { euiPaletteForStatus } from '@elastic/eui';
 
-export const ruleTypes: { label: string; value: string; abbr: string }[] = [];
+export const ruleTypes: { label: string; value: string; id: string }[] = [];
 
 const paletteColors = euiPaletteForStatus(5);
 

diff --git a/public/store/LogTypeStore.ts b/public/store/LogTypeStore.ts
@@ -53,8 +53,8 @@ export class LogTypeStore {
         ruleTypes.length,
         ...logTypes.map((logType) => ({
           label: logType.name,
-          value: logType.id,
-          abbr: '',
+          value: logType.name,
+          id: logType.id,
         }))
       );
 

diff --git a/public/utils/validation.ts b/public/utils/validation.ts
@@ -10,6 +10,8 @@ export const MAX_NAME_CHARACTERS = 50;
 // numbers 0-9, hyphens, spaces, and underscores.
 export const NAME_REGEX = new RegExp(/^[a-zA-Z0-9 _-]{5,50}$/);
 
+export const LOG_TYPE_NAME_REGEX = new RegExp(/^[a-z0-9_-]{2,50}$/);
+
 // This regex pattern support MIN to MAX character limit, capital and lowercase letters,
 // numbers 0-9, hyphens, dot, and underscores.
 export const DETECTION_NAME_REGEX = new RegExp(/^[a-zA-Z0-9_.-]{5,50}$/);
@@ -28,8 +30,13 @@ export const AUTHOR_REGEX = new RegExp(/^[a-zA-Z0-9 _,-.]{5,50}$/);
  * @param regex
  * @return TRUE if valid; else FALSE.
  */
-export function validateName(name: string, regex: RegExp = NAME_REGEX): boolean {
-  return name.trim().match(regex) !== null;
+export function validateName(
+  name: string,
+  regex: RegExp = NAME_REGEX,
+  shouldTrimName: boolean = true
+): boolean {
+  const toValidate = shouldTrimName ? name.trim() : name;
+  return toValidate.match(regex) !== null;
 }
 
 export function validateDetectionFieldName(