Fix closing sideMenu when pushing a screen (#4491)

When pushing a screen into a stack in the centre controller with `sideMenu.left/right.visible: false` - side menu was not closed as expected.
This happened because when either side menus is open, it’s considered the current child and when options are resolved. the centre controller’s options were ignored.

This commit fixes this issue on Android. When resolving options, the centre controllers options are resolved as well.
Related to #4267

lib/android/app/src/main/java/com/reactnativenavigation/parse/SideMenuOptions.java

@@ -28,17 +28,16 @@ public class SideMenuOptions {
     }
 
     public void mergeWith(SideMenuOptions other) {
-        if (other.visible.hasValue()) {
-            visible = other.visible;
-        }
-        if (other.enabled.hasValue()) {
-            enabled = other.enabled;
-        }
-        if (other.height.hasValue()) {
-            height = other.height;
-        }
-        if (other.width.hasValue()) {
-            width = other.width;
-        }
+        if (other.visible.hasValue()) visible = other.visible;
+        if (other.enabled.hasValue()) enabled = other.enabled;
+        if (other.height.hasValue()) height = other.height;
+        if (other.width.hasValue()) width = other.width;
+    }
+
+    public void mergeWithDefault(SideMenuOptions defaultOptions) {
+        if (!visible.hasValue()) visible = defaultOptions.visible;
+        if (!enabled.hasValue()) enabled = defaultOptions.enabled;
+        if (!height.hasValue()) height = defaultOptions.height;
+        if (!width.hasValue()) width = defaultOptions.width;
     }
 }

lib/android/app/src/main/java/com/reactnativenavigation/presentation/SideMenuPresenter.java

@@ -3,6 +3,7 @@ package com.reactnativenavigation.presentation;
 import android.support.v4.widget.DrawerLayout;
 import android.view.Gravity;
 
+import com.reactnativenavigation.parse.Options;
 import com.reactnativenavigation.parse.SideMenuRootOptions;
 
 public class SideMenuPresenter {
@@ -13,56 +14,66 @@ public class SideMenuPresenter {
         this.sideMenu = sideMenu;
     }
 
-    /**
-     * Called when initializing the sideMenu DrawerLayout.
-     *
-     * @param options Side menu options
-     */
-    public void applyInitialOptions(SideMenuRootOptions options) {
-        if (options.left.enabled.isFalse()) {
-            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED, Gravity.LEFT);
+    public boolean handleBack() {
+        if (sideMenu.isDrawerOpen(Gravity.LEFT)) {
+            sideMenu.closeDrawer(Gravity.LEFT);
+            return true;
         }
-        else  if (options.left.enabled.isTrue()) {
-            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED, Gravity.LEFT);
+        if (sideMenu.isDrawerOpen(Gravity.RIGHT)) {
+            sideMenu.closeDrawer(Gravity.RIGHT);
+            return true;
         }
+        return false;
+    }
 
-        if (options.right.enabled.isFalse()) {
-            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED, Gravity.RIGHT);
-        }
-        else  if (options.right.enabled.isTrue()) {
-            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED, Gravity.RIGHT);
-        }
+    public void mergeOptions(SideMenuRootOptions options) {
+        mergeLockMode(options);
+        mergeVisibility(options);
+    }
+
+    public void mergeChildOptions(SideMenuRootOptions options) {
+        mergeLockMode(options);
+        mergeVisibility(options);
+    }
+
+    public void applyChildOptions(Options options) {
+        applyLockMode(options.sideMenuRootOptions);
+        mergeVisibility(options.sideMenuRootOptions);
     }
 
-    public void present(SideMenuRootOptions options) {
-        // TODO: Not sure why we call these options when we show the DrawerLayout rather than when initializing it.
-        // TODO: (i.e. `setDrawerLockMode()` is supposed to be called when the DrawerLayout is initialized.
-        applyInitialOptions(options);
+    private void applyLockMode(SideMenuRootOptions options) {
+        int leftLockMode = options.left.enabled.isTrueOrUndefined() ? DrawerLayout.LOCK_MODE_UNLOCKED : DrawerLayout.LOCK_MODE_LOCKED_CLOSED;
+        sideMenu.setDrawerLockMode(leftLockMode, Gravity.LEFT);
+
+        int rightLockMode = options.right.enabled.isTrueOrUndefined() ? DrawerLayout.LOCK_MODE_UNLOCKED : DrawerLayout.LOCK_MODE_LOCKED_CLOSED;
+        sideMenu.setDrawerLockMode(rightLockMode, Gravity.RIGHT);
+    }
 
+    private void mergeVisibility(SideMenuRootOptions options) {
         if (options.left.visible.isTrue()) {
             sideMenu.openDrawer(Gravity.LEFT);
-
-        } else if (options.left.visible.isFalse() && sideMenu.isDrawerOpen(Gravity.LEFT)) {
+        } else if (options.left.visible.isFalse()) {
             sideMenu.closeDrawer(Gravity.LEFT);
         }
 
         if (options.right.visible.isTrue()) {
             sideMenu.openDrawer(Gravity.RIGHT);
-
-        } else if (options.right.visible.isFalse() && sideMenu.isDrawerOpen(Gravity.RIGHT)){
+        } else if (options.right.visible.isFalse()) {
             sideMenu.closeDrawer(Gravity.RIGHT);
         }
     }
 
-    public boolean handleBack() {
-        if (sideMenu.isDrawerOpen(Gravity.LEFT)) {
-            sideMenu.closeDrawer(Gravity.LEFT);
-            return true;
+    private void mergeLockMode(SideMenuRootOptions options) {
+        if (options.left.enabled.isFalse()) {
+            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED, Gravity.LEFT);
+        } else if (options.left.enabled.isTrue()) {
+            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED, Gravity.LEFT);
         }
-        if (sideMenu.isDrawerOpen(Gravity.RIGHT)) {
-            sideMenu.closeDrawer(Gravity.RIGHT);
-            return true;
+
+        if (options.right.enabled.isFalse()) {
+            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_LOCKED_CLOSED, Gravity.RIGHT);
+        } else if (options.right.enabled.isTrue()) {
+            sideMenu.setDrawerLockMode(DrawerLayout.LOCK_MODE_UNLOCKED, Gravity.RIGHT);
         }
-        return false;
     }
 }

lib/android/app/src/main/java/com/reactnativenavigation/viewcontrollers/sidemenu/SideMenuController.java

@@ -72,7 +72,7 @@ public class SideMenuController extends ParentController<DrawerLayout> {
     @Override
     public void applyChildOptions(Options options, Component child) {
         super.applyChildOptions(options, child);
-        presenter.applyInitialOptions(options.sideMenuRootOptions);
+        presenter.applyChildOptions(resolveCurrentOptions());
         performOnParentController(parentController ->
                 ((ParentController) parentController).applyChildOptions(this.options, child)
         );
@@ -81,7 +81,7 @@ public class SideMenuController extends ParentController<DrawerLayout> {
     @Override
     public void mergeChildOptions(Options options, ViewController childController, Component child) {
         super.mergeChildOptions(options, childController, child);
-        presenter.present(options.sideMenuRootOptions);
+        presenter.mergeChildOptions(options.sideMenuRootOptions);
         performOnParentController(parentController ->
                 ((ParentController) parentController).mergeChildOptions(options.copy().clearSideMenuOptions(), childController, child)
         );
@@ -90,7 +90,16 @@ public class SideMenuController extends ParentController<DrawerLayout> {
     @Override
     public void mergeOptions(Options options) {
         super.mergeOptions(options);
-        presenter.present(this.options.sideMenuRootOptions);
+        presenter.mergeOptions(options.sideMenuRootOptions);
+    }
+
+    @Override
+    public Options resolveCurrentOptions() {
+        Options options = super.resolveCurrentOptions();
+        if (getView().isDrawerOpen(Gravity.LEFT) || getView().isDrawerOpen(Gravity.RIGHT)) {
+            options = options.mergeWith(center.resolveCurrentOptions());
+        }
+        return options;
     }
 
     @Override

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/sidemenu/SideMenuControllerTest.java

@@ -12,16 +12,22 @@ import com.reactnativenavigation.parse.Options;
 import com.reactnativenavigation.parse.SideMenuOptions;
 import com.reactnativenavigation.parse.params.Bool;
 import com.reactnativenavigation.parse.params.Number;
+import com.reactnativenavigation.parse.params.Text;
 import com.reactnativenavigation.presentation.Presenter;
 import com.reactnativenavigation.presentation.SideMenuPresenter;
 import com.reactnativenavigation.utils.CommandListenerAdapter;
 import com.reactnativenavigation.viewcontrollers.ChildControllersRegistry;
+import com.reactnativenavigation.viewcontrollers.ParentController;
+import com.reactnativenavigation.viewcontrollers.ViewController;
+import com.reactnativenavigation.views.Component;
 
 import org.junit.Test;
+import org.mockito.Mockito;
 
 import static android.view.ViewGroup.LayoutParams.MATCH_PARENT;
 import static org.assertj.core.api.Java6Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -32,20 +38,32 @@ public class SideMenuControllerTest extends BaseTest {
     private Activity activity;
     private ChildControllersRegistry childRegistry;
     private SideMenuPresenter presenter;
-    private SimpleComponentViewController left;
-    private SimpleComponentViewController right;
-    private SimpleComponentViewController center;
+    private ViewController left;
+    private ViewController right;
+    private ViewController center;
+    private ViewController child;
+    private ParentController parent;
+    private Options resolvedOptions;
 
     @Override
     public void beforeEach() {
         activity = newActivity();
         childRegistry = new ChildControllersRegistry();
         presenter = spy(new SideMenuPresenter());
+        child = new SimpleComponentViewController(activity, childRegistry, "child", new Options());
         left = new SimpleComponentViewController(activity, childRegistry, "left", new Options());
         right = new SimpleComponentViewController(activity, childRegistry, "right", new Options());
         center = spy(new SimpleComponentViewController(activity, childRegistry, "center", new Options()));
-        uut = new SideMenuController(activity, childRegistry, "sideMenu", new Options(), presenter, new Presenter(activity, new Options()));
+        uut = new SideMenuController(activity, childRegistry, "sideMenu", new Options(), presenter, new Presenter(activity, new Options())) {
+            @Override
+            public Options resolveCurrentOptions() {
+                resolvedOptions = super.resolveCurrentOptions();
+                return resolvedOptions;
+            }
+        };
         uut.setCenterController(center);
+        parent = Mockito.mock(ParentController.class);
+        uut.setParentController(parent);
     }
 
     @Test
@@ -54,6 +72,13 @@ public class SideMenuControllerTest extends BaseTest {
         verify(presenter).bindView(uut.getView());
     }
 
+    @Test
+    public void applyChildOptions() {
+        uut.applyChildOptions(new Options(), (Component) child.getView());
+        verify(presenter).applyChildOptions(eq(resolvedOptions));
+        verify(parent).applyChildOptions(uut.options, (Component) child.getView());
+    }
+
     @Test
     public void mergeOptions_openLeftSideMenu() {
         uut.setLeftController(new SimpleComponentViewController(activity, childRegistry, "left", new Options()));
@@ -84,6 +109,23 @@ public class SideMenuControllerTest extends BaseTest {
         assertThat(uut.options.sideMenuRootOptions).isNotEqualTo(initialOptions.sideMenuRootOptions);
     }
 
+    @Test
+    public void mergeChildOptions() {
+        Options options = new Options();
+        uut.mergeChildOptions(options, child, (Component) child.getView());
+        verify(presenter).mergeChildOptions(options.sideMenuRootOptions);
+    }
+
+    @Test
+    public void resolveCurrentOptions_centerOptionsAreMergedEvenIfDrawerIsOpen() {
+        uut.setLeftController(left);
+        center.options.topBar.title.text = new Text("Center");
+        assertThat(uut.resolveCurrentOptions().topBar.title.text.hasValue()).isTrue();
+
+        uut.getView().openDrawer(Gravity.LEFT);
+        assertThat(uut.resolveCurrentOptions().topBar.title.text.hasValue()).isTrue();
+    }
+
     @Test
     public void setLeftController_matchesParentByDefault() {
         SideMenuOptions options = new SideMenuOptions();
@@ -98,6 +140,7 @@ public class SideMenuControllerTest extends BaseTest {
         assertThat(params.width).isEqualTo(MATCH_PARENT);
         assertThat(params.height).isEqualTo(MATCH_PARENT);
     }
+
     @Test
     public void setLeftController_setHeightAndWidthWithOptions() {
         SideMenuOptions options = new SideMenuOptions();
@@ -115,6 +158,7 @@ public class SideMenuControllerTest extends BaseTest {
         assertThat(params.width).isEqualTo(widthInDp);
         assertThat(params.height).isEqualTo(heightInDp);
     }
+
     @Test
     public void setRightController_matchesParentByDefault() {
         SideMenuOptions options = new SideMenuOptions();
@@ -129,6 +173,7 @@ public class SideMenuControllerTest extends BaseTest {
         assertThat(params.width).isEqualTo(MATCH_PARENT);
         assertThat(params.height).isEqualTo(MATCH_PARENT);
     }
+
     @Test
     public void setRightController_setHeightAndWidthWithOptions() {
         SideMenuOptions options = new SideMenuOptions();

playground/src/screens/SideMenuScreen.js

@@ -1,7 +1,7 @@
 const React = require('react');
 const { Component } = require('react');
 
-const { View, Text, Button } = require('react-native');
+const { View, Text, Button, Platform } = require('react-native');
 
 const { Navigation } = require('react-native-navigation');
 const testIDs = require('../testIDs');
@@ -31,10 +31,20 @@ class SideMenuScreen extends Component {
   }
 
   pushAndCloseSideMenu() {
-    this.hideSideMenu();
+    if (Platform.OS === 'ios') {
+      this.hideSideMenu();
+    }
     Navigation.push('tab1Stack', {
       component: {
-        name: 'navigation.playground.TextScreen'
+        name: 'navigation.playground.TextScreen',
+        options: {
+          sideMenu: {
+            left: {
+              visible: false,
+              enabled: false
+            }
+          }
+        }
       }
     });
   }