Skip to content

[go_router_builder]: Add support for relative routes #9749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

LukasMirbt
Copy link
Contributor

Adds support for TypedRelativeGoRoute.

Builds on #9732

Continuation of #8476 by @ThangVuNguyenViet

Compared to #8476, the approach taken in this PR avoids breaking changes and creates a separate RouteData subclass instead of extending GoRouteData. The approach increases flexibility and avoids extending behavior that might not make sense for a relative route.

Fully resolves flutter/flutter#108177.

Pre-Review Checklist

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. 2 3

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces support for relative routes with TypedRelativeGoRoute. I've added one suggestion to improve validation by ensuring that paths for relative routes are not absolute, which will help catch errors early during development.

@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 9 times, most recently from 2162d41 to 2f641f3 Compare August 6, 2025 23:39
@LukasMirbt
Copy link
Contributor Author

LukasMirbt commented Aug 7, 2025

Update

  • Factored out repeated logic between GoRouteConfig and RelativeGoRouteConfig with a mixin
  • Added readme section
  • Added build-time validation preventing the entire sub-tree of a TypedRelativeGoRoute from containing a TypedGoRoute (all other types are valid)
  • Added build-time validation preventing a TypedRelativeGoRoute path from starting with "/"

@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 3 times, most recently from a2592d6 to 31d0358 Compare August 7, 2025 21:59
@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 2 times, most recently from 0cd3be6 to db007f4 Compare August 7, 2025 23:14
@LukasMirbt
Copy link
Contributor Author

Update

  • Added to readme explaining the purpose of relative routes
  • Bumped minor version
  • Renamed confusingly named RelativeGoRouteData location getter to subpath

@LukasMirbt LukasMirbt requested a review from chunhtai August 7, 2025 23:27
@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 6 times, most recently from eea9408 to a9a7c30 Compare August 13, 2025 19:22
@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 10 times, most recently from 949e44a to 872280b Compare August 18, 2025 20:42
Copy link
Member

@hannah-hyj hannah-hyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

auto-submit bot pushed a commit that referenced this pull request Aug 18, 2025
)

Adds `RelativeGoRouteData` and `TypedRelativeGoRoute` to support type-safe relative routes.

Foundation for #9749 which adds relative route support in `go_router_builder`. 

Continuation of #8476 by @ThangVuNguyenViet 

Compared to #8476, the approach taken in this PR avoids breaking changes and creates a separate `RouteData` subclass instead of extending `GoRouteData`. The approach increases flexibility and avoids extending behavior that might not make sense for a relative route.

Necessary to fully resolve flutter/flutter#108177.

## Pre-Review Checklist

**Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). 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.

[^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.
@chunhtai
Copy link
Contributor

the base pr is merged, can you rebase and see if the ci passes?

@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch from 872280b to 1ad8184 Compare August 18, 2025 21:51
@LukasMirbt
Copy link
Contributor Author

LukasMirbt commented Aug 18, 2025

@chunhtai Checks failing because the PR depends on go_router: ^16.2.0. Not sure what to do, please advise.

@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 3 times, most recently from 21a980d to 0afd194 Compare August 18, 2025 23:49
@LukasMirbt
Copy link
Contributor Author

@chunhtai CI passing!

@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch 2 times, most recently from b6f6e91 to f04874b Compare August 19, 2025 14:38
@LukasMirbt LukasMirbt force-pushed the go-router-builder/add-support-for-relative-routes branch from f04874b to 7a6ba60 Compare August 19, 2025 16:04
@chunhtai chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 19, 2025
@auto-submit auto-submit bot merged commit 58c02e0 into flutter:main Aug 19, 2025
80 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: go_router_builder
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[go_router] Add support for relative routes
3 participants