feat: add list transaction operations

Author: mcquenji

.gitignore

@@ -10,3 +10,4 @@ pubspec.lock
 .fvm/
 custom_lint.log
 grumpy_lints.log
+build/

lib/src/module/infra/services/canonical_module_registry_service.dart

@@ -57,7 +57,7 @@ class CanonicalModuleRegistryService<T, Config extends Object>
       _modulesByType[module.runtimeType] = module;
     } else if (!identical(existing, module)) {
       log(
-        'Canonicalizing duplicate ${module.runtimeType}.'
+        'Canonicalizing duplicate ${module.logTag}.'
         ' Using existing instance: $existing',
       );
     }
@@ -184,7 +184,7 @@ class CanonicalModuleRegistryService<T, Config extends Object>
     final toDeactivate = _activeModules.difference(required);
 
     log(
-      'Syncing modules: toActivate=$toActivate, toDeactivate=$toDeactivate, required=$required',
+      'Reconciling modules: toActivate=$toActivate, toDeactivate=$toDeactivate, required=$required',
     );
 
     final order = _topological(required);
@@ -196,20 +196,19 @@ class CanonicalModuleRegistryService<T, Config extends Object>
           // This module was mounted through legacy module import mounting.
           // Adopt it so we don't try to create a duplicate DI scope.
           _mountedModules.add(module);
-          log('Adopted externally mounted module: ${module.runtimeType}');
+          log('Adopted externally mounted module: $module');
         } else {
-          log('Initializing ${module.logTag}');
+          log('Initializing $module');
 
           await module.initialize();
-          log('Cock');
           _mountedModules.add(module);
-          log('Mounted module: ${module.runtimeType}');
+          log('Mounted module: $module');
         }
       }
-
+      log('Activating $module');
       await module.activate();
       _activeModules.add(module);
-      log('Activated module: ${module.runtimeType}');
+      log('Activated module: $module');
     }
 
     final deactivateOrder = _topological(_activeModules).reversed;
@@ -218,7 +217,7 @@ class CanonicalModuleRegistryService<T, Config extends Object>
 
       await module.deactivate();
       _activeModules.remove(module);
-      log('Deactivated module: ${module.runtimeType}');
+      log('Deactivated module: $module');
     }
 
     log('Sync complete.');

lib/src/module/module.dart

@@ -182,8 +182,6 @@ abstract class Module<RouteType, Config extends Object>
 
     log('Initializing...');
 
-    return;
-
     _isInitializing = true;
 
     try {
@@ -248,6 +246,9 @@ abstract class Module<RouteType, Config extends Object>
 
   /// The routes provided by this module.
   List<Route<RouteType, Config>> get routes;
+
+  @override
+  String toString() => '$logTag<$RouteType,$Config>';
 }
 
 /// A function that binds a [Builder] for a specific [Base] type with a given [Config].

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

@@ -28,4 +28,7 @@ class LeafRoute<T, Config extends Object> extends Route<T, Config> {
   String toString() {
     return 'ViewRoute(path: $path, view: $view, middleware: $middleware, children: $children)';
   }
+
+  /// `true` if this route is the root route.
+  bool get isRoot => path == '/';
 }

lib/src/routing/domain/services/routing_service.dart

@@ -75,6 +75,10 @@ abstract class RoutingService<T, Config extends Object> extends Service {
   /// A stream of all view change events.
   Stream<ViewChangedEvent<T, Config>> get viewStream;
 
+  /// Waits until the current route is ready and the view has been rendered.
+  @visibleForTesting
+  Future<void> get currentNavigation;
+
   @override
   bool get singelton => true;
 }

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

@@ -18,6 +18,8 @@ class RoutingKitRoutingService<T, Config extends Object>
   /// Centralized module lifecycle manager.
   final ModuleRegistryService<T, Config> moduleRegistry;
 
+  Future<void> _currentNavigation = Future.value();
+
   RouteContext? _context;
 
   final Map<Uri, (Future<bool>, LeafRoute<T, Config>)> _pendingNavigations = {};
@@ -262,6 +264,7 @@ class RoutingKitRoutingService<T, Config extends Object>
       if (leaf is ModuleRoute<T, Config>) {
         leaf =
             leaf.root ??
+            leaf.module.routes.root ??
             (throw ArgumentError.value(
               path,
               'path',
@@ -283,6 +286,7 @@ class RoutingKitRoutingService<T, Config extends Object>
       final future = _navigate(uri, leaf, skipPreview, handler);
 
       _pendingNavigations[uri] = (future, leaf);
+      _currentNavigation = future;
       await future;
     } catch (e, s) {
       log('Navigation to $path failed with error', e, s);
@@ -356,4 +360,7 @@ class RoutingKitRoutingService<T, Config extends Object>
   @override
   Stream<ViewChangedEvent<T, Config>> get viewStream =>
       _viewChangeController.stream.asBroadcastStream();
+
+  @override
+  Future<void> get currentNavigation => _currentNavigation;
 }

lib/src/routing/routing.dart

@@ -1 +1,2 @@
 export 'domain/domain.dart';
+export 'utils/utils.dart';

lib/src/routing/utils/route_utils.dart

@@ -0,0 +1,14 @@
+import 'package:grumpy/grumpy.dart';
+
+/// Helper extension for handling lists of routes.
+extension RouteX<T, Config extends Object> on List<Route<T, Config>> {
+  /// Returns the root leaf route of this list or null if none is found.
+  LeafRoute<T, Config>? get root {
+    for (final route in this) {
+      if (route is LeafRoute<T, Config> && route.isRoot) {
+        return route;
+      }
+    }
+    return null;
+  }
+}

lib/src/routing/utils/utils.dart

@@ -0,0 +1 @@
+export 'route_utils.dart';

lib/src/transactions/domain/models/list_add_element_tx_operation.dart

@@ -0,0 +1,52 @@
+import 'package:grumpy/grumpy.dart';
+
+/// {@template list_add_element_tx_operation}
+/// A [TxOperation] for adding an element to a list.
+/// {@endtemplate}
+class ListAddElementTxOperation<Element, TResult>
+    extends TxOperation<List<Element>, TResult> {
+  /// {@macro list_add_element_tx_operation}
+  ListAddElementTxOperation({
+    required super.name,
+    required super.id,
+    required super.baseVersion,
+    required this.element,
+    required this.createElement,
+    required this.apply,
+    this.shouldRollbackOnError = TxOperation.alwaysRollback,
+  }) : super(touchedKeys: const <String>{});
+
+  @override
+  Set<String> get touchedKeys => {createElement.toString()};
+
+  /// The optimistic element to be added.
+  final Element element;
+
+  /// Creates the element on the remote and returns the commit result.
+  final Future<TResult> Function() createElement;
+
+  /// Applies commit result to the optimistic element and returns the confirmed element.
+  final Element Function(Element optimisticElement, TResult createResult) apply;
+
+  /// {@macro shouldRollbackOnError}
+  final bool Function(Object error, StackTrace? stackTrace)
+  shouldRollbackOnError;
+
+  @override
+  List<Element>? applyConfirmed(List<Element> confirmed, TResult result) {
+    final appliedElement = apply(element, result);
+    return [...confirmed, appliedElement];
+  }
+
+  @override
+  Future<TResult> commit(_) => createElement();
+
+  @override
+  List<Element> optimisticApply(List<Element> current) {
+    return [...current, element];
+  }
+
+  @override
+  bool shouldRollback(Object error, StackTrace? stackTrace) =>
+      shouldRollbackOnError(error, stackTrace);
+}