Ensure app context is used even when SDK is initialized via Activity …

…Context (#3669)

* Ensure app context is used even when SDK is initialized via Activity Context

* Update Changelog

* Exclude saucelabs from leakcanary

* Exclude saucelabs TouchListener from leakCanary

* Allow leakcanary for non-debug ui-test builds

* Fix lint

CHANGELOG.md

@@ -17,6 +17,7 @@
   - redact/ignore `View`s of a certain type by adding fully-qualified classname to one of the lists `options.experimental.sessionReplay.addRedactViewClass()` or `options.experimental.sessionReplay.addIgnoreViewClass()`. Note, that all of the view subclasses/subtypes will be redacted/ignored as well
     - For example, (this is already a default behavior) to redact all `TextView`s and their subclasses (`RadioButton`, `EditText`, etc.): `options.experimental.sessionReplay.addRedactViewClass("android.widget.TextView")`
     - If you're using code obfuscation, adjust your proguard-rules accordingly, so your custom view class name is not minified
+- Fix ensure Application Context is used even when SDK is initialized via Activity Context ([#3669](https://github.com/getsentry/sentry-java/pull/3669))
 
 *Breaking changes*:
 

buildSrc/src/main/java/Config.kt

@@ -53,7 +53,7 @@ object Config {
         val appCompat = "androidx.appcompat:appcompat:1.3.0"
         val timber = "com.jakewharton.timber:timber:4.7.1"
         val okhttp = "com.squareup.okhttp3:okhttp:$okHttpVersion"
-        val leakCanary = "com.squareup.leakcanary:leakcanary-android:2.8.1"
+        val leakCanary = "com.squareup.leakcanary:leakcanary-android:2.14"
         val constraintLayout = "androidx.constraintlayout:constraintlayout:2.1.3"
 
         private val lifecycleVersion = "2.2.0"
@@ -197,6 +197,7 @@ object Config {
         val hsqldb = "org.hsqldb:hsqldb:2.6.1"
         val javaFaker = "com.github.javafaker:javafaker:1.0.2"
         val msgpack = "org.msgpack:msgpack-core:0.9.8"
+        val leakCanaryInstrumentation = "com.squareup.leakcanary:leakcanary-android-instrumentation:2.14"
     }
 
     object QualityPlugins {

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

@@ -158,6 +158,7 @@ public final class io/sentry/android/core/BuildInfoProvider {
 }
 
 public final class io/sentry/android/core/ContextUtils {
+	public static fun getApplicationContext (Landroid/content/Context;)Landroid/content/Context;
 	public static fun isForegroundImportance ()Z
 }
 

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

@@ -90,10 +90,7 @@ static void loadDefaultAndMetadataOptions(
       final @NotNull BuildInfoProvider buildInfoProvider) {
     Objects.requireNonNull(context, "The context is required.");
 
-    // it returns null if ContextImpl, so let's check for nullability
-    if (context.getApplicationContext() != null) {
-      context = context.getApplicationContext();
-    }
+    context = ContextUtils.getApplicationContext(context);
 
     Objects.requireNonNull(options, "The options object is required.");
     Objects.requireNonNull(logger, "The ILogger object is required.");

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

@@ -87,7 +87,9 @@ public AndroidTransactionProfiler(
       final boolean isProfilingEnabled,
       final int profilingTracesHz,
       final @NotNull ISentryExecutorService executorService) {
-    this.context = Objects.requireNonNull(context, "The application context is required");
+    this.context =
+        Objects.requireNonNull(
+            ContextUtils.getApplicationContext(context), "The application context is required");
     this.logger = Objects.requireNonNull(logger, "ILogger is required");
     this.frameMetricsCollector =
         Objects.requireNonNull(frameMetricsCollector, "SentryFrameMetricsCollector is required");

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

@@ -33,7 +33,7 @@ public final class AnrIntegration implements Integration, Closeable {
   private final @NotNull Object startLock = new Object();
 
   public AnrIntegration(final @NotNull Context context) {
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
   }
 
   /**

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

@@ -97,7 +97,7 @@ public AnrV2EventProcessor(
       final @NotNull SentryAndroidOptions options,
       final @NotNull BuildInfoProvider buildInfoProvider,
       final @Nullable SecureRandom random) {
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
     this.options = options;
     this.buildInfoProvider = buildInfoProvider;
     this.random = random;

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

@@ -63,7 +63,7 @@ public AnrV2Integration(final @NotNull Context context) {
 
   AnrV2Integration(
       final @NotNull Context context, final @NotNull ICurrentDateProvider dateProvider) {
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
     this.dateProvider = dateProvider;
   }
 

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

@@ -29,7 +29,8 @@ public final class AppComponentsBreadcrumbsIntegration
   private @Nullable SentryAndroidOptions options;
 
   public AppComponentsBreadcrumbsIntegration(final @NotNull Context context) {
-    this.context = Objects.requireNonNull(context, "Context is required");
+    this.context =
+        Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
   }
 
   @Override

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

@@ -383,4 +383,19 @@ static void setAppPackageInfo(
     }
     app.setPermissions(permissions);
   }
+
+  /**
+   * Get the app context
+   *
+   * @return the app context, or if not available, the provided context
+   */
+  @NotNull
+  public static Context getApplicationContext(final @NotNull Context context) {
+    // it returns null if ContextImpl, so let's check for nullability
+    final @Nullable Context appContext = context.getApplicationContext();
+    if (appContext != null) {
+      return appContext;
+    }
+    return context;
+  }
 }

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

@@ -47,7 +47,9 @@ public DefaultAndroidEventProcessor(
       final @NotNull Context context,
       final @NotNull BuildInfoProvider buildInfoProvider,
       final @NotNull SentryAndroidOptions options) {
-    this.context = Objects.requireNonNull(context, "The application context is required.");
+    this.context =
+        Objects.requireNonNull(
+            ContextUtils.getApplicationContext(context), "The application context is required.");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "The BuildInfoProvider is required.");
     this.options = Objects.requireNonNull(options, "The options object is required.");
@@ -57,7 +59,7 @@ public DefaultAndroidEventProcessor(
     // some device info performs disk I/O, but it's result is cached, let's pre-cache it
     final @NotNull ExecutorService executorService = Executors.newSingleThreadExecutor();
     this.deviceInfoUtil =
-        executorService.submit(() -> DeviceInfoUtil.getInstance(context, options));
+        executorService.submit(() -> DeviceInfoUtil.getInstance(this.context, options));
     executorService.shutdown();
   }
 

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

@@ -76,7 +76,7 @@ public static DeviceInfoUtil getInstance(
     if (instance == null) {
       synchronized (DeviceInfoUtil.class) {
         if (instance == null) {
-          instance = new DeviceInfoUtil(context.getApplicationContext(), options);
+          instance = new DeviceInfoUtil(ContextUtils.getApplicationContext(context), options);
         }
       }
     }

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

@@ -42,7 +42,8 @@ public NetworkBreadcrumbsIntegration(
       final @NotNull Context context,
       final @NotNull BuildInfoProvider buildInfoProvider,
       final @NotNull ILogger logger) {
-    this.context = Objects.requireNonNull(context, "Context is required");
+    this.context =
+        Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required");
     this.logger = Objects.requireNonNull(logger, "ILogger is required");

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

@@ -28,7 +28,8 @@ public final class PhoneStateBreadcrumbsIntegration implements Integration, Clos
   private final @NotNull Object startLock = new Object();
 
   public PhoneStateBreadcrumbsIntegration(final @NotNull Context context) {
-    this.context = Objects.requireNonNull(context, "Context is required");
+    this.context =
+        Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
   }
 
   @Override

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

@@ -159,10 +159,9 @@ private void launchAppStartProfiler(final @NotNull AppStartMetrics appStartMetri
 
       final @NotNull ITransactionProfiler appStartProfiler =
           new AndroidTransactionProfiler(
-              context.getApplicationContext(),
+              context,
               buildInfoProvider,
-              new SentryFrameMetricsCollector(
-                  context.getApplicationContext(), logger, buildInfoProvider),
+              new SentryFrameMetricsCollector(context, logger, buildInfoProvider),
               logger,
               profilingOptions.getProfilingTracesDirPath(),
               profilingOptions.isProfilingEnabled(),

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

@@ -77,7 +77,8 @@ public SystemEventsBreadcrumbsIntegration(final @NotNull Context context) {
 
   public SystemEventsBreadcrumbsIntegration(
       final @NotNull Context context, final @NotNull List<String> actions) {
-    this.context = Objects.requireNonNull(context, "Context is required");
+    this.context =
+        Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
     this.actions = Objects.requireNonNull(actions, "Actions list is required");
   }
 

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

@@ -34,7 +34,8 @@ public final class TempSensorBreadcrumbsIntegration
   private final @NotNull Object startLock = new Object();
 
   public TempSensorBreadcrumbsIntegration(final @NotNull Context context) {
-    this.context = Objects.requireNonNull(context, "Context is required");
+    this.context =
+        Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
   }
 
   @Override

sentry-android-core/src/main/java/io/sentry/android/core/internal/debugmeta/AssetsDebugMetaLoader.java

@@ -6,6 +6,7 @@
 import android.content.res.AssetManager;
 import io.sentry.ILogger;
 import io.sentry.SentryLevel;
+import io.sentry.android.core.ContextUtils;
 import io.sentry.internal.debugmeta.IDebugMetaLoader;
 import java.io.BufferedInputStream;
 import java.io.FileNotFoundException;
@@ -24,7 +25,7 @@ public final class AssetsDebugMetaLoader implements IDebugMetaLoader {
   private final @NotNull ILogger logger;
 
   public AssetsDebugMetaLoader(final @NotNull Context context, final @NotNull ILogger logger) {
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
     this.logger = logger;
   }
 

sentry-android-core/src/main/java/io/sentry/android/core/internal/modules/AssetsModulesLoader.java

@@ -3,6 +3,7 @@
 import android.content.Context;
 import io.sentry.ILogger;
 import io.sentry.SentryLevel;
+import io.sentry.android.core.ContextUtils;
 import io.sentry.internal.modules.ModulesLoader;
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -19,7 +20,7 @@ public final class AssetsModulesLoader extends ModulesLoader {
 
   public AssetsModulesLoader(final @NotNull Context context, final @NotNull ILogger logger) {
     super(logger);
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
   }
 
   @Override

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/AndroidConnectionStatusProvider.java

@@ -12,6 +12,7 @@
 import io.sentry.ILogger;
 import io.sentry.SentryLevel;
 import io.sentry.android.core.BuildInfoProvider;
+import io.sentry.android.core.ContextUtils;
 import java.util.HashMap;
 import java.util.Map;
 import org.jetbrains.annotations.ApiStatus;
@@ -37,7 +38,7 @@ public AndroidConnectionStatusProvider(
       @NotNull Context context,
       @NotNull ILogger logger,
       @NotNull BuildInfoProvider buildInfoProvider) {
-    this.context = context;
+    this.context = ContextUtils.getApplicationContext(context);
     this.logger = logger;
     this.buildInfoProvider = buildInfoProvider;
     this.registeredCallbacks = new HashMap<>();

sentry-android-core/src/main/java/io/sentry/android/core/internal/util/SentryFrameMetricsCollector.java

@@ -17,6 +17,7 @@
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
 import io.sentry.android.core.BuildInfoProvider;
+import io.sentry.android.core.ContextUtils;
 import io.sentry.util.Objects;
 import java.lang.ref.WeakReference;
 import java.lang.reflect.Field;
@@ -84,15 +85,17 @@ public SentryFrameMetricsCollector(
       final @NotNull ILogger logger,
       final @NotNull BuildInfoProvider buildInfoProvider,
       final @NotNull WindowFrameMetricsManager windowFrameMetricsManager) {
-    Objects.requireNonNull(context, "The context is required");
+    final @NotNull Context appContext =
+        Objects.requireNonNull(
+            ContextUtils.getApplicationContext(context), "The context is required");
     this.logger = Objects.requireNonNull(logger, "Logger is required");
     this.buildInfoProvider =
         Objects.requireNonNull(buildInfoProvider, "BuildInfoProvider is required");
     this.windowFrameMetricsManager =
         Objects.requireNonNull(windowFrameMetricsManager, "WindowFrameMetricsManager is required");
 
     // registerActivityLifecycleCallbacks is only available if Context is an AppContext
-    if (!(context instanceof Application)) {
+    if (!(appContext instanceof Application)) {
       return;
     }
     // FrameMetrics api is only available since sdk version N
@@ -110,7 +113,7 @@ public SentryFrameMetricsCollector(
 
     // We have to register the lifecycle callback, even if no profile is started, otherwise when we
     // start a profile, we wouldn't have the current activity and couldn't get the frameMetrics.
-    ((Application) context).registerActivityLifecycleCallbacks(this);
+    ((Application) appContext).registerActivityLifecycleCallbacks(this);
 
     // Most considerations regarding timestamps of frames are inspired from JankStats library:
     // https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:metrics/metrics-performance/src/main/java/androidx/metrics/performance/JankStatsApi24Impl.kt

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

@@ -29,6 +29,7 @@ import kotlin.test.assertEquals
 import kotlin.test.assertFalse
 import kotlin.test.assertNotNull
 import kotlin.test.assertNull
+import kotlin.test.assertSame
 import kotlin.test.assertTrue
 
 @Config(sdk = [33])
@@ -213,4 +214,21 @@ class ContextUtilsTest {
         )
         assertFalse(ContextUtils.isForegroundImportance())
     }
+
+    @Test
+    fun `getApplicationContext returns context if app context is null`() {
+        val contextMock = mock<Context>()
+        val appContext = ContextUtils.getApplicationContext(contextMock)
+        assertSame(contextMock, appContext)
+    }
+
+    @Test
+    fun `getApplicationContext returns app context`() {
+        val contextMock = mock<Context>()
+        val appContextMock = mock<Context>()
+        whenever(contextMock.applicationContext).thenReturn(appContextMock)
+
+        val appContext = ContextUtils.getApplicationContext(contextMock)
+        assertSame(appContextMock, appContext)
+    }
 }

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

@@ -362,7 +362,7 @@ class SentryAndroidTest {
         optionsConfig: (SentryAndroidOptions) -> Unit = {},
         callback: (session: Session?) -> Unit
     ) {
-        Mockito.mockStatic(ContextUtils::class.java).use { mockedContextUtils ->
+        Mockito.mockStatic(ContextUtils::class.java, Mockito.CALLS_REAL_METHODS).use { mockedContextUtils ->
             mockedContextUtils.`when`<Any> { ContextUtils.isForegroundImportance() }
                 .thenReturn(inForeground)
             SentryAndroid.init(context) { options ->

sentry-android-integration-tests/sentry-uitest-android/build.gradle.kts

@@ -109,6 +109,7 @@ dependencies {
     implementation(Config.Libs.androidxRecylerView)
     implementation(Config.Libs.constraintLayout)
     implementation(Config.TestLibs.espressoIdlingResource)
+    implementation(Config.Libs.leakCanary)
 
     compileOnly(Config.CompileOnly.nopen)
     errorprone(Config.CompileOnly.nopenChecker)
@@ -123,6 +124,7 @@ dependencies {
     androidTestImplementation(Config.TestLibs.androidxTestCoreKtx)
     androidTestImplementation(Config.TestLibs.mockWebserver)
     androidTestImplementation(Config.TestLibs.androidxJunit)
+    androidTestImplementation(Config.TestLibs.leakCanaryInstrumentation)
     androidTestUtil(Config.TestLibs.androidxTestOrchestrator)
 }
 

sentry-android-integration-tests/sentry-uitest-android/src/androidTest/java/io/sentry/uitest/android/BaseUiTest.kt

@@ -77,6 +77,7 @@ abstract class BaseUiTest {
      */
     protected fun initSentry(
         relayWaitForRequests: Boolean = false,
+        context: Context = this.context,
         optionsConfiguration: ((options: SentryAndroidOptions) -> Unit)? = null
     ) {
         relay.waitForRequests = relayWaitForRequests