Update RouteRetrievalEvent

Author: danesfeder

app/build.gradle

@@ -89,6 +89,11 @@ dependencies {
   implementation dependenciesList.mapboxMapSdk
   implementation dependenciesList.mapboxSearchSdk
 
+  // TODO remove when dependency is released upstream
+  implementation("com.mapbox.mapboxsdk:mapbox-sdk-services:4.4.0-SNAPSHOT") {
+    force = true
+  }
+
   // Support libraries
   implementation dependenciesList.supportAppcompatV7
   implementation dependenciesList.supportDesign

build.gradle

@@ -33,6 +33,8 @@ allprojects {
     jcenter()
     maven { url 'https://plugins.gradle.org/m2' }
     maven { url 'https://mapbox.bintray.com/mapbox' }
+    // TODO remove after java services are released
+    maven { url "http://oss.sonatype.org/content/repositories/snapshots/" }
   }
 
   group = GROUP

gradle/dependencies.gradle

@@ -9,7 +9,7 @@ ext {
 
   version = [
       mapboxMapSdk           : '7.1.2',
-      mapboxSdkServices      : '4.3.0',
+      mapboxSdkServices      : '4.4.0-SNAPSHOT',
       mapboxEvents           : '4.2.0',
       mapboxNavigator        : '4.0.0',
       mapboxAnnotationPlugin : '0.5.0',

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

@@ -5,6 +5,9 @@
 import com.mapbox.services.android.navigation.v5.exception.NavigationException;
 
 class ElapsedTime {
+
+  private static final double ELAPSED_TIME_DENOMINATOR = 1e+9;
+  private static final double PRECISION = 100d;
   private Long start = null;
   private Long end = null;
 
@@ -29,10 +32,12 @@ Long getEnd() {
     return end;
   }
 
-  long getElapsedTime() {
+  double getElapsedTime() {
     if (start == null || end == null) {
       throw new NavigationException("Must call start() and end() before calling getElapsedTime()");
     }
-    return end - start;
+    long elapsedTimeInNanoseconds = end - start;
+    double elapsedTimeInSeconds = elapsedTimeInNanoseconds / ELAPSED_TIME_DENOMINATOR;
+    return Math.round(elapsedTimeInSeconds * PRECISION) / PRECISION;
   }
 }

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

@@ -47,6 +47,9 @@ private NavigationMetricsWrapper() {
   static void init(Context context, String accessToken, String userAgent) {
     mapboxTelemetry = new MapboxTelemetry(context, accessToken, userAgent);
     mapboxTelemetry.enable();
+
+    // TODO disable after testing
+    mapboxTelemetry.updateDebugLoggingEnabled(true);
   }
 
   static void toggleLogging(boolean isDebugLoggingEnabled) {
@@ -371,7 +374,7 @@ static void feedbackEvent(SessionState sessionState, MetricsRouteProgress metric
     mapboxTelemetry.push(feedbackEvent);
   }
 
-  static void routeRetrievalEvent(long elapsedTime, String routeUuid, String sessionId) {
+  static void routeRetrievalEvent(double elapsedTime, String routeUuid, String sessionId) {
     push(new RouteRetrievalEvent(elapsedTime, routeUuid, sessionId));
   }
 

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

@@ -23,7 +23,6 @@
 
 import retrofit2.Call;
 import retrofit2.Callback;
-import retrofit2.Response;
 
 
 /**
@@ -41,8 +40,7 @@
 public final class NavigationRoute {
 
   private final MapboxDirections mapboxDirections;
-  private final NavigationTelemetry navigationTelemetry;
-  private final ElapsedTime elapsedTime;
+  private static final NavigationRouteEventListener EVENT_LISTENER = new NavigationRouteEventListener();
 
   /**
    * Package private constructor used for the {@link Builder#build()} method.
@@ -51,14 +49,7 @@ public final class NavigationRoute {
    * @since 0.5.0
    */
   NavigationRoute(MapboxDirections mapboxDirections) {
-    this(mapboxDirections, NavigationTelemetry.getInstance(), new ElapsedTime());
-  }
-
-  NavigationRoute(MapboxDirections mapboxDirections, NavigationTelemetry navigationTelemetry,
-                  ElapsedTime elapsedTime) {
     this.mapboxDirections = mapboxDirections;
-    this.navigationTelemetry = navigationTelemetry;
-    this.elapsedTime = elapsedTime;
   }
 
   /**
@@ -72,7 +63,7 @@ public static Builder builder(Context context) {
   }
 
   static Builder builder(Context context, LocaleUtils localeUtils) {
-    return new Builder()
+    return new Builder(EVENT_LISTENER)
       .annotations(DirectionsCriteria.ANNOTATION_CONGESTION, DirectionsCriteria.ANNOTATION_DISTANCE)
       .language(context, localeUtils)
       .voiceUnits(context, localeUtils)
@@ -87,24 +78,7 @@ static Builder builder(Context context, LocaleUtils localeUtils) {
    * @since 0.5.0
    */
   public void getRoute(final Callback<DirectionsResponse> callback) {
-    elapsedTime.start();
-
-    mapboxDirections.enqueueCall(new Callback<DirectionsResponse>() {
-      @Override
-      public void onResponse(Call<DirectionsResponse> call, Response<DirectionsResponse> response) {
-        elapsedTime.end();
-        callback.onResponse(call, response);
-        if (response.body().routes() != null && !response.body().routes().isEmpty()) {
-          navigationTelemetry.routeRetrievalEvent(elapsedTime,
-            response.body().routes().get(0).routeOptions().requestUuid());
-        }
-      }
-
-      @Override
-      public void onFailure(Call<DirectionsResponse> call, Throwable throwable) {
-        callback.onFailure(call, throwable);
-      }
-    });
+    mapboxDirections.enqueueCall(new NavigationRouteCallback(EVENT_LISTENER, callback));
   }
 
   /**
@@ -145,12 +119,14 @@ public static final class Builder {
     private static final String SEMICOLON = ";";
     private static final String COMMA = ",";
     private final MapboxDirections.Builder directionsBuilder;
+    private final NavigationRouteEventListener eventListener;
 
     /**
      * Private constructor for initializing the raw MapboxDirections.Builder
      */
-    private Builder() {
-      directionsBuilder = MapboxDirections.builder();
+    private Builder(NavigationRouteEventListener eventListener) {
+      this.eventListener = eventListener;
+      this.directionsBuilder = MapboxDirections.builder();
     }
 
     /**
@@ -586,14 +562,14 @@ public Builder routeOptions(RouteOptions options) {
       }
 
       if (!TextUtils.isEmpty(options.waypointNames())) {
-        String[] waypointNames = options.waypointNames().split(SEMICOLON);
-        directionsBuilder.addWaypointNames(waypointNames);
+        String[] wayPointNames = options.waypointNames().split(SEMICOLON);
+        directionsBuilder.addWaypointNames(wayPointNames);
       }
 
-      String waypointTargets = options.waypointTargets();
-      if (!TextUtils.isEmpty(waypointTargets)) {
-        Point[] splittedWaypointTargets = parseWaypointTargets(waypointTargets);
-        directionsBuilder.addWaypointTargets(splittedWaypointTargets);
+      String wayPointTargets = options.waypointTargets();
+      if (!TextUtils.isEmpty(wayPointTargets)) {
+        Point[] splitWayPointTargets = parseWaypointTargets(wayPointTargets);
+        directionsBuilder.addWaypointTargets(splitWayPointTargets);
       }
 
       return this;
@@ -615,7 +591,8 @@ public NavigationRoute build() {
         .overview(DirectionsCriteria.OVERVIEW_FULL)
         .voiceInstructions(true)
         .bannerInstructions(true)
-        .roundaboutExits(true);
+        .roundaboutExits(true)
+        .eventListener(eventListener);
       return new NavigationRoute(directionsBuilder.build());
     }
 

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

@@ -0,0 +1,49 @@
+package com.mapbox.services.android.navigation.v5.navigation;
+
+import android.support.annotation.NonNull;
+
+import com.mapbox.api.directions.v5.models.DirectionsResponse;
+
+import retrofit2.Call;
+import retrofit2.Callback;
+import retrofit2.Response;
+
+class NavigationRouteCallback implements Callback<DirectionsResponse> {
+
+  private final NavigationTelemetry telemetry;
+  private final NavigationRouteEventListener listener;
+  private final Callback<DirectionsResponse> callback;
+
+  NavigationRouteCallback(NavigationRouteEventListener listener, Callback<DirectionsResponse> callback) {
+    this(NavigationTelemetry.getInstance(), listener, callback);
+  }
+
+  NavigationRouteCallback(NavigationTelemetry telemetry, NavigationRouteEventListener listener,
+                          Callback<DirectionsResponse> callback) {
+    this.telemetry = telemetry;
+    this.listener = listener;
+    this.callback = callback;
+  }
+
+  @Override
+  public void onResponse(@NonNull Call<DirectionsResponse> call, @NonNull Response<DirectionsResponse> response) {
+    callback.onResponse(call, response);
+    if (isValid(response)) {
+      String uuid = response.body().uuid();
+      sendEventWith(listener.getTime(), uuid);
+    }
+  }
+
+  @Override
+  public void onFailure(@NonNull Call<DirectionsResponse> call, @NonNull Throwable throwable) {
+    callback.onFailure(call, throwable);
+  }
+
+  private boolean isValid(Response<DirectionsResponse> response) {
+    return response.body().routes() != null && !response.body().routes().isEmpty();
+  }
+
+  private void sendEventWith(ElapsedTime time, String uuid) {
+    telemetry.routeRetrievalEvent(time, uuid);
+  }
+}

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

@@ -0,0 +1,33 @@
+package com.mapbox.services.android.navigation.v5.navigation;
+
+import okhttp3.Call;
+import okhttp3.EventListener;
+
+class NavigationRouteEventListener extends EventListener {
+
+  private final ElapsedTime time;
+
+  NavigationRouteEventListener() {
+    this(new ElapsedTime());
+  }
+
+  NavigationRouteEventListener(ElapsedTime time) {
+    this.time = time;
+  }
+
+  @Override
+  public void callStart(Call call) {
+    super.callStart(call);
+    time.start();
+  }
+
+  @Override
+  public void callEnd(Call call) {
+    super.callEnd(call);
+    time.end();
+  }
+
+  ElapsedTime getTime() {
+    return time;
+  }
+}

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

@@ -303,7 +303,8 @@ void cancelFeedback(String feedbackId) {
 
   void routeRetrievalEvent(ElapsedTime elapsedTime, String routeUuid) {
     if (navigationSessionState != null && !navigationSessionState.sessionIdentifier().isEmpty()) {
-      NavigationMetricsWrapper.routeRetrievalEvent(elapsedTime.getElapsedTime(), routeUuid,
+      double time = elapsedTime.getElapsedTime();
+      NavigationMetricsWrapper.routeRetrievalEvent(time, routeUuid,
         navigationSessionState.sessionIdentifier());
     } else {
       routeRetrievalElapsedTime = elapsedTime;

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

@@ -9,10 +9,10 @@ class RouteRetrievalEvent extends NavigationPerformanceEvent implements Parcelab
   private static final String ELAPSED_TIME_NAME = "elapsed_time";
   private static final String ROUTE_UUID_NAME = "route_uuid";
 
-  RouteRetrievalEvent(long elapsedTime, String routeUuid, String sessionId) {
+  RouteRetrievalEvent(double elapsedTime, String routeUuid, String sessionId) {
     super(sessionId);
 
-    addCounter(new LongCounter(ELAPSED_TIME_NAME, elapsedTime));
+    addCounter(new DoubleCounter(ELAPSED_TIME_NAME, elapsedTime));
     addAttribute(new Attribute(ROUTE_UUID_NAME, routeUuid));
   }
 }