[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)

chunhtai

LGTM

hannah-hyj

LGTM

chunhtai · 2025-04-24T22:19:32Z

Hi @ThangVuNguyenViet looks like there are some test failures, can you fix it so that we can land this pr?

ThangVuNguyenViet · 2025-04-28T18:11:45Z

sure I'll do that

btrautmann · 2025-04-29T15:28:15Z

@ThangVuNguyenViet I was doing a bit of testing of relative routes as we may be looking to use them in our project, and I had a question RE: the generation of location for a relative route. AFAICT, there are 2 ways to route using relative routes:

context.go(RelativeRoute().relativeLocation)
RelativeRoute().goRelative(context)

However, context.go(RelativeRoute().location) does not work as it fails the following assertion:

════════ Exception caught by foundation library ════════════════════════════════
The following assertion was thrown while dispatching notifications for GoRouteInformationProvider:
'package:go_router/src/match.dart': Failed assertion: line 235 pos 12: 'uri.path.startsWith(newMatchedLocation)': is not true.

When the exception was thrown, this was the stack:
#2      RouteMatchBase._matchByNavigatorKeyForGoRoute (package:go_router/src/match.dart:235:12)
match.dart:235
#3      RouteMatchBase._matchByNavigatorKey (package:go_router/src/match.dart:110:16)

Is there a use-case for using the location of a relative route? If not, should it even be generated?

chunhtai · 2025-05-08T22:05:52Z

Hi @ThangVuNguyenViet , do you have a chance to look into the error?

ThangVuNguyenViet · 2025-05-16T19:54:02Z

I'll check that out. Sorry for late reply, not seeing the email

ThangVuNguyenViet · 2025-05-17T16:34:39Z

@btrautmann hey could you provide reproducible code? I can't reproduce it

leofeng99 · 2025-05-20T15:28:48Z

@ThangVuNguyenViet @chunhtai @hannah-hyj This looks awesome and offers lots of routing flexibility for apps at large scale. Looks like tests are passing. Could this be prioritized for merging? Thanks!

thangmoxielabs · 2025-05-20T15:48:24Z

Idk, seems like there is an error, which I can't reproduce

leofeng99 · 2025-05-20T19:06:42Z

Idk, seems like there is an error, which I can't reproduce

@thangmoxielabs I think @btrautmann's comment on context.go(RelativeRoute().location) triggering an error is mostly a question around the .location API when used on a relative route. RelativeRoute().location returns a subpath of some full absolute path, therefore trying to go to it probably won't work. Example:

HomeRoute (/home)
- RelativeRoute (/relative)

Doesn't work: context.go(RelativeRoute().location) -> context.go('/relative')
Works: context.go('${HomeRoute().location}${RelativeRoute().location}') -> context.go('/home/relative')

It's more of a dev experience concern, and it doesn't seem merge blocking. One might find that having the .location method return a relative route is better so context.go(RelativeRoute().location) -> context.go('./relative'). But that sort of creates polymorphic behavior for the .location method which might causes other confusion.

thangmoxielabs · 2025-05-20T19:19:38Z

Oh yea I just reread his comment. Thought he was saying the .relativeLocation doesn't work
Well on my app I use the .location primarily to get the string, so I could use for sth like the nav bar selectedItem, e.g GoRouterState.of(context).matchedLocation.contains(RelativeRoute().location). I don't directly use it on context.go though
But I'm going to create a PR which lets navigate to siblings route by "../", which that .location api will be used. Idk if I should add "goSibling" into that next PR or not

thangmoxielabs · 2025-05-20T19:22:55Z

And I do agree the relativeRoute.location is much much different from the normal route.location. Normal route is safe to call, no exception is expected. Relative routes are expected to throw exceptions if you don't know which route you're currently at. A trade off for the convenience

caseycrogers · 2025-05-29T14:22:07Z

We're hoping to use Relative Routes in an upcoming app version release (early July?) at our company. Is there any way we could accelerate merging this in? Happy to assist and contribute if that would help things move along-what are the blockers right now?

thangmoxielabs · 2025-05-29T14:25:36Z

I thinks it's more of a dev ex issue?

caseycrogers · 2025-05-29T18:00:23Z

Oh sorry I didn't mean that there was a blocker, I more just meant can we accelerate merging this? It looks like the only thing stopping us right now is you need to resolve the merge conflicts.

Once the conflicts are merged, we're just waiting on @chunhtai to merge right?

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

chunhtai approved these changes Mar 28, 2025

View reviewed changes

chunhtai requested a review from hannah-hyj March 28, 2025 20:01

hannah-hyj approved these changes Apr 22, 2025

View reviewed changes

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

edef7a5

ThangVuNguyenViet added 2 commits May 17, 2025 23:45

fix generated file

5474303

Fix failed test due to generated files

dbf7f9d

[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

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!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

hannah-hyj left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai commented Apr 24, 2025

Uh oh!

ThangVuNguyenViet commented Apr 28, 2025

Uh oh!

btrautmann commented Apr 29, 2025

Uh oh!

chunhtai commented May 8, 2025

Uh oh!

ThangVuNguyenViet commented May 16, 2025

Uh oh!

ThangVuNguyenViet commented May 17, 2025

Uh oh!

leofeng99 commented May 20, 2025

Uh oh!

thangmoxielabs commented May 20, 2025

Uh oh!

leofeng99 commented May 20, 2025

Uh oh!

thangmoxielabs commented May 20, 2025

Uh oh!

thangmoxielabs commented May 20, 2025

Uh oh!

caseycrogers commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thangmoxielabs commented May 29, 2025

Uh oh!

caseycrogers commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ThangVuNguyenViet commented Jan 22, 2025 •

edited

Loading

caseycrogers commented May 29, 2025 •

edited

Loading

caseycrogers commented May 29, 2025 •

edited

Loading