Merge pull request #97 from nubank/dont-rebuild-by-default

Update Nuvigator default behavior to not reload when NuRouter changes

CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+## 1.7.0-beta.0
+- [FIX] [POSSIBLY BREAKING] Makes the default behavior of Nuvigator to not re-build itself and it's state when the NuRouter provided instance changes. This allows for fixing some state reloads/resets and navigation lost, specially on nested flows. If for some reason you were relying in the current behavior for some feature, you can provide a `shouldRebuild` property to the `Nuvigator` that should return `true` when you wish to perform the rebuild.
+
 ## 1.6.2
 - [FIX] Revert changes from 1.6.1 due to some unexpected behaviors found
 

example/lib/main.dart

@@ -42,7 +42,6 @@ class MyApp extends StatelessWidget {
         child: ChangeNotifierProvider.value(
           value: FriendRequestBloc(10),
           child: Nuvigator(
-            shouldRebuild: (_, __) => false,
             debug: true,
             router: MainAppRouter(),
           ),

example/lib/samples/modules/composer/module.dart

@@ -42,7 +42,6 @@ class ComposerRoute extends NuRoute<NuRouter, void, String> {
   @override
   Widget build(BuildContext context, NuRouteSettings<Object> settings) {
     return Nuvigator.routes(
-      shouldRebuild: (_, __) => false,
       initialRoute: settings.name,
       routes: [
         _ComposerHelpRoute(),

lib/src/next/v1/nu_router.dart

@@ -428,6 +428,7 @@ class NuRouterLoader extends StatefulWidget {
 
 class _NuRouterLoaderState extends State<NuRouterLoader> {
   Widget nuvigator;
+  NuRouter router;
   bool loading;
   Widget errorWidget;
 
@@ -436,16 +437,17 @@ class _NuRouterLoaderState extends State<NuRouterLoader> {
   }
 
   Future<void> _initModule() async {
+    router = widget.router;
     setState(() {
-      loading = widget.router.awaitForInit;
+      loading = router.awaitForInit;
       errorWidget = null;
     });
     try {
-      await widget.router._init(context);
+      await router._init(context);
     } catch (error, stackTrace) {
       debugPrintStack(stackTrace: stackTrace, label: error.toString());
       final errorWidget =
-          widget.router.onError(error, NuRouterController(reload: _reload));
+          router.onError(error, NuRouterController(reload: _reload));
       if (errorWidget != null) {
         setState(() {
           this.errorWidget = errorWidget;
@@ -458,11 +460,14 @@ class _NuRouterLoaderState extends State<NuRouterLoader> {
     }
   }
 
+  bool get _shouldRebuildProvided => widget.shouldRebuild != null;
+
   @override
   void didUpdateWidget(covariant NuRouterLoader oldWidget) {
-    if (widget.shouldRebuild(oldWidget.router, widget.router)) {
+    if (_shouldRebuildProvided &&
+        widget.shouldRebuild(oldWidget.router, widget.router)) {
       _initModule();
-      nuvigator = widget.builder(widget.router);
+      nuvigator = widget.builder(router);
     }
     super.didUpdateWidget(oldWidget);
   }
@@ -476,11 +481,15 @@ class _NuRouterLoaderState extends State<NuRouterLoader> {
   @override
   Widget build(BuildContext context) {
     if (loading) {
-      return widget.router.loadingWidget;
+      return router.loadingWidget;
     } else if (errorWidget != null) {
       return errorWidget;
     }
-    nuvigator ??= widget.builder(widget.router);
-    return nuvigator;
+    if (_shouldRebuildProvided) {
+      nuvigator ??= widget.builder(router);
+      return nuvigator;
+    } else {
+      return widget.builder(router);
+    }
   }
 }

lib/src/nuvigator.dart

@@ -512,9 +512,6 @@ class NuvigatorState<T extends INuRouter> extends NavigatorState
   }
 }
 
-bool _defaultShouldRebuild(NuRouter previousRouter, NuRouter newRouter) =>
-    previousRouter != newRouter;
-
 /// Creates a new Nuvigator. When using the Next API, several of those options
 /// are provided by the [NuRouter]. Providing them here will thrown an assertion
 /// error.
@@ -622,7 +619,7 @@ class Nuvigator<T extends INuRouter> extends StatelessWidget {
     return NuRouterLoader(
       // ignore: avoid_as
       router: router as NuRouter,
-      shouldRebuild: shouldRebuild ?? _defaultShouldRebuild,
+      shouldRebuild: shouldRebuild,
       builder: (moduleRouter) => _NuvigatorInner(
         router: moduleRouter,
         debug: debug,

pubspec.yaml

@@ -1,6 +1,6 @@
 name: nuvigator
 description: A powerful routing abstraction over Flutter navigator, providing some new features and an easy way to define routers.
-version: 1.6.2
+version: 1.7.0-beta.0
 
 homepage: https://github.com/nubank/nuvigator
 

test/nuvigator_test.dart

@@ -544,9 +544,12 @@ void main() {
   });
 
   testWidgets(
-    'Should rebuild Nuvigator by default when NuRouter instance changes',
+    'Should Nuvigator when shouldRebuild is provided',
     (tester) async {
-      final tracker = await pumpApp(tester);
+      final tracker = await pumpApp(
+        tester,
+        shouldRebuild: (oldRouter, newRouter) => oldRouter != newRouter,
+      );
 
       // Go to Screen3
       unawaited(tracker.rootNuvigator.pushNamed('screen3'));
@@ -580,9 +583,9 @@ void main() {
   );
 
   testWidgets(
-    'Should not rebuild Nuvigator when shouldRebuild returns false',
+    'Should not rebuild Nuvigator by default when shouldRebuild is not provided',
     (tester) async {
-      final tracker = await pumpApp(tester, shouldRebuild: (_, __) => false);
+      final tracker = await pumpApp(tester);
 
       // Go to Screen3
       unawaited(tracker.rootNuvigator.pushNamed('screen3'));