[go_router]: Fix `GoRouter.refresh()` trigger route rebuild/refresh
Add _refreshKey to MatchBase and update GoRouter.refresh() logic
This maybe fix: https://github.com/flutter/flutter/issues/175399
Pre-Review Checklist
- [x] I read the Contributor Guide and followed the process outlined there for submitting PRs.
- [x] I read the Tree Hygiene page, which explains my responsibilities.
- [x] I read and followed the relevant style guides and ran the auto-formatter.
- [x] I signed the CLA.
- [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g.
[shared_preferences] - [x] I linked to at least one issue that this PR fixes in the description above.
- [x] I updated
pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under[^1]. - [x] I updated
CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under[^1]. - [x] I updated/added any relevant documentation (doc comments with
///). - [x] I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under[^1].
- [x] All existing and new tests are passing.
If you need help, consider asking for advice on the #hackers-new channel on Discord.
Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.
[^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
If the RoutematchList doesn't change, why do we want to force a rebuild in the RouterDelegate? I thought the point to do the refresh is that the redirect would produce a different result
My intention is to update the _refreshKey in RoutematchList to notify the _CustomNavigator since it was only notify when matchList was changed
My intention is to update the _refreshKey in RoutematchList to notify the _CustomNavigator
Can you talk more about the use case? why would the navigator want to be notified even though there is no change the the route?
Can you talk more about the use case? why would the navigator want to be notified even though there is no change the the route?
In related issue and in current code. Goruter.refresh() does not trigger the rebuild/refresh of the route because _CustomNavigator is blocked when checking matchList.
In my pr the main purpose is to add _refreshKey to the routes to ensure that every time refresh() is called it will update the value of _refreshKey and make _CustomNavigator notify the builder
I think the confusing thing is that I am using routerDelegate.setNewRoutePath for the refresh() function. This I think does not affect because from what I understand the package is processing based on the key of the route. (please confirm) . What I am trying to do is to update all current routes with the new _refreshKey value
I understand what the code is doing. My question is why we want a CustomNavigator rebuild when match list doesn't change. It seems to me your use case is relying on a side affect of custom navigator rebuild, and I am not sure if that is a good thing.