fix(compass-schema-validation): rules generated message COMPASS-9252 (#6843)

paula-stacho · web-flow · commit 2b2a627da31f · 2025-04-11T13:36:43.000+02:00
diff --git a/packages/compass-schema-validation/src/components/validation-editor.spec.tsx b/packages/compass-schema-validation/src/components/validation-editor.spec.tsx
@@ -36,6 +36,7 @@ async function renderValidationEditor(
         validation={validation}
         generateValidationRules={() => {}}
         isRulesGenerationInProgress={false}
+        isValidatorGenerated={false}
         isSavingInProgress={false}
         isEditable
         isEditingEnabled
diff --git a/packages/compass-schema-validation/src/components/validation-editor.tsx b/packages/compass-schema-validation/src/components/validation-editor.tsx
@@ -84,6 +84,18 @@ const modifiedMessageStyles = css({
   flex: 1,
 });
 
+const generatedMessageStyles = css({
+  color: palette.green.dark2,
+  display: 'flex',
+  alignItems: 'center',
+  gap: spacing[200],
+  flex: 1,
+});
+
+const generatedMessageDarkStyles = css({
+  color: palette.green.light2,
+});
+
 const modifiedMessageDarkStyles = css({
   color: palette.yellow.light2,
 });
@@ -150,6 +162,7 @@ type ValidationEditorProps = {
   isEditingEnabled: boolean;
   isRulesGenerationInProgress: boolean;
   isSavingInProgress: boolean;
+  isValidatorGenerated: boolean;
 };
 
 /**
@@ -173,6 +186,7 @@ export const ValidationEditor: React.FunctionComponent<
   isEditingEnabled,
   isRulesGenerationInProgress,
   isSavingInProgress,
+  isValidatorGenerated,
 }) => {
   const enableExportSchema = usePreference('enableExportSchema');
   const track = useTelemetry();
@@ -315,7 +329,7 @@ export const ValidationEditor: React.FunctionComponent<
         <div className={actionsStyles}>
           {isEditingEnabled ? (
             <>
-              {isChanged && (
+              {isChanged && !isValidatorGenerated && (
                 <Body
                   className={cx(
                     modifiedMessageStyles,
@@ -327,6 +341,18 @@ export const ValidationEditor: React.FunctionComponent<
                   applied. Please review before applying.
                 </Body>
               )}
+              {isValidatorGenerated && (
+                <Body
+                  className={cx(
+                    generatedMessageStyles,
+                    darkMode && generatedMessageDarkStyles
+                  )}
+                  data-testid="validation-action-message"
+                >
+                  <Icon glyph="Checkmark" /> Rules generated. Please review
+                  before applying.
+                </Body>
+              )}
               <Button
                 type="button"
                 className={buttonStyles}
@@ -376,6 +402,7 @@ const mapStateToProps = (state: RootState) => ({
   validation: state.validation,
   namespace: state.namespace.ns,
   isRulesGenerationInProgress: state.rulesGeneration.isInProgress,
+  isValidatorGenerated: state.rulesGeneration.isGenerated,
   isSavingInProgress: state.validation.isSaving,
 });
 
diff --git a/packages/compass-schema-validation/src/modules/rules-generation.ts b/packages/compass-schema-validation/src/modules/rules-generation.ts
@@ -3,7 +3,11 @@ import { zeroStateChanged } from './zero-state';
 import { enableEditRules } from './edit-mode';
 import type { MongoError } from 'mongodb';
 import type { Action, Reducer } from 'redux';
-import { validationLevelChanged, validatorChanged } from './validation';
+import {
+  ValidationActions,
+  validationLevelChanged,
+  validatorChanged,
+} from './validation';
 import {
   type analyzeSchema as analyzeSchemaType,
   calculateSchemaMetadata,
@@ -48,6 +52,7 @@ export type RulesGenerationError = {
 
 export interface RulesGenerationState {
   isInProgress: boolean;
+  isGenerated: boolean;
   error?: RulesGenerationError;
 }
 
@@ -56,6 +61,7 @@ export interface RulesGenerationState {
  */
 export const INITIAL_STATE: RulesGenerationState = {
   isInProgress: false,
+  isGenerated: false,
 };
 
 function getErrorDetails(error: Error): RulesGenerationError {
@@ -103,6 +109,7 @@ export const rulesGenerationReducer: Reducer<RulesGenerationState, Action> = (
     return {
       ...state,
       isInProgress: false,
+      isGenerated: true,
     };
   }
 
@@ -119,6 +126,26 @@ export const rulesGenerationReducer: Reducer<RulesGenerationState, Action> = (
     };
   }
 
+  if (
+    isAction(action, ValidationActions.ValidatorChanged) &&
+    state.isGenerated
+  ) {
+    return {
+      ...state,
+      isGenerated: false, // the generated validator has been changed
+    };
+  }
+
+  if (
+    isAction(action, ValidationActions.ValidationSaveEnded) &&
+    state.isGenerated
+  ) {
+    return {
+      ...state,
+      isGenerated: false, // the generated validator has been saved
+    };
+  }
+
   if (
     isAction<RulesGenerationErrorCleared>(
       action,
