Route progress immutable (#415)

* rafactored monitor location method

* fixed routeProgress object not updating in NavigationService

* finished route progress and added test

* reset navigation example

Author: Cameron Mace

Makefile

@@ -65,6 +65,11 @@ dex-count:
 	cd mapbox; ./gradlew countDebugDexMethods
 	cd mapbox; ./gradlew countReleaseDexMethods
 
+navigation-fixtures:
+	# Navigation: Taylor street to Page street
+	curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.413165,37.795042;-122.433378,37.7727?geometries=polyline6&overview=full&steps=true&access_token=$(MAPBOX_ACCESS_TOKEN)" \
+		-o mapbox/libandroid-services/src/test/resources/navigation.json
+
 geocoding-fixtures:
 	# Geocoding: 1600 Pennsylvania Ave NW
 	curl "https://api.mapbox.com/geocoding/v5/mapbox.places/1600+pennsylvania+ave+nw.json?access_token=$(MAPBOX_ACCESS_TOKEN)" \

mapbox/app/src/main/java/com/mapbox/services/android/testapp/MasApplication.java

@@ -7,6 +7,8 @@
 import com.mapbox.mapboxsdk.Mapbox;
 import com.squareup.leakcanary.LeakCanary;
 
+import timber.log.Timber;
+
 public class MasApplication extends Application {
 
   private static final String LOG_TAG = MasApplication.class.getSimpleName();
@@ -21,6 +23,10 @@ public void onCreate() {
     }
     LeakCanary.install(this);
 
+    if (BuildConfig.DEBUG) {
+      Timber.plant(new Timber.DebugTree());
+    }
+
     // Access token
     String mapboxAccessToken = Utils.getMapboxAccessToken(getApplicationContext());
     if (TextUtils.isEmpty(mapboxAccessToken)) {

mapbox/app/src/main/java/com/mapbox/services/android/testapp/nav/NavigationActivity.java

@@ -197,7 +197,7 @@ public void onRunning(boolean running) {
 
   @Override
   public void onProgressChange(Location location, RouteProgress routeProgress) {
-    Timber.d("onProgressChange: fraction of route traveled: %d", routeProgress.getFractionTraveledOnRoute());
+    Timber.d("onProgressChange: fraction of route traveled: %d", routeProgress.getFractionTraveled());
   }
 
   @Override

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

@@ -13,11 +13,13 @@
 import android.support.v4.app.NotificationCompat;
 
 import com.mapbox.services.Experimental;
+import com.mapbox.services.android.Constants;
 import com.mapbox.services.android.R;
 import com.mapbox.services.android.telemetry.location.LocationEngine;
 import com.mapbox.services.android.telemetry.location.LocationEngineListener;
 import com.mapbox.services.api.directions.v5.models.DirectionsRoute;
 import com.mapbox.services.api.navigation.v5.RouteProgress;
+import com.mapbox.services.commons.models.Position;
 
 import timber.log.Timber;
 
@@ -42,6 +44,7 @@ public class NavigationService extends Service implements LocationEngineListener
   private LocationUpdatedThread locationUpdatedThread;
 
   private RouteProgress routeProgress;
+  private DirectionsRoute directionsRoute;
 
   @Override
   public void onCreate() {
@@ -66,7 +69,8 @@ public void setupNotification(Activity activity) {
     // Sets up the top bar notification
     notifyBuilder = new NotificationCompat.Builder(this)
       .setContentTitle("Mapbox Navigation")
-      .setContentText("Distance: " + routeProgress.getDistanceRemainingOnStep())
+      .setContentText("Distance: " + routeProgress.getCurrentLegProgress().getCurrentStepProgress()
+        .getDistanceRemaining())
       .setSmallIcon(R.drawable.ic_navigation_black)
       .setContentIntent(PendingIntent.getActivity(this, 0,
         new Intent(this, activity.getClass()), 0));
@@ -116,18 +120,27 @@ public void setSnapToRoute(boolean snapToRoute) {
 
   private void startNavigation() {
     Timber.d("Navigation session started.");
-    routeProgress = new RouteProgress();
+    if (navigationEventListener != null) {
+      navigationEventListener.onRunning(true);
+    }
 
     Handler responseHandler = new Handler();
     locationUpdatedThread = new LocationUpdatedThread(responseHandler);
     locationUpdatedThread.start();
     locationUpdatedThread.getLooper();
     Timber.d("Background thread started");
+
+    locationUpdatedThread.setNewRouteProgressListener(new NewRouteProgressListener() {
+      @Override
+      public void onRouteProgressChange(RouteProgress routeProgress) {
+        NavigationService.this.routeProgress = routeProgress;
+      }
+    });
   }
 
-  public void startRoute(DirectionsRoute route) {
+  public void startRoute(DirectionsRoute directionsRoute) {
     Timber.d("Start Route called.");
-    routeProgress.setRoute(route);
+    this.directionsRoute = directionsRoute;
 
     if (locationEngine != null) {
       // Begin listening into location at its highest accuracy and add navigation location listener
@@ -191,18 +204,35 @@ public void setLocationEngine(LocationEngine locationEngine) {
   @Override
   public void onConnected() {
     Timber.d("NavigationService now connected to location listener");
-    locationEngine.requestLocationUpdates();
     Location lastLocation = locationEngine.getLastLocation();
+    if (routeProgress == null) {
+      Timber.d("Create new routeProgress object");
+      routeProgress = new RouteProgress(
+        directionsRoute,
+        Position.fromCoordinates(lastLocation.getLongitude(), lastLocation.getLatitude()),
+        0, 0,
+        Constants.NONE_ALERT_LEVEL
+      );
+    }
     if (locationUpdatedThread != null && lastLocation != null) {
-      locationUpdatedThread.updateLocation(routeProgress, lastLocation);
+      locationUpdatedThread.updateLocation(directionsRoute, routeProgress, lastLocation);
     }
   }
 
   @Override
   public void onLocationChanged(Location location) {
     Timber.d("LocationChange occurred");
+    if (routeProgress == null && location != null) {
+      Timber.d("Create new routeProgress object");
+      routeProgress = new RouteProgress(
+        directionsRoute,
+        Position.fromCoordinates(location.getLongitude(), location.getLatitude()),
+        0, 0,
+        Constants.NONE_ALERT_LEVEL
+      );
+    }
     if (locationUpdatedThread != null && location != null) {
-      locationUpdatedThread.updateLocation(routeProgress, location);
+      locationUpdatedThread.updateLocation(directionsRoute, routeProgress, location);
     }
   }
 }

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

@@ -0,0 +1,7 @@
+package com.mapbox.services.android.navigation.v5;
+
+import com.mapbox.services.api.navigation.v5.RouteProgress;
+
+public interface NewRouteProgressListener {
+  void onRouteProgressChange(RouteProgress routeProgress);
+}

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

@@ -7,6 +7,8 @@
 
 public class BaseNavigationTest {
 
+  protected static final double DELTA = 1E-10;
+
   static String convertStreamToString(InputStream is) throws IOException {
     final int bufferSize = 1024;
     final char[] buffer = new char[bufferSize];

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

@@ -0,0 +1,83 @@
+package com.mapbox.services.android.navigation.v5;
+
+import com.google.gson.Gson;
+import com.mapbox.services.api.directions.v5.models.DirectionsResponse;
+import com.mapbox.services.api.directions.v5.models.DirectionsRoute;
+import com.mapbox.services.api.navigation.v5.RouteProgress;
+import com.mapbox.services.commons.models.Position;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.junit.Assert.assertEquals;
+
+public class RouteProgressTest extends BaseNavigationTest {
+
+  private static final int NONE_ALERT_LEVEL = 0;
+  private static final int LOW_ALERT_LEVEL = 2;
+  private static final String NAVIGATION_FIXTURE = "navigation.json";
+
+  private DirectionsRoute route;
+  private RouteProgress routeProgress;
+
+  @Before
+  public void setUp() throws IOException {
+    Gson gson = new Gson();
+    InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(NAVIGATION_FIXTURE);
+    String body = convertStreamToString(inputStream);
+    DirectionsResponse response = gson.fromJson(body, DirectionsResponse.class);
+    route = response.getRoutes().get(0);
+
+    Position userSnappedPosition = Position.fromCoordinates(-122.413165, 37.795042);
+    routeProgress = new RouteProgress(route, userSnappedPosition, 0, 0, NONE_ALERT_LEVEL);
+  }
+
+  @Test
+  public void routeProgressTest() {
+    assertEquals(routeProgress.getCurrentLeg(), route.getLegs().get(0));
+    assertEquals(routeProgress.getAlertUserLevel(), NONE_ALERT_LEVEL);
+    assertEquals(routeProgress.getLegIndex(), 0);
+    assertEquals(routeProgress.getFractionTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getDistanceRemaining(), 4317.5, 0.1);
+    assertEquals(routeProgress.getDistanceTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getDurationRemaining(), 916, DELTA);
+  }
+
+  @Test
+  public void routeLegProgressTest() {
+    assertEquals(routeProgress.getCurrentLegProgress().getUpComingStep(), route.getLegs().get(0).getSteps().get(1));
+    assertEquals(routeProgress.getCurrentLegProgress().getDistanceRemaining(), 4317.5, 0.1);
+    assertEquals(routeProgress.getCurrentLegProgress().getDurationRemaining(), 916);
+    assertEquals(routeProgress.getCurrentLegProgress().getFractionTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getCurrentLegProgress().getCurrentStep(), route.getLegs().get(0).getSteps().get(0));
+    assertEquals(routeProgress.getCurrentLegProgress().getDistanceTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getCurrentLegProgress().getPreviousStep(), null);
+    assertEquals(routeProgress.getCurrentLegProgress().getStepIndex(), 0);
+  }
+
+  @Test
+  public void routeStepProgressTest() {
+    assertEquals(routeProgress.getCurrentLegProgress().getCurrentStepProgress().getDistanceRemaining(), 279.8, 0.1);
+    assertEquals(routeProgress.getCurrentLegProgress().getCurrentStepProgress().getFractionTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getCurrentLegProgress().getCurrentStepProgress().getDistanceTraveled(), 0, DELTA);
+    assertEquals(routeProgress.getCurrentLegProgress().getCurrentStepProgress().getDurationRemaining(), 69, DELTA);
+  }
+
+
+  @Test
+  public void nextRouteStepProgressTest() {
+    Position userNextStepSnappedPosition = route.getLegs().get(0).getSteps().get(1).getManeuver().asPosition();
+    RouteProgress nextRouteProgress = new RouteProgress(route, userNextStepSnappedPosition, 0, 1, LOW_ALERT_LEVEL);
+
+    assertEquals(nextRouteProgress.getCurrentLeg(), route.getLegs().get(0));
+    assertEquals(nextRouteProgress.getAlertUserLevel(), LOW_ALERT_LEVEL);
+    assertEquals(nextRouteProgress.getLegIndex(), 0);
+    assertEquals(nextRouteProgress.getDistanceRemaining(), 4037.6, 0.1);
+    assertEquals(nextRouteProgress.getDistanceTraveled(), 279.8, 0.1);
+    assertEquals(nextRouteProgress.getDurationRemaining(), 856, DELTA);
+    assertEquals(nextRouteProgress.getFractionTraveled(), 0.0648, 0.0001);
+  }
+}