[maps-android] add delay before calling resetThreadServiceType + handle onResume (#4975)

natiginfo · github-actions[bot] · commit d099d830aefc · 2025-07-08T10:05:51.000Z
GitOrigin-RevId: 855abf51f8b147193cbff5280a8839cc83decc99
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ Mapbox welcomes participation and contributions from everyone.
 # 11.14.0-rc.1
 ## Features ✨ and improvements 🏁
 * Added `setContentDescription()` method to `AttributionPlugin` and `AttributionView` interfaces to programmatically set accessibility content description for the attribution button.
+* Added `MapView.onResume()` which should be called in `onResume()` of the host activity or fragment to resume the map view if `plugin-lifecycle` is not used.
 
 ## Bug fixes 🐞
 * Fix exception when accessing enum properties in annotations.
diff --git a/extension-compose/src/main/java/com/mapbox/maps/extension/compose/internal/MapViewLifecycle.kt b/extension-compose/src/main/java/com/mapbox/maps/extension/compose/internal/MapViewLifecycle.kt
@@ -53,11 +53,12 @@ internal fun MapViewLifecycle(mapView: MapView) {
 private fun MapView.lifecycleEventObserver(): LifecycleEventObserver =
   LifecycleEventObserver { _, event ->
     when (event) {
-      Lifecycle.Event.ON_CREATE, Lifecycle.Event.ON_PAUSE, Lifecycle.Event.ON_RESUME, Lifecycle.Event.ON_DESTROY -> {
+      Lifecycle.Event.ON_CREATE, Lifecycle.Event.ON_PAUSE, Lifecycle.Event.ON_DESTROY -> {
         // no-ops, onDestroy handled in DisposeEffect.onDispose
       }
       Lifecycle.Event.ON_START -> this.onStart()
       Lifecycle.Event.ON_STOP -> this.onStop()
+      Lifecycle.Event.ON_RESUME -> this.onResume()
 
       else -> throw IllegalStateException()
     }
diff --git a/maps-sdk/api/Release/metalava.txt b/maps-sdk/api/Release/metalava.txt
@@ -90,6 +90,7 @@ package com.mapbox.maps {
     method public void onDestroy();
     method public boolean onGenericMotionEvent(android.view.MotionEvent event);
     method public void onLowMemory();
+    method public void onResume();
     method public void onSizeChanged(int w, int h);
     method public void onStart();
     method public void onStop();
@@ -126,6 +127,7 @@ package com.mapbox.maps {
     method public static final boolean isTerrainRenderingSupported();
     method public void onDestroy();
     method public void onLowMemory();
+    method public void onResume();
     method public void onSizeChanged(int w, int h, int oldw, int oldh);
     method public void onSizeChanged(int w, int h);
     method public void onStart();
diff --git a/maps-sdk/api/maps-sdk.api b/maps-sdk/api/maps-sdk.api
@@ -86,6 +86,7 @@ public final class com/mapbox/maps/MapSurface : com/mapbox/maps/MapControllable,
 	public fun onDestroy ()V
 	public fun onGenericMotionEvent (Landroid/view/MotionEvent;)Z
 	public fun onLowMemory ()V
+	public fun onResume ()V
 	public fun onSizeChanged (II)V
 	public fun onStart ()V
 	public fun onStop ()V
@@ -126,6 +127,7 @@ public class com/mapbox/maps/MapView : android/widget/FrameLayout, com/mapbox/ma
 	public fun onGenericMotionEvent (Landroid/view/MotionEvent;)Z
 	public fun onInterceptTouchEvent (Landroid/view/MotionEvent;)Z
 	public fun onLowMemory ()V
+	public fun onResume ()V
 	public fun onSizeChanged (II)V
 	public fun onSizeChanged (IIII)V
 	public fun onStart ()V
diff --git a/maps-sdk/src/main/java/com/mapbox/maps/MapController.kt b/maps-sdk/src/main/java/com/mapbox/maps/MapController.kt
@@ -198,6 +198,10 @@ internal class MapController : MapPluginProviderDelegate, MapControllable {
     MapProvider.flushPendingEvents()
   }
 
+  override fun onResume() {
+    renderer.onResume()
+  }
+
   override fun onDestroy() {
     if (lifecycleState == LifecycleState.STATE_DESTROYED) {
       return
diff --git a/maps-sdk/src/main/java/com/mapbox/maps/MapSurface.kt b/maps-sdk/src/main/java/com/mapbox/maps/MapSurface.kt
@@ -229,6 +229,13 @@ class MapSurface : MapPluginProviderDelegate, MapControllable {
     mapController.onStop()
   }
 
+  /**
+   * Called when the activity is resumed
+   */
+  override fun onResume() {
+    mapController.onResume()
+  }
+
   /**
    * Called to dispose the renderer
    */
diff --git a/maps-sdk/src/main/java/com/mapbox/maps/MapView.kt b/maps-sdk/src/main/java/com/mapbox/maps/MapView.kt
@@ -249,6 +249,15 @@ open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable {
     }
   }
 
+  /**
+   * You must call this method from the parent's Activity#onResume() or Fragment#onResume()
+   * @see android.app.Activity.onResume
+   * @see android.app.Fragment.onResume
+   */
+  override fun onResume() {
+    mapController.onResume()
+  }
+
   /**
    * You must call this method from the parent's Activity#onLowMemory() or Fragment#onLowMemory()
    * @see android.app.Activity.onLowMemory
diff --git a/maps-sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderThread.kt b/maps-sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderThread.kt
@@ -24,6 +24,10 @@ import com.mapbox.maps.renderer.gl.TextureRenderer
 import com.mapbox.maps.renderer.widget.Widget
 import com.mapbox.maps.viewannotation.ViewAnnotationManager
 import com.mapbox.maps.viewannotation.ViewAnnotationUpdateMode
+import kotlinx.coroutines.DelicateCoroutinesApi
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.launch
 import java.util.concurrent.ConcurrentLinkedQueue
 import java.util.concurrent.locks.Condition
 import java.util.concurrent.locks.ReentrantLock
@@ -713,11 +717,15 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
     logI(TAG, "Renderer paused")
   }
 
+  @OptIn(DelicateCoroutinesApi::class)
   @UiThread
   fun resume() {
     paused = false
     logI(TAG, "Renderer resumed, renderThreadPrepared=$renderThreadPrepared, surface.isValid=${surface?.isValid}")
-    mapboxRenderer.resetThreadServiceType()
+    GlobalScope.launch {
+      delay(RESET_THREAD_SERVICE_TYPE_DELAY_MS)
+      mapboxRenderer.resetThreadServiceType()
+    }
     // schedule render if we resume not after first create (e.g. bring map back to front)
     renderPreparedGuardedRun(::postPrepareRenderFrame)
   }
@@ -787,5 +795,11 @@ internal class MapboxRenderThread : Choreographer.FrameCallback {
      * rescheduling configuration with that delay in order not to overflood handler thread message queue.
      */
     internal const val RETRY_DELAY_MS = 50L
+    /**
+     * Delay before calling resetThreadServiceType() on resume to ensure CPU affinity is properly set.
+     * This delay helps address timing issues where CPU affinity might not be set immediately
+     * when coming back from background.
+     */
+    internal const val RESET_THREAD_SERVICE_TYPE_DELAY_MS = 300L
   }
 }
diff --git a/maps-sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderer.kt b/maps-sdk/src/main/java/com/mapbox/maps/renderer/MapboxRenderer.kt
@@ -145,6 +145,11 @@ internal abstract class MapboxRenderer(mapName: String) : DelegatingMapClient {
     renderFrameCancelable = map?.subscribe(renderFrameFinishedCallback)
   }
 
+  @UiThread
+  fun onResume() {
+    renderThread.resume()
+  }
+
   @RenderThread
   fun snapshot(): Bitmap? {
     if (!readyForSnapshot.get()) {
diff --git a/maps-sdk/src/test/java/com/mapbox/maps/MapControllerTest.kt b/maps-sdk/src/test/java/com/mapbox/maps/MapControllerTest.kt
@@ -144,6 +144,17 @@ class MapControllerTest {
     }
   }
 
+  @Test
+  fun onResume() {
+    every { mockRenderer.onResume() } just Runs
+
+    testMapController.onResume()
+
+    verifySequence {
+      mockRenderer.onResume()
+    }
+  }
+
   @OptIn(com.mapbox.annotation.MapboxExperimental::class)
   @Test
   fun onStartDeliversUpdatedStyle() {
diff --git a/maps-sdk/src/test/java/com/mapbox/maps/MapViewTest.kt b/maps-sdk/src/test/java/com/mapbox/maps/MapViewTest.kt
@@ -57,6 +57,12 @@ class MapViewTest {
     verify { mapController.onStop() }
   }
 
+  @Test
+  fun resume() {
+    mapView.onResume()
+    verify { mapController.onResume() }
+  }
+
   @Test
   fun onDestroy() {
     mapView.onDestroy()
diff --git a/maps-sdk/src/test/java/com/mapbox/maps/renderer/MapboxRendererTest.kt b/maps-sdk/src/test/java/com/mapbox/maps/renderer/MapboxRendererTest.kt
@@ -75,6 +75,12 @@ internal abstract class MapboxRendererTest {
     verify { renderThread.pause() }
   }
 
+  @Test
+  fun onResumeTest() {
+    mapboxRenderer.onResume()
+    verify { renderThread.resume() }
+  }
+
   @Test
   fun setValidMaximumFpsTest() {
     mapboxRenderer.setMaximumFps(10)
diff --git a/plugin-lifecycle-lint-rules/src/main/java/com/mapbox/maps/lint/lifecycle/LifecycleMethodDetector.kt b/plugin-lifecycle-lint-rules/src/main/java/com/mapbox/maps/lint/lifecycle/LifecycleMethodDetector.kt
@@ -23,13 +23,14 @@ class LifecycleMethodDetector : Detector(), Detector.UastScanner {
   companion object Issues {
     private const val ON_START = "onStart"
     private const val ON_STOP = "onStop"
+    private const val ON_PAUSE = "onPause"
     private const val ON_DESTROY = "onDestroy"
     private const val ON_LOW_MEMORY = "onLowMemory"
     private const val ISSUE_ID = "Lifecycle"
     private const val BRIEF_DESCRIPTION = "Redundant method call"
     private const val PRIORITY = 8
     private const val REPORT_MESSAGE =
-      "It's no longer required to manually invoke onStart/onStop/onDestroy/onLowMemory MapView lifecycle methods explicitly. The Mapbox Maps SDK for Android depends on the plugin-lifecycle that leverages androidx.lifecycle to make the MapView a lifecycle aware component. This behavior is automatically enforced when appcompact 1.3.0+ is used. The plugin-lifecycle can be removed from class path to opt-out of the associated behavior."
+      "It's no longer required to manually invoke onStart/onStop/onPause/onDestroy/onLowMemory MapView lifecycle methods explicitly. The Mapbox Maps SDK for Android depends on the plugin-lifecycle that leverages androidx.lifecycle to make the MapView a lifecycle aware component. This behavior is automatically enforced when appcompact 1.3.0+ is used. The plugin-lifecycle can be removed from class path to opt-out of the associated behavior."
 
     private val IMPLEMENTATION = Implementation(
       LifecycleMethodDetector::class.java, Scope.JAVA_FILE_SCOPE
diff --git a/plugin-lifecycle/README.md b/plugin-lifecycle/README.md
@@ -2,7 +2,7 @@
 
 ### Overview
 
-The Mapbox Maps Lifecycle Plugin for Android is an public library for handling Lifecycle events of the Mapbox SDK MapView. By default, the Lifecycle Plugin will automatically hook into the lifecycle events(onStart/onStop/onDestroy) of the host Activity or Fragment, so that developers don't need to invoke the corresponding lifecycle methods of MapView manually themselves.
+The Mapbox Maps Lifecycle Plugin for Android is an public library for handling Lifecycle events of the Mapbox SDK MapView. By default, the Lifecycle Plugin will automatically hook into the lifecycle events(onStart/onStop/onResume/onDestroy) of the host Activity or Fragment, so that developers don't need to invoke the corresponding lifecycle methods of MapView manually themselves.
 
 A full overview of classes and interfaces can be found in our [API documentation](https://docs.mapbox.com/android/beta/maps/guides/).
 
diff --git a/plugin-lifecycle/src/main/java/com/mapbox/maps/plugin/lifecycle/MapboxLifecyclePluginImpl.kt b/plugin-lifecycle/src/main/java/com/mapbox/maps/plugin/lifecycle/MapboxLifecyclePluginImpl.kt
@@ -13,6 +13,7 @@ import android.view.View
 import androidx.annotation.RestrictTo
 import androidx.lifecycle.*
 import com.mapbox.maps.MapboxLifecycleObserver
+import com.mapbox.maps.logI
 import com.mapbox.maps.logW
 
 /**
@@ -55,6 +56,7 @@ internal class MapboxLifecyclePluginImpl : MapboxLifecyclePlugin {
       object : LifecycleObserver {
         @OnLifecycleEvent(Lifecycle.Event.ON_START)
         fun onStart() {
+          logI(TAG, "onStart is called, MapboxLifecycleObserver will be notified.")
           observer.onStart()
         }
 
@@ -63,6 +65,12 @@ internal class MapboxLifecyclePluginImpl : MapboxLifecyclePlugin {
           observer.onStop()
         }
 
+        @OnLifecycleEvent(Lifecycle.Event.ON_RESUME)
+        fun onResume() {
+          logI(TAG, "onResume is called, MapboxLifecycleObserver will be notified.")
+          observer.onResume()
+        }
+
         @OnLifecycleEvent(Lifecycle.Event.ON_DESTROY)
         fun onDestroy() {
           observer.onDestroy()
diff --git a/sdk-base/api/Release/metalava.txt b/sdk-base/api/Release/metalava.txt
@@ -121,6 +121,7 @@ package com.mapbox.maps {
   public interface MapboxLifecycleObserver {
     method public void onDestroy();
     method public void onLowMemory();
+    method public void onResume();
     method public void onStart();
     method public void onStop();
   }
diff --git a/sdk-base/api/sdk-base.api b/sdk-base/api/sdk-base.api
@@ -141,6 +141,7 @@ public abstract interface annotation class com/mapbox/maps/MapboxExperimental :
 public abstract interface class com/mapbox/maps/MapboxLifecycleObserver {
 	public abstract fun onDestroy ()V
 	public abstract fun onLowMemory ()V
+	public abstract fun onResume ()V
 	public abstract fun onStart ()V
 	public abstract fun onStop ()V
 }
diff --git a/sdk-base/src/main/java/com/mapbox/maps/MapboxLifecycleObserver.kt b/sdk-base/src/main/java/com/mapbox/maps/MapboxLifecycleObserver.kt
@@ -23,4 +23,9 @@ interface MapboxLifecycleObserver {
    * Called to reduce memory use
    */
   fun onLowMemory()
+
+  /**
+   * Called when the activity is resumed
+   */
+  fun onResume()
 }

Original file line number	Diff line number	Diff line change
`@@ -53,11 +53,12 @@ internal fun MapViewLifecycle(mapView: MapView) {`
`53`	`53`	`private fun MapView.lifecycleEventObserver(): LifecycleEventObserver =`
`54`	`54`	`LifecycleEventObserver { _, event ->`
`55`	`55`	`when (event) {`
`56`		`- Lifecycle.Event.ON_CREATE, Lifecycle.Event.ON_PAUSE, Lifecycle.Event.ON_RESUME, Lifecycle.Event.ON_DESTROY -> {`
	`56`	`+ Lifecycle.Event.ON_CREATE, Lifecycle.Event.ON_PAUSE, Lifecycle.Event.ON_DESTROY -> {`
`57`	`57`	`// no-ops, onDestroy handled in DisposeEffect.onDispose`
`58`	`58`	`}`
`59`	`59`	`Lifecycle.Event.ON_START -> this.onStart()`
`60`	`60`	`Lifecycle.Event.ON_STOP -> this.onStop()`
	`61`	`+ Lifecycle.Event.ON_RESUME -> this.onResume()`
`61`	`62`
`62`	`63`	`else -> throw IllegalStateException()`
`63`	`64`	`}`