Merge pull request #1506 from majumdersubhanu/issue-1484

fix: #1484 autoValidateMode breaks invalidate method

Author: deandreamatias

example/pubspec.lock

@@ -60,7 +60,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "10.3.0+1"
+    version: "10.3.0+2"
   flutter_lints:
     dependency: "direct dev"
     description:
@@ -131,10 +131,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
+      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.18"
+    version: "0.12.19"
   material_color_utilities:
     dependency: transitive
     description:
@@ -208,10 +208,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "93167629bfc610f71560ab9312acdda4959de4df6fac7492c89ff0d3886f6636"
+      sha256: "8161c84903fd860b26bfdefb7963b3f0b68fee7adea0f59ef805ecca346f0c7a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.9"
+    version: "0.7.10"
   vector_math:
     dependency: transitive
     description:

lib/src/fields/form_builder_checkbox.dart

@@ -107,6 +107,7 @@ class FormBuilderCheckbox extends FormBuilderFieldDecoration<bool> {
     super.focusNode,
     super.restorationId,
     super.errorBuilder,
+    super.forceErrorText,
     required this.title,
     this.activeColor,
     this.autofocus = false,

lib/src/fields/form_builder_checkbox_group.dart

@@ -46,6 +46,7 @@ class FormBuilderCheckboxGroup<T> extends FormBuilderFieldDecoration<List<T>> {
     super.focusNode,
     super.restorationId,
     super.errorBuilder,
+    super.forceErrorText,
     required this.options,
     this.activeColor,
     this.checkColor,

lib/src/fields/form_builder_choice_chips.dart

@@ -353,6 +353,7 @@ class FormBuilderChoiceChips<T> extends FormBuilderFieldDecoration<T> {
     super.decoration,
     super.key,
     required super.name,
+    super.forceErrorText,
     required this.options,
     super.initialValue,
     super.restorationId,

lib/src/fields/form_builder_text_field.dart

@@ -378,6 +378,7 @@ class FormBuilderTextField extends FormBuilderFieldDecoration<String> {
     super.onReset,
     super.focusNode,
     super.restorationId,
+    super.forceErrorText,
     String? initialValue,
     super.errorBuilder,
     this.readOnly = false,

lib/src/form_builder_field.dart

@@ -52,6 +52,7 @@ class FormBuilderField<T> extends FormField<T> {
     required super.builder,
     super.errorBuilder,
     super.onReset,
+    super.forceErrorText,
     required this.name,
     this.valueTransformer,
     this.onChanged,
@@ -210,6 +211,9 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   @override
   void didChange(T? value) {
     super.didChange(value);
+    if (_customErrorText != null) {
+      setState(() => _customErrorText = null);
+    }
     _informFormForFieldChange();
     widget.onChanged?.call(value);
   }
@@ -229,8 +233,13 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
 
   /// Validate field
   ///
+  /// **BREAKING CHANGE**:
+  /// In previous versions, calling `validate()` would automatically clear any custom errors set via `invalidate()`.
+  /// Now, `validate()` does not clear custom errors by default.
+  /// If you want to clear the custom error when validating, you must explicitly pass `clearCustomError: true`.
+  ///
   /// Clear custom error if [clearCustomError] is `true`.
-  /// By default `true`
+  /// By default `false`
   ///
   /// Focus when field is invalid if [focusOnInvalid] is `true`.
   /// By default `true`
@@ -244,7 +253,7 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
   /// not because [autoScrollWhenFocusOnInvalid] is `true`.
   @override
   bool validate({
-    bool clearCustomError = true,
+    bool clearCustomError = false,
     bool focusOnInvalid = true,
     bool autoScrollWhenFocusOnInvalid = false,
   }) {

lib/src/form_builder_field_decoration.dart

@@ -20,6 +20,7 @@ class FormBuilderFieldDecoration<T> extends FormBuilderField<T> {
     super.onReset,
     super.focusNode,
     super.errorBuilder,
+    super.forceErrorText,
     required super.builder,
     this.decoration = const InputDecoration(),
   }) : assert(

pubspec.lock

@@ -111,10 +111,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: "12956d0ad8390bbcc63ca2e1469c0619946ccb52809807067a7020d57e647aa6"
+      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.18"
+    version: "0.12.19"
   material_color_utilities:
     dependency: transitive
     description:
@@ -188,10 +188,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "93167629bfc610f71560ab9312acdda4959de4df6fac7492c89ff0d3886f6636"
+      sha256: "8161c84903fd860b26bfdefb7963b3f0b68fee7adea0f59ef805ecca346f0c7a"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.9"
+    version: "0.7.10"
   vector_math:
     dependency: transitive
     description:

test/src/fields/form_builder_text_field_test.dart

@@ -66,6 +66,20 @@ void main() {
       expect(Focus.of(tester.element(widgetFinder)).hasFocus, true);
       expect(focusNode?.hasFocus, true);
     });
+    testWidgets('forceErrorText should show error', (
+      WidgetTester tester,
+    ) async {
+      const errorText = 'Force error message';
+      const textFieldName = 'text1';
+      final testWidget = FormBuilderTextField(
+        name: textFieldName,
+        forceErrorText: errorText,
+      );
+      await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+      await tester.pumpAndSettle();
+
+      expect(find.text(errorText), findsOneWidget);
+    });
   });
 }
 

test/src/form_builder_field_test.dart

@@ -25,6 +25,77 @@ void main() {
         await tester.pumpAndSettle();
         expect(find.text(errorTextField), findsOneWidget);
       });
+      testWidgets(
+        'Should persist custom error when autovalidateMode is onUserInteraction',
+        (tester) async {
+          final textFieldKey = GlobalKey<FormBuilderFieldState>();
+          const textFieldName = 'text';
+          const errorTextField = 'custom error';
+          final testWidget = FormBuilderTextField(
+            name: textFieldName,
+            key: textFieldKey,
+            autovalidateMode: AutovalidateMode.onUserInteraction,
+          );
+          await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+          // Set custom error
+          textFieldKey.currentState?.invalidate(errorTextField);
+          await tester.pumpAndSettle();
+          expect(find.text(errorTextField), findsOneWidget);
+
+          // Simulate framework call (e.g. build again)
+          tester.binding.scheduleFrame();
+          await tester.pumpAndSettle();
+
+          // Should still be there
+          expect(find.text(errorTextField), findsOneWidget);
+
+          // Should clear when value changes
+          await tester.enterText(find.byType(TextField), 'test');
+          await tester.pumpAndSettle();
+          expect(find.text(errorTextField), findsNothing);
+        },
+      );
+    });
+
+    group('transformedValue -', () {
+      testWidgets('Should return raw value when valueTransformer is null', (
+        tester,
+      ) async {
+        final textFieldKey = GlobalKey<FormBuilderFieldState>();
+        const textFieldName = 'text';
+        final testWidget = FormBuilderTextField(
+          name: textFieldName,
+          key: textFieldKey,
+        );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+        final widgetFinder = find.byWidget(testWidget);
+        await tester.enterText(widgetFinder, '123');
+        await tester.pumpAndSettle();
+
+        expect(textFieldKey.currentState?.transformedValue, '123');
+      });
+
+      testWidgets(
+        'Should return transformed value when valueTransformer is provided',
+        (tester) async {
+          final textFieldKey = GlobalKey<FormBuilderFieldState>();
+          const textFieldName = 'text';
+          final testWidget = FormBuilderTextField(
+            name: textFieldName,
+            key: textFieldKey,
+            valueTransformer: (text) => int.tryParse(text ?? ''),
+          );
+          await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+          final widgetFinder = find.byWidget(testWidget);
+          await tester.enterText(widgetFinder, '123');
+          await tester.pumpAndSettle();
+
+          expect(textFieldKey.currentState?.transformedValue, 123);
+        },
+      );
     });
 
     group('isValid -', () {
@@ -516,5 +587,39 @@ void main() {
         },
       );
     });
+    group('forceErrorText -', () {
+      testWidgets('Should show error when forceErrorText is set', (
+        tester,
+      ) async {
+        const errorText = 'Force error message';
+        final testWidget = FormBuilderTextField(
+          name: 'text',
+          forceErrorText: errorText,
+        );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+        await tester.pumpAndSettle();
+
+        expect(find.text(errorText), findsOneWidget);
+      });
+
+      testWidgets(
+        'Should override validator error when forceErrorText is set',
+        (tester) async {
+          const forceError = 'Force error';
+          const validatorError = 'Validator error';
+          final testWidget = FormBuilderTextField(
+            name: 'text',
+            forceErrorText: forceError,
+            validator: (value) => validatorError,
+            autovalidateMode: AutovalidateMode.always,
+          );
+          await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+          await tester.pumpAndSettle();
+
+          expect(find.text(forceError), findsOneWidget);
+          expect(find.text(validatorError), findsNothing);
+        },
+      );
+    });
   });
 }