[go_router] Add routing functions to GoRouteData

[StevenSorial]

second step of fixing #106790. First PR

This PR adds the routing methods .location, .go(context), .push(context), .pushReplacement(context), and replace(context) to GoRouteData. They will be overridden by the mixin generated by go_router_builder

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.

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

[StevenSorial]

@hannah-hyj

[chunhtai]

LGTM

[chunhtai]

Suggested change

	'It should throw beacuase there is not code generated',
	'It should throw beacuase there is no code generated',

[StevenSorial]

@chunhtai @hannah-hyj Thanks for the approval. There are two things that I would appreciate some help with in this PR:

• Currently if the user installed go_router >= 15.2.0, but go_router_builder < 3.0.0, the exception would be thrown on navigation. Is there a way to describe this dependency?
• I don't like how the test I wrote looks 😅 Is there a way to improve it?

[AndrewDongminYoo]

Hi there,

I ran into a compilation error after upgrading to go_router_builder 3.0.0 together with go_router 15.1.3. The generated mixin looks like this:

mixin _$SplashRoute on GoRouteData {
  static SplashRoute _fromState(GoRouterState state) => const SplashRoute();

  @override
  String get location => GoRouteData.$location('/');

  @override
  void go(BuildContext context) => context.go(location);

  @override
  Future<T?> push<T>(BuildContext context) => context.push<T>(location);
  // …and so on
}

However, in go_router 15.1.3, GoRouteData does not declare location, go(), push(), etc., so the @override annotations cause errors:

Error: The method ‘location’ isn’t defined for the class ‘GoRouteData’.

It looks like the builder is already generating mixins for methods that are only available in an unreleased version of go_router. Could we either:

1. Remove the @override annotations for methods not yet in GoRouteData, or
2. Guard generation so that only methods present in the published go_router API are included?

Happy to provide a minimal repro if it helps. Thanks for looking into this!

[Piinks]

Hi @StevenSorial thanks for contributing! What is the status of thisPR? Were you able to answer the questions you shared above? Looks like CI is happy, just some minor merge conflicts from the changelog and version bump.

[vware]

i dont mean to press this issue, but we now have 1000s of warnings of "The method doesn't override an inherited method.
Try updating this class to match the superclass, or removing the override annotation." in our projects... Could you please merge this? I don't think go_router_builder 3.0 should have been released without this PR here?

[StevenSorial]

Hi @Piinks, what questions? I posted two questions for @chunhtai @hannah-hyj, but no one responded. I was hoping for my two PRs to get merged together, but unfortunately only one got merged and caused warnings to appear.

[Piinks]

I posted two questions for @chunhtai @hannah-hyj

Thanks for sharing! I will see about getting answers here. :)

[chunhtai]

oh i didn't aware the go_router_builder pr needs go_router change, yes in this case this pr needs to be reviewed together with the go_router_builder pr and once both approved, go_router pr needs to merge in first.

Currently if the user installed go_router >= 15.2.0, but go_router_builder <3.0.0, the exception would be thrown on navigation. Is there a way to describe this dependency?

there is not much we can do except asking them to upgrade go_router_builder.

[hannah-hyj]

LGTM

[auto-submit]

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

[auto-submit]

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

• The status or check suite Linux_android_legacy android_platform_tests_legacy_api_shard_5 master has failed. Please fix the issues identified (or deflake) before re-applying this label.
• The status or check suite Linux_android android_build_all_packages stable has failed. Please fix the issues identified (or deflake) before re-applying this label.

[chunhtai]

ci is having issue now