Proposal: deprecate autovalidate parameter of the Form, FormField and TextFormField widget #61648

pedromassango · 2020-07-16T19:30:10Z

Description

This PR comes to deprecate the autovalidate parameter of the Form, FormField and the TextFormField widget in favor of the recently added autovalidateMode parameter. This is a follow up of #59766.

Related Issues

This does not need tests since I'm only deprecating a parameter.

Tests

I added the following tests:

Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I signed the [CLA].
I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement].
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I updated/added relevant documentation (doc comments with ///).
All existing and new tests are passing.
The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read [Handling breaking changes].

No, no existing tests failed, so this is not a breaking change.
Yes, this is a breaking change. If not, delete the remainder of this section.
- I wrote a design doc: https://flutter.dev/go/template Replace this with a link to your design doc's short link
- I got input from the developer relations team, specifically from: Replace with the names of who gave advice
- I wrote a migration guide: https://flutter.dev/go/breaking-changes-template Replace this with a link to a pull request that adds the migration guide to https://flutter.dev/docs/release/breaking-changes

fluttergithubbot · 2020-07-16T19:30:12Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

pedromassango · 2020-07-16T19:52:02Z

@chunhtai this is the PR to deprecate the autovalidate parameter as we talked on #59766.

chunhtai · 2020-07-16T22:49:34Z

it looks like the test in https://github.com/jocosocial/rainbowmonkey is failing, you should be able to repro using https://github.com/flutter/tests/blob/master/registry/rainbowmonkey.test

you can file an issue or pr to fix it in that repo, cc @Hixie for the repo owner.

pedromassango · 2020-07-20T15:00:26Z

Hi @chunhtai the PR was merged on https://github.com/jocosocial/rainbowmonkey but the tests here are not passing. I think this has something to do with the flutter build or rainbowmonkey's build.

Also Hixie pointed something here jocosocial/rainbowmonkey#329 (comment) that may cause this.

chunhtai · 2020-07-20T17:22:39Z

Hi @chunhtai the PR was merged on https://github.com/jocosocial/rainbowmonkey but the tests here are not passing. I think this has something to do with the flutter build or rainbowmonkey's build.

Also Hixie pointed something here jocosocial/rainbowmonkey#329 (comment) that may cause this.

You will need to update the flutter/test library to point to the new ref commit.
https://github.com/flutter/tests/blob/master/registry/rainbowmonkey.test

chunhtai · 2020-07-27T18:39:17Z

flutter/tests#43 has merged, please do a rerun or rebased and the tests should pass

pedromassango · 2020-07-29T19:56:06Z

@chunhtai Done.

chunhtai · 2020-07-29T20:09:20Z

looks like there are some more internal or external test that need to be migrate

pedromassango · 2020-08-03T21:01:22Z

@chunhtai looks like another PR just landed in the Gallery repository and I think that the last commit there has my changes, is there a way to confirm that or restart this PR tests?

chunhtai · 2020-08-03T21:12:05Z

@chunhtai looks like another PR just landed in the Gallery repository and I think that the last commit there has my changes, is there a way to confirm that or restart this PR tests?

I just clicked rerun, you can also trigger rerun by commit a new commit (ex, rebase your branch)

chunhtai · 2020-08-20T21:31:07Z

Hi @pedromassango cirrus seems not happy

justinmc · 2020-08-24T17:14:13Z

If merging in master isn't working, it might need to have all the commits squashed, or rebase master. The failure I looked at was unrelated to the changes.

pedromassango · 2020-08-25T15:24:47Z

If merging in master isn't working, it might need to have all the commits squashed, or rebase master. The failure I looked at was unrelated to the changes.

Not sure why tests are failing too. I will rebase master and see how it goes.

pedromassango · 2020-08-27T14:46:47Z

@justinmc I probably need some help with this, what else I can do to make the tests to pass?

justinmc · 2020-08-27T18:09:56Z

@pedromassango If you squash all of your commits into 1, then rebase off of master, then force push, that should definitely update everything. Sorry that that will make you lose your history, though. I think the idea is that the first commit's SHA needs to change in order for something to get updated and allow the PR to pass.

I see a docs failure that might be real, but I also see some version failures that don't make sense and probably do need the steps above to get fixed.

chunhtai · 2020-09-01T16:33:50Z

This file may require migration as well

dev/integration_tests/flutter_gallery/lib/demo/material/text_form_field_demo.dart:183:11 • deprecated_member_use

chunhtai · 2020-09-01T17:52:39Z

there are also doc string error

dartdoc:stderr:   error: unresolved doc reference [autovalidate]
dartdoc:stderr:     from widgets.Form.autovalidateMode: (file:///b/s/w/ir/k/flutter/packages/flutter/lib/src/widgets/form.dart:144:26)
dartdoc:stderr:     in documentation inherited from widgets.Form.autovalidateMode: (file:///b/s/w/ir/k/flutter/packages/flutter/lib/src/widgets/form.dart:144:26)
dartdoc:stderr:   error: unresolved doc reference [autovalidate]
dartdoc:stderr:     from widgets.FormField.autovalidateMode: (file:///b/s/w/ir/k/flutter/packages/flutter/lib/src/widgets/form.dart:388:26)
dartdoc:stderr:     in documentation inherited from widgets.FormField.autovalidateMode: (file:///b/s/w/ir/k/flutter/packages/flutter/lib/src/widgets/form.dart:388:26)

chunhtai

LGTM

packages/flutter/lib/src/widgets/form.dart

… TextFormField widget (flutter#61648)

skyeskie · 2020-09-18T01:47:11Z

packages/flutter/lib/src/widgets/form.dart

-  /// If true, form fields will validate and update their error text
-  /// immediately after every change. Otherwise, you must call
-  /// [FormState.validate] to validate.
-  final bool autovalidate;


Turns out this is a breaking change. The public field is removed, not deprecated.

This affects (at least) flutter_form_builder.
flutter-form-builder-ecosystem/flutter_form_builder#465

Ideally, should (with appropriate deprecated tag) put something like

bool get autovalidate => autovalidateMode != AutovalidateMode.disabled;

@pedromassango oops did we miss this one?

Hmm. Just checked form.dart file and I don't see any reference for final bool autovalidate. We did removed this intentionally in favour of AutovalidateMode property.

Maybe this is referencing a old commit file?!

bool get autovalidate => autovalidateMode != AutovalidateMode.disabled;

This is interesting and would prevent the breaking changes 🤔
@chunhtai do you think this we should put it back?

@skyeskie
What are the use cases of using this Widget's property?

I think we should put this one back, but we should do

autovalidateMode = autovalidateMode ?? autovalidate ? AutovalidateMode.always : AutovalidateMode.disabled

Same as what we do for other formfield

Alright, I will send a PR to put it back ASAP

FormField has the exact same issue (below, 363-368)

@pedromassango
I personally don't use this, but just ran across when flutter_form_builder refused to compile, specifically when it tries to access autovalidate on FormField in its FormBuilderCustomField class here.

The PR is: #66267

@chunhtai I think we should add it back on formField widget too, right?

fluttergithubbot added f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels. labels Jul 16, 2020

googlebot added the cla: yes label Jul 16, 2020

pedromassango changed the title ~~Proposal: deprecate autovalidate parameter of the Form, FormField and TextFormField~~ Proposal: deprecate autovalidate parameter of the Form, FormField and TextFormField widget Jul 16, 2020

pedromassango mentioned this pull request Jul 17, 2020

Remove usage of deprecated autovalidate parameter jocosocial/rainbowmonkey#329

Merged

pedromassango mentioned this pull request Jul 20, 2020

Update rainbowmonkey.test flutter/tests#43

Merged

HansMuller requested a review from chunhtai July 23, 2020 23:36

This was referenced Jul 29, 2020

Migrate Form autovalidate API flutter/gallery#241

Closed

Migrate Form autovalidate API flutter/gallery#245

Merged

Updated flutter_gallery.test flutter/tests#46

Closed

pedromassango mentioned this pull request Aug 20, 2020

Add Form field autovalidation API migration guide flutter/website#4512

Merged

pedromassango closed this Sep 1, 2020

pedromassango force-pushed the form-autovalidate branch from 99290cd to 6d1242d Compare September 1, 2020 15:34

pedromassango added 2 commits September 1, 2020 16:52

Deprecate autovalidate parameter

30e26b7

Merge remote-tracking branch 'upstream/master' into form-autovalidate

3b58a98

justinmc reopened this Sep 1, 2020

Migrate code from flutter_gallery tests

c925617

Remove docs references of deprecated autovalidate parameter.

eaabca8

chunhtai approved these changes Sep 1, 2020

View reviewed changes

packages/flutter/lib/src/widgets/form.dart Outdated Show resolved Hide resolved

Format references of deprecated autovalidate parameter.

d08fd39

chunhtai added the waiting for tree to go green label Sep 1, 2020

fluttergithubbot merged commit 7fdd921 into flutter:master Sep 2, 2020

mingwandroid pushed a commit to mingwandroid/flutter that referenced this pull request Sep 6, 2020

Proposal: deprecate autovalidate parameter of the Form, FormField and…

41dc208

… TextFormField widget (flutter#61648)

skyeskie reviewed Sep 18, 2020

View reviewed changes

justinmc mentioned this pull request Sep 30, 2020

Restore the autovalidate property and deprecate it #66940

Closed

Piinks mentioned this pull request Jan 15, 2021

Add fixes for autovalidate deprecation in Form, FormField, TextFormField, and DropdownButtonFormField #73996

Merged

8 tasks

pedromassango deleted the form-autovalidate branch January 22, 2022 10:17

Proposal: deprecate autovalidate parameter of the Form, FormField and TextFormField widget #61648

Proposal: deprecate autovalidate parameter of the Form, FormField and TextFormField widget #61648

Uh oh!

Conversation

pedromassango commented Jul 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Tests

Checklist

Breaking Change

Uh oh!

fluttergithubbot commented Jul 16, 2020

Uh oh!

pedromassango commented Jul 16, 2020

Uh oh!

chunhtai commented Jul 16, 2020

Uh oh!

pedromassango commented Jul 20, 2020

Uh oh!

chunhtai commented Jul 20, 2020

Uh oh!

chunhtai commented Jul 27, 2020

Uh oh!

pedromassango commented Jul 29, 2020

Uh oh!

chunhtai commented Jul 29, 2020

Uh oh!

pedromassango commented Aug 3, 2020

Uh oh!

chunhtai commented Aug 3, 2020

Uh oh!

chunhtai commented Aug 20, 2020

Uh oh!

justinmc commented Aug 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pedromassango commented Aug 25, 2020

Uh oh!

pedromassango commented Aug 27, 2020

Uh oh!

justinmc commented Aug 27, 2020

Uh oh!

chunhtai commented Sep 1, 2020

Uh oh!

chunhtai commented Sep 1, 2020

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

pedromassango commented Jul 16, 2020 •

edited

Loading

justinmc commented Aug 24, 2020 •

edited

Loading