[maps-sdk] Add tracing instrumentation for render frame pipeline (#13517)

GitOrigin-RevId: 3f3edc61dd904863024c2ed073b181954eac7775

Author: jush

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

@@ -6,6 +6,7 @@ import androidx.annotation.RestrictTo
 import androidx.annotation.VisibleForTesting
 import com.mapbox.common.Cancelable
 import com.mapbox.common.MapboxOptions
+import com.mapbox.common.MapboxTracing
 import com.mapbox.maps.plugin.InvalidViewPluginHostException
 import com.mapbox.maps.plugin.MapPlugin
 import com.mapbox.maps.plugin.MapPluginRegistry
@@ -384,60 +385,62 @@ internal class MapController : MapPluginProviderDelegate, MapControllable {
     mapView: MapView? = null,
   ) {
     for (plugin in options.plugins) {
-      try {
-        val pluginObject = when (plugin.id) {
-          MAPBOX_GESTURES_PLUGIN_ID -> {
-            createGesturePlugin(options.context, options.attrs, options.mapOptions.pixelRatio)
+      MapboxTracing.traceSync({ "$MAPS_SDK_TRACE_PREFIX createPlugin: ${plugin.id}" }) {
+        try {
+          val pluginObject = when (plugin.id) {
+            MAPBOX_GESTURES_PLUGIN_ID -> {
+              createGesturePlugin(options.context, options.attrs, options.mapOptions.pixelRatio)
+            }
+            MAPBOX_CAMERA_PLUGIN_ID -> {
+              createCameraAnimationPlugin()
+            }
+            MAPBOX_ANNOTATION_PLUGIN_ID -> {
+              createAnnotationPlugin()
+            }
+            MAPBOX_COMPASS_PLUGIN_ID -> {
+              createCompassPlugin()
+            }
+            MAPBOX_ATTRIBUTION_PLUGIN_ID -> {
+              createAttributionPlugin()
+            }
+            MAPBOX_LIFECYCLE_PLUGIN_ID -> {
+              createLifecyclePlugin()
+            }
+            MAPBOX_LOCATION_COMPONENT_PLUGIN_ID -> {
+              createLocationComponentPlugin()
+            }
+            MAPBOX_LOGO_PLUGIN_ID -> {
+              createLogoPlugin()
+            }
+            MAPBOX_MAP_OVERLAY_PLUGIN_ID -> {
+              createOverlayPlugin()
+            }
+            MAPBOX_SCALEBAR_PLUGIN_ID -> {
+              createScaleBarPlugin()
+            }
+            MAPBOX_VIEWPORT_PLUGIN_ID -> {
+              createViewportPlugin()
+            }
+            MAPBOX_INDOOR_SELECTOR_PLUGIN_ID -> {
+              createIndoorSelectorPlugin()
+            }
+            else -> {
+              plugin.instance
+                ?: throw MapboxConfigurationException("Custom non Mapbox plugins must have non-null `instance` parameter!")
+            }
           }
-          MAPBOX_CAMERA_PLUGIN_ID -> {
-            createCameraAnimationPlugin()
-          }
-          MAPBOX_ANNOTATION_PLUGIN_ID -> {
-            createAnnotationPlugin()
-          }
-          MAPBOX_COMPASS_PLUGIN_ID -> {
-            createCompassPlugin()
-          }
-          MAPBOX_ATTRIBUTION_PLUGIN_ID -> {
-            createAttributionPlugin()
-          }
-          MAPBOX_LIFECYCLE_PLUGIN_ID -> {
-            createLifecyclePlugin()
-          }
-          MAPBOX_LOCATION_COMPONENT_PLUGIN_ID -> {
-            createLocationComponentPlugin()
-          }
-          MAPBOX_LOGO_PLUGIN_ID -> {
-            createLogoPlugin()
-          }
-          MAPBOX_MAP_OVERLAY_PLUGIN_ID -> {
-            createOverlayPlugin()
-          }
-          MAPBOX_SCALEBAR_PLUGIN_ID -> {
-            createScaleBarPlugin()
-          }
-          MAPBOX_VIEWPORT_PLUGIN_ID -> {
-            createViewportPlugin()
-          }
-          MAPBOX_INDOOR_SELECTOR_PLUGIN_ID -> {
-            createIndoorSelectorPlugin()
-          }
-          else -> {
-            plugin.instance
-              ?: throw MapboxConfigurationException("Custom non Mapbox plugins must have non-null `instance` parameter!")
-          }
-        }
-        createPlugin(mapView, Plugin.Custom(plugin.id, pluginObject))
-        if (plugin is Plugin.Mapbox) {
-          when (pluginObject) {
-            is CameraAnimationsPlugin -> mapboxMap.cameraAnimationsPlugin = pluginObject
-            is GesturesPlugin -> mapboxMap.gesturesPlugin = pluginObject
+          createPlugin(mapView, Plugin.Custom(plugin.id, pluginObject))
+          if (plugin is Plugin.Mapbox) {
+            when (pluginObject) {
+              is CameraAnimationsPlugin -> mapboxMap.cameraAnimationsPlugin = pluginObject
+              is GesturesPlugin -> mapboxMap.gesturesPlugin = pluginObject
+            }
           }
+        } catch (ex: NoClassDefFoundError) {
+          logI(TAG, PLUGIN_MISSING_TEMPLATE.format(plugin.id))
+        } catch (ex: InvalidViewPluginHostException) {
+          logI(TAG, VIEW_HIERARCHY_MISSING_TEMPLATE.format(plugin))
         }
-      } catch (ex: NoClassDefFoundError) {
-        logI(TAG, PLUGIN_MISSING_TEMPLATE.format(plugin.id))
-      } catch (ex: InvalidViewPluginHostException) {
-        logI(TAG, VIEW_HIERARCHY_MISSING_TEMPLATE.format(plugin))
       }
     }
   }

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

@@ -14,6 +14,7 @@ import androidx.annotation.IntRange
 import androidx.annotation.MainThread
 import androidx.annotation.RestrictTo
 import androidx.annotation.VisibleForTesting
+import com.mapbox.common.MapboxTracing
 import com.mapbox.maps.debugoptions.DebugOptionsController
 import com.mapbox.maps.debugoptions.MapViewDebugOptions
 import com.mapbox.maps.plugin.MapPlugin
@@ -118,42 +119,46 @@ open class MapView : FrameLayout, MapPluginProviderDelegate, MapControllable {
     defStyleRes: Int,
     initOptions: MapInitOptions?,
   ) : super(context, attrs, defStyleAttr, defStyleRes) {
-    val resolvedMapInitOptions = if (attrs != null) {
-      parseTypedArray(context, attrs)
-    } else {
-      initOptions ?: MapInitOptions(context)
-    }
-    if (isInEditMode) {
-      return
-    }
-    val view = if (resolvedMapInitOptions.textureView) {
-      TextureView(context, attrs)
-    } else {
-      SurfaceView(context, attrs)
+    MapboxTracing.traceSync("$MAPS_SDK_TRACE_PREFIX MapView") {
+      val resolvedMapInitOptions = if (attrs != null) {
+        parseTypedArray(context, attrs)
+      } else {
+        initOptions ?: MapInitOptions(context)
+      }
+      if (isInEditMode) {
+        return
+      }
+      val view = if (resolvedMapInitOptions.textureView) {
+        TextureView(context, attrs)
+      } else {
+        SurfaceView(context, attrs)
+      }
+      val contextMode = resolvedMapInitOptions.mapOptions.contextMode ?: ContextMode.UNIQUE
+      val mapName = resolvedMapInitOptions.mapName
+
+      val renderer = MapboxTracing.traceSync({ "$MAPS_SDK_TRACE_PREFIX renderer($mapName)" }) {
+        when (view) {
+          is SurfaceView -> MapboxSurfaceHolderRenderer(
+            view.holder,
+            resolvedMapInitOptions.antialiasingSampleCount,
+            contextMode,
+            resolvedMapInitOptions.mapName,
+          )
+
+          is TextureView -> MapboxTextureViewRenderer(
+            view,
+            resolvedMapInitOptions.antialiasingSampleCount,
+            contextMode,
+            resolvedMapInitOptions.mapName,
+          )
+
+          else -> throw IllegalArgumentException("Provided view has to be a texture or a surface.")
+        }
+      }
+      mapController = MapController(renderer, resolvedMapInitOptions)
+      addView(view, 0)
+      mapController.initializePlugins(resolvedMapInitOptions, this)
     }
-    val contextMode = resolvedMapInitOptions.mapOptions.contextMode ?: ContextMode.UNIQUE
-    mapController = MapController(
-      when (view) {
-        is SurfaceView -> MapboxSurfaceHolderRenderer(
-          view.holder,
-          resolvedMapInitOptions.antialiasingSampleCount,
-          contextMode,
-          resolvedMapInitOptions.mapName,
-        )
-
-        is TextureView -> MapboxTextureViewRenderer(
-          view,
-          resolvedMapInitOptions.antialiasingSampleCount,
-          contextMode,
-          resolvedMapInitOptions.mapName,
-        )
-
-        else -> throw IllegalArgumentException("Provided view has to be a texture or a surface.")
-      },
-      resolvedMapInitOptions
-    )
-    addView(view, 0)
-    mapController.initializePlugins(resolvedMapInitOptions, this)
   }
 
   override fun onAttachedToWindow() {