fix: Package flame_riverpod, setState() or markNeedsBuild() called during build. #2943
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
markvideon
changed the title
markvideon
changed the title
markvideon
changed the title
spydon
approved these changes
Dec 21, 2023
spydon
approved these changes
Dec 21, 2023
Comment on lines
+54
to
+56
| /// As it is undesirable to call [setState] while the widget may be building, | ||
| /// this function honours (potential) subsequent requests to rebuild by | ||
| /// setting a flag. |
6 tasks
spydon
pushed a commit
that referenced
this pull request
Dec 22, 2023
In #2943 a persistent frame callback was added to RiverpodAwareGameWidget's state class, in order to handle multiple requests in rapid succession to rebuild the widget safely, in response to [this thread](https://discord.com/channels/509714518008528896/516639688581316629/1186421112217813062) on the Discord. <details> <summary>Walkthrough of issue with previous block</summary> **Stage 1:** forceBuild has been called for the first time, `_isForceBuilding` set to true **Stage 2:** forceBuild has been called a second time before the setState has completed. `_hasQueuedBuild` is set to true. **Stage 3:** The persistent callback is hit. As `_hasQueuedBuild` is true, `_isForceBuilding` is set to true again, `_hasQueuedBuild` is set to false / consumed, forceBuild is called again. **Stage 4:** Inside forceBuild, `_isForceBuilding` is still true as it was set inside the persistent frame callback. Repeat Stage 2 </details> N/A
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The forceRebuild function now has an "isDirty" check to determine whether setState should be called. Previously, setState was uncritically invoked which could produce the Flutter framework error that occurs when setState is called while widgets are still being rebuilt.
The setState call inside ref.watch has been replaced with a call to forceRebuild, and forceRebuild now has checks to prevent setState from being called while a build is in progress. A persistent frame callback has been added to reset supporting flags.
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues
N/A. Customer reported issue via Discord.