Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update MaterialStatesController docs for calling setState in a listener #143453

Merged
merged 3 commits into from
Feb 16, 2024
Merged

Update MaterialStatesController docs for calling setState in a listener #143453

merged 3 commits into from
Feb 16, 2024

Conversation

TahaTesser
Copy link
Member

@TahaTesser TahaTesser commented Feb 14, 2024 •
edited
Loading

fixes Calling setState in a MaterialStatesController listener and MaterialStateController.update causes Exception

Description

MaterialStatesController listener calls setState during build when MaterialStatesController.update listener calls notifyListeners.

I tried fixing this issue by putting notifyListeners in a post-frame callback. However, this breaks existing customer tests (particularly super editor tests).

A safer approach would be to document that the listener's setState call should be in a post-frame callback to delay it and not call this during the build phase triggered by the MaterialStatesController.update in the widgets such as InkWell or buttons.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I signed the CLA.
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Feb 14, 2024
@TahaTesser TahaTesser force-pushed the fix_material_states_notify_listener branch from 7be40ac to 74a7e7c Compare February 14, 2024 15:57
@TahaTesser TahaTesser changed the title Fix MaterialStatesController.update calls notifyListeners during build Update MaterialStatesController docs for calling setState in a listener Feb 14, 2024
@TahaTesser TahaTesser marked this pull request as ready for review February 14, 2024 16:02
HansMuller
HansMuller approved these changes Feb 15, 2024
View reviewed changes
Copy link
Contributor

@HansMuller HansMuller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

I've made two more suggestions about the text.

packages/flutter/lib/src/material/material_state.dart Outdated Show resolved Hide resolved
packages/flutter/lib/src/material/material_state.dart Outdated Show resolved Hide resolved
@TahaTesser TahaTesser force-pushed the fix_material_states_notify_listener branch from 9f1304e to 4cdb214 Compare February 16, 2024 07:05
@TahaTesser TahaTesser added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 16, 2024
@auto-submit auto-submit bot merged commit a603a17 into flutter:master Feb 16, 2024
66 checks passed
@TahaTesser TahaTesser deleted the fix_material_states_notify_listener branch February 16, 2024 08:22
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 16, 2024
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 16, 2024
@engine-flutter-autoroll
a603a17 Update MaterialStatesController docs for calling setState…
baf01d1 
… in a listener (flutter/flutter#143453)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Feb 16, 2024
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 16, 2024
@engine-flutter-autoroll
a603a17 Update MaterialStatesController docs for calling setState…
755f0ef 
… in a listener (flutter/flutter#143453)
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Feb 16, 2024
@engine-flutter-autoroll
Roll Flutter from a628814 to d7867ca (66 revisions) (#6146)
a36071b 
Roll Flutter from a628814 to d7867ca (66 revisions)

flutter/flutter@a628814...d7867ca

2024-02-16 [email protected] Roll Packages from ef349be to c56c12d (5 revisions) (flutter/flutter#143581)
2024-02-16 [email protected] Update `MaterialStatesController` docs for calling `setState` in a listener  (flutter/flutter#143453)
2024-02-16 [email protected] Update `DataTable`  docs for  disabled `DataRow` ink well (flutter/flutter#143450)
2024-02-16 [email protected] Roll Flutter Engine from b7103bc8b374 to dd530f1556df (17 revisions) (flutter/flutter#143565)
2024-02-16 [email protected] Manual roll Flutter Engine from b7103bc8b374 to 7de84271eb65 (flutter/flutter#143564)
2024-02-16 [email protected] Manual roll Flutter Engine from d3c71d78f8ef to df0dc1fc06ca (flutter/flutter#143563)
2024-02-16 [email protected] Manual roll Flutter Engine from bc4dd534a0fa to d3c71d78f8ef (flutter/flutter#143561)
2024-02-16 [email protected] Manual roll Flutter Engine from edb2745e9834 to bc4dd534a0fa (flutter/flutter#143559)
2024-02-16 [email protected] Manual roll Flutter Engine from 15a358bbaf71 to edb2745e9834 (flutter/flutter#143555)
2024-02-16 [email protected] [devicelab] retain prior events for flutter gallery. (flutter/flutter#143554)
2024-02-16 [email protected] Reland "Disentangle and align flutter build web --wasm flags (#143517)" (flutter/flutter#143549)
2024-02-16 [email protected] Roll Flutter Engine from 3af336bfb2df to 15a358bbaf71 (1 revision) (flutter/flutter#143428)
2024-02-15 [email protected] Android Gradle file templates: make it easier to convert them to Kotlin DSL in the future (flutter/flutter#142146)
2024-02-15 [email protected] Remove bringup from win arm64 builds. (flutter/flutter#143548)
2024-02-15 [email protected] Fix minor spelling error (flutter/flutter#143541)
2024-02-15 [email protected] [devicelab] migrate new gallery benchmarks to local copy. (flutter/flutter#143545)
2024-02-15 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.24.1 to 3.24.3 (flutter/flutter#143546)
2024-02-15 [email protected] [flutter_tool] [dap] Forward Flutter progress events to DAP client (flutter/flutter#142524)
2024-02-15 [email protected] Swap the tasks that have been running fine for a while. (flutter/flutter#143544)
2024-02-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Disentangle and align `flutter build web --wasm` flags (#143517)" (flutter/flutter#143547)
2024-02-15 [email protected] Reland simulatedAccessibilityTraversal fix (flutter/flutter#143527)
2024-02-15 [email protected] Disentangle and align `flutter build web --wasm` flags (flutter/flutter#143517)
2024-02-15 [email protected] [devicelab] introduce new old gallery. (flutter/flutter#143486)
2024-02-15 [email protected] Remove certs dependency. (flutter/flutter#143495)
2024-02-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Fix and test SemanticsController.simulatedAccessibilityTraversal (#143386)" (flutter/flutter#143523)
2024-02-15 [email protected] Roll Packages from a864254 to ef349be (9 revisions) (flutter/flutter#143521)
2024-02-15 [email protected] Modify `plugin_ffi` and `package_ffi` template (flutter/flutter#143376)
2024-02-15 [email protected] Remove certs installation from win_arm builds. (flutter/flutter#143487)
2024-02-14 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Add isEnabled semantics flag to  text field (#143334)" (flutter/flutter#143494)
2024-02-14 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Fix date picker cannot focus on the edit field (#143117)" (flutter/flutter#143493)
2024-02-14 [email protected] [a11y] Fix date picker cannot focus on the edit field (flutter/flutter#143117)
2024-02-14 [email protected] cleanup now-irrelevant ignores for `deprecated_member_use` (flutter/flutter#143403)
2024-02-14 [email protected] Fix and test SemanticsController.simulatedAccessibilityTraversal (flutter/flutter#143386)
2024-02-14 [email protected] Disable deprecation warnings for mega_gallery (flutter/flutter#143466)
2024-02-14 [email protected] The initial/selected item on popup menu should always be visible (flutter/flutter#143118)
2024-02-14 [email protected] Roll native_assets_builder to 0.5.0 (flutter/flutter#143472)
2024-02-14 [email protected] InputDecorator M3 test migration step2 (flutter/flutter#143369)
2024-02-14 [email protected] Add more documentation for TextEditingController default constructor (flutter/flutter#143452)
2024-02-14 [email protected] Format all kotlin according to ktlint (flutter/flutter#143390)
2024-02-14 [email protected] Marks Linux_pixel_7pro integration_ui_keyboard_resize to be unflaky (flutter/flutter#143440)
2024-02-14 [email protected] Roll Packages from 9385bbb to a864254 (6 revisions) (flutter/flutter#143454)
2024-02-14 [email protected] [tools] Add column header for emulators information (flutter/flutter#142853)
2024-02-14 [email protected] Use `dart compile wasm` for wasm compilations (flutter/flutter#143298)
2024-02-14 [email protected] [devicelab] retain first frame data in certain integration tests. (flutter/flutter#143419)
2024-02-14 [email protected] Roll Flutter Engine from 0849250a1419 to 3af336bfb2df (2 revisions) (flutter/flutter#143427)
2024-02-14 [email protected] Roll Flutter Engine from 215d55f4f82d to 0849250a1419 (2 revisions) (flutter/flutter#143425)
...
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 14, 2024
@engine-flutter-autoroll
a603a17 Update MaterialStatesController docs for calling setState…
29638e5 
… in a listener (flutter/flutter#143453)
arc-yong pushed a commit to Arctuition/packages-arc that referenced this pull request Jun 14, 2024
@engine-flutter-autoroll @arc-yong
Roll Flutter from a628814 to d7867ca (66 revisions) (flutter#6146)
23293ef 
Roll Flutter from a628814 to d7867ca (66 revisions)

flutter/flutter@a628814...d7867ca

2024-02-16 [email protected] Roll Packages from ef349be to c56c12d (5 revisions) (flutter/flutter#143581)
2024-02-16 [email protected] Update `MaterialStatesController` docs for calling `setState` in a listener  (flutter/flutter#143453)
2024-02-16 [email protected] Update `DataTable`  docs for  disabled `DataRow` ink well (flutter/flutter#143450)
2024-02-16 [email protected] Roll Flutter Engine from b7103bc8b374 to dd530f1556df (17 revisions) (flutter/flutter#143565)
2024-02-16 [email protected] Manual roll Flutter Engine from b7103bc8b374 to 7de84271eb65 (flutter/flutter#143564)
2024-02-16 [email protected] Manual roll Flutter Engine from d3c71d78f8ef to df0dc1fc06ca (flutter/flutter#143563)
2024-02-16 [email protected] Manual roll Flutter Engine from bc4dd534a0fa to d3c71d78f8ef (flutter/flutter#143561)
2024-02-16 [email protected] Manual roll Flutter Engine from edb2745e9834 to bc4dd534a0fa (flutter/flutter#143559)
2024-02-16 [email protected] Manual roll Flutter Engine from 15a358bbaf71 to edb2745e9834 (flutter/flutter#143555)
2024-02-16 [email protected] [devicelab] retain prior events for flutter gallery. (flutter/flutter#143554)
2024-02-16 [email protected] Reland "Disentangle and align flutter build web --wasm flags (#143517)" (flutter/flutter#143549)
2024-02-16 [email protected] Roll Flutter Engine from 3af336bfb2df to 15a358bbaf71 (1 revision) (flutter/flutter#143428)
2024-02-15 [email protected] Android Gradle file templates: make it easier to convert them to Kotlin DSL in the future (flutter/flutter#142146)
2024-02-15 [email protected] Remove bringup from win arm64 builds. (flutter/flutter#143548)
2024-02-15 [email protected] Fix minor spelling error (flutter/flutter#143541)
2024-02-15 [email protected] [devicelab] migrate new gallery benchmarks to local copy. (flutter/flutter#143545)
2024-02-15 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.24.1 to 3.24.3 (flutter/flutter#143546)
2024-02-15 [email protected] [flutter_tool] [dap] Forward Flutter progress events to DAP client (flutter/flutter#142524)
2024-02-15 [email protected] Swap the tasks that have been running fine for a while. (flutter/flutter#143544)
2024-02-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Disentangle and align `flutter build web --wasm` flags (#143517)" (flutter/flutter#143547)
2024-02-15 [email protected] Reland simulatedAccessibilityTraversal fix (flutter/flutter#143527)
2024-02-15 [email protected] Disentangle and align `flutter build web --wasm` flags (flutter/flutter#143517)
2024-02-15 [email protected] [devicelab] introduce new old gallery. (flutter/flutter#143486)
2024-02-15 [email protected] Remove certs dependency. (flutter/flutter#143495)
2024-02-15 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Fix and test SemanticsController.simulatedAccessibilityTraversal (#143386)" (flutter/flutter#143523)
2024-02-15 [email protected] Roll Packages from a864254 to ef349be (9 revisions) (flutter/flutter#143521)
2024-02-15 [email protected] Modify `plugin_ffi` and `package_ffi` template (flutter/flutter#143376)
2024-02-15 [email protected] Remove certs installation from win_arm builds. (flutter/flutter#143487)
2024-02-14 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Add isEnabled semantics flag to  text field (#143334)" (flutter/flutter#143494)
2024-02-14 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[a11y] Fix date picker cannot focus on the edit field (#143117)" (flutter/flutter#143493)
2024-02-14 [email protected] [a11y] Fix date picker cannot focus on the edit field (flutter/flutter#143117)
2024-02-14 [email protected] cleanup now-irrelevant ignores for `deprecated_member_use` (flutter/flutter#143403)
2024-02-14 [email protected] Fix and test SemanticsController.simulatedAccessibilityTraversal (flutter/flutter#143386)
2024-02-14 [email protected] Disable deprecation warnings for mega_gallery (flutter/flutter#143466)
2024-02-14 [email protected] The initial/selected item on popup menu should always be visible (flutter/flutter#143118)
2024-02-14 [email protected] Roll native_assets_builder to 0.5.0 (flutter/flutter#143472)
2024-02-14 [email protected] InputDecorator M3 test migration step2 (flutter/flutter#143369)
2024-02-14 [email protected] Add more documentation for TextEditingController default constructor (flutter/flutter#143452)
2024-02-14 [email protected] Format all kotlin according to ktlint (flutter/flutter#143390)
2024-02-14 [email protected] Marks Linux_pixel_7pro integration_ui_keyboard_resize to be unflaky (flutter/flutter#143440)
2024-02-14 [email protected] Roll Packages from 9385bbb to a864254 (6 revisions) (flutter/flutter#143454)
2024-02-14 [email protected] [tools] Add column header for emulators information (flutter/flutter#142853)
2024-02-14 [email protected] Use `dart compile wasm` for wasm compilations (flutter/flutter#143298)
2024-02-14 [email protected] [devicelab] retain first frame data in certain integration tests. (flutter/flutter#143419)
2024-02-14 [email protected] Roll Flutter Engine from 0849250a1419 to 3af336bfb2df (2 revisions) (flutter/flutter#143427)
2024-02-14 [email protected] Roll Flutter Engine from 215d55f4f82d to 0849250a1419 (2 revisions) (flutter/flutter#143425)
...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HansMuller HansMuller HansMuller approved these changes

Assignees
No one assigned
Labels
autosubmit Merge PR when tree becomes green via auto submit App f: material design flutter/packages/flutter/material repository. framework flutter/packages/flutter repository. See also f: labels.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Calling setState in a MaterialStatesController listener and MaterialStateController.update causes Exception
2 participants
@TahaTesser @HansMuller