Allow NavigationView to start navigation during existing session (#1655)

Author: danesfeder

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationViewModel.java

@@ -108,6 +108,17 @@ public NavigationViewModel(Application application) {
     this.navigation = navigation;
   }
 
+  // Package private (no modifier) for testing purposes
+  NavigationViewModel(Application application, MapboxNavigation navigation,
+                      LocationEngineConductor conductor, NavigationViewEventDispatcher dispatcher,
+                      VoiceInstructionCache cache) {
+    super(application);
+    this.navigation = navigation;
+    this.locationEngineConductor = conductor;
+    this.navigationViewEventDispatcher = dispatcher;
+    this.voiceInstructionCache = cache;
+  }
+
   public void onCreate() {
     if (!isRunning()) {
       locationEngineConductor.onCreate();
@@ -236,11 +247,13 @@ boolean isOffRoute() {
 
   void updateRoute(DirectionsRoute route) {
     this.route.setValue(route);
-    startNavigation(route);
-    updateSimulatedRoute(route);
+    if (!isChangingConfigurations) {
+      startNavigation(route);
+      locationEngineConductor.updateSimulatedRoute(route);
+      sendEventOnRerouteAlong(route);
+      isOffRoute.setValue(false);
+    }
     resetConfigurationFlag();
-    sendEventOnRerouteAlong(route);
-    isOffRoute.setValue(false);
   }
 
   void sendEventFailedReroute(String errorMessage) {
@@ -497,9 +510,9 @@ private void sendNavigationStatusEvent(boolean isRunning) {
     }
   }
 
-  private void updateSimulatedRoute(DirectionsRoute route) {
-    if (!isChangingConfigurations) {
-      locationEngineConductor.updateSimulatedRoute(route);
+  private void sendEventOnRerouteAlong(DirectionsRoute route) {
+    if (navigationViewEventDispatcher != null && isOffRoute()) {
+      navigationViewEventDispatcher.onRerouteAlong(route);
     }
   }
 
@@ -509,12 +522,6 @@ private void resetConfigurationFlag() {
     }
   }
 
-  private void sendEventOnRerouteAlong(DirectionsRoute route) {
-    if (navigationViewEventDispatcher != null && isOffRoute()) {
-      navigationViewEventDispatcher.onRerouteAlong(route);
-    }
-  }
-
   private SpeechAnnouncement retrieveAnnouncementFromSpeechEvent(SpeechAnnouncement announcement) {
     if (navigationViewEventDispatcher != null) {
       announcement = navigationViewEventDispatcher.onAnnouncement(announcement);
@@ -528,4 +535,4 @@ private BannerInstructions retrieveInstructionsFromBannerEvent(BannerInstruction
     }
     return instructions;
   }
-}
+}

libandroid-navigation-ui/src/main/java/com/mapbox/services/android/navigation/ui/v5/NavigationViewRouteEngineListener.java

@@ -15,9 +15,7 @@ class NavigationViewRouteEngineListener implements ViewRouteListener {
 
   @Override
   public void onRouteUpdate(DirectionsRoute directionsRoute) {
-    if (!navigationViewModel.isRunning() || navigationViewModel.isOffRoute()) {
-      navigationViewModel.updateRoute(directionsRoute);
-    }
+    navigationViewModel.updateRoute(directionsRoute);
   }
 
   @Override

libandroid-navigation-ui/src/test/java/com/mapbox/services/android/navigation/ui/v5/NavigationViewModelTest.java

@@ -2,13 +2,16 @@
 
 import android.app.Application;
 
+import com.mapbox.api.directions.v5.models.DirectionsRoute;
+import com.mapbox.services.android.navigation.ui.v5.location.LocationEngineConductor;
 import com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation;
 
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.robolectric.RobolectricTestRunner;
 
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 
 @RunWith(RobolectricTestRunner.class)
@@ -35,4 +38,33 @@ public void stopNavigation_milestoneListenersAreRemoved() {
 
     verify(navigation).removeMilestoneEventListener(null);
   }
+
+  @Test
+  public void updateRoute_navigationIsNotUpdatedWhenChangingConfigurations() {
+    Application application = mock(Application.class);
+    MapboxNavigation navigation = mock(MapboxNavigation.class);
+    DirectionsRoute route = mock(DirectionsRoute.class);
+    NavigationViewModel viewModel = new NavigationViewModel(application, navigation);
+    viewModel.onDestroy(true);
+
+    viewModel.updateRoute(route);
+
+    verify(navigation, times(0)).startNavigation(route);
+  }
+
+  @Test
+  public void updateRoute_navigationIsUpdated() {
+    Application application = mock(Application.class);
+    MapboxNavigation navigation = mock(MapboxNavigation.class);
+    LocationEngineConductor conductor = mock(LocationEngineConductor.class);
+    NavigationViewEventDispatcher dispatcher = mock(NavigationViewEventDispatcher.class);
+    VoiceInstructionCache cache = mock(VoiceInstructionCache.class);
+    DirectionsRoute route = mock(DirectionsRoute.class);
+    NavigationViewModel viewModel = new NavigationViewModel(application, navigation, conductor, dispatcher, cache);
+    viewModel.isOffRoute.postValue(true);
+
+    viewModel.updateRoute(route);
+
+    verify(navigation).startNavigation(route);
+  }
 }

libandroid-navigation-ui/src/test/java/com/mapbox/services/android/navigation/ui/v5/NavigationViewRouteEngineListenerTest.java

@@ -16,9 +16,8 @@
 public class NavigationViewRouteEngineListenerTest {
 
   @Test
-  public void checksUpdateRouteCalledIfNavigationIsNotRunning() {
+  public void onRouteUpdate_checksUpdateRouteCalled() {
     NavigationViewModel mockedNavigationViewModel = mock(NavigationViewModel.class);
-    when(mockedNavigationViewModel.isRunning()).thenReturn(false);
     DirectionsRoute aDirectionsRoute = mock(DirectionsRoute.class);
     NavigationViewRouteEngineListener theRouteEngineListener
       = new NavigationViewRouteEngineListener(mockedNavigationViewModel);
@@ -28,34 +27,6 @@ public void checksUpdateRouteCalledIfNavigationIsNotRunning() {
     verify(mockedNavigationViewModel).updateRoute(eq(aDirectionsRoute));
   }
 
-  @Test
-  public void checksUpdateRouteCalledIfNavigationIsOffRoute() {
-    NavigationViewModel mockedNavigationViewModel = mock(NavigationViewModel.class);
-    when(mockedNavigationViewModel.isRunning()).thenReturn(true);
-    when(mockedNavigationViewModel.isOffRoute()).thenReturn(true);
-    DirectionsRoute aDirectionsRoute = mock(DirectionsRoute.class);
-    NavigationViewRouteEngineListener theRouteEngineListener
-      = new NavigationViewRouteEngineListener(mockedNavigationViewModel);
-
-    theRouteEngineListener.onRouteUpdate(aDirectionsRoute);
-
-    verify(mockedNavigationViewModel).updateRoute(eq(aDirectionsRoute));
-  }
-
-  @Test
-  public void checksUpdateRouteNotCalledIfNavigationIsRunningAndIsNotOffRoute() {
-    NavigationViewModel mockedNavigationViewModel = mock(NavigationViewModel.class);
-    when(mockedNavigationViewModel.isRunning()).thenReturn(true);
-    when(mockedNavigationViewModel.isOffRoute()).thenReturn(false);
-    DirectionsRoute aDirectionsRoute = mock(DirectionsRoute.class);
-    NavigationViewRouteEngineListener theRouteEngineListener
-      = new NavigationViewRouteEngineListener(mockedNavigationViewModel);
-
-    theRouteEngineListener.onRouteUpdate(aDirectionsRoute);
-
-    verify(mockedNavigationViewModel, times(0)).updateRoute(eq(aDirectionsRoute));
-  }
-
   @Test
   public void checksSendEventFailedRerouteCalledIfNavigationIsOffRoute() {
     NavigationViewModel mockedNavigationViewModel = mock(NavigationViewModel.class);