Merge branch 'main' into 08-11-do_not_store_no-op_scopes_onto_opentelemetry_context_when_wrapping

Author: adinauer

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## Unreleased
+## 8.19.0
+
+### Features
+
+- Add a `isEnableSystemEventBreadcrumbsExtras` option to disable reporting system events extras for breadcrumbs ([#4625](https://github.com/getsentry/sentry-java/pull/4625))
 
 ### Improvements
 
@@ -28,6 +32,8 @@
 - Ensure frame metrics listeners are registered/unregistered on the main thread ([#4582](https://github.com/getsentry/sentry-java/pull/4582))
 - Do not report cached events as lost ([#4575](https://github.com/getsentry/sentry-java/pull/4575))
   - Previously events were recorded as lost early despite being retried later through the cache
+- Move and flush unfinished previous session on init ([#4624](https://github.com/getsentry/sentry-java/pull/4624))
+  - This removes the need for unnecessary blocking our background queue for 15 seconds in the case of a background app start
 - Switch to compileOnly dependency for compose-ui-material ([#4630](https://github.com/getsentry/sentry-java/pull/4630))
   - This fixes `StackOverflowError` when using OSS Licenses plugin 
 

gradle.properties

@@ -11,7 +11,7 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 android.useAndroidX=true
 
 # Release information
-versionName=8.18.0
+versionName=8.19.0
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

sentry-android-core/api/sentry-android-core.api

@@ -336,6 +336,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun isEnableRootCheck ()Z
 	public fun isEnableScopeSync ()Z
 	public fun isEnableSystemEventBreadcrumbs ()Z
+	public fun isEnableSystemEventBreadcrumbsExtras ()Z
 	public fun isReportHistoricalAnrs ()Z
 	public fun setAnrEnabled (Z)V
 	public fun setAnrReportInDebug (Z)V
@@ -360,6 +361,7 @@ public final class io/sentry/android/core/SentryAndroidOptions : io/sentry/Sentr
 	public fun setEnableRootCheck (Z)V
 	public fun setEnableScopeSync (Z)V
 	public fun setEnableSystemEventBreadcrumbs (Z)V
+	public fun setEnableSystemEventBreadcrumbsExtras (Z)V
 	public fun setFrameMetricsCollector (Lio/sentry/android/core/internal/util/SentryFrameMetricsCollector;)V
 	public fun setNativeHandlerStrategy (Lio/sentry/android/core/NdkHandlerStrategy;)V
 	public fun setNativeSdkName (Ljava/lang/String;)V

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

@@ -177,6 +177,9 @@ public final class SentryAndroidOptions extends SentryOptions {
    */
   private boolean enableAutoTraceIdGeneration = true;
 
+  /** Enable or disable intent extras reporting for system event breadcrumbs. Default is false. */
+  private boolean enableSystemEventBreadcrumbsExtras = false;
+
   public interface BeforeCaptureCallback {
 
     /**
@@ -614,6 +617,15 @@ public void setEnableAutoTraceIdGeneration(final boolean enableAutoTraceIdGenera
     this.enableAutoTraceIdGeneration = enableAutoTraceIdGeneration;
   }
 
+  public boolean isEnableSystemEventBreadcrumbsExtras() {
+    return enableSystemEventBreadcrumbsExtras;
+  }
+
+  public void setEnableSystemEventBreadcrumbsExtras(
+      final boolean enableSystemEventBreadcrumbsExtras) {
+    this.enableSystemEventBreadcrumbsExtras = enableSystemEventBreadcrumbsExtras;
+  }
+
   static class AndroidUserFeedbackIDialogHandler implements SentryFeedbackOptions.IDialogHandler {
     @Override
     public void showDialog(

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

@@ -370,7 +370,7 @@ String getStringAfterDotFast(final @Nullable String str) {
         if (batteryState.charging != null) {
           breadcrumb.setData("charging", batteryState.charging);
         }
-      } else {
+      } else if (options.isEnableSystemEventBreadcrumbsExtras()) {
         final Bundle extras = intent.getExtras();
         if (extras != null && !extras.isEmpty()) {
           final Map<String, String> newExtras = new HashMap<>(extras.size());

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

@@ -181,6 +181,20 @@ class SentryAndroidOptionsTest {
     )
   }
 
+  @Test
+  fun `system event breadcrumbs extras disabled by default`() {
+    val sentryOptions = SentryAndroidOptions()
+
+    assertFalse(sentryOptions.isEnableSystemEventBreadcrumbsExtras)
+  }
+
+  @Test
+  fun `system event breadcrumbs extras can be enabled`() {
+    val sentryOptions = SentryAndroidOptions()
+    sentryOptions.isEnableSystemEventBreadcrumbsExtras = true
+    assertTrue(sentryOptions.isEnableSystemEventBreadcrumbsExtras)
+  }
+
   private class CustomDebugImagesLoader : IDebugImagesLoader {
     override fun loadDebugImages(): List<DebugImage>? = null
 

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

@@ -51,11 +51,13 @@ class SystemEventsBreadcrumbsIntegrationTest {
 
     fun getSut(
       enableSystemEventBreadcrumbs: Boolean = true,
+      enableSystemEventBreadcrumbsExtras: Boolean = false,
       executorService: ISentryExecutorService = ImmediateExecutorService(),
     ): SystemEventsBreadcrumbsIntegration {
       options =
         SentryAndroidOptions().apply {
           isEnableSystemEventBreadcrumbs = enableSystemEventBreadcrumbs
+          isEnableSystemEventBreadcrumbsExtras = enableSystemEventBreadcrumbsExtras
           this.executorService = executorService
         }
       return SystemEventsBreadcrumbsIntegration(
@@ -528,4 +530,59 @@ class SystemEventsBreadcrumbsIntegrationTest {
 
     assertNull(sut.receiver)
   }
+
+  @Test
+  fun `system event breadcrumbs include extras when enableSystemEventBreadcrumbsExtras is true`() {
+    val sut = fixture.getSut(enableSystemEventBreadcrumbsExtras = true)
+
+    sut.register(fixture.scopes, fixture.options)
+    val intent =
+      Intent().apply {
+        action = Intent.ACTION_TIME_CHANGED
+        putExtra("test", 10)
+        putExtra("test2", 20)
+      }
+    sut.receiver!!.onReceive(fixture.context, intent)
+
+    verify(fixture.scopes)
+      .addBreadcrumb(
+        check<Breadcrumb> {
+          assertEquals("device.event", it.category)
+          assertEquals("system", it.type)
+          assertEquals(SentryLevel.INFO, it.level)
+          assertEquals("TIME_SET", it.data["action"])
+          assertNotNull(it.data["extras"])
+          val extras = it.data["extras"] as Map<String, String>
+          assertEquals("10", extras["test"])
+          assertEquals("20", extras["test2"])
+        },
+        anyOrNull(),
+      )
+  }
+
+  @Test
+  fun `system event breadcrumbs do not include extras when enableSystemEventBreadcrumbsExtras is false`() {
+    val sut = fixture.getSut(enableSystemEventBreadcrumbsExtras = false)
+
+    sut.register(fixture.scopes, fixture.options)
+    val intent =
+      Intent().apply {
+        action = Intent.ACTION_TIME_CHANGED
+        putExtra("test", 10)
+        putExtra("test2", 20)
+      }
+    sut.receiver!!.onReceive(fixture.context, intent)
+
+    verify(fixture.scopes)
+      .addBreadcrumb(
+        check<Breadcrumb> {
+          assertEquals("device.event", it.category)
+          assertEquals("system", it.type)
+          assertEquals(SentryLevel.INFO, it.level)
+          assertEquals("TIME_SET", it.data["action"])
+          assertNull(it.data["extras"])
+        },
+        anyOrNull(),
+      )
+  }
 }

sentry/api/sentry.api

@@ -4346,13 +4346,15 @@ public class io/sentry/cache/EnvelopeCache : io/sentry/cache/IEnvelopeCache {
 	public static final field SUFFIX_ENVELOPE_FILE Ljava/lang/String;
 	protected static final field UTF_8 Ljava/nio/charset/Charset;
 	protected final field cacheLock Lio/sentry/util/AutoClosableReentrantLock;
+	protected final field sessionLock Lio/sentry/util/AutoClosableReentrantLock;
 	public fun <init> (Lio/sentry/SentryOptions;Ljava/lang/String;I)V
 	public static fun create (Lio/sentry/SentryOptions;)Lio/sentry/cache/IEnvelopeCache;
 	public fun discard (Lio/sentry/SentryEnvelope;)V
 	public fun flushPreviousSession ()V
 	public static fun getCurrentSessionFile (Ljava/lang/String;)Ljava/io/File;
 	public static fun getPreviousSessionFile (Ljava/lang/String;)Ljava/io/File;
 	public fun iterator ()Ljava/util/Iterator;
+	public fun movePreviousSession (Ljava/io/File;Ljava/io/File;)V
 	public fun store (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)V
 	public fun storeEnvelope (Lio/sentry/SentryEnvelope;Lio/sentry/Hint;)Z
 	public fun waitPreviousSessionFlush ()Z

sentry/src/main/java/io/sentry/MovePreviousSession.java

@@ -0,0 +1,44 @@
+package io.sentry;
+
+import static io.sentry.SentryLevel.DEBUG;
+import static io.sentry.SentryLevel.INFO;
+
+import io.sentry.cache.EnvelopeCache;
+import io.sentry.cache.IEnvelopeCache;
+import java.io.File;
+import org.jetbrains.annotations.NotNull;
+
+final class MovePreviousSession implements Runnable {
+
+  private final @NotNull SentryOptions options;
+
+  MovePreviousSession(final @NotNull SentryOptions options) {
+    this.options = options;
+  }
+
+  @Override
+  public void run() {
+    final String cacheDirPath = options.getCacheDirPath();
+    if (cacheDirPath == null) {
+      options.getLogger().log(INFO, "Cache dir is not set, not moving the previous session.");
+      return;
+    }
+
+    if (!options.isEnableAutoSessionTracking()) {
+      options
+          .getLogger()
+          .log(DEBUG, "Session tracking is disabled, bailing from previous session mover.");
+      return;
+    }
+
+    final IEnvelopeCache cache = options.getEnvelopeDiskCache();
+    if (cache instanceof EnvelopeCache) {
+      final File currentSessionFile = EnvelopeCache.getCurrentSessionFile(cacheDirPath);
+      final File previousSessionFile = EnvelopeCache.getPreviousSessionFile(cacheDirPath);
+
+      ((EnvelopeCache) cache).movePreviousSession(currentSessionFile, previousSessionFile);
+
+      ((EnvelopeCache) cache).flushPreviousSession();
+    }
+  }
+}

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

@@ -346,6 +346,8 @@ private static void init(final @NotNull SentryOptions options, final boolean glo
           options.setExecutorService(new SentryExecutorService(options));
           options.getExecutorService().prewarm();
         }
+
+        movePreviousSession(options);
         // when integrations are registered on Scopes ctor and async integrations are fired,
         // it might and actually happened that integrations called captureSomething
         // and Scopes was still NoOp.
@@ -497,6 +499,16 @@ private static void handleAppStartProfilingConfig(
     return options.getInternalTracesSampler().sample(appStartSamplingContext);
   }
 
+  @SuppressWarnings("FutureReturnValueIgnored")
+  private static void movePreviousSession(final @NotNull SentryOptions options) {
+    // enqueue a task to move previous unfinished session to its own file
+    try {
+      options.getExecutorService().submit(new MovePreviousSession(options));
+    } catch (Throwable e) {
+      options.getLogger().log(SentryLevel.DEBUG, "Failed to move previous session.", e);
+    }
+  }
+
   @SuppressWarnings("FutureReturnValueIgnored")
   private static void finalizePreviousSession(
       final @NotNull SentryOptions options, final @NotNull IScopes scopes) {