feat: WIP improve autovalidate mode

Author: deandreamatias

lib/src/extensions/autovalidatemode_extension.dart

@@ -0,0 +1,8 @@
+import 'package:flutter/material.dart';
+
+extension AutovalidateModeExtension on AutovalidateMode {
+  /// Is always or is onUserInteraction
+  bool get isEnable => isAlways || isOnUserInteraction;
+  bool get isAlways => this == AutovalidateMode.always;
+  bool get isOnUserInteraction => this == AutovalidateMode.onUserInteraction;
+}

lib/src/form_builder.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_form_builder/src/extensions/autovalidatemode_extension.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 
 /// A container for form fields.
@@ -151,23 +152,16 @@ class FormBuilderState extends State<FormBuilder> {
         initialValue[name];
   }
 
-  void setInternalFieldValue<T>(String name, T? value,
-      {required bool isSetState}) {
+  void setInternalFieldValue<T>(String name, T? value) {
     _instantValue[name] = value;
-    if (isSetState) {
-      setState(() {});
+    if (widget.autovalidateMode?.isEnable ?? false) {
+      validate();
     }
     widget.onChanged?.call();
   }
 
-  void removeInternalFieldValue(
-    String name, {
-    required bool isSetState,
-  }) {
+  void removeInternalFieldValue(String name) {
     _instantValue.remove(name);
-    if (isSetState) {
-      setState(() {});
-    }
   }
 
   void registerField(String name, FormBuilderFieldState field) {

lib/src/form_builder_field.dart

@@ -1,5 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
+import 'package:flutter_form_builder/src/extensions/autovalidatemode_extension.dart';
 
 enum OptionsOrientation { horizontal, vertical, wrap }
 
@@ -51,7 +52,7 @@ class FormBuilderField<T> extends FormField<T> {
     super.key,
     super.onSaved,
     super.initialValue,
-    super.autovalidateMode = AutovalidateMode.onUserInteraction,
+    super.autovalidateMode,
     super.enabled = true,
     super.validator,
     super.restorationId,
@@ -106,6 +107,12 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
 
   bool get enabled => widget.enabled && (_formBuilderState?.enabled ?? true);
   bool get _readOnly => !(_formBuilderState?.widget.skipDisabled ?? false);
+  bool get _isEnableValidate =>
+      widget.autovalidateMode.isEnable ||
+      (_formBuilderState?.widget.autovalidateMode?.isEnable ?? false);
+  bool get _isAlwaysValidate =>
+      widget.autovalidateMode.isAlways ||
+      (_formBuilderState?.widget.autovalidateMode?.isAlways ?? false);
 
   /// Will be true if the field is dirty
   ///
@@ -145,10 +152,7 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
     focusAttachment = effectiveFocusNode.attach(context);
 
     // Verify if need auto validate form
-    if ((enabled || _readOnly) &&
-        (widget.autovalidateMode == AutovalidateMode.always ||
-            _formBuilderState?.widget.autovalidateMode ==
-                AutovalidateMode.always)) {
+    if ((enabled || _readOnly) && _isAlwaysValidate) {
       WidgetsBinding.instance.addPostFrameCallback((_) {
         validate();
       });
@@ -186,17 +190,11 @@ class FormBuilderFieldState<F extends FormBuilderField<T>, T>
     if (_formBuilderState != null) {
       _dirty = true;
       if (enabled || _readOnly) {
-        _formBuilderState!.setInternalFieldValue<T>(
-          widget.name,
-          value,
-          isSetState: false,
-        );
-      } else {
-        _formBuilderState!.removeInternalFieldValue(
-          widget.name,
-          isSetState: false,
-        );
+        _formBuilderState!.setInternalFieldValue<T>(widget.name, value);
+        if (_isEnableValidate) validate();
+        return;
       }
+      _formBuilderState!.removeInternalFieldValue(widget.name);
     }
   }
 

test/src/form_builder_field_test.dart

@@ -24,6 +24,58 @@ void main() {
         expect(find.text(errorTextField), findsOneWidget);
       });
     });
+    group('isValid -', () {
+      testWidgets('Should invalid when set custom error', (tester) async {
+        final textFieldKey = GlobalKey<FormBuilderFieldState>();
+        const textFieldName = 'text';
+        const errorTextField = 'error text field';
+        final testWidget = FormBuilderTextField(
+          name: textFieldName,
+          key: textFieldKey,
+        );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+        // Set custom error
+        textFieldKey.currentState?.invalidate(errorTextField);
+        await tester.pumpAndSettle();
+
+        expect(textFieldKey.currentState?.isValid, isFalse);
+      });
+    });
+    group('hasErrors -', () {
+      testWidgets('Should has errors when set custom error', (tester) async {
+        final textFieldKey = GlobalKey<FormBuilderFieldState>();
+        const textFieldName = 'text';
+        const errorTextField = 'error text field';
+        final testWidget = FormBuilderTextField(
+          name: textFieldName,
+          key: textFieldKey,
+        );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+        // Set custom error
+        textFieldKey.currentState?.invalidate(errorTextField);
+        await tester.pumpAndSettle();
+
+        expect(textFieldKey.currentState?.hasError, isTrue);
+      });
+      testWidgets('Should no has errors when is empty and no has validators',
+          (tester) async {
+        final textFieldKey = GlobalKey<FormBuilderFieldState>();
+        const textFieldName = 'text';
+        final testWidget = FormBuilderTextField(
+          name: textFieldName,
+          key: textFieldKey,
+        );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+
+        // Set custom error
+        textFieldKey.currentState?.validate();
+        await tester.pumpAndSettle();
+
+        expect(textFieldKey.currentState?.hasError, isFalse);
+      });
+    });
 
     group('autovalidateMode -', () {
       testWidgets(
@@ -33,14 +85,29 @@ void main() {
         const errorTextField = 'error text field';
         final testWidget = FormBuilderTextField(
           name: textFieldName,
-          validator: (value) => errorTextField,
+          validator: (value) =>
+              value == null || value.isEmpty ? errorTextField : null,
+          autovalidateMode: AutovalidateMode.always,
         );
-        await tester.pumpWidget(
-          buildTestableFieldWidget(
-            testWidget,
-            autovalidateMode: AutovalidateMode.always,
-          ),
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+        await tester.pumpAndSettle();
+
+        expect(find.text(errorTextField), findsOneWidget);
+      });
+      testWidgets(
+          'Should show error when AutovalidateMode is onUserInteraction and change field',
+          (tester) async {
+        const textFieldName = 'text4';
+        const errorTextField = 'error text field';
+        final testWidget = FormBuilderTextField(
+          name: textFieldName,
+          autovalidateMode: AutovalidateMode.onUserInteraction,
+          validator: (value) => errorTextField,
         );
+        await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+        expect(find.text(errorTextField), findsNothing);
+
+        await tester.enterText(find.byWidget(testWidget), 'hola');
         await tester.pumpAndSettle();
 
         expect(find.text(errorTextField), findsOneWidget);

test/src/form_builder_test.dart

@@ -177,9 +177,11 @@ void main() {
       final testWidget = FormBuilderTextField(
         name: textFieldName,
         validator: (value) => errorTextField,
-        autovalidateMode: AutovalidateMode.always,
       );
-      await tester.pumpWidget(buildTestableFieldWidget(testWidget));
+      await tester.pumpWidget(buildTestableFieldWidget(
+        testWidget,
+        autovalidateMode: AutovalidateMode.always,
+      ));
       await tester.pumpAndSettle();
 
       expect(find.text(errorTextField), findsOneWidget);