[go_router_builder] Add support for relative routes #8476

ThangVuNguyenViet · 2025-01-22T08:19:39Z

This PR is a 2nd part of #6825 to fully resolves flutter/flutter#108177, which allow users to use TypedRelativeGoRoute to construct the route relatively.

This is a continuation of #7174

Example:

import 'package:go_router/go_router.dart';

const TypedRelativeGoRoute<RelativeRoute> relativeRoute =
    TypedRelativeGoRoute<RelativeRoute>(
  path: 'relative-route',
  routes: <TypedRoute<RouteData>>[
    TypedRelativeGoRoute<InnerRelativeRoute>(path: 'inner-relative-route')
  ],
);

@TypedGoRoute<Route1>(
  path: 'route-1',
  routes: <TypedRoute<RouteData>>[relativeRoute],
)
class Route1 extends GoRouteData {
  const Route1();
}

@TypedGoRoute<Route2>(
  path: 'route-2',
  routes: <TypedRoute<RouteData>>[relativeRoute],
)
class Route2 extends GoRouteData {
  const Route2();
}

class RelativeRoute extends GoRouteData {
  const RelativeRoute();
}

class InnerRelativeRoute extends GoRouteData {
  const InnerRelativeRoute();
}

Basically the added TypedRelativeGoRoute allows us to construct the route tree above. If we replace it with the existing TypedGoRoute it will declare multiple extensions of a same thing and produce build time error

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

- Adds `TypedRelativeGoRoute`

…for `concatenateUris`

…dUri

…ly use dependency_overrides to take local go_router

…Route's extension

ThangVuNguyenViet · 2025-01-22T08:34:08Z

@chunhtai same issue I asked in the old PR. The test will fail without the temp dependency_overrides. Should I make a PR that contains only the TypedRelativeGoRoute in go_router and wait for it to get merged first?

chunhtai · 2025-02-05T22:00:42Z

packages/go_router_builder/example/lib/go_relative.dart

+final GoRouter _router = GoRouter(
+  routes: $appRoutes,
+);
+const TypedRelativeGoRoute<DetailsRoute> detailRoute =


What is different between using this vs a regular TypedGoRoute?

The example I gave isn't clearly explaining the purpose. Let me update this

I still can't see the difference. Is this a way to reuse the typedGoRoute in multiple places in the routing tree?

Yes. Without this you'd have to define routes like
SettingsFromHomeRoute
SettingsFromDashboardRoute

And those routes all build (or build page) the same screen

yeah this makes sense. I will take another look

ThangVuNguyenViet

just updated the example

ThangVuNguyenViet · 2025-02-06T13:33:31Z

packages/go_router_builder/example/lib/go_relative.dart

+final GoRouter _router = GoRouter(
+  routes: $appRoutes,
+);
+const TypedRelativeGoRoute<DetailsRoute> detailRoute =


chunhtai

See my comment #8476 (comment)

robertsonja · 2025-06-05T21:04:54Z

I also would love this.

ThangVuNguyenViet · 2025-06-12T06:38:45Z

Just did another merge conflict. Is there a better way to avoid conflict in the changelog file?

caseycrogers · 2025-06-18T14:01:28Z

@chunhtai is there any way you could step back in and help us get this merged? It's super high value for us and it looks like it has been done for a couple of months and just stuck in a merge conflict loop waiting for your approval and merge.

Piinks · 2025-06-18T19:00:25Z

I am working on an updated workflow for flutter/packages to remove the pain point of the changelog and version merge conflicts, hoping to get that out sooner rather than later.

I can help shepherd this in, but please do update the pubspec to match what you have indicated as the new version in the changelog, that seems to be have been omitted. CI is also failing, can you take a look?

Piinks · 2025-06-18T19:02:01Z

@hannah-hyj I noticed you mentioned in #8665 that PRs should be split between go_router and go_router_builder. Is that not relevant here?

caseycrogers · 2025-06-18T19:54:12Z

cc @ThangVuNguyenViet for the pubspce and CI issues mentioned

mit-mit · 2025-07-01T15:39:35Z

Hi there @ThangVuNguyenViet, thanks much for contributing! Are you still able to work on this to complete the few things mentioned?

ThangVuNguyenViet · 2025-07-01T15:46:12Z

hey @mit-mit I don't think what she mentioned was relevant

Piinks · 2025-07-08T17:06:52Z

Hey @ThangVuNguyenViet I'd love to help you get this in. Currently there are several failing tests, can you take a look?

ThangVuNguyenViet · 2025-07-09T04:30:29Z

@Piinks there seems to be a new convention for go_router_builder, which requires with _$RouteMixin. I'll try to update and fix the issue

ThangVuNguyenViet · 2025-07-09T06:43:01Z

There are lots of breaking changes in #9277 that results in this test run failure. Specifically it throws Should be generated using [Type-safe routing](https://pub.dev/documentation/go_router/latest/topics/Type-safe%20routes-topic.html).

After carefully inspected the changes, I've removed 1 breaking change that that PR made, which is the adding of routing methods \.location, \.go$context$, \.push$context$, \.pushReplacement$context$, and replace$context$ to GoRouteData. I find them should be removed because

That PR assumes there are only that set of changes in GoRouteData, since at the time there was no TypedRelativeGoRoute. This PR introduces goRelative, pushRelative, etc, which breaks the assumption.
The PR changes go_router_builder from generating extension to mixin, which is a breaking change. That list of methods added prevents compile time error when migrating to the go router version where it uses mixin instead of extension. That's why I wasn't able to detect error until tests run.

I'm removing that set of routing methods in the upcoming commits, and adapting the generation of TypedRelativeGoRoute from extension to mixin as well. Please let me know what I should do instead

…ator to use mixin instead of extension. Update tests to use appropriate mixins

ThangVuNguyenViet · 2025-07-09T07:27:19Z

btw I am unable to run the ensure_build test on my local. The error message says
Could not find a command named "/Users/vietthangvunguyen/Workspace/flutter/bin/cache/dart-sdk/bin/snapshots/frontend_server.dart.snapshot".
do you have any idea? The test still runs fine on CI

…s much as possible. Add case sensitive support. Fix failing tests

ThangVuNguyenViet · 2025-07-09T15:33:16Z

@Piinks please assist me on the breaking change. I think removing that part was right, but if you tell me that wasn't the right direction, I'm happy to bring it back and make changes as needed

Piinks · 2025-07-09T15:42:51Z

I've removed 1 breaking change that that PR made

I don't think undoing the other change as part of this one is the right course of action. That change has already been published, and undoing it would be another breaking change.

packages/go_router/CHANGELOG.md

ThangVuNguyenViet · 2025-07-10T05:30:45Z

okay so what do you suggest?
I could bring back the routing methods, .go, .push, ... but what about the .goRelative and .pushRelative that this PR introduces?
Further more, it makes no sense for a RelativeRoute to have .go method and it will always throws error. That's like the biggest foot gun for any package users

One thing we could do is to change the name from .goRelative into .go, but I wouldn't recommend doing so. Having a .goRelative api says you need to treat it differently with .go. .go is idempotent and error free, calling it many times in a row wouldn't lead to a RouteException. .goRelative isn't. Having 1 same api name but different use case will lead to big confusion. Speaking from my own experience here, since I've been using my own fork for a year

justinmc · 2025-07-21T18:14:00Z

There's a failure here that can probably be fixed with a merge/rebase.

LukasMirbt · 2025-08-03T14:04:02Z

okay so what do you suggest? I could bring back the routing methods, .go, .push, ... but what about the .goRelative and .pushRelative that this PR introduces? Further more, it makes no sense for a RelativeRoute to have .go method and it will always throws error. That's like the biggest foot gun for any package users

One thing we could do is to change the name from .goRelative into .go, but I wouldn't recommend doing so. Having a .goRelative api says you need to treat it differently with .go. .go is idempotent and error free, calling it many times in a row wouldn't lead to a RouteException. .goRelative isn't. Having 1 same api name but different use case will lead to big confusion. Speaking from my own experience here, since I've been using my own fork for a year

Hi @ThangVuNguyenViet,

Thank you for all the work you've put into this PR.

To help this feature move forward, I have opened two new PRs (#9732, #9749).
My proposal introduces a new RelativeGoRouteData class. This allows relative routes to have their own specific methods without inheriting the standard .go, which seems to solve the "foot gun" issue you raised while avoiding breaking changes.

Please let me know if you have any feedback or see any issues with this approach.

For testing, add the following to pubspec.yaml:

dependencies:
  go_router:
    git:
      url: https://github.com/LukasMirbt/packages.git
      ref: relative-routes
      path: packages/go_router

dev_dependencies:
  go_router_builder:
    git:
      url: https://github.com/LukasMirbt/packages.git
      ref: relative-routes
      path: packages/go_router_builder

abdullahalamodi · 2025-08-03T18:28:47Z

okay so what do you suggest? I could bring back the routing methods, .go, .push, ... but what about the .goRelative and .pushRelative that this PR introduces? Further more, it makes no sense for a RelativeRoute to have .go method and it will always throws error. That's like the biggest foot gun for any package users

One thing we could do is to change the name from .goRelative into .go, but I wouldn't recommend doing so. Having a .goRelative api says you need to treat it differently with .go. .go is idempotent and error free, calling it many times in a row wouldn't lead to a RouteException. .goRelative isn't. Having 1 same api name but different use case will lead to big confusion. Speaking from my own experience here, since I've been using my own fork for a year

Is it this fork?
https://github.com/ThangVuNguyenViet/packages/tree/go_router/go-relative/packages/go_router

I want to use it until this PR has been merged.

thangmoxielabs · 2025-08-06T18:15:38Z

@abdullahalamodi you should've used the main branch, as from this PR branch

ThangVuNguyenViet added 17 commits June 19, 2024 20:02

- Adds GoRouter.goRelative

37be48c

- Adds `TypedRelativeGoRoute`

add go_relative example for go_router

f8061ce

add go_relative_test for the example

8a77147

fix failed test

61127f3

replace goRelative with go('./$path')

687b332

Commit missing files during merge

cca1454

update changelog & version

975128b

Prevent concatenateUris from adding trailing redundant '?'. Add test …

6d90488

…for `concatenateUris`

Add more concatenateUris test. Fix joining params

ccb38f9

update example description

80d85d6

Make concatenateUris not merging parameters, only take them from chil…

a09aa94

…dUri

Add GoRelativeRouteConfig

a174cbe

Add test, examples and example tests for go_router_builder. Temporari…

4cb0334

…ly use dependency_overrides to take local go_router

Add relativeLocation, push, pushReplacement & replace to the Relative…

ceaa318

…Route's extension

Merge branch 'flutter-main'

d3b5355

update go_router package dependency

07b4a23

Fix merge issues

6008b8b

ThangVuNguyenViet requested a review from chunhtai as a code owner January 22, 2025 08:19

github-actions bot added p: go_router_builder p: go_router labels Jan 22, 2025

temporarily add dependency_override

d2fbc0e

ThangVuNguyenViet added 2 commits February 4, 2025 02:04

change relative route actions to have suffix Relative

8b5fb4d

Fix example

02c3d7b

chunhtai reviewed Feb 5, 2025

View reviewed changes

Update go_relative test

72c06de

ThangVuNguyenViet commented Feb 6, 2025

View reviewed changes

chunhtai self-requested a review February 6, 2025 23:32

chunhtai reviewed Feb 13, 2025

View reviewed changes

chunhtai self-requested a review February 27, 2025 23:05

Merge branch 'main' of github.com:flutter/packages

868a2d5

Merge branch 'main' of github.com:flutter/packages

232dc7d

Merge branch 'main' of github.com:flutter/packages

1d5ad11

ThangVuNguyenViet added 2 commits July 9, 2025 13:56

Remove GoRouteData routing methods. Update TypedRelativeGoRoute gener…

f899939

…ator to use mixin instead of extension. Update tests to use appropriate mixins

remove overrides on other tests

92f6cac

make sure relative go route generated code resembles typed go route a…

f98505e

…s much as possible. Add case sensitive support. Fix failing tests

Piinks reviewed Jul 9, 2025

View reviewed changes

packages/go_router/CHANGELOG.md Outdated Show resolved Hide resolved

update changelog

20fd5d6

This was referenced Aug 3, 2025

[go_router]: Add RelativeGoRouteData and TypedRelativeGoRoute #9732

Open

[go_router_builder]: Add support for relative routes LukasMirbt/packages#1

Closed

LukasMirbt mentioned this pull request Aug 4, 2025

[go_router_builder]: Add support for relative routes #9749

Open

11 tasks

[go_router_builder] Add support for relative routes #8476

Are you sure you want to change the base?

[go_router_builder] Add support for relative routes #8476

Uh oh!

Conversation

ThangVuNguyenViet commented Jan 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

ThangVuNguyenViet commented Jan 22, 2025

Uh oh!

chunhtai Feb 5, 2025

Choose a reason for hiding this comment

Uh oh!

ThangVuNguyenViet Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

ThangVuNguyenViet Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Feb 13, 2025

Choose a reason for hiding this comment

Uh oh!

ThangVuNguyenViet Feb 14, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Feb 27, 2025

Choose a reason for hiding this comment

Uh oh!

ThangVuNguyenViet left a comment

Choose a reason for hiding this comment

Uh oh!

ThangVuNguyenViet Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

robertsonja commented Jun 5, 2025

Uh oh!

ThangVuNguyenViet commented Jun 12, 2025

Uh oh!

caseycrogers commented Jun 18, 2025

Uh oh!

Piinks commented Jun 18, 2025

Uh oh!

Piinks commented Jun 18, 2025

Uh oh!

caseycrogers commented Jun 18, 2025

Uh oh!

mit-mit commented Jul 1, 2025

Uh oh!

ThangVuNguyenViet commented Jul 1, 2025

Uh oh!

Piinks commented Jul 8, 2025

Uh oh!

ThangVuNguyenViet commented Jul 9, 2025

Uh oh!

ThangVuNguyenViet commented Jul 9, 2025

Uh oh!

ThangVuNguyenViet commented Jul 9, 2025

Uh oh!

ThangVuNguyenViet commented Jul 9, 2025

Uh oh!

Piinks commented Jul 9, 2025

Uh oh!

Uh oh!

ThangVuNguyenViet commented Jul 10, 2025

Uh oh!

justinmc commented Jul 21, 2025

Uh oh!

LukasMirbt commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abdullahalamodi commented Aug 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thangmoxielabs commented Aug 6, 2025

Uh oh!

Uh oh!

ThangVuNguyenViet commented Jan 22, 2025 •

edited

Loading

LukasMirbt commented Aug 3, 2025 •

edited

Loading

abdullahalamodi commented Aug 3, 2025 •

edited

Loading