[go_router]Show ShellRoute's routes in debug log (flutter#3664)

koji-1009 · web-flow · commit f74744119749 · 2023-04-12T15:47:25.000Z
[go_router]Show ShellRoute's routes in debug log
diff --git a/packages/go_router/CHANGELOG.md b/packages/go_router/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 6.5.6
+
+- Fixes an issue where ShellRoute routes were not logged when debugLogDiagnostic was enabled.
+
 ## 6.5.5
 
 - Fixes an issue when popping pageless route would accidentally complete imperative page.
diff --git a/packages/go_router/example/lib/shell_route.dart b/packages/go_router/example/lib/shell_route.dart
@@ -31,6 +31,7 @@ class ShellRouteExampleApp extends StatelessWidget {
   final GoRouter _router = GoRouter(
     navigatorKey: _rootNavigatorKey,
     initialLocation: '/a',
+    debugLogDiagnostics: true,
     routes: <RouteBase>[
       /// Application shell
       ShellRoute(
diff --git a/packages/go_router/lib/src/configuration.dart b/packages/go_router/lib/src/configuration.dart
@@ -26,7 +26,7 @@ class RouteConfiguration {
         assert(_debugCheckParentNavigatorKeys(
             routes, <GlobalKey<NavigatorState>>[navigatorKey])) {
     _cacheNameToPath('', routes);
-    log.info(_debugKnownRoutes());
+    log.info(debugKnownRoutes());
   }
 
   static bool _debugCheckPath(List<RouteBase> routes, bool isTopLevel) {
@@ -172,7 +172,12 @@ class RouteConfiguration {
     return 'RouterConfiguration: $routes';
   }
 
-  String _debugKnownRoutes() {
+  /// Returns the full path of [routes].
+  ///
+  /// Each path is indented based depth of the hierarchy, and its `name`
+  /// is also appended if not null
+  @visibleForTesting
+  String debugKnownRoutes() {
     final StringBuffer sb = StringBuffer();
     sb.writeln('Full paths for routes:');
     _debugFullPathsFor(routes, '', 0, sb);
@@ -194,6 +199,8 @@ class RouteConfiguration {
         final String fullpath = concatenatePaths(parentFullpath, route.path);
         sb.writeln('  => ${''.padLeft(depth * 2)}$fullpath');
         _debugFullPathsFor(route.routes, fullpath, depth + 1, sb);
+      } else if (route is ShellRoute) {
+        _debugFullPathsFor(route.routes, parentFullpath, depth, sb);
       }
     }
   }
diff --git a/packages/go_router/pubspec.yaml b/packages/go_router/pubspec.yaml
@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 6.5.5
+version: 6.5.6
 repository: https://github.com/flutter/packages/tree/main/packages/go_router
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22
 
diff --git a/packages/go_router/test/configuration_test.dart b/packages/go_router/test/configuration_test.dart
@@ -502,6 +502,77 @@ void main() {
         throwsAssertionError,
       );
     });
+
+    test(
+      'All known route strings returned by debugKnownRoutes are correct',
+      () {
+        final GlobalKey<NavigatorState> root =
+            GlobalKey<NavigatorState>(debugLabel: 'root');
+        final GlobalKey<NavigatorState> shell =
+            GlobalKey<NavigatorState>(debugLabel: 'shell');
+
+        expect(
+          RouteConfiguration(
+            navigatorKey: root,
+            routes: <RouteBase>[
+              GoRoute(
+                path: '/a',
+                parentNavigatorKey: root,
+                builder: _mockScreenBuilder,
+                routes: <RouteBase>[
+                  ShellRoute(
+                    navigatorKey: shell,
+                    builder: _mockShellBuilder,
+                    routes: <RouteBase>[
+                      GoRoute(
+                        path: 'b',
+                        parentNavigatorKey: shell,
+                        builder: _mockScreenBuilder,
+                      ),
+                      GoRoute(
+                        path: 'c',
+                        parentNavigatorKey: shell,
+                        builder: _mockScreenBuilder,
+                      ),
+                    ],
+                  ),
+                ],
+              ),
+              GoRoute(
+                path: '/d',
+                parentNavigatorKey: root,
+                builder: _mockScreenBuilder,
+                routes: <RouteBase>[
+                  GoRoute(
+                    path: 'e',
+                    parentNavigatorKey: root,
+                    builder: _mockScreenBuilder,
+                    routes: <RouteBase>[
+                      GoRoute(
+                        path: 'f',
+                        parentNavigatorKey: root,
+                        builder: _mockScreenBuilder,
+                      ),
+                    ],
+                  ),
+                ],
+              ),
+            ],
+            redirectLimit: 10,
+            topRedirect: (BuildContext context, GoRouterState state) {
+              return null;
+            },
+          ).debugKnownRoutes(),
+          'Full paths for routes:\n'
+          '  => /a\n'
+          '  =>   /a/b\n'
+          '  =>   /a/c\n'
+          '  => /d\n'
+          '  =>   /d/e\n'
+          '  =>     /d/e/f\n',
+        );
+      },
+    );
   });
 }
 

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class RouteConfiguration {`
`26`	`26`	`assert(_debugCheckParentNavigatorKeys(`
`27`	`27`	`routes, <GlobalKey<NavigatorState>>[navigatorKey])) {`
`28`	`28`	`_cacheNameToPath('', routes);`
`29`		`- log.info(_debugKnownRoutes());`
	`29`	`+ log.info(debugKnownRoutes());`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`static bool _debugCheckPath(List<RouteBase> routes, bool isTopLevel) {`
`@@ -172,7 +172,12 @@ class RouteConfiguration {`
`172`	`172`	`return 'RouterConfiguration: $routes';`
`173`	`173`	`}`
`174`	`174`
`175`		`- String _debugKnownRoutes() {`
	`175`	`+ /// Returns the full path of [routes].`
	`176`	`+ ///`
	`177`	+ /// Each path is indented based depth of the hierarchy, and its `name`
	`178`	`+ /// is also appended if not null`
	`179`	`+ @visibleForTesting`
	`180`	`+ String debugKnownRoutes() {`
`176`	`181`	`final StringBuffer sb = StringBuffer();`
`177`	`182`	`sb.writeln('Full paths for routes:');`
`178`	`183`	`_debugFullPathsFor(routes, '', 0, sb);`
`@@ -194,6 +199,8 @@ class RouteConfiguration {`
`194`	`199`	`final String fullpath = concatenatePaths(parentFullpath, route.path);`
`195`	`200`	`sb.writeln(' => ${''.padLeft(depth * 2)}$fullpath');`
`196`	`201`	`_debugFullPathsFor(route.routes, fullpath, depth + 1, sb);`
	`202`	`+ } else if (route is ShellRoute) {`
	`203`	`+ _debugFullPathsFor(route.routes, parentFullpath, depth, sb);`
`197`	`204`	`}`
`198`	`205`	`}`
`199`	`206`	`}`