Extend MapSurface with createPlugin and removePlugin methods (#15000)

I'm making Android Auto integration great again. The last update was
made in 2023. I'm working on adding support for the new road camera
module.

Road Cameras are working as a [Map
Plugin](https://github.com/mapbox/mapbox-sdk/blob/6ad1970e3b9147cc4a5e28d080c430ee0a31d1bc/projects/navigation-android/roadcam-ui/src/main/java/com/mapbox/roadcam/ui/internal/RoadCamerasMapControllerImpl.kt#L425).

In Android Auto, we don't use MapView, but instead use MapSurface. This
PR adds the missing `createPlugin` and `removePlugin` methods to the
MapSurface class.

cc @mapbox/maps-android

cc @mapbox/navnative

GitOrigin-RevId: 3a5c56bb64d87e92644217991b9daaae121f1cf8

Author: stanis-k

maps-sdk/api/Release/metalava.txt

@@ -85,6 +85,7 @@ package com.mapbox.maps {
     method public void addRendererSetupErrorListener(com.mapbox.maps.renderer.RendererSetupErrorListener rendererSetupErrorListener);
     method @com.mapbox.maps.MapboxExperimental public void addWidget(com.mapbox.maps.renderer.widget.Widget widget);
     method @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public void clearMaximumFps();
+    method public void createPlugin(com.mapbox.maps.plugin.Plugin plugin);
     method public android.content.Context getContext();
     method public com.mapbox.maps.MapboxMap getMapboxMap();
     method @Deprecated @kotlin.jvm.JvmSynthetic public com.mapbox.maps.MapboxMap! getMapboxMap();
@@ -101,6 +102,7 @@ package com.mapbox.maps {
     method public boolean onTouchEvent(android.view.MotionEvent event);
     method public void queueEvent(Runnable event, boolean needRender);
     method @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public void removeOnMaximumFpsChangedListener(com.mapbox.maps.renderer.OnMaximumFpsChangedListener listener);
+    method public void removePlugin(String id);
     method public void removeRendererSetupErrorListener(com.mapbox.maps.renderer.RendererSetupErrorListener rendererSetupErrorListener);
     method @com.mapbox.maps.MapboxExperimental public boolean removeWidget(com.mapbox.maps.renderer.widget.Widget widget);
     method @MainThread public void setMaximumFps(int fps);

maps-sdk/api/maps-sdk.api

@@ -82,6 +82,7 @@ public final class com/mapbox/maps/MapSurface : com/mapbox/maps/MapControllable,
 	public fun addRendererSetupErrorListener (Lcom/mapbox/maps/renderer/RendererSetupErrorListener;)V
 	public fun addWidget (Lcom/mapbox/maps/renderer/widget/Widget;)V
 	public final fun clearMaximumFps ()V
+	public final fun createPlugin (Lcom/mapbox/maps/plugin/Plugin;)V
 	public final fun getContext ()Landroid/content/Context;
 	public fun getMapboxMap ()Lcom/mapbox/maps/MapboxMap;
 	public final synthetic fun getMapboxMapDeprecated ()Lcom/mapbox/maps/MapboxMap;
@@ -98,6 +99,7 @@ public final class com/mapbox/maps/MapSurface : com/mapbox/maps/MapControllable,
 	public fun onTouchEvent (Landroid/view/MotionEvent;)Z
 	public fun queueEvent (Ljava/lang/Runnable;Z)V
 	public final fun removeOnMaximumFpsChangedListener (Lcom/mapbox/maps/renderer/OnMaximumFpsChangedListener;)V
+	public final fun removePlugin (Ljava/lang/String;)V
 	public fun removeRendererSetupErrorListener (Lcom/mapbox/maps/renderer/RendererSetupErrorListener;)V
 	public fun removeWidget (Lcom/mapbox/maps/renderer/widget/Widget;)Z
 	public fun setMaximumFps (I)V

maps-sdk/src/main/java/com/mapbox/maps/MapSurface.kt

@@ -11,6 +11,7 @@ import androidx.annotation.RestrictTo
 import androidx.annotation.VisibleForTesting
 import androidx.annotation.VisibleForTesting.Companion.PRIVATE
 import com.mapbox.maps.plugin.MapPlugin
+import com.mapbox.maps.plugin.Plugin
 import com.mapbox.maps.plugin.delegates.MapPluginProviderDelegate
 import com.mapbox.maps.renderer.*
 import com.mapbox.maps.renderer.widget.Widget
@@ -346,7 +347,7 @@ class MapSurface : MapPluginProviderDelegate, MapControllable {
   /**
    * Add an instance of [RendererSetupErrorListener].
    *
-   * Please note that errors could be already reported from the renderer during [MapView] creation
+   * Please note that errors could be already reported from the renderer during [MapSurface] creation
    * before this method will be called - all accumulated renderer errors will be delivered.
    */
   override fun addRendererSetupErrorListener(rendererSetupErrorListener: RendererSetupErrorListener) {
@@ -360,6 +361,25 @@ class MapSurface : MapPluginProviderDelegate, MapControllable {
     mapController.removeRendererSetupErrorListener(rendererSetupErrorListener)
   }
 
+  /**
+   * Create a new plugin instance that will be added to the map.
+   * Only one instance of [Plugin.instance] with given [Plugin.id] can exist for given [MapSurface].
+   *
+   * @param plugin instance of [Plugin] that will be added to the [MapSurface].
+   */
+  fun createPlugin(
+    plugin: Plugin
+  ) = mapController.createPlugin(null, plugin)
+
+  /**
+   * Remove the plugin instance that will be removed from the map.
+   *
+   * Removing the plugin from [MapSurface] will result in [MapPlugin.cleanup] being called and existing
+   * events subscription cancelled.
+   *
+   * @param id the id of the plugin to be removed
+   */
+  fun removePlugin(id: String) = mapController.removePlugin(id)
   /**
    * Get the plugin instance.
    *

maps-sdk/src/test/java/com/mapbox/maps/MapSurfaceTest.kt

@@ -8,6 +8,7 @@ import android.view.MotionEvent
 import android.view.Surface
 import android.view.WindowManager
 import com.mapbox.maps.plugin.MapPlugin
+import com.mapbox.maps.plugin.Plugin
 import com.mapbox.maps.renderer.MapboxSurfaceRenderer
 import com.mapbox.maps.renderer.OnFpsChangedListener
 import com.mapbox.maps.renderer.RendererSetupErrorListener
@@ -264,6 +265,20 @@ class MapSurfaceTest {
     verifyOnce { mapController.removeRendererSetupErrorListener(listener) }
   }
 
+  @Test
+  fun createPlugin() {
+    every { mapController.createPlugin(any(), any()) } returns mockk()
+    val plugin = Plugin.Custom("id", mockk())
+    mapSurface.createPlugin(plugin)
+    verify { mapController.createPlugin(null, plugin) }
+  }
+
+  @Test
+  fun removePlugin() {
+    mapSurface.removePlugin("id")
+    verify { mapController.removePlugin("id") }
+  }
+
   @Test
   fun getPluginTest() {
     val pluginId = "no_such_plugin"

maps-sdk/src/test/java/com/mapbox/maps/MapViewTest.kt

@@ -218,6 +218,12 @@ class MapViewTest {
     verify { mapController.createPlugin(mapView, plugin) }
   }
 
+  @Test
+  fun removePlugin() {
+    mapView.removePlugin("id")
+    verify { mapController.removePlugin("id") }
+  }
+
   @Test
   fun getPlugin() {
     every { mapController.getPlugin<MapPlugin>(any()) } returns mockk()