add ability to observe when map click was not handled by drop-in (#6313)

Author: Zayankovsky

CHANGELOG.md

@@ -14,6 +14,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed an issue with `NavigationView` that caused `ViewOptionsCustomization.routeArrowOptions` to be ignored, if arrows have already been drawn on the map. [#6333](https://github.com/mapbox/mapbox-navigation-android/pull/6333)
 - Replaced `ViewStyleCustomization.defaultMarkerAnnotationOptions` with `ViewStyleCustomization.defaultDestinationMarkerAnnotationOptions`. [#6365](https://github.com/mapbox/mapbox-navigation-android/pull/6365)
 - Fixed the issue with incorrect geometry indices for `RouteLeg#incidents` and `RouteLeg#closures` after refresh. [#6364](https://github.com/mapbox/mapbox-navigation-android/pull/6364)
+- Introduced `NavigationViewListener#onMapClicked` to inform when a map was clicked, but the event was not processed by `NavigationView`. [#6360](https://github.com/mapbox/mapbox-navigation-android/pull/6360)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.2 - 16 September, 2022
 ### Changelog

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewContext.kt

@@ -6,6 +6,7 @@ import androidx.lifecycle.LifecycleOwner
 import androidx.lifecycle.lifecycleScope
 import com.mapbox.maps.MapView
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.dropin.binder.map.MapClickBehavior
 import com.mapbox.navigation.dropin.component.infopanel.InfoPanelBehavior
 import com.mapbox.navigation.dropin.component.maneuver.ManeuverBehavior
 import com.mapbox.navigation.dropin.component.marker.MapMarkerFactory
@@ -46,11 +47,13 @@ internal class NavigationViewContext(
     val infoPanelBehavior = InfoPanelBehavior()
     val mapViewOwner = MapViewOwner()
     val mapStyleLoader = MapStyleLoader(context, options)
+    val mapClickBehavior = MapClickBehavior()
     val listenerRegistry by lazy {
         NavigationViewListenerRegistry(
             store,
             maneuverBehavior,
             infoPanelBehavior,
+            mapClickBehavior,
             lifecycleOwner.lifecycleScope
         )
     }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewListener.kt

@@ -147,4 +147,11 @@ abstract class NavigationViewListener {
      * Called when maneuver view has been collapsed.
      */
     open fun onManeuverCollapsed() = Unit
+
+    /**
+     * Called when a map was clicked, but the event was not handled by NavigationView.
+     *
+     * @param point The projected map coordinate the user clicked on.
+     */
+    open fun onMapClicked(point: Point) = Unit
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/NavigationViewListenerRegistry.kt

@@ -4,6 +4,7 @@ import android.view.KeyEvent
 import android.view.View
 import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.dropin.binder.map.MapClickBehavior
 import com.mapbox.navigation.dropin.component.infopanel.InfoPanelBehavior
 import com.mapbox.navigation.dropin.component.maneuver.ManeuverBehavior
 import com.mapbox.navigation.ui.app.internal.Store
@@ -15,13 +16,16 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.flow.collect
 import kotlinx.coroutines.flow.filterNotNull
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.launch
 
 @ExperimentalPreviewMapboxNavigationAPI
 internal class NavigationViewListenerRegistry(
     private val store: Store,
     private val maneuverSubscriber: ManeuverBehavior,
     private val infoPanelSubscriber: InfoPanelBehavior,
+    private val mapClickSubscriber: MapClickBehavior,
     private val coroutineScope: CoroutineScope
 ) : View.OnKeyListener {
     private var listeners = mutableMapOf<NavigationViewListener, Job>()
@@ -133,6 +137,10 @@ internal class NavigationViewListenerRegistry(
                         }
                     }
             }
+
+            mapClickSubscriber.mapClickBehavior
+                .onEach { listener.onMapClicked(it) }
+                .launchIn(scope = this)
         }
     }
 

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/binder/map/MapBinder.kt

@@ -1,6 +1,7 @@
 package com.mapbox.navigation.dropin.binder.map
 
 import android.view.ViewGroup
+import com.mapbox.geojson.Point
 import com.mapbox.maps.MapView
 import com.mapbox.maps.plugin.compass.compass
 import com.mapbox.maps.plugin.locationcomponent.location
@@ -91,7 +92,7 @@ internal class MapBinder(
 
     private fun routeLineComponent(lineOptions: MapboxRouteLineOptions) =
         RouteLineComponent(mapView.getMapboxMap(), mapView, lineOptions, contractProvider = {
-            RouteLineComponentContractImpl(store)
+            RouteLineComponentContractImpl(store, context.mapClickBehavior)
         })
 
     private fun longPressMapComponent(navigationState: NavigationState) =
@@ -129,7 +130,8 @@ internal class MapBinder(
 
 @ExperimentalPreviewMapboxNavigationAPI
 internal class RouteLineComponentContractImpl(
-    private val store: Store
+    private val store: Store,
+    private val mapClickBehavior: MapClickBehavior,
 ) : RouteLineComponentContract {
     override fun setRoutes(mapboxNavigation: MapboxNavigation, routes: List<NavigationRoute>) {
         when (store.state.value.navigation) {
@@ -161,4 +163,8 @@ internal class RouteLineComponentContractImpl(
             }
         }
     }
+
+    override fun onMapClicked(point: Point) {
+        mapClickBehavior.onMapClicked(point)
+    }
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/binder/map/MapClickBehavior.kt

@@ -0,0 +1,19 @@
+package com.mapbox.navigation.dropin.binder.map
+
+import com.mapbox.geojson.Point
+import kotlinx.coroutines.channels.BufferOverflow
+import kotlinx.coroutines.flow.MutableSharedFlow
+import kotlinx.coroutines.flow.asSharedFlow
+
+internal class MapClickBehavior {
+
+    private val _mapClickBehavior = MutableSharedFlow<Point>(
+        extraBufferCapacity = 1,
+        onBufferOverflow = BufferOverflow.DROP_OLDEST,
+    )
+    val mapClickBehavior = _mapClickBehavior.asSharedFlow()
+
+    fun onMapClicked(point: Point) {
+        _mapClickBehavior.tryEmit(point)
+    }
+}

libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/NavigationViewListenerRegistryTest.kt

@@ -9,8 +9,6 @@ import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.base.route.NavigationRoute
 import com.mapbox.navigation.base.route.RouterFailure
 import com.mapbox.navigation.base.route.RouterOrigin
-import com.mapbox.navigation.dropin.component.infopanel.InfoPanelBehavior
-import com.mapbox.navigation.dropin.component.maneuver.ManeuverBehavior
 import com.mapbox.navigation.dropin.util.TestStore
 import com.mapbox.navigation.testing.MainCoroutineRule
 import com.mapbox.navigation.ui.app.internal.State
@@ -25,10 +23,11 @@ import io.mockk.spyk
 import io.mockk.verify
 import io.mockk.verifyOrder
 import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.MutableSharedFlow
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.asSharedFlow
 import kotlinx.coroutines.flow.asStateFlow
 import org.junit.Assert.assertTrue
-import org.junit.Before
 import org.junit.Rule
 import org.junit.Test
 
@@ -37,34 +36,27 @@ import org.junit.Test
 class NavigationViewListenerRegistryTest {
 
     @get:Rule
-    var coroutineRule = MainCoroutineRule()
-
-    private lateinit var sut: NavigationViewListenerRegistry
-    private lateinit var testStore: TestStore
-    private lateinit var maneuverBehaviorFlow: MutableStateFlow<MapboxManeuverViewState>
-    private lateinit var infoPanelBehaviorFlow: MutableStateFlow<Int?>
-    private lateinit var testListener: NavigationViewListener
-
-    @Before
-    fun setUp() {
-        testStore = TestStore()
-        maneuverBehaviorFlow = MutableStateFlow(MapboxManeuverViewState.COLLAPSED)
-        infoPanelBehaviorFlow = MutableStateFlow(null)
-        val mockManeuverBehavior = mockk<ManeuverBehavior> {
+    val coroutineRule = MainCoroutineRule()
+
+    private val testStore = TestStore()
+    private val maneuverBehaviorFlow =
+        MutableStateFlow<MapboxManeuverViewState>(MapboxManeuverViewState.COLLAPSED)
+    private val infoPanelBehaviorFlow = MutableStateFlow<Int?>(value = null)
+    private val mapClickBehaviorFlow = MutableSharedFlow<Point>(extraBufferCapacity = 1)
+    private val testListener = spyk(object : NavigationViewListener() {})
+    private val sut = NavigationViewListenerRegistry(
+        testStore,
+        mockk {
             every { maneuverBehavior } returns maneuverBehaviorFlow.asStateFlow()
-        }
-        val mockInfoPanelBehavior = mockk<InfoPanelBehavior> {
+        },
+        mockk {
             every { infoPanelBehavior } returns infoPanelBehaviorFlow.asStateFlow()
-        }
-        testListener = spyk(object : NavigationViewListener() {})
-
-        sut = NavigationViewListenerRegistry(
-            testStore,
-            mockManeuverBehavior,
-            mockInfoPanelBehavior,
-            coroutineRule.coroutineScope
-        )
-    }
+        },
+        mockk {
+            every { mapClickBehavior } returns mapClickBehaviorFlow.asSharedFlow()
+        },
+        coroutineRule.coroutineScope,
+    )
 
     @Test
     fun onDestinationChanged() {
@@ -380,4 +372,13 @@ class NavigationViewListenerRegistryTest {
             testListener.onManeuverCollapsed()
         }
     }
+
+    @Test
+    fun onMapClicked() {
+        sut.registerListener(testListener)
+        val point = mockk<Point>()
+        mapClickBehaviorFlow.tryEmit(point)
+
+        verify { testListener.onMapClicked(point) }
+    }
 }

libnavui-dropin/src/test/java/com/mapbox/navigation/dropin/binder/map/MapClickBehaviorTest.kt

@@ -0,0 +1,28 @@
+package com.mapbox.navigation.dropin.binder.map
+
+import com.mapbox.geojson.Point
+import io.mockk.mockk
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.cancelAndJoin
+import kotlinx.coroutines.flow.launchIn
+import kotlinx.coroutines.flow.onEach
+import kotlinx.coroutines.test.runBlockingTest
+import org.junit.Assert.assertEquals
+import org.junit.Test
+
+@ExperimentalCoroutinesApi
+class MapClickBehaviorTest {
+
+    @Test
+    fun `when map is clicked, event is received`() = runBlockingTest {
+        val sut = MapClickBehavior()
+        val events = arrayListOf<Point>()
+        val job = sut.mapClickBehavior.onEach { events.add(it) }.launchIn(scope = this)
+
+        val point = mockk<Point>()
+        sut.onMapClicked(point)
+        job.cancelAndJoin()
+
+        assertEquals(listOf(point), events)
+    }
+}

libnavui-maps/src/main/java/com/mapbox/navigation/ui/maps/internal/ui/RouteLineComponent.kt

@@ -36,6 +36,8 @@ interface RouteLineComponentContract {
     fun setRoutes(mapboxNavigation: MapboxNavigation, routes: List<NavigationRoute>)
 
     fun getRouteInPreview(): Flow<List<NavigationRoute>?>
+
+    fun onMapClicked(point: Point)
 }
 
 @ExperimentalPreviewMapboxNavigationAPI
@@ -47,6 +49,10 @@ internal class MapboxRouteLineComponentContract : RouteLineComponentContract {
     override fun getRouteInPreview(): Flow<List<NavigationRoute>?> {
         return flowOf(null)
     }
+
+    override fun onMapClicked(point: Point) {
+        // do nothing
+    }
 }
 
 @ExperimentalPreviewMapboxNavigationAPI
@@ -70,7 +76,7 @@ class RouteLineComponent(
 
     private val routeClickPadding = Utils.dpToPx(30f)
 
-    private var onMapClickListener = OnMapClickListener { point ->
+    private val onMapClickListener = OnMapClickListener { point ->
         mapboxNavigation?.also { selectRoute(it, point) }
         false
     }
@@ -144,23 +150,20 @@ class RouteLineComponent(
 
     private fun selectRoute(mapboxNavigation: MapboxNavigation, point: Point) {
         coroutineScope.launch {
-            val result = routeLineApi.findClosestRoute(
-                point,
-                mapboxMap,
-                routeClickPadding
-            )
-
-            result.onValue { resultValue ->
-                if (resultValue.navigationRoute != routeLineApi.getPrimaryNavigationRoute()) {
-                    val reOrderedRoutes = routeLineApi.getNavigationRoutes()
-                        .filter { it != resultValue.navigationRoute }
-                        .toMutableList()
-                        .also {
-                            it.add(0, resultValue.navigationRoute)
+            routeLineApi.findClosestRoute(point, mapboxMap, routeClickPadding).fold(
+                { contractProvider.get().onMapClicked(point) },
+                { result ->
+                    if (result.navigationRoute != routeLineApi.getPrimaryNavigationRoute()) {
+                        val reOrderedRoutes = arrayListOf(result.navigationRoute)
+                        routeLineApi.getNavigationRoutes().filterTo(reOrderedRoutes) { route ->
+                            route != result.navigationRoute
                         }
-                    contractProvider.get().setRoutes(mapboxNavigation, reOrderedRoutes)
-                }
-            }
+                        contractProvider.get().setRoutes(mapboxNavigation, reOrderedRoutes)
+                    } else {
+                        contractProvider.get().onMapClicked(point)
+                    }
+                },
+            )
         }
     }