[go_router_builder] Fix generated onExit handling

[agarwalrahul2702]

Fixes flutter/flutter#189503

Description

Generated typed GoRouteData and RelativeGoRouteData route constructors now pass hasOverriddenOnExit based on whether the route data class actually overrides onExit.

This keeps generated routes without onExit overrides aligned with handwritten GoRoute behavior, while still enabling onExit for routes that define it.

Root cause

go_router treats an omitted hasOverriddenOnExit marker as true for backward compatibility with older generated code. go_router_builder was omitting that marker for every generated typed route, so routes that did not override onExit still received an onExit callback. That changes pop timing and can surface Flutter's Navigator _RouteLifecycle.idle assertion during rapid system-back/re-enter navigation.

Tests

• Reproduced the Navigator assertion locally with typed routes using GoRouteData.$route without hasOverriddenOnExit.
• Added generator coverage in test_inputs/on_exit.dart / .expect for routes with and without onExit overrides.
• Regenerated checked-in example .g.dart files.
• Ran dart run tool/run_tests.dart in packages/go_router_builder.
• Ran dart analyze --fatal-infos in packages/go_router_builder.
• Ran dart test in packages/go_router_builder.
• Ran dart format --output=none --set-exit-if-changed packages/go_router_builder.
• Ran flutter_plugin_tools analyze --packages=go_router_builder --exact-match-only --no-downgrade.
• Ran flutter_plugin_tools dart-test --packages=go_router_builder --exact-match-only.
• Ran flutter_plugin_tools validate --packages=go_router_builder --exact-match-only.
• Ran flutter_plugin_tools custom-test --packages=go_router_builder --exact-match-only.

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.

CLA status is left for the GitHub CLA bot/account owner to verify.

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 updates the go_router_builder package to only enable onExit on generated routes when the route data class explicitly overrides it. It introduces a _hasOverriddenOnExit check in route_config.dart to inspect the class hierarchy and appends the hasOverriddenOnExit parameter to the generated route configurations. Additionally, the package version is bumped to 4.3.2, and corresponding test inputs and generated files are updated. Feedback suggests making the _hasOverriddenOnExit check more robust by also excluding GoRouteData and RelativeGoRouteData from being identified as user-overridden classes.

[agarwalrahul2702]

Follow-up pushed in 2321012 to cover review feedback:

• Added generator coverage for an inherited GoRouteData.onExit override.
• Added generator coverage for RelativeGoRouteData.onExit.
• Simplified the onExit test fixture to return bool synchronously.
• Clarified CHANGELOG entry with [go_router_builder] Navigator assertion (_RouteLifecycle.idle) during rapid back-and-forth navigation flutter#189503 and the ^17.3.0 go_router requirement.

Local checks run with the repo Flutter SDK (Dart 3.12.2):

• dart run script/tool/bin/flutter_plugin_tools.dart custom-test --packages=go_router_builder --exact-match-only
• dart run script/tool/bin/flutter_plugin_tools.dart analyze --packages=go_router_builder --custom-analysis=script/configs/custom_analysis.yaml
• dart run script/tool/bin/flutter_plugin_tools.dart dart-test --packages=go_router_builder --exact-match-only