[go_router] feat: access GoRouter.of from redirect methods

[tomassasovsky]

This PR fixes being able to access the GoRouter instance from the context inside redirect methods.

It solves flutter/flutter#116855 (comment)

My use case for this is:

I'm building an extension package for navigation guards for go_router. Specifically, for type-safe generated routes. These guards are chainable and need to have the ability to block a route push/go. For this, I have the following method implemented:

  /// Block navigation by redirecting to current location
  void block({bool reevaluateOnChange = false}) {
    if (isResolved) return;
    final currentLocation =
        GoRouter.of(context).routerDelegate.currentConfiguration.fullPath;
    // Block by redirecting to current location
    _completer.complete(GuardResult.redirect(
      currentLocation,
      reevaluateOnChange: reevaluateOnChange,
    ));
  }

This method, however, needs this PR because it's ran on the redirect function of a GoRouteData.

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• 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 updated pubspec.yaml with 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¹.
• I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption 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. ↩ ↩² ↩³

[gemini-code-assist]

Code Review

This pull request introduces a great feature to access GoRouter.of(context) from within redirect methods by using a Zone. The implementation is solid and the new tests cover the functionality well.

I have a couple of suggestions to improve the code quality:

• I've identified a duplicated constant across two files and suggest centralizing it to improve maintainability.
• There's some redundant logic in the new GoRouter.of method which can be simplified.

Please see my detailed comments. Overall, great work!

[stuartmorgan-g]

Thanks for the contribution! You haven’t checked off any of the items in the PR checklist above, so I’m assuming this is a work in progress and am marking it as a Draft. Please review the checklist, updating the PR as appropriate, and when that’s complete please feel free to mark the PR as ready for review.

[tomassasovsky]

Thanks @stuartmorgan-g! Just updated and marked as ready.

[chunhtai]

approach seems fine to me, just need some more error handling

[chunhtai]

Can you add a test that the error throw during the redirect can be caught by onException?

[tomassasovsky]

Added proper exception handling in the _redirect method to ensure redirect errors are gracefully converted to error RouteMatchList objects instead of crashing navigation.

What changed:

• Wrapped redirect calls in try-catch for sync exceptions
• Added .catchError() for async redirect exceptions
• Both paths convert exceptions to GoException and return error match lists

Why this matters:
This ensures that when a redirect throws an exception (like in the failing test), it gets properly handled by the onException callback instead of breaking the entire navigation flow. Previously, exceptions would bubble up and crash the router - now they're caught and transformed into proper error states that the router knows how to handle.

Works hand-in-hand with the configuration.dart fix to provide complete exception handling coverage throughout the redirect chain.

[chunhtai]

LGTM

[chunhtai]

looks like there is some conflict and ci error

[tomassasovsky]

I'm not too sure about what's failing here @chunhtai - I made sure everything's formatted correctly so it doesn't fail, but it still is.

[chunhtai]

looks like you may be using an outdated formatter. can you make sure you have latest flutter and also run flutter pub dev in go_router package?

[tomassasovsky]

All fixed now, thanks @chunhtai :)

[hannah-hyj]

LGTM

[tomassasovsky]

any updates on this? @chunhtai

[auto-submit]

autosubmit label was removed for flutter/packages/9706, because - The status or check suite Mac_arm64 ios_platform_tests_shard_5 master has failed. Please fix the issues identified (or deflake) before re-applying this label.

• The status or check suite Mac_arm64 macos_repo_checks has failed. Please fix the issues identified (or deflake) before re-applying this label.