Navigation events (#489)

* enable custom turnstile event and new events

* separate platform and os constants

* make date formatting a bit more flexible

* include static generators for all new nav types

* move UUID logic to utils

* document buildUUID in the context of navigation

* add javadoc to events

* sdkName is now sdKIdentifier

* schemaVersion is now eventVersion

* sessionUUID is now sessionIdentifier

* add lat and lng keys

* add a method to compute screen brightness

* add method to detect volume level

* add keys for volumeLevel, screenBrightness, applicationState, batteryPluggedIn, batteryLevel, and connectivity

* remove completedDuration

* completedDistance is now distanceCompleted

* add distanceRemaining and durationRemaining

* changes to feedback event

* normalize getVolumeLevel

* only set newDistanceRemaining, newDurationRemaining, and secondsSinceLastReroute for a reroute type

* remove platform key

* add reroute event

* fix checkstyle

* added some missing metadata

* added step metadata to reroute

* seperated step key to make seperate json object

* added step metadata to feedback

* fixed a few missing metadata

Author: zugaldia

mapbox/libandroid-telemetry/src/androidTest/java/com/mapbox/services/android/telemetry/ExampleInstrumentedTest.java

@@ -27,6 +27,7 @@
 import com.mapbox.services.android.telemetry.location.AndroidLocationEngine;
 import com.mapbox.services.android.telemetry.location.LocationEngine;
 import com.mapbox.services.android.telemetry.location.LocationEngineListener;
+import com.mapbox.services.android.telemetry.navigation.MapboxNavigationEvent;
 import com.mapbox.services.android.telemetry.permissions.PermissionsManager;
 import com.mapbox.services.android.telemetry.service.TelemetryService;
 import com.mapbox.services.android.telemetry.utils.TelemetryUtils;
@@ -36,7 +37,6 @@
 import java.util.Hashtable;
 import java.util.Timer;
 import java.util.TimerTask;
-import java.util.UUID;
 import java.util.Vector;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -71,6 +71,7 @@ public class MapboxTelemetry implements Callback, LocationEngineListener {
   private boolean withShutDown = false;
   private Boolean telemetryEnabled = null;
   protected CopyOnWriteArrayList<TelemetryListener> telemetryListeners;
+  private Hashtable<String, Object> customTurnstileEvent = null;
 
   /**
    * Private constructor for configuring the single instance per app.
@@ -147,6 +148,14 @@ public boolean removeTelemetryListener(TelemetryListener listener) {
     return this.telemetryListeners.remove(listener);
   }
 
+  public Hashtable<String, Object> getCustomTurnstileEvent() {
+    return customTurnstileEvent;
+  }
+
+  public void setCustomTurnstileEvent(Hashtable<String, Object> customTurnstileEvent) {
+    this.customTurnstileEvent = customTurnstileEvent;
+  }
+
   /**
    * Checks that TelemetryService has been configured by developer
    */
@@ -226,7 +235,7 @@ private void rotateSessionId() {
     long timeSinceLastSet = System.currentTimeMillis() - mapboxSessionIdLastSet;
     if ((TextUtils.isEmpty(mapboxSessionId))
       || (timeSinceLastSet > TelemetryConstants.SESSION_ID_ROTATION_MS)) {
-      mapboxSessionId = UUID.randomUUID().toString();
+      mapboxSessionId = TelemetryUtils.buildUUID();
       mapboxSessionIdLastSet = System.currentTimeMillis();
     }
   }
@@ -277,7 +286,7 @@ private void loadUserPreferences() {
 
     // Create vendor ID (if needed)
     if (TextUtils.isEmpty(mapboxVendorId)) {
-      mapboxVendorId = UUID.randomUUID().toString();
+      mapboxVendorId = TelemetryUtils.buildUUID();
       SharedPreferences.Editor editor = prefs.edit();
       editor.putString(TelemetryConstants.MAPBOX_SHARED_PREFERENCE_KEY_VENDOR_ID, mapboxVendorId);
       editor.apply();
@@ -501,6 +510,42 @@ public void pushEvent(Hashtable<String, Object> eventWithAttributes) {
       eventWithAttributes.put(MapboxEvent.KEY_CELLULAR_NETWORK_TYPE, TelemetryUtils.getCellularNetworkType(context));
       eventWithAttributes.put(MapboxEvent.KEY_WIFI, TelemetryUtils.getConnectedToWifi(context));
       putEventOnQueue(eventWithAttributes);
+    } else if (eventType.equalsIgnoreCase(MapboxNavigationEvent.TYPE_DEPART)) {
+      // User started a route
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_VOLUME_LEVEL, TelemetryUtils.getVolumeLevel(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_SCREEN_BRIGHTNESS, TelemetryUtils.getScreenBrightness(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_APPLICATION_STATE, TelemetryUtils.getApplicationState(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_PLUGGED_IN, isPluggedIn());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_LEVEL, getBatteryLevel());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_CONNECTIVITY, TelemetryUtils.getCellularNetworkType(context));
+      putEventOnQueue(eventWithAttributes);
+    } else if (eventType.equalsIgnoreCase(MapboxNavigationEvent.TYPE_FEEDBACK)) {
+      // User feedback/reroute event
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_VOLUME_LEVEL, TelemetryUtils.getVolumeLevel(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_SCREEN_BRIGHTNESS, TelemetryUtils.getScreenBrightness(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_APPLICATION_STATE, TelemetryUtils.getApplicationState(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_PLUGGED_IN, isPluggedIn());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_LEVEL, getBatteryLevel());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_CONNECTIVITY, TelemetryUtils.getCellularNetworkType(context));
+      putEventOnQueue(eventWithAttributes);
+    } else if (eventType.equalsIgnoreCase(MapboxNavigationEvent.TYPE_ARRIVE)) {
+      // User arrived
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_VOLUME_LEVEL, TelemetryUtils.getVolumeLevel(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_SCREEN_BRIGHTNESS, TelemetryUtils.getScreenBrightness(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_APPLICATION_STATE, TelemetryUtils.getApplicationState(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_PLUGGED_IN, isPluggedIn());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_LEVEL, getBatteryLevel());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_CONNECTIVITY, TelemetryUtils.getCellularNetworkType(context));
+      putEventOnQueue(eventWithAttributes);
+    } else if (eventType.equalsIgnoreCase(MapboxNavigationEvent.TYPE_CANCEL)) {
+      // User canceled navigation
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_VOLUME_LEVEL, TelemetryUtils.getVolumeLevel(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_SCREEN_BRIGHTNESS, TelemetryUtils.getScreenBrightness(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_APPLICATION_STATE, TelemetryUtils.getApplicationState(context));
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_PLUGGED_IN, isPluggedIn());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_BATTERY_LEVEL, getBatteryLevel());
+      eventWithAttributes.put(MapboxNavigationEvent.KEY_CONNECTIVITY, TelemetryUtils.getCellularNetworkType(context));
+      putEventOnQueue(eventWithAttributes);
     } else {
       Log.w(LOG_TAG, String.format("Unknown event type provided: %s.", eventType));
     }
@@ -536,11 +581,16 @@ private void flushEventsQueueImmediately(boolean hasTurnstileEvent) {
    * Pushes turnstile event for internal billing purposes.
    */
   private void pushTurnstileEvent() {
-    Hashtable<String, Object> event = new Hashtable<>();
-    event.put(MapboxEvent.KEY_EVENT, MapboxEvent.TYPE_TURNSTILE);
+    Hashtable<String, Object> event = getCustomTurnstileEvent();
+    if (event == null) {
+      event = new Hashtable<>();
+      event.put(MapboxEvent.KEY_EVENT, MapboxEvent.TYPE_TURNSTILE);
+    }
+
     event.put(MapboxEvent.KEY_CREATED, TelemetryUtils.generateCreateDate(null));
     event.put(MapboxEvent.KEY_USER_ID, mapboxVendorId);
     event.put(MapboxEvent.KEY_ENABLED_TELEMETRY, isTelemetryEnabled());
+
     events.add(event);
     flushEventsQueueImmediately(true);
   }