Merge pull request #5831 from getsentry/fix/data-collection-device-info-options

fix(android): [Data Collection 15] Scope device info cache to SDK options

Author: adinauer

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

@@ -283,7 +283,6 @@ public final class io/sentry/android/core/DeviceInfoUtil {
 	public fun getSplitApksInfo ()Lio/sentry/android/core/ContextUtils$SplitApksInfo;
 	public fun getTotalMemory ()Ljava/lang/Long;
 	public static fun isCharging (Landroid/content/Intent;Lio/sentry/SentryOptions;)Ljava/lang/Boolean;
-	public static fun resetInstance ()V
 }
 
 public abstract class io/sentry/android/core/EnvelopeFileObserverIntegration : io/sentry/Integration, java/io/Closeable {

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

@@ -15,15 +15,13 @@
 import android.os.SystemClock;
 import android.util.DisplayMetrics;
 import io.sentry.DateUtils;
-import io.sentry.ISentryLifecycleToken;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.android.core.internal.util.CpuInfoUtils;
 import io.sentry.android.core.internal.util.DeviceOrientations;
 import io.sentry.android.core.internal.util.RootChecker;
 import io.sentry.protocol.Device;
 import io.sentry.protocol.OperatingSystem;
-import io.sentry.util.AutoClosableReentrantLock;
 import java.io.File;
 import java.util.Calendar;
 import java.util.Collections;
@@ -34,17 +32,10 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import org.jetbrains.annotations.TestOnly;
 
 @ApiStatus.Internal
 public final class DeviceInfoUtil {
 
-  @SuppressLint("StaticFieldLeak")
-  private static volatile DeviceInfoUtil instance;
-
-  private static final @NotNull AutoClosableReentrantLock staticLock =
-      new AutoClosableReentrantLock();
-
   private final @NotNull Context context;
   private final @NotNull SentryAndroidOptions options;
   private final @NotNull BuildInfoProvider buildInfoProvider;
@@ -80,19 +71,7 @@ public DeviceInfoUtil(
   @NotNull
   public static DeviceInfoUtil getInstance(
       final @NotNull Context context, final @NotNull SentryAndroidOptions options) {
-    if (instance == null) {
-      try (final @NotNull ISentryLifecycleToken ignored = staticLock.acquire()) {
-        if (instance == null) {
-          instance = new DeviceInfoUtil(ContextUtils.getApplicationContext(context), options);
-        }
-      }
-    }
-    return instance;
-  }
-
-  @TestOnly
-  public static void resetInstance() {
-    instance = null;
+    return options.getOrCreateDeviceInfoUtil(context);
   }
 
   // we can get some inspiration here

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

@@ -3,8 +3,10 @@
 import android.app.Activity;
 import android.app.ActivityManager;
 import android.app.ApplicationExitInfo;
+import android.content.Context;
 import io.sentry.Hint;
 import io.sentry.IScope;
+import io.sentry.ISentryLifecycleToken;
 import io.sentry.ISpan;
 import io.sentry.Sentry;
 import io.sentry.SentryEvent;
@@ -141,6 +143,8 @@ public final class SentryAndroidOptions extends SentryOptions {
   /** Enables or disables collecting of external storage context. */
   private boolean collectExternalStorageContext = false;
 
+  private volatile @Nullable DeviceInfoUtil deviceInfoUtil;
+
   /**
    * Controls how many seconds to wait for sending events in case there were Startup Crashes in the
    * previous run. Sentry SDKs normally send events from a background queue, but in the case of
@@ -200,6 +204,18 @@ public final class SentryAndroidOptions extends SentryOptions {
   /** Enable or disable intent extras reporting for system event breadcrumbs. Default is false. */
   private boolean enableSystemEventBreadcrumbsExtras = false;
 
+  @NotNull
+  DeviceInfoUtil getOrCreateDeviceInfoUtil(final @NotNull Context context) {
+    if (deviceInfoUtil == null) {
+      try (final @NotNull ISentryLifecycleToken ignored = lock.acquire()) {
+        if (deviceInfoUtil == null) {
+          deviceInfoUtil = new DeviceInfoUtil(ContextUtils.getApplicationContext(context), this);
+        }
+      }
+    }
+    return deviceInfoUtil;
+  }
+
   public interface BeforeCaptureCallback {
 
     /**

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

@@ -201,8 +201,6 @@ class ApplicationExitInfoEventProcessorTest {
 
   @BeforeTest
   fun `set up`() {
-    DeviceInfoUtil.resetInstance()
-    ContextUtils.resetInstance()
     fixture.context = ApplicationProvider.getApplicationContext()
   }
 

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

@@ -87,7 +87,6 @@ class DefaultAndroidEventProcessorTest {
   fun `set up`() {
     context = ApplicationProvider.getApplicationContext()
     AppState.getInstance().resetInstance()
-    DeviceInfoUtil.resetInstance()
     CpuInfoUtils.getInstance().clear()
   }
 

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

@@ -15,7 +15,9 @@ import kotlin.test.BeforeTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertNotNull
+import kotlin.test.assertNotSame
 import kotlin.test.assertNull
+import kotlin.test.assertSame
 import org.junit.runner.RunWith
 import org.robolectric.annotation.Config
 
@@ -32,7 +34,45 @@ class DeviceInfoUtilTest {
         .putExtra(BatteryManager.EXTRA_LEVEL, 75)
         .putExtra(BatteryManager.EXTRA_PLUGGED, 0)
     )
-    DeviceInfoUtil.resetInstance()
+  }
+
+  @Test
+  fun `same options reuse device info util`() {
+    val options = SentryAndroidOptions()
+
+    val first = DeviceInfoUtil.getInstance(context, options)
+    val second = DeviceInfoUtil.getInstance(context, options)
+
+    assertSame(first, second)
+  }
+
+  @Test
+  fun `different options use isolated device info utils`() {
+    val enabledOptions =
+      SentryAndroidOptions().apply {
+        dataCollection.setUserInfo(true)
+        isCollectAdditionalContext = true
+        isEnableRootCheck = true
+      }
+    val disabledOptions =
+      SentryAndroidOptions().apply {
+        dataCollection.setUserInfo(false)
+        isCollectAdditionalContext = false
+        isEnableRootCheck = false
+      }
+
+    val enabled = DeviceInfoUtil.getInstance(context, enabledOptions)
+    val disabled = DeviceInfoUtil.getInstance(context, disabledOptions)
+    val enabledDevice = enabled.collectDeviceInformation(true, false)
+    val disabledDevice = disabled.collectDeviceInformation(true, false)
+
+    assertNotSame(enabled, disabled)
+    assertNotNull(enabledDevice.id)
+    assertNotNull(enabledDevice.storageSize)
+    assertNotNull(enabled.operatingSystem.isRooted)
+    assertNull(disabledDevice.id)
+    assertNull(disabledDevice.storageSize)
+    assertNull(disabled.operatingSystem.isRooted)
   }
 
   @Test

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

@@ -259,7 +259,6 @@ class InternalSentrySdkTest {
   fun `set up`() {
     Sentry.close()
     context = ApplicationProvider.getApplicationContext()
-    DeviceInfoUtil.resetInstance()
   }
 
   @Test