[MAPSAND-2981] Make RenderThreadStatsRecorder thread safe and owned by each map (#20562)

GitOrigin-RevId: 4dc3d006ad710bd53edf7c233019c45ef1c54b85

Author: jush

CHANGELOG.md

@@ -5,11 +5,17 @@ Mapbox welcomes participation and contributions from everyone.
 > **16 KB Page Size Support:** Starting with version 11.7.0 and 10.19.0, **NDK 27 is supported** with dedicated artifacts that include [support for 16 KB page sizes](https://developer.android.com/guide/practices/page-sizes). If your app does not require 16 KB page size support, you can keep using our default artifacts without `-ndk27` suffix. For more information about our NDK support, see https://docs.mapbox.com/android/maps/guides/#ndk-support
 
 # main
+## Breaking changes ⚠️
+* Remove the deprecated experimental `RenderThreadStats.totalDroppedFrames`. Use `totalSkippedVsync` instead, which holds the same value.
+* Replace the experimental `setRenderThreadStatsRecorder()` with a `renderThreadStatsRecorder` property on `MapView` and `MapSurface`. Each map now owns its recorder, and the `RenderThreadStatsRecorder` constructor is no longer public.
+* Rename the experimental `RenderThreadStatsRecorder.end()` to `stop()`, to match `start()`.
+
 ## Features ✨ and improvements 🏁
 * [compose] Add `showHdRoads` and `colorHdRoads` configuration options to the Standard style.
 
 ## Bug fixes 🐞
 * Fix a native crash that could occur when the app went to background or the `MapView` was detached while the map was still rendering.
+* Fix a race in the experimental `RenderThreadStatsRecorder` where calling `stop()` while the map was rendering could return inconsistent stats or carry frames over into the next recording session. Recording never makes the render thread wait.
 
 
 ## Bug fixes 🐞

app/src/main/java/com/mapbox/maps/testapp/examples/SimulateNavigationRouteActivity.kt

@@ -13,7 +13,6 @@ import com.mapbox.maps.MapboxExperimental
 import com.mapbox.maps.dsl.cameraOptions
 import com.mapbox.maps.logI
 import com.mapbox.maps.renderer.RenderThreadStats
-import com.mapbox.maps.renderer.RenderThreadStatsRecorder
 import com.mapbox.maps.testapp.examples.SimulateNavigationRouteActivity.Companion.SIMULATION_DURATION
 import com.mapbox.maps.testapp.examples.annotation.AnnotationUtils
 import com.mapbox.maps.testapp.utils.NavigationSimulator
@@ -61,8 +60,7 @@ class SimulateNavigationRouteActivity : AppCompatActivity() {
         )
       }
       repeat(repetitions) {
-        val renderThreadStatsRecorder = RenderThreadStatsRecorder()
-        mapView.setRenderThreadStatsRecorder(renderThreadStatsRecorder)
+        val renderThreadStatsRecorder = mapView.renderThreadStatsRecorder
         val navigationSimulator = NavigationSimulator(mapView, routePoints)
         navigationSimulator.disableGestures()
         renderThreadStatsRecorder.start()
@@ -78,7 +76,7 @@ class SimulateNavigationRouteActivity : AppCompatActivity() {
           }
         )
         delay(SIMULATION_DURATION)
-        logStats(renderThreadStatsRecorder.end())
+        logStats(renderThreadStatsRecorder.stop())
         navigationSimulator.onDestroy()
       }
       finish()

compose/compose-app/src/main/java/com/mapbox/maps/compose/testapp/utils/FrameStatsRecorder.kt

@@ -29,14 +29,13 @@ public class FrameStatsRecorder {
   private lateinit var recorder: RenderThreadStatsRecorder
   private var writeSummaryJob: Job = Job().apply { cancel() }
 
-  public fun register(mapView: MapView) {
-    recorder = RenderThreadStatsRecorder()
-    mapView.setRenderThreadStatsRecorder(recorder)
+  public fun start(mapView: MapView) {
+    recorder = mapView.renderThreadStatsRecorder
     recorder.start()
   }
 
   private fun getStatisticalModel(): JsonObject {
-    val stats = recorder.end()
+    val stats = recorder.stop()
     val jsonObject = JsonObject()
     // for TTRC SLAs no recorded render calls happen after "CreateMap" command
     // so we return an empty JSON
@@ -110,7 +109,7 @@ public class FrameStatsRecorder {
 public fun RecordFrameStats() {
   DisposableMapEffect(Unit) {
     val frameStatsRecorder = FrameStatsRecorder()
-    frameStatsRecorder.register(it)
+    frameStatsRecorder.start(it)
     onDispose {
       frameStatsRecorder.stop(it)
     }

maps-sdk/api/Release/metalava.txt

@@ -5,6 +5,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 public com.mapbox.maps.MapboxMap getMapboxMap();
+    method public com.mapbox.maps.renderer.RenderThreadStatsRecorder getRenderThreadStatsRecorder();
     method public boolean onGenericMotionEvent(android.view.MotionEvent event);
     method public void onSizeChanged(int w, int h);
     method public boolean onTouchEvent(android.view.MotionEvent event);
@@ -13,10 +14,10 @@ package com.mapbox.maps {
     method @com.mapbox.maps.MapboxExperimental public boolean removeWidget(com.mapbox.maps.renderer.widget.Widget widget);
     method @MainThread public void setMaximumFps(int fps);
     method public void setOnFpsChangedListener(com.mapbox.maps.renderer.OnFpsChangedListener listener);
-    method @com.mapbox.maps.MapboxExperimental public void setRenderThreadStatsRecorder(com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder);
     method public android.graphics.Bitmap? snapshot();
     method public void snapshot(com.mapbox.maps.MapView.OnSnapshotReady listener);
     property public abstract com.mapbox.maps.MapboxMap mapboxMap;
+    property public abstract com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder;
   }
 
   public final class MapInitOptions {
@@ -94,6 +95,7 @@ package com.mapbox.maps {
     method @Deprecated @kotlin.jvm.JvmSynthetic public com.mapbox.maps.MapboxMap! getMapboxMap();
     method @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public Integer? getMaximumFps();
     method public <T extends com.mapbox.maps.plugin.MapPlugin> T? getPlugin(String id);
+    method public com.mapbox.maps.renderer.RenderThreadStatsRecorder getRenderThreadStatsRecorder();
     method public android.view.Surface getSurface();
     method public void onDestroy();
     method public boolean onGenericMotionEvent(android.view.MotionEvent event);
@@ -110,7 +112,6 @@ package com.mapbox.maps {
     method @com.mapbox.maps.MapboxExperimental public boolean removeWidget(com.mapbox.maps.renderer.widget.Widget widget);
     method @MainThread public void setMaximumFps(int fps);
     method public void setOnFpsChangedListener(com.mapbox.maps.renderer.OnFpsChangedListener listener);
-    method @com.mapbox.maps.MapboxExperimental public void setRenderThreadStatsRecorder(com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder);
     method public android.graphics.Bitmap? snapshot();
     method public void snapshot(com.mapbox.maps.MapView.OnSnapshotReady listener);
     method public void surfaceChanged(int width, int height);
@@ -119,6 +120,7 @@ package com.mapbox.maps {
     property public final android.content.Context context;
     property public com.mapbox.maps.MapboxMap mapboxMap;
     property @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public final Integer? maximumFps;
+    property public com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder;
     property public final android.view.Surface surface;
   }
 
@@ -137,6 +139,7 @@ package com.mapbox.maps {
     method @Deprecated @kotlin.jvm.JvmSynthetic public com.mapbox.maps.MapboxMap! getMapboxMap();
     method @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public final Integer? getMaximumFps();
     method public <T extends com.mapbox.maps.plugin.MapPlugin> T? getPlugin(String id);
+    method public com.mapbox.maps.renderer.RenderThreadStatsRecorder getRenderThreadStatsRecorder();
     method public final com.mapbox.maps.viewannotation.ViewAnnotationManager getViewAnnotationManager();
     method public static final boolean isRenderingSupported();
     method public static final boolean isTerrainRenderingSupported();
@@ -156,13 +159,13 @@ package com.mapbox.maps {
     method public final void setDebugOptions(java.util.Set<com.mapbox.maps.debugoptions.MapViewDebugOptions>);
     method @MainThread 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);
-    method @com.mapbox.maps.MapboxExperimental public void setRenderThreadStatsRecorder(com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder);
     method @com.mapbox.maps.MapboxExperimental public final void setSnapshotLegacyMode(boolean enabled);
     method public android.graphics.Bitmap? snapshot();
     method public void snapshot(com.mapbox.maps.MapView.OnSnapshotReady listener);
     property public final java.util.Set<com.mapbox.maps.debugoptions.MapViewDebugOptions> debugOptions;
     property public com.mapbox.maps.MapboxMap mapboxMap;
     property @MainThread @RestrictTo(androidx.annotation.RestrictTo.Scope.LIBRARY_GROUP_PREFIX) public final Integer? maximumFps;
+    property public com.mapbox.maps.renderer.RenderThreadStatsRecorder renderThreadStatsRecorder;
     property public final com.mapbox.maps.viewannotation.ViewAnnotationManager viewAnnotationManager;
     field public static final com.mapbox.maps.MapView.Companion Companion;
   }
@@ -703,7 +706,6 @@ package com.mapbox.maps.renderer {
     method public Double? getPercentile90();
     method public Double? getPercentile95();
     method public Double? getPercentile99();
-    method @Deprecated public long getTotalDroppedFrames();
     method public long getTotalFrames();
     method public long getTotalSkippedVsync();
     method public long getTotalTime();
@@ -714,20 +716,21 @@ package com.mapbox.maps.renderer {
     property public final Double? percentile90;
     property public final Double? percentile95;
     property public final Double? percentile99;
-    property @Deprecated public final long totalDroppedFrames;
     property public final long totalFrames;
     property public final long totalSkippedVsync;
     property public final long totalTime;
   }
 
   @com.mapbox.maps.MapboxExperimental public final class RenderThreadStatsRecorder {
-    ctor public RenderThreadStatsRecorder();
-    method public com.mapbox.maps.renderer.RenderThreadStats end();
     method public boolean isRecording();
     method public void start();
+    method public com.mapbox.maps.renderer.RenderThreadStats stop();
     property public final boolean isRecording;
   }
 
+  public final class RenderThreadStatsRecorderKt {
+  }
+
   public final class RendererError {
     ctor public RendererError(int eglErrorCode);
     method public int getEglErrorCode();

maps-sdk/api/maps-sdk.api

@@ -2,6 +2,7 @@ public abstract interface class com/mapbox/maps/MapControllable : com/mapbox/map
 	public abstract fun addRendererSetupErrorListener (Lcom/mapbox/maps/renderer/RendererSetupErrorListener;)V
 	public abstract fun addWidget (Lcom/mapbox/maps/renderer/widget/Widget;)V
 	public abstract fun getMapboxMap ()Lcom/mapbox/maps/MapboxMap;
+	public abstract fun getRenderThreadStatsRecorder ()Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;
 	public abstract fun onGenericMotionEvent (Landroid/view/MotionEvent;)Z
 	public abstract fun onSizeChanged (II)V
 	public abstract fun onTouchEvent (Landroid/view/MotionEvent;)Z
@@ -10,7 +11,6 @@ public abstract interface class com/mapbox/maps/MapControllable : com/mapbox/map
 	public abstract fun removeWidget (Lcom/mapbox/maps/renderer/widget/Widget;)Z
 	public abstract fun setMaximumFps (I)V
 	public abstract fun setOnFpsChangedListener (Lcom/mapbox/maps/renderer/OnFpsChangedListener;)V
-	public abstract fun setRenderThreadStatsRecorder (Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;)V
 	public abstract fun snapshot ()Landroid/graphics/Bitmap;
 	public abstract fun snapshot (Lcom/mapbox/maps/MapView$OnSnapshotReady;)V
 }
@@ -90,6 +90,7 @@ public final class com/mapbox/maps/MapSurface : com/mapbox/maps/MapControllable,
 	public final synthetic fun getMapboxMapDeprecated ()Lcom/mapbox/maps/MapboxMap;
 	public final fun getMaximumFps ()Ljava/lang/Integer;
 	public fun getPlugin (Ljava/lang/String;)Lcom/mapbox/maps/plugin/MapPlugin;
+	public fun getRenderThreadStatsRecorder ()Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;
 	public final fun getSurface ()Landroid/view/Surface;
 	public fun onDestroy ()V
 	public fun onGenericMotionEvent (Landroid/view/MotionEvent;)Z
@@ -106,7 +107,6 @@ public final class com/mapbox/maps/MapSurface : com/mapbox/maps/MapControllable,
 	public fun removeWidget (Lcom/mapbox/maps/renderer/widget/Widget;)Z
 	public fun setMaximumFps (I)V
 	public fun setOnFpsChangedListener (Lcom/mapbox/maps/renderer/OnFpsChangedListener;)V
-	public fun setRenderThreadStatsRecorder (Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;)V
 	public fun snapshot ()Landroid/graphics/Bitmap;
 	public fun snapshot (Lcom/mapbox/maps/MapView$OnSnapshotReady;)V
 	public final fun surfaceChanged (II)V
@@ -132,6 +132,7 @@ public class com/mapbox/maps/MapView : android/widget/FrameLayout, com/mapbox/ma
 	public final synthetic fun getMapboxMapDeprecated ()Lcom/mapbox/maps/MapboxMap;
 	public final fun getMaximumFps ()Ljava/lang/Integer;
 	public fun getPlugin (Ljava/lang/String;)Lcom/mapbox/maps/plugin/MapPlugin;
+	public fun getRenderThreadStatsRecorder ()Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;
 	public final fun getViewAnnotationManager ()Lcom/mapbox/maps/viewannotation/ViewAnnotationManager;
 	public static final fun isRenderingSupported ()Z
 	public static final fun isTerrainRenderingSupported ()Z
@@ -155,7 +156,6 @@ public class com/mapbox/maps/MapView : android/widget/FrameLayout, com/mapbox/ma
 	public final fun setDebugOptions (Ljava/util/Set;)V
 	public fun setMaximumFps (I)V
 	public fun setOnFpsChangedListener (Lcom/mapbox/maps/renderer/OnFpsChangedListener;)V
-	public fun setRenderThreadStatsRecorder (Lcom/mapbox/maps/renderer/RenderThreadStatsRecorder;)V
 	public final fun setSnapshotLegacyMode (Z)V
 	public fun snapshot ()Landroid/graphics/Bitmap;
 	public fun snapshot (Lcom/mapbox/maps/MapView$OnSnapshotReady;)V
@@ -751,7 +751,7 @@ public abstract interface annotation class com/mapbox/maps/renderer/RenderThread
 }
 
 public final class com/mapbox/maps/renderer/RenderThreadStats {
-	public synthetic fun <init> (JJJJJJLjava/util/List;Ljava/lang/Double;Ljava/lang/Double;Ljava/lang/Double;Ljava/lang/Double;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (JJJJJLjava/util/List;Ljava/lang/Double;Ljava/lang/Double;Ljava/lang/Double;Ljava/lang/Double;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getFrameTimeList ()Ljava/util/List;
 	public final fun getMissedMapRenderFrames ()J
@@ -760,7 +760,6 @@ public final class com/mapbox/maps/renderer/RenderThreadStats {
 	public final fun getPercentile90 ()Ljava/lang/Double;
 	public final fun getPercentile95 ()Ljava/lang/Double;
 	public final fun getPercentile99 ()Ljava/lang/Double;
-	public final fun getTotalDroppedFrames ()J
 	public final fun getTotalFrames ()J
 	public final fun getTotalSkippedVsync ()J
 	public final fun getTotalTime ()J
@@ -769,10 +768,9 @@ public final class com/mapbox/maps/renderer/RenderThreadStats {
 }
 
 public final class com/mapbox/maps/renderer/RenderThreadStatsRecorder {
-	public fun <init> ()V
-	public final fun end ()Lcom/mapbox/maps/renderer/RenderThreadStats;
 	public final fun isRecording ()Z
 	public final fun start ()V
+	public final fun stop ()Lcom/mapbox/maps/renderer/RenderThreadStats;
 }
 
 public final class com/mapbox/maps/renderer/RendererError {

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

@@ -78,10 +78,11 @@ interface MapControllable : MapboxLifecycleObserver {
   fun setOnFpsChangedListener(listener: OnFpsChangedListener)
 
   /**
-   * Set [RenderThreadStatsRecorder] to record frame stats.
+   * The [RenderThreadStatsRecorder] of this map. Call [RenderThreadStatsRecorder.start] and
+   * [RenderThreadStatsRecorder.end] on it to record frame stats.
    */
   @MapboxExperimental
-  fun setRenderThreadStatsRecorder(renderThreadStatsRecorder: RenderThreadStatsRecorder)
+  val renderThreadStatsRecorder: RenderThreadStatsRecorder
 
   /**
    * Add [Widget] to the map.

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

@@ -324,9 +324,9 @@ internal class MapController : MapPluginProviderDelegate, MapControllable {
     renderer.setOnFpsChangedListener(listener)
   }
 
-  override fun setRenderThreadStatsRecorder(renderThreadStatsRecorder: RenderThreadStatsRecorder) {
-    renderer.renderThread.renderThreadStatsRecorder = renderThreadStatsRecorder
-  }
+  @MapboxExperimental
+  override val renderThreadStatsRecorder: RenderThreadStatsRecorder
+    get() = renderer.renderThread.renderThreadStatsRecorder
 
   @OptIn(MapboxExperimental::class)
   override fun addWidget(widget: Widget) {

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

@@ -283,12 +283,12 @@ class MapSurface : MapPluginProviderDelegate, MapControllable {
   }
 
   /**
-   * Set [RenderThreadStatsRecorder] to record frame stats.
+   * The [RenderThreadStatsRecorder] of this map. Call [RenderThreadStatsRecorder.start] and
+   * [RenderThreadStatsRecorder.end] on it to record frame stats.
    */
   @MapboxExperimental
-  override fun setRenderThreadStatsRecorder(renderThreadStatsRecorder: RenderThreadStatsRecorder) {
-    mapController.setRenderThreadStatsRecorder(renderThreadStatsRecorder)
-  }
+  override val renderThreadStatsRecorder: RenderThreadStatsRecorder
+    get() = mapController.renderThreadStatsRecorder
 
   /**
    * Called to resume rendering

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

@@ -588,12 +588,12 @@ open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable {
   }
 
   /**
-   * Set [RenderThreadStatsRecorder] to record frame stats.
+   * The [RenderThreadStatsRecorder] of this map. Call [RenderThreadStatsRecorder.start] and
+   * [RenderThreadStatsRecorder.end] on it to record frame stats.
    */
   @MapboxExperimental
-  override fun setRenderThreadStatsRecorder(renderThreadStatsRecorder: RenderThreadStatsRecorder) {
-    mapController.setRenderThreadStatsRecorder(renderThreadStatsRecorder)
-  }
+  override val renderThreadStatsRecorder: RenderThreadStatsRecorder
+    get() = mapController.renderThreadStatsRecorder
 
   /**
    * Add [Widget] to the map.