[Drop-In UI] Moved CameraModeButtonComponent outside Drop-In UI (#6202)

* NavigationCamera component + CameraMode component.
Unit tests for new components. Re-gen libnavui-maps Metalava API file.

* Regen libnavui-base Metalava API.

* CHAGELOG entry

* Static analysis fix.

Author: tomaszrybakiewicz

CHANGELOG.md

@@ -4,6 +4,9 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## Unreleased
 #### Features
+- Added `ComponentInstaller` for the `NavigationCameraComponent` that offers simplified integration of the `NavigationCamera`. [#6202](https://github.com/mapbox/mapbox-navigation-android/pull/6202)
+- Added `ComponentInstaller` for the `CameraModeButtonComponent` that offers simplified integration of the `NavigationCamera` mode button. [#6202](https://github.com/mapbox/mapbox-navigation-android/pull/6202)
+
 #### Bug fixes and improvements
 
 ## Mapbox Navigation SDK 2.8.0-alpha.3 - 17 August, 2022

libnavui-base/api/current.txt

@@ -12,9 +12,11 @@ package com.mapbox.navigation.ui.base.installer {
   @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public sealed interface ComponentInstaller {
     method public default com.mapbox.navigation.ui.base.installer.Installation component(com.mapbox.navigation.ui.base.lifecycle.UIComponent component);
     method public com.mapbox.navigation.ui.base.installer.Installation components(com.mapbox.navigation.ui.base.lifecycle.UIComponent... components);
+    method public <T> T? findComponent(kotlin.jvm.functions.Function1<java.lang.Object,java.lang.Boolean> predicate);
   }
 
   public final class ComponentInstallerKt {
+    method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public static inline <reified T> T! findComponent(com.mapbox.navigation.ui.base.installer.ComponentInstaller);
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public static void installComponents(com.mapbox.navigation.core.lifecycle.MapboxNavigationApp, androidx.lifecycle.LifecycleOwner lifecycleOwner, kotlin.jvm.functions.Function1<? super com.mapbox.navigation.ui.base.installer.ComponentInstaller,kotlin.Unit> config);
     method @com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI public static void installComponents(com.mapbox.navigation.core.MapboxNavigation, androidx.lifecycle.LifecycleOwner lifecycleOwner, kotlin.jvm.functions.Function1<? super com.mapbox.navigation.ui.base.installer.ComponentInstaller,kotlin.Unit> config);
   }

libnavui-base/src/main/java/com/mapbox/navigation/ui/base/installer/ComponentInstaller.kt

@@ -24,6 +24,11 @@ sealed interface ComponentInstaller {
      * Install multiple UIComponents and manage their lifecycle alongside MapboxNavigation lifecycle.
      */
     fun components(vararg components: UIComponent): Installation
+
+    /**
+     * Find installed component that matches given [predicate].
+     */
+    fun <T> findComponent(predicate: (Any) -> Boolean): T?
 }
 
 /**
@@ -126,4 +131,18 @@ internal class NavigationComponents(
         componentsChain.addAll(*components)
         return Installation { componentsChain.removeAndDetach(*components) }
     }
+
+    override fun <T> findComponent(predicate: (Any) -> Boolean): T? {
+        return componentsChain.toList().firstOrNull(predicate) as? T
+    }
+}
+
+/**
+ * Find installed component of type T.
+ *
+ * Shorthand for `findComponent { it is T } as? T`
+ */
+@ExperimentalPreviewMapboxNavigationAPI
+inline fun <reified T> ComponentInstaller.findComponent(): T? {
+    return findComponent { it is T } as? T
 }

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

@@ -13,14 +13,15 @@ import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
 import com.mapbox.navigation.dropin.ActionButtonDescription
 import com.mapbox.navigation.dropin.NavigationViewContext
 import com.mapbox.navigation.dropin.R
-import com.mapbox.navigation.dropin.component.cameramode.CameraModeButtonComponent
+import com.mapbox.navigation.dropin.component.cameramode.CameraModeButtonComponentContractImpl
 import com.mapbox.navigation.dropin.component.recenter.RecenterButtonComponentContractImpl
 import com.mapbox.navigation.dropin.databinding.MapboxActionButtonsLayoutBinding
 import com.mapbox.navigation.dropin.internal.extensions.reloadOnChange
 import com.mapbox.navigation.ui.app.internal.Store
 import com.mapbox.navigation.ui.app.internal.audioguidance.AudioAction
 import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
+import com.mapbox.navigation.ui.maps.internal.ui.CameraModeButtonComponent
 import com.mapbox.navigation.ui.maps.internal.ui.RecenterButtonComponent
 import com.mapbox.navigation.ui.voice.internal.ui.AudioComponentContract
 import com.mapbox.navigation.ui.voice.internal.ui.AudioGuidanceButtonComponent
@@ -43,11 +44,7 @@ internal class ActionButtonBinder(
                 audioGuidanceButtonComponent(binding, style, store)
             },
             reloadOnChange(context.styles.cameraModeButtonStyle) { style ->
-                CameraModeButtonComponent(
-                    store = store,
-                    cameraModeButton = binding.cameraModeButton,
-                    cameraModeStyle = style
-                )
+                cameraModeButtonComponent(binding, style, store)
             },
             reloadOnChange(context.styles.recenterButtonStyle) { style ->
                 recenterButtonComponent(binding, style, store)
@@ -91,6 +88,16 @@ internal class ActionButtonBinder(
         })
     }
 
+    private fun cameraModeButtonComponent(
+        binding: MapboxActionButtonsLayoutBinding,
+        style: Int,
+        store: Store
+    ): CameraModeButtonComponent {
+        return CameraModeButtonComponent(binding.cameraModeButton, contractProvider = {
+            CameraModeButtonComponentContractImpl(context.viewModel.viewModelScope, store)
+        }, style)
+    }
+
     private fun recenterButtonComponent(
         binding: MapboxActionButtonsLayoutBinding,
         style: Int,

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/cameramode/CameraModeButtonComponent.kt

@@ -0,0 +1,46 @@
+package com.mapbox.navigation.dropin.component.cameramode
+
+import android.view.View
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.ui.app.internal.Store
+import com.mapbox.navigation.ui.app.internal.camera.CameraAction
+import com.mapbox.navigation.ui.app.internal.camera.TargetCameraMode
+import com.mapbox.navigation.ui.app.internal.camera.toNavigationCameraState
+import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
+import com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState
+import com.mapbox.navigation.ui.maps.internal.ui.CameraModeButtonComponentContract
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.flow.StateFlow
+
+@ExperimentalPreviewMapboxNavigationAPI
+internal class CameraModeButtonComponentContractImpl(
+    coroutineScope: CoroutineScope,
+    private val store: Store
+) : CameraModeButtonComponentContract {
+
+    override val buttonState: StateFlow<NavigationCameraState> =
+        store.slice(coroutineScope) { state ->
+            val cameraState = state.camera
+            if (cameraState.cameraMode == TargetCameraMode.Idle) {
+                cameraState.savedCameraMode.toNavigationCameraState()
+            } else {
+                cameraState.cameraMode.toNavigationCameraState()
+            }
+        }
+
+    override val isVisible: StateFlow<Boolean> =
+        store.slice(coroutineScope) { it.navigation != NavigationState.RoutePreview }
+
+    override fun onClick(view: View) {
+        val cameraMode = store.state.value.camera.cameraMode.let {
+            if (it != TargetCameraMode.Idle) it
+            else store.state.value.camera.savedCameraMode
+        }
+        when (cameraMode) {
+            TargetCameraMode.Following ->
+                store.dispatch(CameraAction.SetCameraMode(TargetCameraMode.Overview))
+            else ->
+                store.dispatch(CameraAction.SetCameraMode(TargetCameraMode.Following))
+        }
+    }
+}

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/cameramode/CameraModeButtonComponentContractImpl.kt

@@ -0,0 +1,147 @@
+package com.mapbox.navigation.dropin.component.cameramode
+
+import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.dropin.util.TestStore
+import com.mapbox.navigation.testing.MainCoroutineRule
+import com.mapbox.navigation.ui.app.internal.camera.CameraAction
+import com.mapbox.navigation.ui.app.internal.camera.TargetCameraMode
+import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
+import com.mapbox.navigation.ui.maps.camera.state.NavigationCameraState
+import com.mapbox.navigation.ui.maps.internal.ui.CameraModeButtonComponentContract
+import io.mockk.mockk
+import io.mockk.spyk
+import io.mockk.verify
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.flow.take
+import kotlinx.coroutines.flow.toList
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.runBlockingTest
+import kotlinx.coroutines.yield
+import org.junit.Assert.assertEquals
+import org.junit.Before
+import org.junit.Rule
+import org.junit.Test
+
+@OptIn(ExperimentalPreviewMapboxNavigationAPI::class, ExperimentalCoroutinesApi::class)
+class CameraModeButtonComponentContractImplTest {
+
+    @get:Rule
+    var coroutineRule = MainCoroutineRule()
+
+    private lateinit var mockMapboxNavigation: MapboxNavigation
+    private lateinit var testStore: TestStore
+
+    private lateinit var sut: CameraModeButtonComponentContract
+
+    @Before
+    fun setUp() {
+        testStore = spyk(TestStore())
+        mockMapboxNavigation = mockk(relaxed = true)
+        sut = CameraModeButtonComponentContractImpl(
+            coroutineRule.coroutineScope,
+            testStore,
+        )
+    }
+
+    @Test
+    fun `buttonState should map TargetCameraMode to NavigationCameraState`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(camera = it.camera.copy(cameraMode = TargetCameraMode.Following))
+        }
+        val buttonStates = mutableListOf<NavigationCameraState>()
+        val job = launch {
+            sut.buttonState.take(2).toList(buttonStates)
+            yield()
+        }
+        testStore.updateState {
+            it.copy(camera = it.camera.copy(cameraMode = TargetCameraMode.Overview))
+        }
+
+        job.join()
+        assertEquals(
+            listOf(NavigationCameraState.FOLLOWING, NavigationCameraState.OVERVIEW),
+            buttonStates
+        )
+    }
+
+    @Test
+    fun `buttonState when TargetCameraMode is Idle should return saved state`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(
+                camera = it.camera.copy(
+                    cameraMode = TargetCameraMode.Idle,
+                    savedCameraMode = TargetCameraMode.Following,
+                )
+            )
+        }
+
+        val navCamState = sut.buttonState.take(1).toList().first()
+
+        assertEquals(NavigationCameraState.FOLLOWING, navCamState)
+    }
+
+    @Test
+    fun `isVisible use NavigationState to determine visibility`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(navigation = NavigationState.RoutePreview)
+        }
+        val visibility = mutableListOf<Boolean>()
+        val job = launch {
+            sut.isVisible.take(2).toList(visibility)
+            yield()
+        }
+        testStore.updateState {
+            it.copy(navigation = NavigationState.ActiveNavigation)
+        }
+
+        job.join()
+        assertEquals(listOf(false, true), visibility)
+    }
+
+    @Test
+    fun `onClick should request Overview mode current is Following`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(
+                camera = it.camera.copy(
+                    cameraMode = TargetCameraMode.Following
+                )
+            )
+        }
+
+        sut.onClick(mockk())
+
+        verify { testStore.dispatch(CameraAction.SetCameraMode(TargetCameraMode.Overview)) }
+    }
+
+    @Test
+    fun `onClick should request Following mode current is Overview`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(
+                camera = it.camera.copy(
+                    cameraMode = TargetCameraMode.Overview
+                )
+            )
+        }
+
+        sut.onClick(mockk())
+
+        verify { testStore.dispatch(CameraAction.SetCameraMode(TargetCameraMode.Following)) }
+    }
+
+    @Test
+    fun `onClick should use savedCameraMode mode value when current is Idle`() = runBlockingTest {
+        testStore.updateState {
+            it.copy(
+                camera = it.camera.copy(
+                    cameraMode = TargetCameraMode.Idle,
+                    savedCameraMode = TargetCameraMode.Overview,
+                )
+            )
+        }
+
+        sut.onClick(mockk())
+
+        verify { testStore.dispatch(CameraAction.SetCameraMode(TargetCameraMode.Following)) }
+    }
+}