feat(routing): pass path params to routing context

Author: mcquenji

lib/src/routing/domain/models/route_context.dart

@@ -79,7 +79,7 @@ abstract class RouteContext extends Model with _$RouteContext {
   /// Retrieves a query parameter by its [key].
   String? getQueryParam(String key) => queryParams[key];
 
-  /// Retrieves a parameter by checkings [pathParams] first, then [queryParams].
+  /// Retrieves a parameter by checking [pathParams] first, then [queryParams].
   String? get(String key) => pathParams[key] ?? queryParams[key];
 
   /// Retrieves a parameter by checking [pathParams] first, then [queryParams].

lib/src/routing/infra/services/routing_kit_routing_service.dart

@@ -26,7 +26,8 @@ class RoutingKitRoutingService<T, Config extends Object>
 
   RouteContext? _context;
 
-  final Map<Uri, (Future<bool>, LeafRoute<T, Config>)> _pendingNavigations = {};
+  final Map<Uri, (Future<bool>, LeafRoute<T, Config>, RouteContext)>
+  _pendingNavigations = {};
 
   /// The root module of the application.
   final RootModule<T, Config> rootModule;
@@ -250,6 +251,16 @@ class RoutingKitRoutingService<T, Config extends Object>
     return Uri.parse(normalized).pathSegments;
   }
 
+  RouteContext _createContext(Uri uri, Map<String, String> pathParams) {
+    return RouteContext(
+      fullPath: uri.toString(),
+      pathParams: pathParams,
+      queryParams: uri.queryParameters,
+      queryParamsAll: uri.queryParametersAll,
+      fragment: uri.fragment,
+    );
+  }
+
   @override
   Future<void> navigate(
     String path, {
@@ -283,10 +294,10 @@ class RoutingKitRoutingService<T, Config extends Object>
     if (_pendingNavigations.containsKey(uri)) {
       log('Navigation to $path is already in progress, forwarding callback.');
 
-      final (future, leaf) = _pendingNavigations[uri]!;
+      final (future, leaf, context) = _pendingNavigations[uri]!;
 
       if (!skipPreview) {
-        callback(leaf.view.preview(RouteContext.fromUri(uri)), true);
+        callback(leaf.view.preview(context), true);
       }
 
       log('Waiting for pending navigation to $path to complete.');
@@ -302,7 +313,7 @@ class RoutingKitRoutingService<T, Config extends Object>
 
       log('Pending navigation to $path completed, invoking content callback.');
 
-      callback(await leaf.view.content(RouteContext.fromUri(uri)), false);
+      callback(await leaf.view.content(context), false);
 
       return;
     }
@@ -346,10 +357,11 @@ class RoutingKitRoutingService<T, Config extends Object>
       }
 
       final (:leaf, :lineage) = _resolveLeafRoute(matchedRoute, path);
+      final context = _createContext(uri, match.params);
 
-      final future = _navigate(uri, leaf, lineage, skipPreview, handler);
+      final future = _navigate(context, leaf, lineage, skipPreview, handler);
 
-      _pendingNavigations[uri] = (future, leaf);
+      _pendingNavigations[uri] = (future, leaf, context);
       _currentNavigation = future;
       await future;
     } catch (e, s) {
@@ -361,15 +373,15 @@ class RoutingKitRoutingService<T, Config extends Object>
   }
 
   Future<bool> _navigate(
-    Uri uri,
+    RouteContext initialContext,
     LeafRoute<T, Config> leaf,
     List<Route<T, Config>> lineage,
     bool skipPreview,
     void Function(T, bool) callback,
   ) async {
-    var context = RouteContext.fromUri(uri);
+    var context = initialContext;
     final previousContext = _context;
-    final cleanPath = uri.path;
+    final cleanPath = context.uri.path;
     final middleware = _collectMiddleware(lineage);
 
     log('Navigating to $cleanPath with context: $context');

test/routing/harness/routing_test_harness.dart

@@ -271,6 +271,20 @@ class TestLeaf2 extends Leaf<String> {
   Future<String> content(RouteContext ctx) async => 'built:${ctx.fullPath}';
 }
 
+class ParamLeaf extends Leaf<String> {
+  @override
+  String preview(RouteContext ctx) {
+    final id = ctx.pathParams['id'];
+    return 'preview:$id:${ctx.getPathParam('id')}:${ctx.get('id')}';
+  }
+
+  @override
+  Future<String> content(RouteContext ctx) async {
+    final id = ctx.pathParams['id'];
+    return 'built:$id:${ctx.getPathParam('id')}:${ctx.get('id')}';
+  }
+}
+
 class FeatureModule extends Module<String, Cfg> {
   FeatureModule(this.middlewareOrder);
 
@@ -390,6 +404,7 @@ class RootTestModule extends RootModule<String, Cfg> {
       view: TestLeaf2(),
       middleware: [slowBlockedMiddleware],
     ),
+    LeafRoute<String, Cfg>(path: 'courses/:id', view: ParamLeaf()),
     ModuleRoute<String, Cfg>(path: 'module', module: featureModule),
     ModuleRoute<String, Cfg>(path: 'dependent', module: DependentModule()),
     const Route<String, Cfg>(path: 'idk'),

test/routing/tests/routing_test.dart

@@ -255,6 +255,31 @@ void main() {
       },
     );
 
+    test('passes matched path params into leaf route contexts', () async {
+      final callbackResults = <String>[];
+      final streamEvents = <ViewChangedEvent<String, Cfg>>[];
+      final streamDone = Completer<void>();
+      final sub = routing.onViewChanged((event) {
+        streamEvents.add(event);
+        if (streamEvents.length == 2 && !streamDone.isCompleted) {
+          streamDone.complete();
+        }
+      });
+
+      await routing.navigate(
+        '/courses/42?id=query#lesson',
+        callback: (result, _) => callbackResults.add(result),
+      );
+      await streamDone.future;
+      await sub.cancel();
+
+      expect(callbackResults, ['preview:42:42:42', 'built:42:42:42']);
+      expect(routing.currentContext?.pathParams, {'id': '42'});
+      expect(routing.currentContext?.queryParams, {'id': 'query'});
+      expect(routing.currentContext?.fragment, 'lesson');
+      expect(streamEvents.last.context?.pathParams, {'id': '42'});
+    });
+
     test('isActive returns false when no route is active', () {
       expect(routing.isActive('/feature/child'), isFalse);
       expect(routing.isActive('/feature', exact: false), isFalse);