Renamed reportFullDisplayed to reportFullyDisplayed

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Improve versatility of exception resolver component for Spring with more flexible API for consumers. ([#2577](https://github.com/getsentry/sentry-java/pull/2577))
 
+### Fixes
+
+- Deprecate reportFullDisplayed in favor of reportFullyDisplayed ([#2585](https://github.com/getsentry/sentry-java/pull/2585))
+
 ## 6.15.0
 
 ### Features

sentry-android-core/src/main/java/io/sentry/android/core/ActivityLifecycleIntegration.java

@@ -12,7 +12,7 @@
 import android.view.View;
 import androidx.annotation.NonNull;
 import io.sentry.Breadcrumb;
-import io.sentry.FullDisplayedReporter;
+import io.sentry.FullyDisplayedReporter;
 import io.sentry.Hint;
 import io.sentry.IHub;
 import io.sentry.ISpan;
@@ -64,7 +64,7 @@ public final class ActivityLifecycleIntegration
   private boolean firstActivityCreated = false;
   private final boolean foregroundImportance;
 
-  private @Nullable FullDisplayedReporter fullDisplayedReporter = null;
+  private @Nullable FullyDisplayedReporter fullyDisplayedReporter = null;
   private @Nullable ISpan appStartSpan;
   private final @NotNull WeakHashMap<Activity, ISpan> ttidSpanMap = new WeakHashMap<>();
   private @NotNull SentryDate lastPausedTime = AndroidDateUtils.getCurrentSentryDateTime();
@@ -115,7 +115,7 @@ public void register(final @NotNull IHub hub, final @NotNull SentryOptions optio
             this.options.isEnableActivityLifecycleBreadcrumbs());
 
     performanceEnabled = isPerformanceEnabled(this.options);
-    fullDisplayedReporter = this.options.getFullDisplayedReporter();
+    fullyDisplayedReporter = this.options.getFullyDisplayedReporter();
     timeToFullDisplaySpanEnabled = this.options.isEnableTimeToFullDisplayTracing();
 
     if (this.options.isEnableActivityLifecycleBreadcrumbs() || performanceEnabled) {
@@ -239,7 +239,7 @@ private void startTracing(final @NotNull Activity activity) {
           transaction.startChild(
               TTID_OP, getTtidDesc(activityName), ttidStartTime, Instrumenter.SENTRY));
 
-      if (timeToFullDisplaySpanEnabled && fullDisplayedReporter != null && options != null) {
+      if (timeToFullDisplaySpanEnabled && fullyDisplayedReporter != null && options != null) {
         ttfdSpan =
             transaction.startChild(
                 TTFD_OP, getTtfdDesc(activityName), ttidStartTime, Instrumenter.SENTRY);
@@ -344,8 +344,8 @@ public synchronized void onActivityCreated(
 
     firstActivityCreated = true;
 
-    if (fullDisplayedReporter != null) {
-      fullDisplayedReporter.registerFullyDrawnListener(
+    if (fullyDisplayedReporter != null) {
+      fullyDisplayedReporter.registerFullyDrawnListener(
           () -> {
             finishSpan(ttfdSpan);
             cancelTtfdAutoClose();

sentry-android-core/src/test/java/io/sentry/android/core/ActivityLifecycleIntegrationTest.kt

@@ -12,7 +12,7 @@ import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import io.sentry.Breadcrumb
 import io.sentry.DateUtils
-import io.sentry.FullDisplayedReporter
+import io.sentry.FullyDisplayedReporter
 import io.sentry.Hub
 import io.sentry.ISentryExecutorService
 import io.sentry.Scope
@@ -66,7 +66,7 @@ class ActivityLifecycleIntegrationTest {
         val bundle = mock<Bundle>()
         val context = TransactionContext("name", "op")
         val activityFramesTracker = mock<ActivityFramesTracker>()
-        val fullDisplayedReporter = FullDisplayedReporter.getInstance()
+        val fullyDisplayedReporter = FullyDisplayedReporter.getInstance()
         val transactionFinishedCallback = mock<TransactionFinishedCallback>()
         lateinit var transaction: SentryTracer
         val buildInfo = mock<BuildInfoProvider>()
@@ -729,7 +729,7 @@ class ActivityLifecycleIntegrationTest {
         val activity = mock<Activity>()
         sut.onActivityCreated(activity, mock())
         sut.ttidSpanMap.values.first().finish()
-        fixture.fullDisplayedReporter.reportFullyDrawn()
+        fixture.fullyDisplayedReporter.reportFullyDrawn()
         assertTrue(sut.ttfdSpan!!.isFinished)
         assertNotEquals(SpanStatus.CANCELLED, sut.ttfdSpan?.status)
     }
@@ -1103,7 +1103,7 @@ class ActivityLifecycleIntegrationTest {
         assertNotNull(autoCloseFuture)
 
         // ReportFullyDrawn should finish the ttfd span and cancel the future
-        fixture.options.fullDisplayedReporter.reportFullyDrawn()
+        fixture.options.fullyDisplayedReporter.reportFullyDrawn()
         assertTrue(ttfdSpan.isFinished)
         assertNotEquals(SpanStatus.DEADLINE_EXCEEDED, ttfdSpan.status)
         assertTrue(autoCloseFuture.isCancelled)

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java

@@ -207,6 +207,6 @@ protected void onResume() {
     if (span != null) {
       span.setMeasurement("screen_load_count", screenLoadCount, new MeasurementUnit.Custom("test"));
     }
-    Sentry.reportFullDisplayed();
+    Sentry.reportFullyDisplayed();
   }
 }

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/PermissionsActivity.kt

@@ -38,6 +38,6 @@ class PermissionsActivity : AppCompatActivity() {
         }
 
         setContentView(binding.root)
-        Sentry.reportFullDisplayed()
+        Sentry.reportFullyDisplayed()
     }
 }

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/ProfilingActivity.kt

@@ -69,7 +69,7 @@ class ProfilingActivity : AppCompatActivity() {
             }.start()
         }
         setContentView(binding.root)
-        Sentry.reportFullDisplayed()
+        Sentry.reportFullyDisplayed()
     }
 
     private fun finishTransactionAndPrintResults(t: ITransaction) {

sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/SecondActivity.kt

@@ -76,7 +76,7 @@ class SecondActivity : AppCompatActivity() {
 
                 showText(true, "error: ${t.message}")
 
-                Sentry.reportFullDisplayed()
+                Sentry.reportFullyDisplayed()
             }
 
             override fun onResponse(call: Call<List<Repo>>, response: Response<List<Repo>>) {
@@ -86,7 +86,7 @@ class SecondActivity : AppCompatActivity() {
 
                 showText(text = "items: ${repos.size}")
 
-                Sentry.reportFullDisplayed()
+                Sentry.reportFullyDisplayed()
             }
         })
     }

sentry/api/sentry.api

@@ -277,13 +277,13 @@ public final class io/sentry/ExternalOptions {
 	public fun setTracesSampleRate (Ljava/lang/Double;)V
 }
 
-public final class io/sentry/FullDisplayedReporter {
-	public static fun getInstance ()Lio/sentry/FullDisplayedReporter;
-	public fun registerFullyDrawnListener (Lio/sentry/FullDisplayedReporter$FullDisplayedReporterListener;)V
+public final class io/sentry/FullyDisplayedReporter {
+	public static fun getInstance ()Lio/sentry/FullyDisplayedReporter;
+	public fun registerFullyDrawnListener (Lio/sentry/FullyDisplayedReporter$FullyDisplayedReporterListener;)V
 	public fun reportFullyDrawn ()V
 }
 
-public abstract interface class io/sentry/FullDisplayedReporter$FullDisplayedReporterListener {
+public abstract interface class io/sentry/FullyDisplayedReporter$FullyDisplayedReporterListener {
 	public abstract fun onFullyDrawn ()V
 }
 
@@ -344,7 +344,7 @@ public final class io/sentry/Hub : io/sentry/IHub {
 	public fun pushScope ()V
 	public fun removeExtra (Ljava/lang/String;)V
 	public fun removeTag (Ljava/lang/String;)V
-	public fun reportFullDisplayed ()V
+	public fun reportFullyDisplayed ()V
 	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public fun setFingerprint (Ljava/util/List;)V
 	public fun setLevel (Lio/sentry/SentryLevel;)V
@@ -388,7 +388,7 @@ public final class io/sentry/HubAdapter : io/sentry/IHub {
 	public fun pushScope ()V
 	public fun removeExtra (Ljava/lang/String;)V
 	public fun removeTag (Ljava/lang/String;)V
-	public fun reportFullDisplayed ()V
+	public fun reportFullyDisplayed ()V
 	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public fun setFingerprint (Ljava/util/List;)V
 	public fun setLevel (Lio/sentry/SentryLevel;)V
@@ -457,7 +457,8 @@ public abstract interface class io/sentry/IHub {
 	public abstract fun pushScope ()V
 	public abstract fun removeExtra (Ljava/lang/String;)V
 	public abstract fun removeTag (Ljava/lang/String;)V
-	public abstract fun reportFullDisplayed ()V
+	public fun reportFullDisplayed ()V
+	public abstract fun reportFullyDisplayed ()V
 	public abstract fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public abstract fun setFingerprint (Ljava/util/List;)V
 	public abstract fun setLevel (Lio/sentry/SentryLevel;)V
@@ -784,7 +785,7 @@ public final class io/sentry/NoOpHub : io/sentry/IHub {
 	public fun pushScope ()V
 	public fun removeExtra (Ljava/lang/String;)V
 	public fun removeTag (Ljava/lang/String;)V
-	public fun reportFullDisplayed ()V
+	public fun reportFullyDisplayed ()V
 	public fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public fun setFingerprint (Ljava/util/List;)V
 	public fun setLevel (Lio/sentry/SentryLevel;)V
@@ -1183,6 +1184,7 @@ public final class io/sentry/Sentry {
 	public static fun removeExtra (Ljava/lang/String;)V
 	public static fun removeTag (Ljava/lang/String;)V
 	public static fun reportFullDisplayed ()V
+	public static fun reportFullyDisplayed ()V
 	public static fun setCurrentHub (Lio/sentry/IHub;)V
 	public static fun setExtra (Ljava/lang/String;Ljava/lang/String;)V
 	public static fun setFingerprint (Ljava/util/List;)V
@@ -1546,7 +1548,7 @@ public class io/sentry/SentryOptions {
 	public fun getEventProcessors ()Ljava/util/List;
 	public fun getExecutorService ()Lio/sentry/ISentryExecutorService;
 	public fun getFlushTimeoutMillis ()J
-	public fun getFullDisplayedReporter ()Lio/sentry/FullDisplayedReporter;
+	public fun getFullyDisplayedReporter ()Lio/sentry/FullyDisplayedReporter;
 	public fun getGestureTargetLocators ()Ljava/util/List;
 	public fun getHostnameVerifier ()Ljavax/net/ssl/HostnameVerifier;
 	public fun getIdleTimeout ()Ljava/lang/Long;

sentry/src/main/java/io/sentry/FullDisplayedReporter.java → sentry/src/main/java/io/sentry/FullyDisplayedReporter.java

@@ -7,34 +7,34 @@
 import org.jetbrains.annotations.NotNull;
 
 @ApiStatus.Internal
-public final class FullDisplayedReporter {
+public final class FullyDisplayedReporter {
 
-  private static final @NotNull FullDisplayedReporter instance = new FullDisplayedReporter();
+  private static final @NotNull FullyDisplayedReporter instance = new FullyDisplayedReporter();
 
-  private final @NotNull List<FullDisplayedReporterListener> listeners =
+  private final @NotNull List<FullyDisplayedReporterListener> listeners =
       new CopyOnWriteArrayList<>();
 
-  private FullDisplayedReporter() {}
+  private FullyDisplayedReporter() {}
 
-  public static @NotNull FullDisplayedReporter getInstance() {
+  public static @NotNull FullyDisplayedReporter getInstance() {
     return instance;
   }
 
   public void registerFullyDrawnListener(
-      final @NotNull FullDisplayedReporter.FullDisplayedReporterListener listener) {
+      final @NotNull FullyDisplayedReporter.FullyDisplayedReporterListener listener) {
     listeners.add(listener);
   }
 
   public void reportFullyDrawn() {
-    final @NotNull Iterator<FullDisplayedReporterListener> listenerIterator = listeners.iterator();
+    final @NotNull Iterator<FullyDisplayedReporterListener> listenerIterator = listeners.iterator();
     listeners.clear();
     while (listenerIterator.hasNext()) {
       listenerIterator.next().onFullyDrawn();
     }
   }
 
   @ApiStatus.Internal
-  public interface FullDisplayedReporterListener {
+  public interface FullyDisplayedReporterListener {
     void onFullyDrawn();
   }
 }

sentry/src/main/java/io/sentry/Hub.java

@@ -515,9 +515,9 @@ public void pushScope() {
   }
 
   @Override
-  public void reportFullDisplayed() {
+  public void reportFullyDisplayed() {
     if (options.isEnableTimeToFullDisplayTracing()) {
-      options.getFullDisplayedReporter().reportFullyDrawn();
+      options.getFullyDisplayedReporter().reportFullyDrawn();
     }
   }
 

sentry/src/main/java/io/sentry/HubAdapter.java

@@ -231,7 +231,7 @@ public void setSpanContext(
   }
 
   @Override
-  public void reportFullDisplayed() {
-    Sentry.reportFullDisplayed();
+  public void reportFullyDisplayed() {
+    Sentry.reportFullyDisplayed();
   }
 }

sentry/src/main/java/io/sentry/IHub.java

@@ -572,5 +572,13 @@ void setSpanContext(
    * <p>This method is safe to be called multiple times. If the time-to-full-display span is already
    * finished, this call will be ignored.
    */
-  void reportFullDisplayed();
+  void reportFullyDisplayed();
+
+  /**
+   * @deprecated See {@link IHub#reportFullyDisplayed()}.
+   */
+  @Deprecated
+  default void reportFullDisplayed() {
+    reportFullyDisplayed();
+  }
 }

sentry/src/main/java/io/sentry/NoOpHub.java

@@ -188,5 +188,5 @@ public void setSpanContext(
   }
 
   @Override
-  public void reportFullDisplayed() {}
+  public void reportFullyDisplayed() {}
 }

sentry/src/main/java/io/sentry/Sentry.java

@@ -873,8 +873,17 @@ public static void endSession() {
    * <p>This method is safe to be called multiple times. If the time-to-full-display span is already
    * finished, this call will be ignored.
    */
+  public static void reportFullyDisplayed() {
+    getCurrentHub().reportFullyDisplayed();
+  }
+
+  /**
+   * @deprecated See {@link Sentry#reportFullyDisplayed()}.
+   */
+  @Deprecated
+  @SuppressWarnings("InlineMeSuggester")
   public static void reportFullDisplayed() {
-    getCurrentHub().reportFullDisplayed();
+    reportFullyDisplayed();
   }
 
   /**

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -406,8 +406,8 @@ public class SentryOptions {
   private boolean enableTimeToFullDisplayTracing = false;
 
   /** Screen fully displayed reporter, used for time-to-full-display spans. */
-  private final @NotNull FullDisplayedReporter fullDisplayedReporter =
-      FullDisplayedReporter.getInstance();
+  private final @NotNull FullyDisplayedReporter fullyDisplayedReporter =
+      FullyDisplayedReporter.getInstance();
 
   /**
    * Adds an event processor
@@ -1967,8 +1967,8 @@ public void setEnableTimeToFullDisplayTracing(final boolean enableTimeToFullDisp
    * @return The reporter to call when a screen is fully loaded.
    */
   @ApiStatus.Internal
-  public @NotNull FullDisplayedReporter getFullDisplayedReporter() {
-    return fullDisplayedReporter;
+  public @NotNull FullyDisplayedReporter getFullyDisplayedReporter() {
+    return fullyDisplayedReporter;
   }
 
   /**

sentry/src/test/java/io/sentry/FullDisplayedReporterTest.kt → sentry/src/test/java/io/sentry/FullyDisplayedReporterTest.kt

@@ -1,6 +1,6 @@
 package io.sentry
 
-import io.sentry.FullDisplayedReporter.FullDisplayedReporterListener
+import io.sentry.FullyDisplayedReporter.FullyDisplayedReporterListener
 import io.sentry.test.getProperty
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.verify
@@ -9,14 +9,14 @@ import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
-class FullDisplayedReporterTest {
+class FullyDisplayedReporterTest {
 
-    private val reporter = FullDisplayedReporter.getInstance()
-    private val listeners = reporter.getProperty<MutableList<FullDisplayedReporterListener>>("listeners")
-    private val listener1 = FullDisplayedReporterListener {}
-    private val listener2 = FullDisplayedReporterListener {}
-    private val mockListener1 = mock<FullDisplayedReporterListener>()
-    private val mockListener2 = mock<FullDisplayedReporterListener>()
+    private val reporter = FullyDisplayedReporter.getInstance()
+    private val listeners = reporter.getProperty<MutableList<FullyDisplayedReporterListener>>("listeners")
+    private val listener1 = FullyDisplayedReporterListener {}
+    private val listener2 = FullyDisplayedReporterListener {}
+    private val mockListener1 = mock<FullyDisplayedReporterListener>()
+    private val mockListener2 = mock<FullyDisplayedReporterListener>()
 
     @AfterTest
     fun shutdown() {