NAVAND-552: use MapboxNavigationObserver

Author: dzinad

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

@@ -397,7 +397,7 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
         if (::mapboxNavigation.isInitialized) {
             mapboxNavigation.registerRoutesObserver(routesObserver)
             mapboxNavigation.registerLocationObserver(locationObserver)
-            mapboxNavigation.registerVoiceInstructionsTriggerObserver(voiceInstructionsDownloadTrigger)
+            voiceInstructionsDownloadTrigger.onAttached(mapboxNavigation)
             mapboxNavigation.registerRouteProgressObserver(routeProgressObserver)
             mapboxNavigation.registerRouteProgressObserver(replayProgressObserver)
             mapboxNavigation.registerVoiceInstructionsObserver(voiceInstructionsObserver)
@@ -410,7 +410,7 @@ class MapboxVoiceActivity : AppCompatActivity(), OnMapLongClickListener {
         super.onStop()
         ResourceLoaderFactory.getInstance().unregisterObserver(resourceLoadObserver)
         mapboxNavigation.unregisterRoutesObserver(routesObserver)
-        mapboxNavigation.registerVoiceInstructionsTriggerObserver(voiceInstructionsDownloadTrigger)
+        voiceInstructionsDownloadTrigger.onDetached(mapboxNavigation)
         mapboxNavigation.unregisterLocationObserver(locationObserver)
         mapboxNavigation.unregisterRouteProgressObserver(routeProgressObserver)
         mapboxNavigation.unregisterRouteProgressObserver(replayProgressObserver)

libnavigation-core/api/current.txt

@@ -59,7 +59,6 @@ package com.mapbox.navigation.core {
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void registerRoutesPreviewObserver(com.mapbox.navigation.core.preview.RoutesPreviewObserver observer);
     method public void registerTripSessionStateObserver(com.mapbox.navigation.core.trip.session.TripSessionStateObserver tripSessionStateObserver);
     method public void registerVoiceInstructionsObserver(com.mapbox.navigation.core.trip.session.VoiceInstructionsObserver voiceInstructionsObserver);
-    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public <T extends com.mapbox.navigation.core.directions.session.RoutesObserver & com.mapbox.navigation.core.trip.session.RouteProgressObserver> void registerVoiceInstructionsTriggerObserver(T observer);
     method public void requestAlternativeRoutes();
     method public void requestAlternativeRoutes(com.mapbox.navigation.core.routealternatives.NavigationRouteAlternativesRequestCallback? callback = null);
     method public void requestAlternativeRoutes(com.mapbox.navigation.core.routealternatives.RouteAlternativesRequestCallback callback);
@@ -103,7 +102,6 @@ package com.mapbox.navigation.core {
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public void unregisterRoutesPreviewObserver(com.mapbox.navigation.core.preview.RoutesPreviewObserver observer);
     method public void unregisterTripSessionStateObserver(com.mapbox.navigation.core.trip.session.TripSessionStateObserver tripSessionStateObserver);
     method public void unregisterVoiceInstructionsObserver(com.mapbox.navigation.core.trip.session.VoiceInstructionsObserver voiceInstructionsObserver);
-    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public <T extends com.mapbox.navigation.core.directions.session.RoutesObserver & com.mapbox.navigation.core.trip.session.RouteProgressObserver> void unregisterVoiceInstructionsTriggerObserver(T observer);
     property public final com.mapbox.navigator.Experimental experimental;
     property public final com.mapbox.navigation.core.trip.session.eh.GraphAccessor graphAccessor;
     property public final com.mapbox.navigation.core.history.MapboxHistoryRecorder historyRecorder;

libnavigation-core/src/main/java/com/mapbox/navigation/core/MapboxNavigation.kt

@@ -1283,28 +1283,6 @@ class MapboxNavigation @VisibleForTesting internal constructor(
         }
     }
 
-    /**
-     * Subscribes voice instructions trigger observer for all the necessary updates.
-     */
-    @ExperimentalPreviewMapboxNavigationAPI
-    fun <T> registerVoiceInstructionsTriggerObserver(
-        observer: T
-    ) where T : RoutesObserver, T : RouteProgressObserver {
-        registerRoutesObserver(observer)
-        registerRouteProgressObserver(observer)
-    }
-
-    /**
-     * Unsubscribes voice instructions trigger observer from all the updates it was subsribed for.
-     */
-    @ExperimentalPreviewMapboxNavigationAPI
-    fun <T> unregisterVoiceInstructionsTriggerObserver(
-        observer: T
-    ) where T : RoutesObserver, T : RouteProgressObserver {
-        unregisterRoutesObserver(observer)
-        unregisterRouteProgressObserver(observer)
-    }
-
     /**
      * Unregisters [RoutesObserver].
      */

libnavigation-core/src/test/java/com/mapbox/navigation/core/MapboxNavigationTest.kt

@@ -2020,33 +2020,6 @@ internal class MapboxNavigationTest : MapboxNavigationBaseTest() {
         }
     }
 
-    @Test
-    fun registerVoiceInstructionsTriggerObserver() {
-        val observer = TestVoiceInstructionsTriggerObserver()
-        createMapboxNavigation()
-
-        mapboxNavigation.registerVoiceInstructionsTriggerObserver(observer)
-
-        verify(exactly = 1) {
-            directionsSession.registerRoutesObserver(observer)
-            tripSession.registerRouteProgressObserver(observer)
-        }
-    }
-
-    @Test
-    fun unregisterVoiceInstructionsTriggerObserver() {
-        val observer = TestVoiceInstructionsTriggerObserver()
-        createMapboxNavigation()
-        mapboxNavigation.registerVoiceInstructionsTriggerObserver(observer)
-
-        mapboxNavigation.unregisterVoiceInstructionsTriggerObserver(observer)
-
-        verify(exactly = 1) {
-            directionsSession.unregisterRoutesObserver(observer)
-            tripSession.unregisterRouteProgressObserver(observer)
-        }
-    }
-
     private class TestVoiceInstructionsTriggerObserver : RoutesObserver, RouteProgressObserver {
 
         override fun onRouteProgressChanged(routeProgress: RouteProgress) {

libnavui-voice/api/current.txt

@@ -85,12 +85,12 @@ package com.mapbox.navigation.ui.voice.api {
     method @kotlin.jvm.Throws(exceptionClasses=IllegalArgumentException::class) public void volume(com.mapbox.navigation.ui.voice.model.SpeechVolume state) throws java.lang.IllegalArgumentException;
   }
 
-  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class VoiceInstructionsDownloadTrigger implements com.mapbox.navigation.core.trip.session.RouteProgressObserver com.mapbox.navigation.core.directions.session.RoutesObserver {
+  @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public final class VoiceInstructionsDownloadTrigger implements com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver {
     ctor public VoiceInstructionsDownloadTrigger(com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
     ctor public VoiceInstructionsDownloadTrigger(int observableTime, double timePercentageToTriggerAfter, com.mapbox.navigation.ui.voice.api.MapboxSpeechApi speechApi);
     method public void destroy();
-    method public void onRouteProgressChanged(com.mapbox.navigation.base.trip.model.RouteProgress routeProgress);
-    method public void onRoutesChanged(com.mapbox.navigation.core.directions.session.RoutesUpdatedResult result);
+    method public void onAttached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
+    method public void onDetached(com.mapbox.navigation.core.MapboxNavigation mapboxNavigation);
     field public static final com.mapbox.navigation.ui.voice.api.VoiceInstructionsDownloadTrigger.Companion Companion;
     field public static final int DEFAULT_OBSERVABLE_TIME_SECONDS = 180; // 0xb4
     field public static final double DEFAULT_TIME_PERCENTAGE_TO_TRIGGER_AFTER = 0.5;

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidance.kt

@@ -177,11 +177,11 @@ internal constructor(
             .distinctUntilChanged()
             .map { language ->
                 audioGuidanceVoice?.destroy()
-                trigger?.let { unregisterVoiceInstructionsTriggerObserver(it) }
+                trigger?.onDetached(this)
                 audioGuidanceServices.mapboxAudioGuidanceVoice(this, language).also {
                     audioGuidanceVoice = it
-                    trigger = VoiceInstructionsDownloadTrigger(it.mapboxSpeechApi).also {
-                        registerVoiceInstructionsTriggerObserver(it)
+                    trigger = VoiceInstructionsDownloadTrigger(it.mapboxSpeechApi).also { trigger ->
+                        trigger.onAttached(this)
                     }
                 }
             }

libnavui-voice/src/main/java/com/mapbox/navigation/ui/voice/api/VoiceInstructionsDownloadTrigger.kt

@@ -6,15 +6,18 @@ import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.core.directions.session.RoutesExtra
 import com.mapbox.navigation.core.directions.session.RoutesObserver
 import com.mapbox.navigation.core.directions.session.RoutesUpdatedResult
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.core.trip.session.RouteProgressObserver
 import com.mapbox.navigation.utils.internal.Time
 import com.mapbox.navigation.utils.internal.ifNonNull
 
 /**
  * Class that is responsible for listening to relevant updates and triggering
  * voice instructions predownloading when needed.
- * Register and unregister with [MapboxNavigation.registerVoiceInstructionsTriggerObserver] and
- * [MapboxNavigation.unregisterVoiceInstructionsTriggerObserver].
+ * Register and unregister with [MapboxNavigationApp.registerObserver]
+ * and [MapboxNavigationApp.unregisterObserver]
+ * or invoke [onAttached] and [onDetached] manually if you are not using [MapboxNavigationApp].
  */
 @ExperimentalPreviewMapboxNavigationAPI
 class VoiceInstructionsDownloadTrigger internal constructor(
@@ -23,7 +26,7 @@ class VoiceInstructionsDownloadTrigger internal constructor(
     private val speechApi: MapboxSpeechApi,
     private val nextVoiceInstructionsProvider: NextVoiceInstructionsProvider,
     private val timeProvider: Time,
-) : RouteProgressObserver, RoutesObserver {
+) : MapboxNavigationObserver {
 
     /**
      * Creates [VoiceInstructionsDownloadTrigger] with default
@@ -60,6 +63,10 @@ class VoiceInstructionsDownloadTrigger internal constructor(
         Time.SystemImpl
     )
 
+    private val routesObserver = RoutesObserver { onRoutesChanged(it) }
+
+    private val routeProgressObserver = RouteProgressObserver { onRouteProgressChanged(it) }
+
     private val ignoredRouteUpdateReasons = setOf(
         RoutesExtra.ROUTES_UPDATE_REASON_CLEAN_UP,
         RoutesExtra.ROUTES_UPDATE_REASON_ALTERNATIVE,
@@ -68,9 +75,22 @@ class VoiceInstructionsDownloadTrigger internal constructor(
     private var lastDownloadTime: Long = 0
 
     /**
-     * See [RoutesObserver.onRoutesChanged].
+     * See [MapboxNavigationObserver.onAttached].
+     */
+    override fun onAttached(mapboxNavigation: MapboxNavigation) {
+        mapboxNavigation.registerRoutesObserver(routesObserver)
+        mapboxNavigation.registerRouteProgressObserver(routeProgressObserver)
+    }
+
+    /**
+     * See [MapboxNavigationObserver.onDetached].
      */
-    override fun onRoutesChanged(result: RoutesUpdatedResult) {
+    override fun onDetached(mapboxNavigation: MapboxNavigation) {
+        mapboxNavigation.unregisterRoutesObserver(routesObserver)
+        mapboxNavigation.unregisterRouteProgressObserver(routeProgressObserver)
+    }
+
+    private fun onRoutesChanged(result: RoutesUpdatedResult) {
         if (result.reason in ignoredRouteUpdateReasons) {
             return
         }
@@ -89,10 +109,7 @@ class VoiceInstructionsDownloadTrigger internal constructor(
         }
     }
 
-    /**
-     * See [RouteProgressObserver.onRouteProgressChanged].
-     */
-    override fun onRouteProgressChanged(routeProgress: RouteProgress) {
+    private fun onRouteProgressChanged(routeProgress: RouteProgress) {
         if (shouldDownloadBasedOnTime()) {
             val legIndex = routeProgress.currentLegProgress?.legIndex
             val currentStepProgress = routeProgress.currentLegProgress?.currentStepProgress

libnavui-voice/src/test/java/com/mapbox/navigation/ui/voice/api/MapboxAudioGuidanceTest.kt

@@ -3,6 +3,8 @@ package com.mapbox.navigation.ui.voice.api
 import com.mapbox.api.directions.v5.models.VoiceInstructions
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.core.directions.session.RoutesObserver
+import com.mapbox.navigation.core.trip.session.RouteProgressObserver
 import com.mapbox.navigation.testing.MainCoroutineRule
 import com.mapbox.navigation.ui.voice.TestMapboxAudioGuidanceServices
 import com.mapbox.navigation.ui.voice.TestMapboxAudioGuidanceServices.Companion.SPEECH_ANNOUNCEMENT_DELAY_MS
@@ -296,27 +298,29 @@ class MapboxAudioGuidanceTest {
 
     @Test
     fun `triggers are registered and unregistered`() = coroutineRule.runBlockingTest {
-        val triggerSlot = mutableListOf<VoiceInstructionsDownloadTrigger>()
+        val routesObserverSlot = mutableListOf<RoutesObserver>()
+        val routeProgressObserverSlot = mutableListOf<RouteProgressObserver>()
         carAppAudioGuidance.onAttached(mapboxNavigation)
         clearMocks(mapboxNavigation, answers = false)
 
         testMapboxAudioGuidanceServices.emitVoiceLanguage("ru")
         delay(SPEECH_ANNOUNCEMENT_DELAY_MS)
 
         verify(exactly = 1) {
-            mapboxNavigation.registerVoiceInstructionsTriggerObserver(capture(triggerSlot))
+            mapboxNavigation.registerRoutesObserver(capture(routesObserverSlot))
+            mapboxNavigation.registerRouteProgressObserver(capture(routeProgressObserverSlot))
         }
 
         testMapboxAudioGuidanceServices.emitVoiceLanguage("fr")
         delay(SPEECH_ANNOUNCEMENT_DELAY_MS)
 
         verify(exactly = 1) {
-            mapboxNavigation.unregisterVoiceInstructionsTriggerObserver(triggerSlot.first())
+            mapboxNavigation.unregisterRoutesObserver(routesObserverSlot.first())
+            mapboxNavigation.registerRouteProgressObserver(routeProgressObserverSlot.first())
         }
         verify(exactly = 2) {
-            mapboxNavigation.registerVoiceInstructionsTriggerObserver(
-                any<VoiceInstructionsDownloadTrigger>()
-            )
+            mapboxNavigation.registerRoutesObserver(any())
+            mapboxNavigation.registerRouteProgressObserver(any())
         }
 
         carAppAudioGuidance.onDetached(mapboxNavigation)