[go_router] Fix pop() restoring stale configuration when route has onExit

[dkajiwara]

GoRouter.pop() unconditionally called restore() after routerDelegate.pop(). When the route has onExit, the pop is deferred to a microtask, so restore() was called with the pre-pop configuration. This caused async redirects to overwrite
the post-pop state, making the popped route reappear.

Fixed by comparing currentConfiguration identity before and after pop. restore() is only called when the configuration was actually updated (synchronous pop).

Fixes flutter/flutter#174525 flutter/flutter#180002

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the AI contribution guidelines and understand my responsibilities, or I am not using AI tools.
• I read the Tree Hygiene page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter.
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style, or I have commented below to indicate which documented exception this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• 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¹.
• 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.

Footnotes

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. ↩ ↩²

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[gemini-code-assist]

Code Review

This pull request fixes an issue where GoRouter.pop() could restore a stale configuration when a route has an onExit handler, which could lead to the popped route reappearing. The fix cleverly uses an identical() check to ensure restore() is only called for synchronous pops where the configuration has actually changed. The changes are well-supported by new regression tests that cover the fixed scenario and related edge cases. My review includes one suggestion to enhance a code comment for better long-term maintainability.

[gemini-code-assist]

The current comment explains the condition well. To further improve maintainability, consider adding a brief note about why this check is important, mentioning the risk of restoring a stale configuration. This will help future developers understand the full context and prevent accidental regressions.

// Only restore on a synchronous pop to avoid restoring a stale configuration.
// A deferred pop (e.g. due to an async `onExit`) would leave the
// `currentConfiguration` instance unchanged, and restoring it could cause issues.

[chunhtai]

code lgtm, the go_router now needs to put change log in pending_changelogs folder, ci should flag this.

[dkajiwara]

@chunhtai Thanks for the review! Moved changelog to pending_changelogs/.

[chunhtai]

LGTM

[hannah-hyj]

LGTM