Add some flexibility to NavigationLocationProvider

CHANGELOG.md

@@ -13,6 +13,9 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with restricted road visualization on the route line that occurred during route refreshes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Improved precision of restricted sections visualization, especially for long routes. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
 - Fixed a rare issue where alternative route would not be vanished until deviation point for `MapboxRouteLineApi#setNavigationRoutes(routes, metadata)` when the route's geometry contained duplicate points. [#6399](https://github.com/mapbox/mapbox-navigation-android/pull/6399)
+- Make `NavigationLocationProvider` an open class so it can be extended. [#6420](https://github.com/mapbox/mapbox-navigation-android/pull/6420)
+- Make `NavigationLocationProvider` inherit from `MapboxNavigationObserver` so it can be used with `MapboxNavigationApp`. [#6420](https://github.com/mapbox/mapbox-navigation-android/pull/6420)
+- Convert `LocationObserver` into a java interface with default functions so the functions are optional and new functions can be added. [#6420](https://github.com/mapbox/mapbox-navigation-android/pull/6420)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.4 - 30 September, 2022
 ### Changelog

examples/src/main/java/com/mapbox/navigation/examples/core/IndependentRouteGenerationActivity.kt

@@ -129,7 +129,6 @@ class IndependentRouteGenerationActivity : AppCompatActivity() {
     private val locationObserver = object : LocationObserver {
         private var initialUpdateDone = false
 
-        override fun onNewRawLocation(rawLocation: Location) {}
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             val enhancedLocation = locationMatcherResult.enhancedLocation
             if (!initialUpdateDone) {

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxBuildingHighlightActivity.kt

@@ -149,7 +149,6 @@ class MapboxBuildingHighlightActivity : AppCompatActivity(), OnMapLongClickListe
     }
 
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {}
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxCustomStyleActivity.kt

@@ -134,7 +134,6 @@ class MapboxCustomStyleActivity : AppCompatActivity(), OnMapLongClickListener {
     private val replayProgressObserver = ReplayProgressObserver(mapboxReplayer)
 
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {}
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxJunctionActivity.kt

@@ -129,7 +129,6 @@ class MapboxJunctionActivity : AppCompatActivity(), OnMapLongClickListener {
     private val replayProgressObserver = ReplayProgressObserver(mapboxReplayer)
 
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {}
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxManeuverActivity.kt

@@ -132,9 +132,6 @@ class MapboxManeuverActivity : AppCompatActivity(), OnMapLongClickListener {
     }
 
     private val locationObserver = object : LocationObserver {
-
-        override fun onNewRawLocation(rawLocation: Location) {}
-
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxNavigationActivity.kt

@@ -178,10 +178,6 @@ class MapboxNavigationActivity : AppCompatActivity() {
 
     /* ----- Location and route progress callbacks ----- */
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {
-            // not handled
-        }
-
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             // update location puck's position on the map
             navigationLocationProvider.changePosition(

examples/src/main/java/com/mapbox/navigation/examples/core/MapboxRouteLineAndArrowActivity.kt

@@ -321,7 +321,6 @@ class MapboxRouteLineAndArrowActivity : AppCompatActivity(), OnMapLongClickListe
     }
 
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {}
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             navigationLocationProvider.changePosition(
                 locationMatcherResult.enhancedLocation,

examples/src/main/java/com/mapbox/navigation/examples/core/camera/MapboxCameraAnimationsActivity.kt

@@ -146,9 +146,6 @@ class MapboxCameraAnimationsActivity :
     private val poiSource = geoJsonSource("circle_source") {}.data("")
 
     private val locationObserver = object : LocationObserver {
-
-        override fun onNewRawLocation(rawLocation: Location) {}
-
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             val transitionOptions: (ValueAnimator.() -> Unit) =
                 if (locationMatcherResult.isTeleport) {

instrumentation-tests/src/androidTest/java/com/mapbox/navigation/instrumentation_tests/utils/idling/FirstLocationIdlingResource.kt

@@ -54,10 +54,6 @@ class FirstLocationIdlingResource(
 
     /** Used to communicate with [MapboxNavigation.registerLocationObserver] **/
     private val locationObserver = object : LocationObserver {
-        override fun onNewRawLocation(rawLocation: Location) {
-            // Do nothing
-        }
-
         override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
             if (firstLocation == null) {
                 firstLocation = locationMatcherResult.enhancedLocation

libnavigation-core/api/current.txt

@@ -932,8 +932,8 @@ package com.mapbox.navigation.core.trip.session {
   }
 
   @UiThread public interface LocationObserver {
-    method public void onNewLocationMatcherResult(com.mapbox.navigation.core.trip.session.LocationMatcherResult locationMatcherResult);
-    method public void onNewRawLocation(android.location.Location rawLocation);
+    method public default void onNewLocationMatcherResult(com.mapbox.navigation.core.trip.session.LocationMatcherResult);
+    method public default void onNewRawLocation(android.location.Location);
   }
 
   public abstract sealed class NavigationSessionState {

libnavigation-core/src/main/java/com/mapbox/navigation/core/trip/session/LocationObserver.java

@@ -0,0 +1,33 @@
+package com.mapbox.navigation.core.trip.session;
+
+import android.location.Location;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.UiThread;
+
+/**
+ * An interface which enables listening to location updates
+ *
+ * @see LocationMatcherResult
+ */
+@UiThread
+public interface LocationObserver {
+
+  /**
+   * Invoked as soon as a new [Location] has been received.
+   *
+   * @param rawLocation un-snapped update
+   */
+  default void onNewRawLocation(@NonNull Location rawLocation) {
+    // Override to capture
+  }
+
+  /**
+   * Provides the best possible location update, snapped to the route or map-matched to the road if possible.
+   *
+   * @param locationMatcherResult details about the status of the enhanced location.
+   */
+  default void onNewLocationMatcherResult(@NonNull LocationMatcherResult locationMatcherResult) {
+    // Override to capture
+  }
+}

libnavui-maps/api/current.txt

@@ -717,15 +717,23 @@ package com.mapbox.navigation.ui.maps.installer {
 
 package com.mapbox.navigation.ui.maps.location {
 
-  public final class NavigationLocationProvider implements com.mapbox.maps.plugin.locationcomponent.LocationProvider {
+  public class NavigationLocationProvider implements com.mapbox.navigation.core.trip.session.LocationObserver com.mapbox.maps.plugin.locationcomponent.LocationProvider com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
     ctor public NavigationLocationProvider();
-    method public void changePosition(android.location.Location location, java.util.List<? extends android.location.Location> keyPoints = emptyList(), kotlin.jvm.functions.Function1<? super android.animation.ValueAnimator,kotlin.Unit>? latLngTransitionOptions = null, kotlin.jvm.functions.Function1<? super android.animation.ValueAnimator,kotlin.Unit>? bearingTransitionOptions = null);
-    method public java.util.List<android.location.Location> getLastKeyPoints();
-    method public android.location.Location? getLastLocation();
-    method public void registerLocationConsumer(com.mapbox.maps.plugin.locationcomponent.LocationConsumer locationConsumer);
-    method public void unRegisterLocationConsumer(com.mapbox.maps.plugin.locationcomponent.LocationConsumer locationConsumer);
+    method @CallSuper public final void changePosition(android.location.Location location, java.util.List<? extends android.location.Location> keyPoints = emptyList(), kotlin.jvm.functions.Function1<? super android.animation.ValueAnimator,kotlin.Unit>? latLngTransitionOptions = null, kotlin.jvm.functions.Function1<? super android.animation.ValueAnimator,kotlin.Unit>? bearingTransitionOptions = null);
+    method public final java.util.List<android.location.Location> getLastKeyPoints();
+    method public final android.location.Location? getLastLocation();
+    method public static final com.mapbox.navigation.ui.maps.location.NavigationLocationProvider getRegisteredInstance();
+    method @CallSuper public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method @CallSuper public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method public final void registerLocationConsumer(com.mapbox.maps.plugin.locationcomponent.LocationConsumer locationConsumer);
+    method public final void unRegisterLocationConsumer(com.mapbox.maps.plugin.locationcomponent.LocationConsumer locationConsumer);
     property public final java.util.List<android.location.Location> lastKeyPoints;
     property public final android.location.Location? lastLocation;
+    field public static final com.mapbox.navigation.ui.maps.location.NavigationLocationProvider.Companion Companion;
+  }
+
+  public static final class NavigationLocationProvider.Companion {
+    method public com.mapbox.navigation.ui.maps.location.NavigationLocationProvider getRegisteredInstance();
   }
 
 }

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/location/NavigationLocationProvider.kt

@@ -3,13 +3,17 @@ package com.mapbox.navigation.ui.maps.location
 import android.animation.ValueAnimator
 import android.annotation.SuppressLint
 import android.location.Location
+import androidx.annotation.CallSuper
 import com.mapbox.geojson.Point
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentConstants
 import com.mapbox.maps.plugin.locationcomponent.LocationComponentPlugin
 import com.mapbox.maps.plugin.locationcomponent.LocationConsumer
 import com.mapbox.maps.plugin.locationcomponent.LocationProvider
 import com.mapbox.maps.plugin.locationcomponent.OnIndicatorPositionChangedListener
 import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
+import com.mapbox.navigation.core.trip.session.LocationMatcherResult
 import com.mapbox.navigation.core.trip.session.LocationObserver
 import com.mapbox.navigation.ui.maps.internal.location.PuckAnimationEvaluator
 import com.mapbox.navigation.utils.internal.ifNonNull
@@ -53,7 +57,10 @@ import java.util.concurrent.CopyOnWriteArraySet
  * }
  * ```
  */
-class NavigationLocationProvider : LocationProvider {
+open class NavigationLocationProvider :
+    LocationProvider,
+    LocationObserver,
+    MapboxNavigationObserver {
 
     private val locationConsumers = CopyOnWriteArraySet<LocationConsumer>()
 
@@ -73,6 +80,17 @@ class NavigationLocationProvider : LocationProvider {
     var lastKeyPoints: List<Location> = emptyList()
         private set
 
+    /**
+     * Automatically updated when this class is registered to [MapboxNavigationApp]
+     */
+    @CallSuper
+    override fun onNewLocationMatcherResult(locationMatcherResult: LocationMatcherResult) {
+        changePosition(
+            locationMatcherResult.enhancedLocation,
+            locationMatcherResult.keyPoints,
+        )
+    }
+
     /**
      * Register the location consumer to the Location Provider.
      *
@@ -81,7 +99,7 @@ class NavigationLocationProvider : LocationProvider {
      * @param locationConsumer
      */
     @SuppressLint("MissingPermission")
-    override fun registerLocationConsumer(locationConsumer: LocationConsumer) {
+    final override fun registerLocationConsumer(locationConsumer: LocationConsumer) {
         if (locationConsumers.add(locationConsumer)) {
             ifNonNull(lastLocation, lastKeyPoints) { location, keyPoints ->
                 locationConsumer.notifyLocationUpdates(
@@ -103,7 +121,7 @@ class NavigationLocationProvider : LocationProvider {
      *
      * @param locationConsumer
      */
-    override fun unRegisterLocationConsumer(locationConsumer: LocationConsumer) {
+    final override fun unRegisterLocationConsumer(locationConsumer: LocationConsumer) {
         locationConsumers.remove(locationConsumer)
     }
 
@@ -122,6 +140,7 @@ class NavigationLocationProvider : LocationProvider {
      * @see LocationObserver
      * @see MapboxNavigation.registerLocationObserver
      */
+    @CallSuper
     fun changePosition(
         location: Location,
         keyPoints: List<Location> = emptyList(),
@@ -140,6 +159,27 @@ class NavigationLocationProvider : LocationProvider {
         lastKeyPoints = keyPoints
     }
 
+    /**
+     * Use [getRegisteredInstance] to share a single instance of the [NavigationLocationProvider].
+     *
+     * @see [MapboxNavigationApp]
+     */
+    @CallSuper
+    override fun onAttached(mapboxNavigation: MapboxNavigation) {
+        mapboxNavigation.registerLocationObserver(this)
+    }
+
+    /**
+     * Disabled automatically with the [MapboxNavigationApp]. You can manually disable with
+     * [MapboxNavigationApp.unregisterObserver].
+     *
+     * @see [MapboxNavigationApp]
+     */
+    @CallSuper
+    override fun onDetached(mapboxNavigation: MapboxNavigation) {
+        mapboxNavigation.unregisterLocationObserver(this)
+    }
+
     private fun LocationConsumer.notifyLocationUpdates(
         location: Location,
         keyPoints: List<Location>,
@@ -176,4 +216,14 @@ class NavigationLocationProvider : LocationProvider {
             clientOptions?.also { apply(it) }
         }
     }
+
+    companion object {
+        /**
+         * Get the registered instance or create one and register it to [MapboxNavigationApp].
+         */
+        @JvmStatic
+        fun getRegisteredInstance(): NavigationLocationProvider = MapboxNavigationApp
+            .getObservers(NavigationLocationProvider::class).firstOrNull()
+            ?: NavigationLocationProvider().also { MapboxNavigationApp.registerObserver(it) }
+    }
 }