update

Author: chunhtai

packages/go_router/README.md

@@ -37,7 +37,8 @@ See the API documentation for details on the following topics:
 - [Error handling](https://pub.dev/documentation/go_router/latest/topics/Error%20handling-topic.html)
 
 ## Migration guides
-- [Migrating to 7.0.0](https://docs.google.com/document/d/10Xbpifbs4E-zh6YE5akIO8raJq_m3FIXs6nUGdOspOg).
+- [Migrating to 8.0.0](https://flutter.dev/go/go-router-v8-breaking-changes).
+- [Migrating to 7.0.0](https://flutter.dev/go/go-router-v7-breaking-changes).
 - [Migrating to 6.0.0](https://flutter.dev/go/go-router-v6-breaking-changes)
 - [Migrating to 5.1.2](https://flutter.dev/go/go-router-v5-1-2-breaking-changes)
 - [Migrating to 5.0](https://flutter.dev/go/go-router-v5-breaking-changes)

packages/go_router/lib/src/builder.dart

@@ -10,6 +10,7 @@ import 'configuration.dart';
 import 'logging.dart';
 import 'match.dart';
 import 'misc/error_screen.dart';
+import 'misc/errors.dart';
 import 'pages/cupertino.dart';
 import 'pages/material.dart';
 import 'route_data.dart';
@@ -82,7 +83,7 @@ class RouteBuilder {
     RouteMatchList matchList,
     bool routerNeglect,
   ) {
-    if (matchList.isEmpty) {
+    if (matchList.isEmpty && !matchList.isError) {
       // The build method can be called before async redirect finishes. Build a
       // empty box until then.
       return const SizedBox.shrink();
@@ -91,18 +92,12 @@ class RouteBuilder {
       context,
       Builder(
         builder: (BuildContext context) {
-          try {
-            final Map<Page<Object?>, GoRouterState> newRegistry =
-                <Page<Object?>, GoRouterState>{};
-            final Widget result = tryBuild(context, matchList, routerNeglect,
-                configuration.navigatorKey, newRegistry);
-            _registry.updateRegistry(newRegistry);
-            return GoRouterStateRegistryScope(
-                registry: _registry, child: result);
-          } on _RouteBuilderError catch (e) {
-            return _buildErrorNavigator(context, e, matchList.uri,
-                onPopPageWithRouteMatch, configuration.navigatorKey);
-          }
+          final Map<Page<Object?>, GoRouterState> newRegistry =
+              <Page<Object?>, GoRouterState>{};
+          final Widget result = tryBuild(context, matchList, routerNeglect,
+              configuration.navigatorKey, newRegistry);
+          _registry.updateRegistry(newRegistry);
+          return GoRouterStateRegistryScope(registry: _registry, child: result);
         },
       ),
     );
@@ -146,28 +141,31 @@ class RouteBuilder {
       bool routerNeglect,
       GlobalKey<NavigatorState> navigatorKey,
       Map<Page<Object?>, GoRouterState> registry) {
-    final Map<GlobalKey<NavigatorState>, List<Page<Object?>>> keyToPage =
-        <GlobalKey<NavigatorState>, List<Page<Object?>>>{};
-    try {
+    final Map<GlobalKey<NavigatorState>, List<Page<Object?>>> keyToPage;
+    if (matchList.isError) {
+      keyToPage = <GlobalKey<NavigatorState>, List<Page<Object?>>>{
+        navigatorKey: <Page<Object?>>[
+          _buildErrorPage(
+              context, _buildErrorState(matchList.error!, matchList.uri)),
+        ]
+      };
+    } else {
+      keyToPage = <GlobalKey<NavigatorState>, List<Page<Object?>>>{};
       _buildRecursive(context, matchList, 0, pagePopContext, routerNeglect,
           keyToPage, navigatorKey, registry);
 
       // Every Page should have a corresponding RouteMatch.
       assert(keyToPage.values.flattened.every((Page<Object?> page) =>
           pagePopContext.getRouteMatchForPage(page) != null));
-      return keyToPage[navigatorKey]!;
-    } on _RouteBuilderError catch (e) {
-      return <Page<Object?>>[
-        _buildErrorPage(context, e, matchList.uri),
-      ];
-    } finally {
-      /// Clean up previous cache to prevent memory leak, making sure any nested
-      /// stateful shell routes for the current match list are kept.
-      final Set<Key> activeKeys = keyToPage.keys.toSet()
-        ..addAll(_nestedStatefulNavigatorKeys(matchList));
-      _goHeroCache.removeWhere(
-          (GlobalKey<NavigatorState> key, _) => !activeKeys.contains(key));
     }
+
+    /// Clean up previous cache to prevent memory leak, making sure any nested
+    /// stateful shell routes for the current match list are kept.
+    final Set<Key> activeKeys = keyToPage.keys.toSet()
+      ..addAll(_nestedStatefulNavigatorKeys(matchList));
+    _goHeroCache.removeWhere(
+        (GlobalKey<NavigatorState> key, _) => !activeKeys.contains(key));
+    return keyToPage[navigatorKey]!;
   }
 
   static Set<GlobalKey<NavigatorState>> _nestedStatefulNavigatorKeys(
@@ -199,15 +197,15 @@ class RouteBuilder {
     }
     final RouteMatch match = matchList.matches[startIndex];
 
-    if (match.error != null) {
-      throw _RouteBuilderError('Match error found during build phase',
-          exception: match.error);
-    }
-
     final RouteBase route = match.route;
     final GoRouterState state = buildState(matchList, match);
     Page<Object?>? page;
-    if (route is GoRoute) {
+    if (state.error != null) {
+      page = _buildErrorPage(context, state);
+      keyToPages.putIfAbsent(navigatorKey, () => <Page<Object?>>[]).add(page);
+      _buildRecursive(context, matchList, startIndex + 1, pagePopContext,
+          routerNeglect, keyToPages, navigatorKey, registry);
+    } else if (route is GoRoute) {
       page = _buildPageForGoRoute(context, state, match, route, pagePopContext);
       // If this GoRoute is for a different Navigator, add it to the
       // list of out of scope pages
@@ -283,7 +281,7 @@ class RouteBuilder {
       registry[page] = state;
       pagePopContext._setRouteMatchForPage(page, match);
     } else {
-      throw _RouteBuilderException('Unsupported route type $route');
+      throw GoError('Unsupported route type $route');
     }
   }
 
@@ -323,8 +321,17 @@ class RouteBuilder {
       name = route.name;
       path = route.path;
     }
-    final RouteMatchList effectiveMatchList =
-        match is ImperativeRouteMatch ? match.matches : matchList;
+    final RouteMatchList effectiveMatchList;
+    if (match is ImperativeRouteMatch) {
+      effectiveMatchList = match.matches;
+      if (effectiveMatchList.isError) {
+        return _buildErrorState(
+            effectiveMatchList.error!, effectiveMatchList.uri);
+      }
+    } else {
+      effectiveMatchList = matchList;
+      assert(!effectiveMatchList.isError);
+    }
     return GoRouterState(
       configuration,
       location: effectiveMatchList.uri.toString(),
@@ -334,10 +341,10 @@ class RouteBuilder {
       fullPath: effectiveMatchList.fullPath,
       pathParameters:
           Map<String, String>.from(effectiveMatchList.pathParameters),
-      error: match.error,
+      error: effectiveMatchList.error,
       queryParameters: effectiveMatchList.uri.queryParameters,
       queryParametersAll: effectiveMatchList.uri.queryParametersAll,
-      extra: match.extra,
+      extra: effectiveMatchList.extra,
       pageKey: match.pageKey,
     );
   }
@@ -369,7 +376,7 @@ class RouteBuilder {
     final GoRouterWidgetBuilder? builder = route.builder;
 
     if (builder == null) {
-      throw _RouteBuilderError('No routeBuilder provided to GoRoute: $route');
+      throw GoError('No routeBuilder provided to GoRoute: $route');
     }
 
     return builder(context, state);
@@ -404,7 +411,7 @@ class RouteBuilder {
     final Widget? widget =
         route.buildWidget(context, state, shellRouteContext!);
     if (widget == null) {
-      throw _RouteBuilderError('No builder provided to ShellRoute: $route');
+      throw GoError('No builder provided to ShellRoute: $route');
     }
 
     return widget;
@@ -484,38 +491,26 @@ class RouteBuilder {
         child: child,
       );
 
-  /// Builds a Navigator containing an error page.
-  Widget _buildErrorNavigator(
-      BuildContext context,
-      _RouteBuilderError e,
-      Uri uri,
-      PopPageWithRouteMatchCallback onPopPage,
-      GlobalKey<NavigatorState> navigatorKey) {
-    return _buildNavigator(
-      (Route<dynamic> route, dynamic result) => onPopPage(route, result, null),
-      <Page<Object?>>[
-        _buildErrorPage(context, e, uri),
-      ],
-      navigatorKey,
-    );
-  }
-
-  /// Builds a an error page.
-  Page<void> _buildErrorPage(
-    BuildContext context,
-    _RouteBuilderError error,
+  GoRouterState _buildErrorState(
+    Exception error,
     Uri uri,
   ) {
-    final GoRouterState state = GoRouterState(
+    final String location = uri.toString();
+    return GoRouterState(
       configuration,
-      location: uri.toString(),
+      location: location,
       matchedLocation: uri.path,
       name: null,
       queryParameters: uri.queryParameters,
       queryParametersAll: uri.queryParametersAll,
-      error: Exception(error),
-      pageKey: const ValueKey<String>('error'),
+      error: error,
+      pageKey: ValueKey<String>('$location(error)'),
     );
+  }
+
+  /// Builds a an error page.
+  Page<void> _buildErrorPage(BuildContext context, GoRouterState state) {
+    assert(state.error != null);
 
     // If the error page builder is provided, use that, otherwise, if the error
     // builder is provided, wrap that in an app-specific page (for example,
@@ -555,42 +550,6 @@ typedef _PageBuilderForAppType = Page<void> Function({
   required Widget child,
 });
 
-/// An error that occurred while building the app's UI based on the route
-/// matches.
-class _RouteBuilderError extends Error {
-  /// Constructs a [_RouteBuilderError].
-  _RouteBuilderError(this.message, {this.exception});
-
-  /// The error message.
-  final String message;
-
-  /// The exception that occurred.
-  final Exception? exception;
-
-  @override
-  String toString() {
-    return '$message ${exception ?? ""}';
-  }
-}
-
-/// An error that occurred while building the app's UI based on the route
-/// matches.
-class _RouteBuilderException implements Exception {
-  /// Constructs a [_RouteBuilderException].
-  _RouteBuilderException(this.message, {this.exception});
-
-  /// The error message.
-  final String message;
-
-  /// The exception that occurred.
-  final Exception? exception;
-
-  @override
-  String toString() {
-    return '$message ${exception ?? ""}';
-  }
-}
-
 /// Context used to provide a route to page association when popping routes.
 class _PagePopContext {
   _PagePopContext._(this.onPopPageWithRouteMatch);

packages/go_router/lib/src/configuration.dart

@@ -187,20 +187,8 @@ class RouteConfiguration {
   static RouteMatchList _errorRouteMatchList(Uri uri, String errorMessage) {
     final Exception error = Exception(errorMessage);
     return RouteMatchList(
-      matches: <RouteMatch>[
-        RouteMatch(
-          matchedLocation: uri.path,
-          extra: null,
-          error: error,
-          route: GoRoute(
-            path: uri.toString(),
-            pageBuilder: (BuildContext context, GoRouterState state) {
-              throw UnimplementedError();
-            },
-          ),
-          pageKey: const ValueKey<String>('error'),
-        ),
-      ],
+      matches: const <RouteMatch>[],
+      error: error,
       uri: uri,
       pathParameters: const <String, String>{},
     );
@@ -267,25 +255,26 @@ class RouteConfiguration {
     final Uri uri = Uri.parse(canonicalUri(location));
 
     final Map<String, String> pathParameters = <String, String>{};
-    final List<RouteMatch>? matches =
-        _getLocRouteMatches(uri, extra, pathParameters);
+    final List<RouteMatch>? matches = _getLocRouteMatches(uri, pathParameters);
 
     if (matches == null) {
       return _errorRouteMatchList(uri, 'no routes for location: $uri');
     }
     return RouteMatchList(
-        matches: matches, uri: uri, pathParameters: pathParameters);
+        matches: matches,
+        uri: uri,
+        pathParameters: pathParameters,
+        extra: extra);
   }
 
   List<RouteMatch>? _getLocRouteMatches(
-      Uri uri, Object? extra, Map<String, String> pathParameters) {
+      Uri uri, Map<String, String> pathParameters) {
     final List<RouteMatch>? result = _getLocRouteRecursively(
       location: uri.path,
       remainingLocation: uri.path,
       matchedLocation: '',
       pathParameters: pathParameters,
       routes: routes,
-      extra: extra,
     );
     return result;
   }
@@ -296,7 +285,6 @@ class RouteConfiguration {
     required String matchedLocation,
     required Map<String, String> pathParameters,
     required List<RouteBase> routes,
-    required Object? extra,
   }) {
     List<RouteMatch>? result;
     late Map<String, String> subPathParameters;
@@ -309,7 +297,6 @@ class RouteConfiguration {
         remainingLocation: remainingLocation,
         matchedLocation: matchedLocation,
         pathParameters: subPathParameters,
-        extra: extra,
       );
 
       if (match == null) {
@@ -347,7 +334,6 @@ class RouteConfiguration {
           matchedLocation: newParentSubLoc,
           pathParameters: subPathParameters,
           routes: route.routes,
-          extra: extra,
         );
 
         // If there's no sub-route matches, there is no match for this location
@@ -369,7 +355,7 @@ class RouteConfiguration {
   /// location.
   FutureOr<RouteMatchList> redirect(
       BuildContext context, FutureOr<RouteMatchList> prevMatchListFuture,
-      {required List<RouteMatchList> redirectHistory, Object? extra}) {
+      {required List<RouteMatchList> redirectHistory}) {
     FutureOr<RouteMatchList> processRedirect(RouteMatchList prevMatchList) {
       final String prevLocation = prevMatchList.uri.toString();
       FutureOr<RouteMatchList> processTopLevelRedirect(
@@ -388,7 +374,6 @@ class RouteConfiguration {
             context,
             newMatch,
             redirectHistory: redirectHistory,
-            extra: extra,
           );
         }
 
@@ -409,7 +394,6 @@ class RouteConfiguration {
               context,
               newMatch,
               redirectHistory: redirectHistory,
-              extra: extra,
             );
           }
           return prevMatchList;
@@ -437,7 +421,7 @@ class RouteConfiguration {
           matchedLocation: prevMatchList.uri.path,
           queryParameters: prevMatchList.uri.queryParameters,
           queryParametersAll: prevMatchList.uri.queryParametersAll,
-          extra: extra,
+          extra: prevMatchList.extra,
           pageKey: const ValueKey<String>('topLevel'),
         ),
       );
@@ -478,7 +462,7 @@ class RouteConfiguration {
           name: route.name,
           path: route.path,
           fullPath: matchList.fullPath,
-          extra: match.extra,
+          extra: matchList.extra,
           pathParameters: matchList.pathParameters,
           queryParameters: matchList.uri.queryParameters,
           queryParametersAll: matchList.uri.queryParametersAll,