Deprecate all SafeTrace/SafeTraceFunctions APIs

Author: tcmulcahy

papa-safetrace/src/main/java/papa/SafeTrace.kt

@@ -54,11 +54,13 @@ object SafeTrace {
 
   @Deprecated("Use forceShellProfileable instead", ReplaceWith("forceShellProfileable()"))
   @JvmStatic
+  @Suppress("DEPRECATION")
   fun forceTraceable() = forceShellProfileable()
 
   /**
    * @see isShellProfileable
    */
+  @Deprecated("Call forceEnableAppTracing/enableMainThreadMessageTracing instead")
   @JvmStatic
   fun forceShellProfileable() {
     androidx.tracing.Trace.forceEnableAppTracing()
@@ -93,6 +95,7 @@ object SafeTrace {
    * Writes a trace message to indicate that a given section of code has begun. This call must
    * be followed by a corresponding call to {@link #endSection()} on the same thread.
    */
+  @Deprecated("Call androidx.tracing.Trace.beginSection instead", ReplaceWith("beginSection", "androidx.tracing.Trace.beginSection"))
   @JvmStatic
   fun beginSection(label: String) {
     if (!isCurrentlyTracing) {
@@ -101,6 +104,7 @@ object SafeTrace {
     androidx.tracing.Trace.beginSection(label.take(MAX_LABEL_LENGTH))
   }
 
+  @Deprecated("Call androidx.tracing.Trace.beginSection instead", ReplaceWith("beginSection", "androidx.tracing.Trace.beginSection"))
   @JvmStatic
   inline fun beginSection(crossinline labelLambda: () -> String) {
     if (!isCurrentlyTracing) {
@@ -113,6 +117,7 @@ object SafeTrace {
    * Begins and ends a section immediately. Useful for reporting information in the trace.
    */
   @JvmStatic
+  @Deprecated("Call androidx.tracing.Trace.beginSection/endSection instead")
   fun logSection(label: String) {
     if (!isCurrentlyTracing) {
       return
@@ -124,6 +129,7 @@ object SafeTrace {
   /**
    * @see [logSection]
    */
+  @Deprecated("Call androidx.tracing.Trace.beginSection/endSection instead")
   @JvmStatic
   inline fun logSection(crossinline labelLambda: () -> String) {
     if (!isCurrentlyTracing) {
@@ -141,6 +147,7 @@ object SafeTrace {
    * ensure that beginSection / endSection pairs are properly nested and called from the same
    * thread.
    */
+  @Deprecated("Call androidx.tracing.Trace.endSection instead", ReplaceWith("endSection", "androidx.tracing.Trace.endSection"))
   @JvmStatic
   fun endSection() {
     if (!isCurrentlyTracing) {
@@ -152,6 +159,7 @@ object SafeTrace {
   /**
    * @see androidx.tracing.Trace.beginAsyncSection
    */
+  @Deprecated("Call androidx.tracing.Trace.beginAsyncSection instead", ReplaceWith("beginAsyncSection", "androidx.tracing.Trace.beginAsyncSection"))
   @JvmStatic
   inline fun beginAsyncSection(
     crossinline labelCookiePairLambda: () -> Pair<String, Int>
@@ -167,6 +175,7 @@ object SafeTrace {
    * [cookie] defaults to 0 (cookie is used for async traces that overlap)
    * @see androidx.tracing.Trace.beginAsyncSection
    */
+  @Deprecated("Call androidx.tracing.Trace.beginAsyncSection instead", ReplaceWith("beginAsyncSection", "androidx.tracing.Trace.beginAsyncSection"))
   @JvmStatic
   fun beginAsyncSection(
     label: String,
@@ -182,6 +191,7 @@ object SafeTrace {
    * [cookie] defaults to 0 (cookie is used for async traces that overlap)
    * @see androidx.tracing.Trace.endAsyncSection
    */
+  @Deprecated("Call androidx.tracing.Trace.endAsyncSection instead", ReplaceWith("endAsyncSection", "androidx.tracing.Trace.endAsyncSection"))
   @JvmStatic
   fun endAsyncSection(
     label: String,
@@ -196,6 +206,7 @@ object SafeTrace {
   /**
    * @see androidx.tracing.Trace.beginAsyncSection
    */
+  @Deprecated("Call androidx.tracing.Trace.endAsyncSection instead", ReplaceWith("endAsyncSection", "androidx.tracing.Trace.endAsyncSection"))
   @JvmStatic
   inline fun endAsyncSection(
     crossinline labelCookiePairLambda: () -> Pair<String, Int>

papa-safetrace/src/main/java/papa/SafeTraceFunctions.kt

@@ -8,6 +8,8 @@ import papa.SafeTrace.isTraceable
  * [label] a string producing lambda if the label is computed dynamically. If the label isn't
  * dynamic, use the [safeTrace] which directly takes a string instead.
  */
+@Deprecated("Call androidx.tracing.trace instead", ReplaceWith("trace", "androidx.tracing.trace"))
+@Suppress("DEPRECATION")
 inline fun <T> safeTrace(
   crossinline label: () -> String,
   crossinline block: () -> T
@@ -26,6 +28,8 @@ inline fun <T> safeTrace(
 /**
  * Allows tracing of a block of code
  */
+@Deprecated("Call androidx.tracing.trace instead", ReplaceWith("trace", "androidx.tracing.trace"))
+@Suppress("DEPRECATION")
 inline fun <T> safeTrace(
   label: String,
   crossinline block: () -> T

papa-safetrace/src/main/java/papa/SafeTraceSetup.kt

@@ -13,6 +13,10 @@ object SafeTraceSetup {
 
   fun init(application: Application) {
     this.application = application
+    enableMainThreadMessageTracing()
+  }
+
+  fun enableMainThreadMessageTracing() {
     SafeTraceMainThreadMessages.enableMainThreadMessageTracing()
   }
 

papa-safetrace/src/main/java/papa/internal/SafeTraceMainThreadMessages.kt

@@ -32,6 +32,7 @@ internal object SafeTraceMainThreadMessages {
     }
   }
 
+  @Suppress("DEPRECATION")
   private fun enableOnMainThread() {
     if (!enabled && SafeTrace.isShellProfileable && traceMainThreadMessages) {
       enabled = true