api: record if PerfMark.setEnabled succeeded (#181)

perfmark · Nov 8, 2022 · ef41d3c · ef41d3c
1 parent 28cff69
commit ef41d3c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 3 deletions.
diff --git a/api/src/main/java/io/perfmark/Impl.java b/api/src/main/java/io/perfmark/Impl.java
@@ -39,6 +39,10 @@ protected Impl(Tag key) {
 
   protected void setEnabled(boolean value) {}
 
+  protected boolean setEnabled(boolean value, boolean overload) {
+    return false;
+  }
+
   protected <T> void startTask(T taskNameObject, StringFunction<? super T> taskNameFunc) {}
 
   protected void startTask(String taskName, Tag tag) {}

diff --git a/api/src/main/java/io/perfmark/PerfMark.java b/api/src/main/java/io/perfmark/PerfMark.java
@@ -16,6 +16,7 @@
 
 package io.perfmark;
 
+import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import com.google.errorprone.annotations.DoNotCall;
 import com.google.errorprone.annotations.MustBeClosed;
 import java.lang.reflect.Method;
@@ -96,8 +97,9 @@ public final class PerfMark {
    *
    * @param value {@code true} to enable PerfMark recording, or {@code false} to disable it.
    */
-  public static void setEnabled(boolean value) {
-    impl.setEnabled(value);
+  @CanIgnoreReturnValue
+  public static boolean setEnabled(boolean value) {
+    return impl.setEnabled(value, false);
   }
 
   /**

diff --git a/api/src/test/java/io/perfmark/CompatibilityTest.java b/api/src/test/java/io/perfmark/CompatibilityTest.java
@@ -166,6 +166,9 @@ public void checkPublicMethods() throws Exception {
 
       var m = currentPerfMarkClz.getMethod(method.getName(), paramTypes);
       assertNotNull(method.getName(), m);
+      if (returnType == void.class) {
+        return;
+      }
       assertEquals(m.getReturnType(), returnType);
     }
   }

diff --git a/impl/src/main/java/io/perfmark/impl/SecretPerfMarkImpl.java b/impl/src/main/java/io/perfmark/impl/SecretPerfMarkImpl.java
@@ -119,7 +119,15 @@ public PerfMarkImpl(Tag key) {
 
     @Override
     protected synchronized void setEnabled(boolean value) {
-      logEnabledChange(value, setEnabledQuiet(value, System.nanoTime()));
+      boolean changed = setEnabledQuiet(value, System.nanoTime());
+      logEnabledChange(value, changed);
+    }
+
+    @Override
+    protected synchronized boolean setEnabled(boolean value, boolean overload) {
+      boolean changed = setEnabledQuiet(value, System.nanoTime());
+      logEnabledChange(value, changed);
+      return changed;
     }
 
     private static synchronized void logEnabledChange(boolean value, boolean success) {