relax path requirements

flutter · Sep 13, 2024 · 0b1eef0 · 0b1eef0
1 parent 8f47459
commit 0b1eef0
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 85 deletions.
diff --git a/packages/go_router/CHANGELOG.md b/packages/go_router/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 14.2.8
+
+- Relax route path requirements. Both root and child routes can now start with '/'.
+
 ## 14.2.7
 
 - Fixes issue so that the parseRouteInformationWithContext can handle non-http Uris.

diff --git a/packages/go_router/lib/src/configuration.dart b/packages/go_router/lib/src/configuration.dart
@@ -36,13 +36,6 @@ class RouteConfiguration {
     for (final RouteBase route in routes) {
       late bool subRouteIsTopLevel;
       if (route is GoRoute) {
-        if (isTopLevel) {
-          assert(route.path.startsWith('/'),
-              '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 ShellRouteBase) {
         subRouteIsTopLevel = isTopLevel;

diff --git a/packages/go_router/lib/src/path_utils.dart b/packages/go_router/lib/src/path_utils.dart
@@ -102,20 +102,14 @@ Map<String, String> extractPathParameters(
 
 /// Concatenates two paths.
 ///
-/// e.g: pathA = /a, pathB = c/d,  concatenatePaths(pathA, pathB) = /a/c/d.
+/// e.g: pathA = /a, pathB = /c/d, concatenatePaths(pathA, pathB) = /a/c/d.
+/// or: pathA = a, pathB = c/d, concatenatePaths(pathA, pathB) = /a/c/d.
 String concatenatePaths(String parentPath, String childPath) {
-  // at the root, just return the path
-  if (parentPath.isEmpty) {
-    assert(childPath.startsWith('/'));
-    assert(childPath == '/' || !childPath.endsWith('/'));
-    return childPath;
-  }
-
-  // not at the root, so append the parent path
-  assert(childPath.isNotEmpty);
-  assert(!childPath.startsWith('/'));
-  assert(!childPath.endsWith('/'));
-  return '${parentPath == '/' ? '' : parentPath}/$childPath';
+  final Iterable<String> segments = <String>[
+    ...parentPath.split('/'),
+    ...childPath.split('/')
+  ].where((String segment) => segment.isNotEmpty);
+  return '/${segments.join('/')}';
 }
 
 /// Builds an absolute path for the provided route.

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: 14.2.7
+version: 14.2.8
 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/go_router_test.dart b/packages/go_router/test/go_router_test.dart
@@ -90,60 +90,6 @@ void main() {
       expect(router.routerDelegate.currentConfiguration.uri.path, '/b');
     });
 
-    test('empty path', () {
-      expect(() {
-        GoRoute(path: '');
-      }, throwsA(isAssertionError));
-    });
-
-    test('leading / on sub-route', () {
-      expect(() {
-        GoRouter(
-          routes: <RouteBase>[
-            GoRoute(
-              path: '/',
-              builder: dummy,
-              routes: <GoRoute>[
-                GoRoute(
-                  path: '/foo',
-                  builder: dummy,
-                ),
-              ],
-            ),
-          ],
-        );
-      }, throwsA(isAssertionError));
-    });
-
-    test('trailing / on sub-route', () {
-      expect(() {
-        GoRouter(
-          routes: <RouteBase>[
-            GoRoute(
-              path: '/',
-              builder: dummy,
-              routes: <GoRoute>[
-                GoRoute(
-                  path: 'foo/',
-                  builder: dummy,
-                ),
-              ],
-            ),
-          ],
-        );
-      }, throwsA(isAssertionError));
-    });
-
-    testWidgets('lack of leading / on top-level route',
-        (WidgetTester tester) async {
-      await expectLater(() async {
-        final List<GoRoute> routes = <GoRoute>[
-          GoRoute(path: 'foo', builder: dummy),
-        ];
-        await createRouter(routes, tester);
-      }, throwsA(isAssertionError));
-    });
-
     testWidgets('match no routes', (WidgetTester tester) async {
       final List<GoRoute> routes = <GoRoute>[
         GoRoute(path: '/', builder: dummy),

diff --git a/packages/go_router/test/path_utils_test.dart b/packages/go_router/test/path_utils_test.dart
@@ -79,17 +79,11 @@ void main() {
       expect(result, expected);
     }
 
-    void verifyThrows(String pathA, String pathB) {
-      expect(
-          () => concatenatePaths(pathA, pathB), throwsA(isA<AssertionError>()));
-    }
-
     verify('/a', 'b/c', '/a/b/c');
     verify('/', 'b', '/b');
-    verifyThrows('/a', '/b');
-    verifyThrows('/a', '/');
-    verifyThrows('/', '/');
-    verifyThrows('/', '');
-    verifyThrows('', '');
+    verify('/a', '/b/c/', '/a/b/c');
+    verify('/a', 'b/c', '/a/b/c');
+    verify('/', '/', '/');
+    verify('', '', '/');
   });
 }