Merge branch 'main' of github.com:flutter/packages into nested-persis…

…tent-navigation

# Conflicts:
#	packages/go_router/CHANGELOG.md
#	packages/go_router/lib/src/builder.dart
#	packages/go_router/lib/src/configuration.dart
#	packages/go_router/lib/src/delegate.dart
#	packages/go_router/lib/src/matching.dart
#	packages/go_router/lib/src/redirection.dart
#	packages/go_router/lib/src/router.dart
#	packages/go_router/test/builder_test.dart

packages/go_router/CHANGELOG.md

@@ -1,10 +1,16 @@
-## 5.2.0
+## 5.3.0
 
 - Introduced a new shell route class called `StatefulShellRoute`, to support using separate
   navigators for child routes as well as preserving state in each navigation tree
   (flutter/flutter#99124).
 - Updated documentation for `pageBuilder` and `builder` fields of `ShellRoute`, to more correctly
   describe the meaning of the child argument in the builder functions.
+- Added support for restorationId to ShellRoute (and StatefulShellRoute).
+
+## 5.2.0
+
+- Fixes `GoRouterState.location` and `GoRouterState.param` to return correct value.
+- Cleans up `RouteMatch` and `RouteMatchList` API.
 
 ## 5.1.10
 

packages/go_router/example/lib/stateful_nested_navigation.dart

@@ -352,17 +352,20 @@ class TabbedRootScreen extends StatelessWidget {
   Widget _child(StatefulShellBranchState branchState) {
     // TabBarView will cache it's root widget, so we need to reevaluate
     // the child (using a Builder) in case it's null.
-    return branchState.child != null ? branchState.child! :
-      Builder(builder: (BuildContext context) =>
-        StatefulShellBranch.of(context).child ?? const SizedBox.expand());
+    return branchState.child != null
+        ? branchState.child!
+        : Builder(
+            builder: (BuildContext context) =>
+                StatefulShellBranch.of(context).child ??
+                const SizedBox.expand());
   }
 
   @override
   Widget build(BuildContext context) {
     final StatefulShellRouteState shellState = StatefulShellRoute.of(context);
     final List<Widget> children = shellState.branchStates.map(_child).toList();
-    final List<Tab> tabs = children.mapIndexed((int i, _) =>
-        Tab(text: 'Tab ${i + 1}')).toList();
+    final List<Tab> tabs =
+        children.mapIndexed((int i, _) => Tab(text: 'Tab ${i + 1}')).toList();
 
     return DefaultTabController(
       length: children.length,

packages/go_router/example/lib/stateful_shell_route_dynamic.dart

@@ -7,7 +7,7 @@ import 'package:flutter/material.dart';
 import 'package:go_router/go_router.dart';
 
 final GlobalKey<NavigatorState> _rootNavigatorKey =
-GlobalKey<NavigatorState>(debugLabel: 'root');
+    GlobalKey<NavigatorState>(debugLabel: 'root');
 
 // This example demonstrates how to setup nested navigation using a
 // BottomNavigationBar, using a dynamic set of tabs. Each tab uses its own
@@ -33,22 +33,23 @@ class NestedTabNavigationExampleApp extends StatefulWidget {
 }
 
 /// An example demonstrating how to use dynamic nested navigators
-class NestedTabNavigationExampleAppState extends State<NestedTabNavigationExampleApp> {
-
+class NestedTabNavigationExampleAppState
+    extends State<NestedTabNavigationExampleApp> {
   final List<StatefulShellBranch> _branches = <StatefulShellBranch>[
     StatefulShellBranch(rootLocation: '/home', name: 'Home'),
     StatefulShellBranch(rootLocation: '/a/0', name: 'Dynamic 0'),
   ];
 
   void _addSection(StatefulShellRouteState shellRouteState) => setState(() {
-    if (_branches.length < 10) {
-      final int index = _branches.length - 1;
-      _branches.add(StatefulShellBranch(rootLocation: '/a/$index', name: 'Dynamic $index'));
-      // In situations where setState isn't possible, you can call refresh() on
-      // StatefulShellRouteState instead, to refresh the branches
-      //shellRouteState.refresh();
-    }
-  });
+        if (_branches.length < 10) {
+          final int index = _branches.length - 1;
+          _branches.add(StatefulShellBranch(
+              rootLocation: '/a/$index', name: 'Dynamic $index'));
+          // In situations where setState isn't possible, you can call refresh() on
+          // StatefulShellRouteState instead, to refresh the branches
+          //shellRouteState.refresh();
+        }
+      });
 
   void _removeSection(StatefulShellRouteState shellRouteState) {
     if (_branches.length > 2) {
@@ -71,33 +72,31 @@ class NestedTabNavigationExampleAppState extends State<NestedTabNavigationExampl
             builder: (BuildContext context, GoRouterState state) => RootScreen(
               label: 'Home',
               addSection: () => _addSection(StatefulShellRoute.of(context)),
-              removeSection: () => _removeSection(StatefulShellRoute.of(context)),
+              removeSection: () =>
+                  _removeSection(StatefulShellRoute.of(context)),
             ),
           ),
           GoRoute(
             /// The screen to display as the root in the first tab of the
             /// bottom navigation bar.
             path: '/a/:id',
-            builder: (BuildContext context, GoRouterState state) =>
-                RootScreen(
-                  label: 'A${state.params['id']}',
-                  detailsPath: '/a/${state.params['id']}/details',
-                ),
+            builder: (BuildContext context, GoRouterState state) => RootScreen(
+              label: 'A${state.params['id']}',
+              detailsPath: '/a/${state.params['id']}/details',
+            ),
             routes: <RouteBase>[
               /// The details screen to display stacked on navigator of the
               /// first tab. This will cover screen A but not the application
               /// shell (bottom navigation bar).
               GoRoute(
                 path: 'details',
-                builder:
-                    (BuildContext context, GoRouterState state) =>
+                builder: (BuildContext context, GoRouterState state) =>
                     DetailsScreen(label: 'A${state.params['id']}'),
               ),
             ],
           ),
         ],
-        builder:
-            (BuildContext context, GoRouterState state, Widget child) {
+        builder: (BuildContext context, GoRouterState state, Widget child) {
           return ScaffoldWithNavBar(body: child);
         },
       ),
@@ -128,12 +127,15 @@ class ScaffoldWithNavBar extends StatelessWidget {
   /// Body, i.e. the index stack
   final Widget body;
 
-  List<BottomNavigationBarItem> _items(List<StatefulShellBranchState> branches) {
+  List<BottomNavigationBarItem> _items(
+      List<StatefulShellBranchState> branches) {
     return branches.mapIndexed((int i, StatefulShellBranchState e) {
       if (i == 0) {
-        return BottomNavigationBarItem(icon: const Icon(Icons.home), label: e.branch.name);
+        return BottomNavigationBarItem(
+            icon: const Icon(Icons.home), label: e.branch.name);
       } else {
-        return BottomNavigationBarItem(icon: const Icon(Icons.star), label: e.branch.name);
+        return BottomNavigationBarItem(
+            icon: const Icon(Icons.star), label: e.branch.name);
       }
     }).toList();
   }
@@ -172,6 +174,7 @@ class RootScreen extends StatelessWidget {
 
   /// Function for adding a new branch
   final VoidCallback? addSection;
+
   /// Function for removing a branch
   final VoidCallback? removeSection;
 

packages/go_router/lib/src/builder.dart

@@ -153,8 +153,7 @@ class RouteBuilder {
     }
 
     final RouteBase route = match.route;
-    final GoRouterState state =
-        buildState(match, matchList.effectiveEncodedParams(startIndex));
+    final GoRouterState state = buildState(matchList, match);
     if (route is GoRoute) {
       final Page<Object?> page = _buildPageForRoute(context, state, match);
       registry[page] = state;

packages/go_router/lib/src/configuration.dart

@@ -8,6 +8,7 @@ import 'package:flutter/widgets.dart';
 import 'configuration.dart';
 import 'logging.dart';
 import 'matching.dart';
+import 'misc/errors.dart';
 import 'path_utils.dart';
 import 'typedefs.dart';
 export 'route.dart';
@@ -36,95 +37,82 @@ class RouteConfiguration {
       if (route is GoRoute) {
         if (isTopLevel) {
           assert(route.path.startsWith('/'),
-              'top-level path must start with "/": ${route.path}');
-        } else if (route is ShellRouteBase) {
-          for (final RouteBase route in routes) {
-            if (route is GoRoute) {
-              assert(route.path.startsWith('/'),
-                  'top-level path must start with "/": ${route.path}');
-            }
-          }
+              'top-level path must start with "/": $route');
+        } else {
+          assert(!route.path.startsWith('/') && !route.path.endsWith('/'),
+              'sub-route path may not start or end with /: $route');
         }
         subRouteIsTopLevel = false;
-      } else if (route is ShellRoute) {
+      } else if (route is ShellRouteBase) {
         subRouteIsTopLevel = isTopLevel;
       }
       _debugCheckPath(route.routes, subRouteIsTopLevel);
     }
     return true;
   }
 
-      // Check that each parentNavigatorKey refers to either a ShellRoute's
-      // navigatorKey or the root navigator key.
-      void checkParentNavigatorKeys(
-          List<RouteBase> routes,
-          List<GlobalKey<NavigatorState>> allowedKeys,
-          Set<GlobalKey<NavigatorState>> allNavigatorKeys) {
-        for (final RouteBase route in routes) {
-          if (route is GoRoute) {
-            final GlobalKey<NavigatorState>? parentKey =
-                route.parentNavigatorKey;
-            if (parentKey != null) {
-              // Verify that the root navigator or a ShellRoute ancestor has a
-              // matching navigator key.
-              assert(
-                  allowedKeys.contains(parentKey),
-                  'parentNavigatorKey $parentKey must refer to'
-                  " an ancestor ShellRoute's navigatorKey or GoRouter's"
-                  ' navigatorKey');
-
-              allNavigatorKeys.add(parentKey);
-              checkParentNavigatorKeys(
-                route.routes,
-                <GlobalKey<NavigatorState>>[
-                  // Once a parentNavigatorKey is used, only that navigator key
-                  // or keys above it can be used.
-                  ...allowedKeys.sublist(0, allowedKeys.indexOf(parentKey) + 1),
-                ],
-                allNavigatorKeys,
-              );
-            } else {
-              checkParentNavigatorKeys(
-                route.routes,
-                <GlobalKey<NavigatorState>>[
-                  ...allowedKeys,
-                ],
-                allNavigatorKeys,
-              );
-            }
-          } else if (route is ShellRoute && route.navigatorKey != null) {
-            allNavigatorKeys.add(route.navigatorKey);
-            checkParentNavigatorKeys(
-              route.routes,
-              <GlobalKey<NavigatorState>>[
-                ...allowedKeys..add(route.navigatorKey)
-              ],
-              allNavigatorKeys,
-            );
-          } else if (route is StatefulShellRoute) {
-            checkParentNavigatorKeys(
-                route.routes, allowedKeys, allNavigatorKeys);
-          }
+  // Check that each parentNavigatorKey refers to either a ShellRoute's
+  // navigatorKey or the root navigator key.
+  static bool _debugCheckParentNavigatorKeys(
+      List<RouteBase> routes, List<GlobalKey<NavigatorState>> allowedKeys) {
+    for (final RouteBase route in routes) {
+      if (route is GoRoute) {
+        final GlobalKey<NavigatorState>? parentKey = route.parentNavigatorKey;
+        if (parentKey != null) {
+          // Verify that the root navigator or a ShellRoute ancestor has a
+          // matching navigator key.
+          assert(
+              allowedKeys.contains(parentKey),
+              'parentNavigatorKey $parentKey must refer to'
+              " an ancestor ShellRoute's navigatorKey or GoRouter's"
+              ' navigatorKey');
+
+          _debugCheckParentNavigatorKeys(
+            route.routes,
+            <GlobalKey<NavigatorState>>[
+              // Once a parentNavigatorKey is used, only that navigator key
+              // or keys above it can be used.
+              ...allowedKeys.sublist(0, allowedKeys.indexOf(parentKey) + 1),
+            ],
+          );
+        } else {
+          _debugCheckParentNavigatorKeys(
+            route.routes,
+            <GlobalKey<NavigatorState>>[
+              ...allowedKeys,
+            ],
+          );
         }
       } else if (route is ShellRoute && route.navigatorKey != null) {
         _debugCheckParentNavigatorKeys(
           route.routes,
           <GlobalKey<NavigatorState>>[...allowedKeys..add(route.navigatorKey)],
         );
+      } else if (route is StatefulShellRoute) {
+        _debugCheckParentNavigatorKeys(route.routes, allowedKeys);
       }
     }
     return true;
   }
 
-      final Set<GlobalKey<NavigatorState>> allNavigatorKeys =
-          <GlobalKey<NavigatorState>>{navigatorKey};
-      checkParentNavigatorKeys(
-          routes, <GlobalKey<NavigatorState>>[navigatorKey], allNavigatorKeys);
-
-      _debugAllNavigatorKeys = allNavigatorKeys;
-
-      return true;
-    }());
+  static bool _debugVerifyNoDuplicatePathParameter(
+      List<RouteBase> routes, Map<String, GoRoute> usedPathParams) {
+    for (final RouteBase route in routes) {
+      if (route is! GoRoute) {
+        continue;
+      }
+      for (final String pathParam in route.pathParams) {
+        if (usedPathParams.containsKey(pathParam)) {
+          final bool sameRoute = usedPathParams[pathParam] == route;
+          throw GoError(
+              "duplicate path parameter, '$pathParam' found in ${sameRoute ? '$route' : '${usedPathParams[pathParam]}, and $route'}");
+        }
+        usedPathParams[pathParam] = route;
+      }
+      _debugVerifyNoDuplicatePathParameter(route.routes, usedPathParams);
+      route.pathParams.forEach(usedPathParams.remove);
+    }
+    return true;
   }
 
   /// The list of top level routes used by [GoRouterDelegate].
@@ -141,7 +129,8 @@ class RouteConfiguration {
 
   final Map<String, String> _nameToPath = <String, String>{};
 
-  late final Set<GlobalKey<NavigatorState>>? _debugAllNavigatorKeys;
+  late final Set<GlobalKey<NavigatorState>> _debugAllNavigatorKeys =
+      _debugAllNavigatorsRecursively(routes);
 
   /// Looks up the url location by a [GoRoute]'s name.
   String namedLocation(
@@ -185,6 +174,25 @@ class RouteConfiguration {
         .toString();
   }
 
+  static Set<GlobalKey<NavigatorState>> _debugAllNavigatorsRecursively(
+      List<RouteBase> routes) {
+    return routes.expand((RouteBase e) {
+      if (e is GoRoute && e.parentNavigatorKey != null) {
+        return <GlobalKey<NavigatorState>>{
+          e.parentNavigatorKey!,
+          ..._debugAllNavigatorsRecursively(e.routes)
+        };
+      } else if (e is ShellRoute) {
+        return <GlobalKey<NavigatorState>>{
+          e.navigatorKey,
+          ..._debugAllNavigatorsRecursively(e.routes)
+        };
+      } else {
+        return _debugAllNavigatorsRecursively(e.routes);
+      }
+    }).toSet();
+  }
+
   /// Validates the branches of a [StatefulShellRoute].
   bool debugValidateStatefulShellBranches(
       StatefulShellRoute shellRoute, List<StatefulShellBranch> branches) {
@@ -200,7 +208,7 @@ class RouteConfiguration {
           'StatefulShellRoute must not uses duplicate defaultLocations for the branches');
 
       assert(
-          _debugAllNavigatorKeys!
+          _debugAllNavigatorKeys
               .intersection(uniqueBranchNavigatorKeys)
               .isEmpty,
           'StatefulShellBranch Navigator key must be unique');

packages/go_router/lib/src/delegate.dart

@@ -99,10 +99,8 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
   }
 
   /// Pushes the given location onto the page stack
-  void push(RouteMatch match) {
-    if (match.route is ShellRouteBase) {
-      throw GoError('ShellRoutes cannot be pushed');
-    }
+  void push(RouteMatchList matches) {
+    assert(matches.last.route is! ShellRouteBase);
 
     // Remap the pageKey to allow any number of the same page on the stack
     final int count = (_pushCounts[matches.fullpath] ?? 0) + 1;