[go_router] Add support for relative routes by ThangVuNguyenViet · Pull Request #6825 · flutter/packages

ThangVuNguyenViet · 2024-05-29T08:18:19Z

Add supports for relative routes by allowing going to a path relatively, like go('./$path')

This PR doesn't fully resolve any issue, but it's mandatory to further add examples & tests for TypedRelativeGoRoute (see #7174), which will resolves #108177

Pre-launch Checklist

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

ThangVuNguyenViet · 2024-05-31T13:12:52Z

@chunhtai I separated the PR as suggested. Please let me know the next steps
It was my project's need for the goRelative that I created this PR, but it's also tempted to pushRelative along with other imperative APIs. However, that'll result in a new set of APIs (goRelative, pushRelative, pushReplacementRelative , etc). Alternatively we can do make a helper function that helps user construct the relativeRoute, like context.go(context.relativeRoute('settings'). Wdyt?

cedvdb · 2024-06-04T21:31:01Z

Why don't you add it to the existing api.

context.go(`./settings`)

is pretty common in router modules in other frameworks as well as in bash

ThangVuNguyenViet · 2024-06-05T10:25:55Z

Why don't you add it to the existing api.
context.go(`./settings`)
is pretty common in router modules in other frameworks as well as in bash

Oh yea that's cool. I didn't know of that pattern

chunhtai

I also agree we should probably use go(./something) for relative path instead of adding new API. Seems more straigtforward

chunhtai · 2024-06-06T17:50:38Z

packages/go_router/lib/src/information_provider.dart

Why not just modify the path and use currentUri.replace(path: newPath)
This way you don't need to worry about other thing such as host/scheme/fragment/queryparameters

Gotcha. I move this in path_utils as concatenateUris

chunhtai · 2024-07-16T16:51:18Z

packages/go_router/lib/src/path_utils.dart

+/// Concatenates two Uri. It will [concatenatePaths] the parent's and the child's paths , then merges their query parameters.
+///
+/// e.g: pathA = /a?fid=f1, pathB = c/d?pid=p2,  concatenatePaths(pathA, pathB) = /a/c/d?fid=1&pid=2.
+Uri concatenateUris(Uri parentUri, Uri childUri) {


the path looks good, but I am a bit hesitate on also merge query parameter. It has different logic from regular go. Regular go will not attempt to merge with current query parameters. I think we should probably follow the same logic to avoid confusion.

Hmm this is quite interesting thing thou. Take this example.

We're in /family/f2?sort=desc and we're going to the inner person/p1 route, and we'll pop it to go back to the family route. How are devs handling this case?

In go_router_builder, devs can't use the easy PersonRoute(pid: 'p1').go but rather have to get its route.location, convert to Uri, and then manually add the sort param. Being able to use Route().go in builder is kinda a big selling point of the package imo

you can access GoRouterState.of(context).uri.queryParemeters.

Also won't in this case PersonRoute also declare sort parameter?

make sense. I've been doing things wrong in my app then

chunhtai · 2024-07-16T16:52:09Z

packages/go_router/lib/src/route_data.dart

 }

+/// A superclass for each typed go route descendant
+@Target(<TargetKind>{TargetKind.library, TargetKind.classType})


Can you also create a go_router_builder pr that shows how this will be used?

it's #7174 @chunhtai , and I also updated the PR desc to reflect that

@chunhtai I've removed this class as discussed in the #7174

- Adds `TypedRelativeGoRoute`

…for `concatenateUris`

…dUri

chunhtai

just pointing out one issue, otherwise, LGTM

chunhtai · 2024-09-19T20:52:19Z

packages/go_router/lib/src/path_utils.dart

+Uri concatenateUris(Uri parentUri, Uri childUri) {
+  Uri newUri = parentUri.replace(
+    path: concatenatePaths(parentUri.path, childUri.path),
+    queryParameters: childUri.queryParameters,


also fragment

we should probably have some test for fragment as well

chunhtai

LGTM

hannah-hyj

LGTM

cedvdb · 2024-10-20T21:41:16Z

@thangmoxielabs This branch has conflicts that must be resolved

vasilich6107 · 2024-11-02T18:34:35Z

@ThangVuNguyenViet This branch has conflicts that must be resolved
@chunhtai @hannah-hyj is there any chance to fix conflicts and merge this very important feature?(How can I help?)

cedvdb · 2024-11-02T23:24:20Z

@ThangVuNguyenViet This branch has conflicts that must be resolved @chunhtai @hannah-hyj is there any chance to fix conflicts and merge this very important feature?(How can I help?)

You can fork and redo a pr

thangmoxielabs · 2024-11-03T09:42:09Z

@cedvdb hey sorry for the late reply. I didn't see any notification

…relative

vasilich6107 · 2024-11-07T11:27:29Z

@chunhtai @hannah-hyj
Could you merge this PR and release

chunhtai · 2024-11-07T17:16:44Z

This somehow slip through the crack. @thangmoxielabs can you fix the conflict again? sorry about the delay

ThangVuNguyenViet · 2024-11-07T18:59:14Z

@chunhtai resolved it

chunhtai · 2024-11-07T19:15:33Z

Hi @ThangVuNguyenViet you also need to bump the package.yaml version

ThangVuNguyenViet · 2024-11-08T12:23:10Z

Hey @chunhtai it's bumped

vasilich6107 · 2024-11-12T22:43:06Z

Hi @chunhtai
go_router was again updated 5 hours ago
Is there any chance to merge this PR before all other?

…#6825)

flutter/packages@72356fd...26e123a 2024-11-13 dasyad00@gmail.com [camera_windows] Set device media type for video preview explicitly (flutter/packages#7447) 2024-11-13 39979207+ThangVuNguyenViet@users.noreply.github.com [go_router] Add support for relative routes (flutter/packages#6825) 2024-11-13 pq@users.noreply.github.com [vector_graphics_compiler] fix a renamed method parameter lint (flutter/packages#8070) 2024-11-12 feinstein@users.noreply.github.com [in_app_purchase] Add expiration date to Transaction (flutter/packages#8030) 2024-11-12 stuartmorgan@google.com [various] Clean up contributing guides (flutter/packages#8032) 2024-11-12 ditman@gmail.com [ci] Remove web renderer option from tools. (flutter/packages#8055) 2024-11-12 stuartmorgan@google.com [url_launcher] Update Pigeon version for Linux (flutter/packages#8065) 2024-11-12 tobias@leafnode.se [go_router] Add support for preloading branches of StatefulShellRoute (revised solution) (flutter/packages#6467) 2024-11-12 stuartmorgan@google.com [pigeon] Make Linux type declarations public (flutter/packages#8040) 2024-11-11 engine-flutter-autoroll@skia.org Roll Flutter from 73546b3 to c8510f2 (30 revisions) (flutter/packages#8042) 2024-11-11 magder@google.com Use dependabot multi-directory configuration for Android package updates (flutter/packages#8048) 2024-11-11 stuartmorgan@google.com [tools] Run `pub get` before `format` (flutter/packages#8052) 2024-11-11 stuartmorgan@google.com [file_selector] Fix Linux cancel regression (flutter/packages#8051) 2024-11-09 stuartmorgan@google.com [shared_preferences] Fix confusing language in README (flutter/packages#8049) 2024-11-08 magder@google.com Use dependabot multi-directory configuration for Android example gradle updates (flutter/packages#8036) 2024-11-08 43054281+camsim99@users.noreply.github.com [animations] Remove `.flutter-plugins` reference from example app (flutter/packages#8002) 2024-11-08 magder@google.com Group dependabot github-action update PRs, delete dead docker updates (flutter/packages#8044) 2024-11-08 37028599+EArminjon@users.noreply.github.com [vector_graphics_compiler] fix-null-exception (flutter/packages#8006) 2024-11-08 stuartmorgan@google.com [tools] Format Dart per-package (flutter/packages#8043) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

subzero911 · 2025-02-13T05:02:45Z

@chunhtai @ThangVuNguyenViet strange behaviour occurs when using context.push instead of context.go

Example:
/profile/referral/select-method/withdraw

When using

context.go('./select-method');
context.go('./withdraw');

it's okay.

When using

context.push('./select-method');
context.push('./withdraw');

we got "GoException: no routes for location /profile/referral/withdraw"

ThangVuNguyenViet requested a review from chunhtai as a code owner May 29, 2024 08:18

github-actions bot added the p: go_router label May 29, 2024

chunhtai reviewed Jun 6, 2024

View reviewed changes

ThangVuNguyenViet force-pushed the go_router/go-relative branch 2 times, most recently from 9aa61bd to 975128b Compare June 19, 2024 13:05

chunhtai self-requested a review June 20, 2024 21:39

chunhtai reviewed Jul 16, 2024

View reviewed changes

ThangVuNguyenViet mentioned this pull request Jul 19, 2024

[go_router_builder] Add support for relative routes #7174

Closed

11 tasks

chunhtai self-requested a review July 25, 2024 21:37

ThangVuNguyenViet force-pushed the go_router/go-relative branch from 0626fb1 to b15b23b Compare September 6, 2024 03:31

ThangVuNguyenViet added 14 commits September 6, 2024 10:33

- Adds GoRouter.goRelative

02689ff

- Adds `TypedRelativeGoRoute`

add go_relative example for go_router

e8ac4ee

add go_relative_test for the example

c42151c

fix failed test

022db98

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

812498e

Commit missing files during merge

07b63ad

update changelog & version

c025d86

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

3fb6463

…for `concatenateUris`

Add more concatenateUris test. Fix joining params

205d096

update example description

8e4db8e

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

0ead0af

…dUri

Refactor example & its test

9407200

Remove TypedRelativeGoRoute

6830539

Add missing import

43eb497

ThangVuNguyenViet force-pushed the go_router/go-relative branch from b15b23b to 43eb497 Compare September 6, 2024 03:47

chunhtai reviewed Sep 19, 2024

View reviewed changes

chunhtai requested a review from hannah-hyj September 19, 2024 21:02

ThangVuNguyenViet and others added 2 commits September 24, 2024 23:49

add fragment test to concatenateUris

2dd80d9

Merge branch 'main' into go_router/go-relative

3071a53

chunhtai approved these changes Oct 3, 2024

View reviewed changes

hannah-hyj approved these changes Oct 12, 2024

View reviewed changes

Merge branch 'main' of github.com:flutter/packages into go_router/go-…

4dba574

…relative

Merge branch 'main' into go_router/go-relative

fb61d97

bump version to 14.4.2 in pubspec.yaml

d1ebfeb

Merge branch 'main' into go_router/go-relative

c246bc3

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Nov 13, 2024

auto-submit bot merged commit 67d8b50 into flutter:main Nov 13, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Nov 13, 2024

engine-flutter-autoroll mentioned this pull request Nov 13, 2024

Roll Packages from 72356fda4684 to 67d8b50c1796 (18 revisions) flutter/flutter#158586

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 13, 2024

67d8b50 [go_router] Add support for relative routes (flutter/packages…

6d28f58

…#6825)

engine-flutter-autoroll mentioned this pull request Nov 13, 2024

Roll Packages from 72356fda4684 to 26e123a6ce03 (19 revisions) flutter/flutter#158626

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 13, 2024

67d8b50 [go_router] Add support for relative routes (flutter/packages…

60a2b92

…#6825)

ThangVuNguyenViet mentioned this pull request Jan 22, 2025

[go_router_builder] Add support for relative routes #8476

Closed

11 tasks

Conversation

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

Uh oh!

Pre-launch Checklist

Uh oh!

ThangVuNguyenViet commented May 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cedvdb commented Jun 4, 2024

Uh oh!

ThangVuNguyenViet commented Jun 5, 2024

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

cedvdb commented Oct 20, 2024

Uh oh!

vasilich6107 commented Nov 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cedvdb commented Nov 2, 2024

Uh oh!

thangmoxielabs commented Nov 3, 2024

Uh oh!

vasilich6107 commented Nov 7, 2024

Uh oh!

chunhtai commented Nov 7, 2024

Uh oh!

ThangVuNguyenViet commented Nov 7, 2024

Uh oh!

chunhtai commented Nov 7, 2024

Uh oh!

ThangVuNguyenViet commented Nov 8, 2024

Uh oh!

vasilich6107 commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subzero911 commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

ThangVuNguyenViet commented May 29, 2024 •

edited

Loading

ThangVuNguyenViet commented May 31, 2024 •

edited

Loading

vasilich6107 commented Nov 2, 2024 •

edited

Loading

vasilich6107 commented Nov 12, 2024 •

edited

Loading

subzero911 commented Feb 13, 2025 •

edited

Loading