[go_router_builder] Migrate to Element2 API and update dependencies #9649

koji-1009 · 2025-07-19T14:08:24Z

close flutter/flutter#170832
close flutter/flutter#171003

Update build, build_test, and source_gen versions.
Update analyzer version to support Element2 API.
Fix unit test code formatting and comparison logic
Flutter 3.29 and Dart 3.7.

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.

Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

gemini-code-assist

Code Review

This pull request migrates the go_router_builder package to the Element2 API, updating dependencies and improving test code formatting. The changes are well-structured and consistently applied across the codebase. The migration to the new API is crucial for maintaining compatibility with the latest versions of analyzer, build, and source_gen.

gemini-code-assist · 2025-07-19T14:10:16Z

packages/go_router_builder/lib/src/route_config.dart

    if (element.isRequired) {
      if (element.type.nullabilitySuffix == NullabilitySuffix.question &&
-          _pathParams.contains(element.name)) {
+          _pathParams.contains(element.displayName)) {


The migration to Element2 API involves changes to how parameter names are accessed. Ensure that the display name is correctly used throughout the codebase to maintain consistency and prevent unexpected behavior.

gemini-code-assist · 2025-07-19T14:10:16Z

packages/go_router_builder/lib/src/route_config.dart

@@ -60,14 +60,14 @@ class ShellRouteConfig extends RouteBaseConfig {

  @override
  Iterable<String> classDeclarations() {
-    if (routeDataClass.unnamedConstructor == null) {
+    if (routeDataClass.unnamedConstructor2 == null) {


The migration to Element2 API involves changes to how constructor elements are accessed. Consider updating the error message to reflect the new API usage and improve clarity for developers debugging potential issues related to constructor access.

gemini-code-assist · 2025-07-19T14:10:16Z

packages/go_router_builder/tool/run_tests.dart

+      final String generated = formatter.format(results.join().replaceAll('\n', ''));
+      final String expected = formatter.format(expectResult.replaceAll('\n', ''));
+      expect(generated, equals(expected));


The comparison logic has been updated to improve robustness against formatting variations. Consider adding a comment explaining why the replaceAll calls are necessary to improve code understanding and maintainability.

koji-1009 · 2025-07-19T23:41:00Z

Mac_arm64 custom_package_tests master and Mac_arm64 custom_package_tests stable are passed, but Windows_x64 custom_package_tests master is failed.

koji-1009 · 2025-07-21T03:50:38Z

Fix test code to support windows path separator. 96d68f9

chunhtai · 2025-07-30T16:33:16Z

packages/go_router_builder/lib/src/go_router_generator.dart

    }
  }

  InfoIterable _generateForAnnotatedElement(
-    Element element,
+    Element2 element,


looking at the doc https://pub.dev/documentation/analyzer/latest/dart_element_element/Element2.html

should we keep the original class name

@chunhtai
Element2 will be deprecated starting with analyzer v8.0.0. Since analyzer: “>=7.4.0 <8.0.0” is set, Element2 is not deprecated.

https://pub.dev/documentation/analyzer/7.7.1/dart_element_element2/Element2-class.html
https://pub.dev/documentation/analyzer/8.0.0/dart_element_element/Element2.html

Other libraries are also replacing Element2 in the same way.

google/json_serializable.dart#1504
rrousselGit/freezed#1276

can we pin analyzer 8.0.0 and above directly?

@chunhtai
It will be difficult as it was not announced in advance. Specifying ^8.0.0 will break compatibility with other packages.

https://github.com/dart-lang/mockito/blob/v5.4.5/pubspec.yaml
https://github.com/google/json_serializable.dart/blob/json_serializable-v6.10.0/json_serializable/pubspec.yaml
https://github.com/rrousselGit/freezed/blob/freezed-v3.2.0/packages/freezed/pubspec.yaml

chunhtai · 2025-07-30T16:33:43Z

packages/go_router_builder/lib/src/go_router_generator.dart

    final String routeData = _annotations[type]!;
-    if (element is! ClassElement) {
+    if (element is! ClassElement2) {


same https://pub.dev/documentation/analyzer/latest/dart_element_element/ClassElement2.html

chunhtai · 2025-07-30T16:34:19Z

packages/go_router_builder/lib/src/route_config.dart

      throw InvalidGenerationSourceError(
        'The ShellRouteData "$_className" class must have an unnamed constructor.',
        element: routeDataClass,
      );
    }

-    final bool isConst = routeDataClass.unnamedConstructor!.isConst;
+    final bool isConst = routeDataClass.unnamedConstructor2!.isConst;


same https://pub.dev/documentation/analyzer/latest/dart_element_element/InterfaceElement/unnamedConstructor2.html

and all other places

koji-1009 · 2025-08-01T00:19:03Z

@chunhtai
I think it is better for go_router_builder to specify analyzer ^7.4.0, at least until source_gen starts specifying analyzer ^8.0.0.

https://github.com/dart-lang/source_gen/blob/source_gen-v3.0.0/source_gen/pubspec.yaml

chunhtai

LGTM

muhammadkamel · 2025-08-12T02:05:47Z

@hannah-hyj
Waiting for your review. Thanks!

hannah-hyj

LGTM

kevmoo · 2025-08-13T17:48:37Z

Thank you! 🙏

…ndencies (flutter/packages#9649)

flutter/packages@08a9b2c...6cb9113 2025-08-13 [email protected] [go_router_builder] Migrate to Element2 API and update dependencies (flutter/packages#9649) 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 [email protected] 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

* main: (56 commits) [go_router_builder] Support extension types (flutter#9458) Roll Flutter from e2a347b14a18 to 34c2a3b158b2 (41 revisions) (flutter#9803) [go_router_builder] Migrate to Element2 API and update dependencies (flutter#9649) [in_app_purchase_storekit] Add support for quantity in consumable product purchases (#171570) (flutter#9698) [pigeon] Improves documentation of `ProxyApi` and moves helper functions to a separate file (flutter#9756) Roll Flutter from 1590543f6794 to e2a347b14a18 (1 revision) (flutter#9784) [camera_avfoundation] Implementation swift migration - part 11 (flutter#9690) [camera_avfoundation] Fix crash when streaming while recording (flutter#9691) Roll Flutter from 38217906e95c to 1590543f6794 (14 revisions) (flutter#9780) Roll Flutter from 92a6bfbfd6ef to 38217906e95c (17 revisions) (flutter#9778) [video_player] Improve KVO handling on iOS (flutter#9718) [dependabot]: Bump the test-dependencies group across 15 directories with 7 updates (flutter#9736) Roll Flutter from 9de63a03428f to 92a6bfbfd6ef (11 revisions) (flutter#9769) [google_maps_flutter_platform_interface] Add Advanced markers support (flutter#9737) [camera_android_camerax] Re-land "Force new Surface for each SurfaceRequest" (flutter#9760) [google_maps_flutter] Add ability to perform Google Maps SDK warmup (flutter#9674) Roll Flutter from 59fc766c6fdf to 9de63a03428f (6 revisions) (flutter#9764) [webview_flutter_wkwebview] Extended Web View API on iOS to add flexibility when working with local HTML content (flutter#8787) [local_auth] Differentiate iOS authentication errors (flutter#9705) manual roll to 59fc766c6fdfd03d0983fc95ce8b76793a300dd5 (flutter#9758) ... # Conflicts: # packages/go_router_builder/lib/src/type_helpers.dart # packages/go_router_builder/pubspec.yaml

…#173726) flutter/packages@08a9b2c...6cb9113 2025-08-13 [email protected] [go_router_builder] Migrate to Element2 API and update dependencies (flutter/packages#9649) 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 [email protected] 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

koji-1009 added 4 commits July 19, 2025 23:06

feat: Update dependencies and migrate to element2 API

4a699ef

fix: set readAllSourcesFromFilesystem

d47937e

test: improve code formatting consistency in test

614c2b2

doc: CHANGLOG

5a0cb6f

github-actions bot added the p: go_router_builder label Jul 19, 2025

gemini-code-assist bot reviewed Jul 19, 2025

View reviewed changes

koji-1009 added 2 commits July 19, 2025 23:35

refactor: dart format

4f83b21

Merge branch 'main' into feat/element2

a4584b4

koji-1009 added 2 commits July 21, 2025 09:27

Merge branch 'main' into feat/element2

4003e03

test: Normalize path separators for cross-platform compatibility

96d68f9

koji-1009 marked this pull request as ready for review July 21, 2025 02:39

koji-1009 requested a review from chunhtai as a code owner July 21, 2025 02:39

koji-1009 mentioned this pull request Jul 21, 2025

[go_router_builder] Support extension types #9458

Merged

11 tasks

doc: Update README

b6f37a8

chunhtai reviewed Jul 30, 2025

View reviewed changes

koji-1009 requested a review from chunhtai July 30, 2025 21:49

chunhtai approved these changes Aug 1, 2025

View reviewed changes

chunhtai requested a review from hannah-hyj August 1, 2025 19:16

hannah-hyj approved these changes Aug 13, 2025

View reviewed changes

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

auto-submit bot merged commit 6cb9113 into flutter:main Aug 13, 2025
78 checks passed

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

6cb9113d5 [go_router_builder] Migrate to Element2 API and update depe…

4b8b990

…ndencies (flutter/packages#9649)

engine-flutter-autoroll mentioned this pull request Aug 13, 2025

Roll Packages from 08a9b2cc46dd to 6cb9113d5fa4 (1 revision) flutter/flutter#173726

Merged

koji-1009 deleted the feat/element2 branch August 13, 2025 22:13

[go_router_builder] Migrate to Element2 API and update dependencies #9649

[go_router_builder] Migrate to Element2 API and update dependencies #9649

Uh oh!

Conversation

koji-1009 commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-Review Checklist

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Jul 19, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 19, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Jul 19, 2025

Choose a reason for hiding this comment

Uh oh!

koji-1009 commented Jul 19, 2025

Uh oh!

koji-1009 commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chunhtai Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

koji-1009 Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koji-1009 Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chunhtai Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

chunhtai Jul 30, 2025

Choose a reason for hiding this comment

Uh oh!

koji-1009 commented Aug 1, 2025

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

muhammadkamel commented Aug 12, 2025

Uh oh!

hannah-hyj left a comment

Choose a reason for hiding this comment

Uh oh!

kevmoo commented Aug 13, 2025

Uh oh!

Uh oh!

Uh oh!

koji-1009 commented Jul 19, 2025 •

edited

Loading

koji-1009 commented Jul 21, 2025 •

edited

Loading

chunhtai Jul 30, 2025 •

edited

Loading

koji-1009 Jul 30, 2025 •

edited

Loading