Remove unnecessary checks for mapbox tracing, improved documentation. (#3015)

Author: pengdev

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

@@ -1,9 +1,5 @@
 package com.mapbox.maps
 
-import android.content.pm.ApplicationInfo
-import androidx.annotation.VisibleForTesting
-import com.mapbox.common.MapboxSDKCommon
-
 /**
  * Allows to control several levels of tracing that could be useful to understand the performance of Mapbox Maps.
  * For more details about Android tracing refer to relevant section of DEVELOPING.md file.
@@ -13,29 +9,14 @@ object MapboxTracing {
   internal const val MAPBOX_TRACE_ID = "mbx"
 
   internal var platformTracingEnabled = false
-  @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
-  internal var tracerAvailable: Boolean? = null
-
-  private fun checkTracerEnabled() {
-    if (tracerAvailable == null) {
-      tracerAvailable =
-        MapboxSDKCommon.getContext().applicationInfo.flags != 0 and ApplicationInfo.FLAG_DEBUGGABLE
-    }
-    if (tracerAvailable == false) {
-      throw RuntimeException(
-        "Mapbox Tracing could not be used as build is not debuggable!" +
-          " You could enable it by setting android:debuggable=\"true\" in AndroidManifest <application> block."
-      )
-    }
-  }
 
   /**
    * Enable all the traces: native rendering engine traces and Android Maps SDK traces.
    *
-   * @throws [RuntimeException] if build is not debuggable.
+   * Enabling Mapbox tracing is only recommended for local performance measurements, to capture accurate results.
+   * This tracing is designed to be usable in release builds to enable local profiling.
    */
   fun enableAll() {
-    checkTracerEnabled()
     platformTracingEnabled = true
     Tracing.setTracingBackendType(TracingBackendType.PLATFORM)
   }
@@ -46,7 +27,6 @@ object MapboxTracing {
    * @throws [RuntimeException] if build is not debuggable.
    */
   fun enablePlatform() {
-    checkTracerEnabled()
     platformTracingEnabled = true
   }
 
@@ -56,7 +36,6 @@ object MapboxTracing {
    * @throws [RuntimeException] if build is not debuggable.
    */
   fun enableCore() {
-    checkTracerEnabled()
     Tracing.setTracingBackendType(TracingBackendType.PLATFORM)
   }
 
@@ -66,7 +45,6 @@ object MapboxTracing {
    * @throws [RuntimeException] if build is not debuggable.
    */
   fun disableAll() {
-    checkTracerEnabled()
     platformTracingEnabled = false
     Tracing.setTracingBackendType(TracingBackendType.NOOP)
   }

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

@@ -23,61 +23,34 @@ class MapboxTracingTest {
   @After
   fun cleanUp() {
     unmockkStatic("com.mapbox.maps.Tracing")
+    MapboxTracing.disableAll()
   }
 
   @Test
-  fun enableAllTracerAvailable() {
-    MapboxTracing.tracerAvailable = true
+  fun enableAll() {
     MapboxTracing.enableAll()
     verifyOnce { Tracing.setTracingBackendType(TracingBackendType.PLATFORM) }
     assert(MapboxTracing.platformTracingEnabled)
   }
 
-  @Test(expected = RuntimeException::class)
-  fun enableAllTracerNotAvailable() {
-    MapboxTracing.tracerAvailable = false
-    MapboxTracing.enableAll()
-  }
-
   @Test
-  fun enablePlatformTracerAvailable() {
-    MapboxTracing.tracerAvailable = true
+  fun enablePlatform() {
     MapboxTracing.enablePlatform()
     verifyNo { Tracing.setTracingBackendType(any()) }
     assert(MapboxTracing.platformTracingEnabled)
   }
 
-  @Test(expected = RuntimeException::class)
-  fun enablePlatformTracerNotAvailable() {
-    MapboxTracing.tracerAvailable = false
-    MapboxTracing.enablePlatform()
-  }
-
   @Test
-  fun enableCoreTracerAvailable() {
-    MapboxTracing.tracerAvailable = true
+  fun enableCore() {
     MapboxTracing.enableCore()
     verifyOnce { Tracing.setTracingBackendType(TracingBackendType.PLATFORM) }
     assert(!MapboxTracing.platformTracingEnabled)
   }
 
-  @Test(expected = RuntimeException::class)
-  fun enableCoreTracerNotAvailable() {
-    MapboxTracing.tracerAvailable = false
-    MapboxTracing.enableCore()
-  }
-
   @Test
-  fun disableAllTracerAvailable() {
-    MapboxTracing.tracerAvailable = true
+  fun disableAll() {
     MapboxTracing.disableAll()
     verifyOnce { Tracing.setTracingBackendType(TracingBackendType.NOOP) }
     assert(!MapboxTracing.platformTracingEnabled)
   }
-
-  @Test(expected = RuntimeException::class)
-  fun disableAllTracerNotAvailable() {
-    MapboxTracing.tracerAvailable = false
-    MapboxTracing.disableAll()
-  }
 }