Fix TopBar visibility and merge options issues

This commit started with a small fix to a TopBar visibility issue detailed in #3971 which unveiled
a few issues with how options are resolved and merged.

TopBar visibility
The initial TopBar visibility issue was a result of hide animators now being cancelled when pushing another screen.
Another issue was that if the TopBar was not measured (Initial stack child was shown with `TopBar.visible = false`),
the start value passed to the Y translation was 0. This commit makes sure the TopBar show animation starts after the TopBar is measured.

Options issues
When resolving current issues in ParentControllers, the options of the current child were wrongfully taken into account.
This commit changes options resolve logic so that initial options (and options dynamically merged to them via mergeOptions call) are merged.

lib/android/app/src/main/java/com/reactnativenavigation/anim/TopBarAnimator.java

@@ -12,6 +12,7 @@ import android.view.animation.DecelerateInterpolator;
 import android.view.animation.LinearInterpolator;
 
 import com.reactnativenavigation.parse.AnimationOptions;
+import com.reactnativenavigation.utils.UiUtils;
 import com.reactnativenavigation.views.topbar.TopBar;
 
 import javax.annotation.Nullable;
@@ -41,12 +42,15 @@ public class TopBarAnimator {
     }
 
     public void show(AnimationOptions options) {
-        if (options.hasValue() && (!options.id.hasValue() || options.id.get().equals(stackId))) {
-            showAnimator = options.getAnimation(topBar);
-        } else {
-            showAnimator = getDefaultShowAnimator(-1 * topBar.getMeasuredHeight(), DECELERATE, DURATION);
-        }
-        show();
+        topBar.setVisibility(View.VISIBLE);
+        UiUtils.runOnMeasured(topBar, () -> {
+            if (options.hasValue() && (!options.id.hasValue() || options.id.get().equals(stackId))) {
+                showAnimator = options.getAnimation(topBar);
+            } else {
+                showAnimator = getDefaultShowAnimator(-1 * topBar.getHeight(), DECELERATE, DURATION);
+            }
+            show();
+        });
     }
 
     public void show(float startTranslation) {
@@ -62,6 +66,7 @@ public class TopBarAnimator {
             }
         });
         topBar.resetAnimationOptions();
+        if (isAnimatingHide()) hideAnimator.cancel();
         showAnimator.start();
     }
 
@@ -96,6 +101,7 @@ public class TopBarAnimator {
                 onAnimationEnd.run();
             }
         });
+        if (isAnimatingShow()) showAnimator.cancel();
         hideAnimator.start();
     }
 

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

@@ -113,7 +113,11 @@ public class StackOptionsPresenter {
                 ((Component) view).drawBelowTopBar(topBar);
             }
         }
-        applyTopBarVisibility(withDefault.topBar, withDefault.animations, options);
+    }
+
+    public void applyInitialChildLayoutOptions(Options options) {
+        Options withDefault = options.copy().withDefaultOptions(defaultOptions);
+        setInitialTopBarVisibility(withDefault.topBar);
     }
 
     public void applyChildOptions(Options options, Component child) {
@@ -203,6 +207,15 @@ public class StackOptionsPresenter {
         }
     }
 
+    private void setInitialTopBarVisibility(TopBarOptions options) {
+        if (options.visible.isFalse()) {
+            topBar.hide();
+        }
+        if (options.visible.isTrueOrUndefined()) {
+            topBar.show();
+        }
+    }
+
     private void applyTopBarVisibility(TopBarOptions options, AnimationsOptions animationOptions, Options componentOptions) {
         if (options.visible.isFalse()) {
             if (options.animate.isTrueOrUndefined() && componentOptions.animations.push.enable.isTrueOrUndefined()) {

lib/android/app/src/main/java/com/reactnativenavigation/utils/UiUtils.java

@@ -30,6 +30,22 @@ public class UiUtils {
         });
     }
 
+    public static void runOnMeasured(View view, Runnable task) {
+        if (view.getHeight() > 0 && view.getWidth() > 0) {
+            task.run();
+        } else {
+            view.getViewTreeObserver().addOnGlobalLayoutListener(new ViewTreeObserver.OnGlobalLayoutListener() {
+                @Override
+                public void onGlobalLayout() {
+                    if (view.getHeight() > 0 && view.getWidth() > 0) {
+                        view.getViewTreeObserver().removeOnGlobalLayoutListener(this);
+                        task.run();
+                    }
+                }
+            });
+        }
+    }
+
 	public static void runOnMainThread(Runnable runnable) {
 		new Handler(Looper.getMainLooper()).post(runnable);
 	}

lib/android/app/src/main/java/com/reactnativenavigation/utils/ViewUtils.java

@@ -4,6 +4,7 @@ import android.graphics.Point;
 import android.support.annotation.Nullable;
 import android.view.View;
 import android.view.ViewGroup;
+import android.view.ViewManager;
 import android.view.ViewParent;
 
 import com.facebook.react.views.view.ReactViewBackgroundDrawable;
@@ -129,4 +130,11 @@ public class ViewUtils {
         }
         throw new RuntimeException(view.getBackground().getClass().getSimpleName() + " is not ReactViewBackgroundDrawable");
     }
+
+    public static void removeFromParent(View view) {
+        ViewParent parent = view.getParent();
+        if (parent != null) {
+            ((ViewManager) parent).removeView(view);
+        }
+    }
 }

lib/android/app/src/main/java/com/reactnativenavigation/viewcontrollers/ParentController.java

@@ -42,11 +42,10 @@ public abstract class ParentController<T extends ViewGroup> extends ChildControl
     @Override
     @CheckResult
     public Options resolveCurrentOptions() {
-	    if (CollectionUtils.isNullOrEmpty(getChildControllers())) return options;
+	    if (CollectionUtils.isNullOrEmpty(getChildControllers())) return initialOptions;
         return getCurrentChild()
                 .resolveCurrentOptions()
-                .copy()
-                .mergeWith(options);
+                .mergeWith(initialOptions);
     }
 
     @Override
@@ -97,7 +96,7 @@ public abstract class ParentController<T extends ViewGroup> extends ChildControl
 
     @CallSuper
     public void applyChildOptions(Options options, Component child) {
-        this.options = this.options.mergeWith(options);
+        this.options = this.initialOptions.mergeWith(options);
         if (isRoot()) {
             presenter.applyRootOptions(getView(), options);
         }

lib/android/app/src/main/java/com/reactnativenavigation/viewcontrollers/ViewController.java

@@ -45,7 +45,7 @@ public abstract class ViewController<T extends ViewGroup> implements ViewTreeObs
         boolean onViewDisappear(View view);
     }
 
-    Options initialOptions;
+    protected Options initialOptions;
     public Options options;
 
     private final Activity activity;
@@ -106,9 +106,11 @@ public abstract class ViewController<T extends ViewGroup> implements ViewTreeObs
 
     @CallSuper
     public void mergeOptions(Options options) {
+        this.initialOptions = this.initialOptions.mergeWith(options);
         this.options = this.options.mergeWith(options);
         if (view != null) applyOptions(this.options);
         this.options.clearOneTimeOptions();
+        initialOptions.clearOneTimeOptions();
     }
 
     @CallSuper

lib/android/app/src/main/java/com/reactnativenavigation/viewcontrollers/stack/StackController.java

@@ -131,7 +131,7 @@ public class StackController extends ParentController<StackLayout> {
 
     public void push(ViewController child, CommandListener listener) {
         final ViewController toRemove = stack.peek();
-        backButtonHelper.addToPushedChild(child);
+        if (size() > 0) backButtonHelper.addToPushedChild(child);
         child.setParentController(this);
         stack.push(child.getId(), child);
         Options resolvedOptions = resolveCurrentOptions(presenter.getDefaultOptions());
@@ -166,6 +166,7 @@ public class StackController extends ParentController<StackLayout> {
         view.setLayoutParams(new RelativeLayout.LayoutParams(MATCH_PARENT, MATCH_PARENT));
         child.setWaitForRender(resolvedOptions.animations.push.waitForRender);
         presenter.applyLayoutParamsOptions(resolvedOptions, view);
+        if (size() == 1) presenter.applyInitialChildLayoutOptions(resolvedOptions);
         getView().addView(view, getView().getChildCount() - 1);
     }
 
@@ -310,6 +311,7 @@ public class StackController extends ParentController<StackLayout> {
         child.setLayoutParams(new RelativeLayout.LayoutParams(MATCH_PARENT, MATCH_PARENT));
         Options options = resolveCurrentOptions();
         presenter.applyLayoutParamsOptions(options, child);
+        presenter.applyInitialChildLayoutOptions(options);
         stackLayout.addView(child, 0);
     }
 

lib/android/app/src/main/java/com/reactnativenavigation/views/topbar/TopBar.java

@@ -265,6 +265,7 @@ public class TopBar extends AppBarLayout implements ScrollEventListener.ScrollAw
     }
 
     public void hideAnimate(AnimationOptions options, Runnable onAnimationEnd) {
+        if (!visible()) return;
         animator.hide(options, onAnimationEnd);
     }
 
@@ -275,7 +276,7 @@ public class TopBar extends AppBarLayout implements ScrollEventListener.ScrollAw
     }
 
     public void clearTopTabs() {
-        topTabs.clear(this);
+        topTabs.clear();
     }
 
     @VisibleForTesting

lib/android/app/src/main/java/com/reactnativenavigation/views/toptabs/TopTabs.java

@@ -4,10 +4,10 @@ import android.content.Context;
 import android.graphics.Typeface;
 import android.support.design.widget.TabLayout;
 import android.support.v4.view.ViewPager;
-import android.view.ViewManager;
 
 import com.reactnativenavigation.parse.params.Colour;
 import com.reactnativenavigation.parse.params.Number;
+import com.reactnativenavigation.utils.ViewUtils;
 import com.reactnativenavigation.views.topbar.TopBar;
 
 public class TopTabs extends TabLayout {
@@ -49,9 +49,9 @@ public class TopTabs extends TabLayout {
         }
     }
 
-    public void clear(ViewManager parent) {
+    public void clear() {
         setupWithViewPager(null);
-        parent.removeView(this);
+        ViewUtils.removeFromParent(this);
     }
 
     public void init(ViewPager viewPager) {

lib/android/app/src/test/java/com/reactnativenavigation/TestUtils.java

@@ -7,9 +7,11 @@ import com.reactnativenavigation.mocks.TitleBarReactViewCreatorMock;
 import com.reactnativenavigation.mocks.TopBarBackgroundViewCreatorMock;
 import com.reactnativenavigation.mocks.TopBarButtonCreatorMock;
 import com.reactnativenavigation.parse.Options;
+import com.reactnativenavigation.parse.params.Bool;
 import com.reactnativenavigation.presentation.StackOptionsPresenter;
 import com.reactnativenavigation.utils.ImageLoader;
 import com.reactnativenavigation.viewcontrollers.ChildControllersRegistry;
+import com.reactnativenavigation.viewcontrollers.ViewController;
 import com.reactnativenavigation.viewcontrollers.stack.StackControllerBuilder;
 import com.reactnativenavigation.viewcontrollers.topbar.TopBarBackgroundViewController;
 import com.reactnativenavigation.viewcontrollers.topbar.TopBarController;
@@ -34,4 +36,8 @@ public class TestUtils {
                 .setStackPresenter(new StackOptionsPresenter(activity, new TitleBarReactViewCreatorMock(), new TopBarButtonCreatorMock(), new ImageLoader(), new Options())                )
                 .setInitialOptions(new Options());
     }
+
+    public static void hideBackButton(ViewController viewController) {
+        viewController.options.topBar.buttons.back.visible = new Bool(false);
+    }
 }

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/BottomTabsControllerTest.java

@@ -26,6 +26,7 @@ import com.reactnativenavigation.react.EventEmitter;
 import com.reactnativenavigation.utils.CommandListenerAdapter;
 import com.reactnativenavigation.utils.ImageLoader;
 import com.reactnativenavigation.utils.OptionHelper;
+import com.reactnativenavigation.utils.ViewUtils;
 import com.reactnativenavigation.viewcontrollers.bottomtabs.BottomTabsController;
 import com.reactnativenavigation.viewcontrollers.stack.StackController;
 import com.reactnativenavigation.views.BottomTabs;
@@ -38,6 +39,7 @@ import org.mockito.Mockito;
 import java.util.Arrays;
 import java.util.List;
 
+import static com.reactnativenavigation.TestUtils.hideBackButton;
 import static org.assertj.core.api.Java6Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
@@ -80,6 +82,7 @@ public class BottomTabsControllerTest extends BaseTest {
         tabs = createTabs();
         presenter = spy(new BottomTabsOptionsPresenter(tabs, new Options()));
         uut = createBottomTabs();
+        activity.setContentView(uut.getView());
     }
 
     @Test
@@ -158,6 +161,8 @@ public class BottomTabsControllerTest extends BaseTest {
 
     @Test
     public void applyOptions_bottomTabsOptionsAreClearedAfterApply() {
+        ViewUtils.removeFromParent(uut.getView());
+
         Options options = new Options();
         options.bottomTabsOptions.backgroundColor = new Colour(Color.RED);
         child1.mergeOptions(options);
@@ -235,7 +240,9 @@ public class BottomTabsControllerTest extends BaseTest {
 
         SimpleViewController stackChild = new SimpleViewController(activity, childRegistry, "stackChild", new Options());
         SimpleViewController stackChild2 = new SimpleViewController(activity, childRegistry, "stackChild", new Options());
+
         disablePushAnimation(stackChild, stackChild2);
+        hideBackButton(stackChild2);
 
         child4.push(stackChild, new CommandListenerAdapter());
         assertThat(child4.size()).isOne();
@@ -245,17 +252,12 @@ public class BottomTabsControllerTest extends BaseTest {
 
     @Test
     public void deepChildOptionsAreApplied() {
-        BottomTabsController spy = spy(uut);
-        activity.setContentView(spy.getView());
-
         child6.options.topBar.drawBehind = new Bool(false);
         disablePushAnimation(child6);
         child4.push(child6, new CommandListenerAdapter());
         assertThat(child4.size()).isOne();
 
-
-        verify(spy, times(1)).onViewAppeared();
-        assertThat(spy.getSelectedIndex()).isZero();
+        assertThat(uut.getSelectedIndex()).isZero();
         verify(child6, times(0)).onViewAppeared();
         assertThat(child4.getTopBar().getHeight())
                 .isNotZero()
@@ -264,16 +266,14 @@ public class BottomTabsControllerTest extends BaseTest {
 
     @Test
     public void oneTimeOptionsAreAppliedOnce() {
-        initialOptions.bottomTabsOptions.currentTabIndex = new Number(1);
-        BottomTabsController spy = spy(createBottomTabs());
-        spy.onViewAppeared();
-
-        assertThat(spy.getSelectedIndex()).isOne();
-        spy.selectTab(0);
-        tabs.get(0).onViewAppeared();
-        verify(spy).clearOptions();
-        assertThat(spy.getSelectedIndex()).isZero();
-        assertThat(spy.options.bottomTabsOptions.currentTabIndex.hasValue()).isFalse();
+        Options options = new Options();
+        options.bottomTabsOptions.currentTabIndex = new Number(1);
+
+        assertThat(uut.getSelectedIndex()).isZero();
+        uut.mergeOptions(options);
+        assertThat(uut.getSelectedIndex()).isOne();
+        assertThat(uut.options.bottomTabsOptions.currentTabIndex.hasValue()).isFalse();
+        assertThat(uut.initialOptions.bottomTabsOptions.currentTabIndex.hasValue()).isFalse();
     }
 
     @NonNull

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/ParentControllerTest.java

@@ -187,20 +187,14 @@ public class ParentControllerTest extends BaseTest {
     @Test
     public void resolveCurrentOptions_returnOptionsIfNoChildren() {
         assertThat(uut.getChildControllers().size()).isZero();
-        assertThat(uut.resolveCurrentOptions()).isEqualTo(uut.options);
+        assertThat(uut.resolveCurrentOptions()).isEqualTo(uut.initialOptions);
     }
 
     @Test
     public void resolveCurrentOptions_mergesWithCurrentChild() {
         ViewController child1 = Mockito.mock(ViewController.class);
         when(child1.getView()).thenReturn(new FrameLayout(activity));
-        Options copiedChildOptions = spy(new Options());
-        Options childOptions = spy(new Options() {
-            @Override
-            public Options copy() {
-                return copiedChildOptions;
-            }
-        });
+        Options childOptions = spy(new Options());
         when(child1.resolveCurrentOptions()).thenReturn(childOptions);
 
         children.add(child1);
@@ -209,7 +203,7 @@ public class ParentControllerTest extends BaseTest {
         assertThat(uut.getCurrentChild()).isEqualTo(child1);
         uut.resolveCurrentOptions();
         verify(child1).resolveCurrentOptions();
-        verify(copiedChildOptions).mergeWith(uut.options);
+        verify(childOptions).mergeWith(uut.initialOptions);
     }
 
     @Test

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/StackOptionsPresenterTest.java

@@ -34,7 +34,6 @@ import com.reactnativenavigation.views.topbar.TopBar;
 import org.json.JSONObject;
 import org.junit.Test;
 import org.mockito.ArgumentCaptor;
-import org.mockito.Mockito;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -279,13 +278,12 @@ public class StackOptionsPresenterTest extends BaseTest {
     }
 
     @Test
-    public void applyLayoutParamsOptions() {
+    public void applyInitialChildLayoutOptions() {
         Options options = new Options();
         options.topBar.visible = new Bool(false);
-        options.topBar.animate = new Bool(false);
-        View view = Mockito.mock(View.class, Mockito.withSettings().extraInterfaces(com.reactnativenavigation.views.Component.class));
+        options.topBar.animate = new Bool(true);
 
-        uut.applyLayoutParamsOptions(options, view);
+        uut.applyInitialChildLayoutOptions(options);
         verify(topBar).hide();
     }
 

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/TopTabsViewControllerTest.java

@@ -6,6 +6,7 @@ import android.view.ViewGroup;
 
 import com.reactnativenavigation.BaseTest;
 import com.reactnativenavigation.TestUtils;
+import com.reactnativenavigation.mocks.SimpleViewController;
 import com.reactnativenavigation.mocks.TestComponentViewCreator;
 import com.reactnativenavigation.mocks.TestReactView;
 import com.reactnativenavigation.parse.Options;
@@ -65,8 +66,6 @@ public class TopTabsViewControllerTest extends BaseTest {
 
         stack = spy(TestUtils.newStackController(activity).build());
         stack.ensureViewIsCreated();
-        stack.push(uut, new CommandListenerAdapter());
-        uut.setParentController(stack);
     }
 
     @NonNull
@@ -209,35 +208,22 @@ public class TopTabsViewControllerTest extends BaseTest {
 
     @Test
     public void applyOptions_tabsAreRemovedAfterViewDisappears() {
-        stack.getView().removeAllViews();
-
-        StackController stackController = spy(TestUtils.newStackController(activity).build());
+        StackController stackController = TestUtils.newStackController(activity).build();
         stackController.ensureViewIsCreated();
-        ComponentViewController first = new ComponentViewController(
-                activity,
-                childRegistry,
-                "firstScreen",
-                "comp1",
-                new TestComponentViewCreator(),
-                new Options(),
-                new OptionsPresenter(activity, new Options())
-        );
-        first.options.animations.push.enable = new Bool(false);
-        uut.options.animations.push.enable = new Bool(false);
+        ViewController first = new SimpleViewController(activity, childRegistry, "first", Options.EMPTY);
+        disablePushAnimation(first, uut);
         stackController.push(first, new CommandListenerAdapter());
         stackController.push(uut, new CommandListenerAdapter());
 
-        first.ensureViewIsCreated();
-        uut.ensureViewIsCreated();
         uut.onViewAppeared();
 
         assertThat(ViewHelper.isVisible(stackController.getTopBar().getTopTabs())).isTrue();
-        stackController.pop(Options.EMPTY, new CommandListenerAdapter() {
-            @Override
-            public void onSuccess(String childId) {
-                assertThat(ViewHelper.isVisible(stackController.getTopBar().getTopTabs())).isFalse();
-            }
-        });
+        disablePopAnimation(uut);
+        stackController.pop(Options.EMPTY, new CommandListenerAdapter());
+
+        first.onViewAppeared();
+
+        assertThat(ViewHelper.isVisible(stackController.getTopBar().getTopTabs())).isFalse();
     }
 
     @Test

lib/android/app/src/test/java/com/reactnativenavigation/viewcontrollers/stack/StackControllerTest.java

@@ -22,6 +22,7 @@ import com.reactnativenavigation.utils.CommandListenerAdapter;
 import com.reactnativenavigation.utils.ImageLoader;
 import com.reactnativenavigation.utils.TitleBarHelper;
 import com.reactnativenavigation.utils.ViewHelper;
+import com.reactnativenavigation.utils.ViewUtils;
 import com.reactnativenavigation.viewcontrollers.ChildControllersRegistry;
 import com.reactnativenavigation.viewcontrollers.ParentController;
 import com.reactnativenavigation.viewcontrollers.ViewController;
@@ -82,7 +83,7 @@ public class StackControllerTest extends BaseTest {
         child3 = spy(new SimpleViewController(activity, childRegistry, "child3", new Options()));
         child4 = spy(new SimpleViewController(activity, childRegistry, "child4", new Options()));
         uut = createStack();
-        uut.ensureViewIsCreated();
+        activity.setContentView(uut.getView());
     }
 
     @Test
@@ -140,9 +141,7 @@ public class StackControllerTest extends BaseTest {
         child2.options.topBar.buttons.left = new ArrayList<>(Collections.singleton(TitleBarHelper.iconButton("someButton", "icon.png")));
 
         uut.push(child2, new CommandListenerAdapter());
-        child2.onViewAppeared();
         assertThat(topBarController.getView().getTitleBar().getNavigationIcon()).isNotNull();
-        verify(topBarController.getView(), times(1)).setLeftButtons(any());
         verify(topBarController.getView(), times(0)).setBackButton(any());
     }
 
@@ -674,6 +673,7 @@ public class StackControllerTest extends BaseTest {
     @Test
     public void pop_doesNotAnimateTopBarIfScreenIsPushedWithoutAnimation() {
         uut.ensureViewIsCreated();
+        disablePushAnimation(child1, child2);
 
         child1.options.topBar.visible = new Bool(false);
         child1.options.topBar.animate = new Bool(false);
@@ -720,6 +720,7 @@ public class StackControllerTest extends BaseTest {
 
     @Test
     public void stackCanBePushed() {
+        ViewUtils.removeFromParent(uut.getView());
         StackController parent = createStack("someStack");
         parent.ensureViewIsCreated();
         parent.push(uut, new CommandListenerAdapter());
@@ -729,6 +730,7 @@ public class StackControllerTest extends BaseTest {
 
     @Test
     public void applyOptions_applyOnlyOnFirstStack() {
+        ViewUtils.removeFromParent(uut.getView());
         StackController parent = spy(createStack("someStack"));
         parent.ensureViewIsCreated();
         parent.push(uut, new CommandListenerAdapter());

playground/src/app.js

@@ -38,7 +38,7 @@ function start() {
         }
       },
       _animations: {
-        startApp: {
+        setRoot: {
           y: {
             from: 1000,
             to: 0,