[maps-android] CPU affinity onsite fixes (#5404)

This PR includes 2 fixes:
* Executing `mapboxRenderer.resetThreadServiceType()` from main thread
since function should be called from owning thread.
* Exposing `MapView.scheduleThreadServiceTypeReset()`.

cc @mapbox/maps-android

---------

Co-authored-by: Peng Liu <[email protected]>
GitOrigin-RevId: cd5a7770e4081b9d271e500fb75d5d5ff079542c

Author: 2 people

CHANGELOG.md

@@ -9,6 +9,9 @@ Mapbox welcomes participation and contributions from everyone.
 
 
 # 11.14.0
+## Features ✨ and improvements 🏁
+* Added experimental `MapView.scheduleThreadServiceTypeReset()` to reset the renderer thread service type to Interactive. This experimental API is intended for edge cases involving custom lifecycle management or specific scenarios where the default lifecycle behavior is insufficient.
+
 ## Bug fixes 🐞
 * [compose] Avoid excessive debug logging on SourceState, which can result in Out Of Memory in extreme cases. Avoid appending geojson data in `GeoJsonSourceState.toString()` override.
 

maps-sdk/api/Release/metalava.txt

@@ -136,6 +136,7 @@ package com.mapbox.maps {
     method public final 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 @com.mapbox.maps.MapboxDelicateApi @com.mapbox.maps.MapboxExperimental public final void scheduleThreadServiceTypeReset();
     method public final void setDebugOptions(java.util.Set<com.mapbox.maps.debugoptions.MapViewDebugOptions>);
     method public void setMaximumFps(@IntRange(from=1L, to=kotlin.jvm.internal.IntCompanionObject.MAX_VALUE.toLong()) int fps);
     method public void setOnFpsChangedListener(com.mapbox.maps.renderer.OnFpsChangedListener listener);

maps-sdk/api/maps-sdk.api

@@ -138,6 +138,7 @@ public class com/mapbox/maps/MapView : android/widget/FrameLayout, com/mapbox/ma
 	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 final fun scheduleThreadServiceTypeReset ()V
 	public final fun setDebugOptions (Ljava/util/Set;)V
 	public fun setMaximumFps (I)V
 	public fun setOnFpsChangedListener (Lcom/mapbox/maps/renderer/OnFpsChangedListener;)V

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

@@ -524,6 +524,21 @@ open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable {
   @MapboxExperimental
   override fun removeWidget(widget: Widget) = mapController.removeWidget(widget)
 
+  /**
+   * Schedules a thread service type reset on the render thread after a specified delay.
+   * This method is called to ensure CPU affinity is properly set
+   * when coming back from background, addressing timing issues where CPU affinity
+   * might not be immediately available.
+   * **Note:** This is a delicate API that should only be used when you experience
+   * performance issues after returning from background. Improper usage may not
+   * provide any benefits or could potentially affect rendering performance.
+   */
+  @MapboxExperimental
+  @MapboxDelicateApi
+  fun scheduleThreadServiceTypeReset() {
+    mapController.renderer.renderThread.scheduleThreadServiceTypeReset()
+  }
+
   /**
    * Add an instance of [RendererSetupErrorListener].
    *

maps-sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderThread.kt

@@ -4,6 +4,8 @@ import android.opengl.EGL14
 import android.opengl.EGLContext
 import android.opengl.EGLSurface
 import android.opengl.GLES20
+import android.os.Handler
+import android.os.Looper
 import android.os.SystemClock
 import android.os.Trace
 import android.view.Choreographer
@@ -87,6 +89,13 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
   @OptIn(MapboxExperimental::class)
   internal var renderThreadStatsRecorder: RenderThreadStatsRecorder? = null
 
+  /**
+   * Handler for posting tasks to the main thread.
+   */
+  private val mainHandler by lazy {
+    Handler(Looper.getMainLooper())
+  }
+
   /**
    * We track moment when native renderer is prepared.
    */
@@ -708,21 +717,19 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
   }
 
   /**
-   * Schedules a resetThreadServiceType on the render thread after a specified delay.
-   * This method is called on resume to ensure CPU affinity is properly set
+   * Schedules a resetThreadServiceType on the main thread after a specified delay.
+   * This method is called to ensure CPU affinity is properly set
    * when coming back from background, addressing timing issues where CPU affinity
    * might not be immediately available.
    */
   @OptIn(MapboxExperimental::class)
   fun scheduleThreadServiceTypeReset() {
     logI(TAG, "Scheduling thread service type reset with delay")
-    postNonRenderEvent(
-      RenderEvent({
-        logI(TAG, "Executing thread service type reset")
-        mapboxRenderer.resetThreadServiceType()
-      }, false),
-      RESET_THREAD_SERVICE_TYPE_DELAY_MS
-    )
+    mainHandler.postDelayed({
+      // log current thread name to help debug
+      logI(TAG, "Executing thread service type reset from ${Thread.currentThread().name} thread")
+      mapboxRenderer.resetThreadServiceType()
+    }, RESET_THREAD_SERVICE_TYPE_DELAY_MS)
   }
 
   @UiThread

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

@@ -244,4 +244,15 @@ class MapViewTest {
     mapView.removeRendererSetupErrorListener(listener)
     verify { mapController.removeRendererSetupErrorListener(listener) }
   }
+
+  @OptIn(MapboxExperimental::class, MapboxDelicateApi::class)
+  @Test
+  fun scheduleThreadServiceTypeReset() {
+    val renderThread = mockk<com.mapbox.maps.renderer.MapboxRenderThread>(relaxUnitFun = true)
+    val renderer = mockk<com.mapbox.maps.renderer.MapboxRenderer>(relaxed = true)
+    every { mapController.renderer } returns renderer
+    every { renderer.renderThread } returns renderThread
+    mapView.scheduleThreadServiceTypeReset()
+    verify { renderThread.scheduleThreadServiceTypeReset() }
+  }
 }

maps-sdk/src/test/java/com/mapbox/maps/renderer/MapboxRenderThreadTest.kt

@@ -26,6 +26,7 @@ import org.robolectric.Shadows
 import org.robolectric.annotation.LooperMode
 import org.robolectric.shadows.ShadowChoreographer
 import org.robolectric.shadows.ShadowLog
+import org.robolectric.shadows.ShadowLooper
 import java.util.concurrent.CountDownLatch
 import java.util.concurrent.TimeUnit
 import java.util.concurrent.locks.Condition
@@ -1082,4 +1083,22 @@ class MapboxRenderThreadTest {
     idleHandler()
     every { logI(any(), any()) } answers { Log.i(firstArg(), secondArg()) }
   }
+
+  @OptIn(com.mapbox.maps.MapboxExperimental::class)
+  @Test
+  fun scheduleThreadServiceTypeResetCallsRendererOnMainThread() {
+    initRenderThread()
+
+    // Verify resetThreadServiceType was not called initially
+    verify(exactly = 0) { mapboxRenderer.resetThreadServiceType() }
+
+    // Schedule the thread service type reset
+    mapboxRenderThread.scheduleThreadServiceTypeReset()
+
+    // Advance time by the delay amount (300ms) and process delayed main thread tasks
+    ShadowLooper.runUiThreadTasksIncludingDelayedTasks()
+
+    // Verify that resetThreadServiceType was called exactly once on the renderer
+    verify(exactly = 1) { mapboxRenderer.resetThreadServiceType() }
+  }
 }