[ANDROID] Support for passing in an Application directly to the AndroidSentryClientFactory (getsentry#714)

justacodefan · bruno-garcia · commit 89695062a08b · 2019-07-18T17:36:23.000+02:00
diff --git a/sentry-android/src/main/java/io/sentry/android/AndroidSentryClientFactory.java b/sentry-android/src/main/java/io/sentry/android/AndroidSentryClientFactory.java
@@ -1,11 +1,13 @@
 package io.sentry.android;
 
 import android.Manifest;
+import android.app.Application;
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.util.Log;
-import io.sentry.*;
+import io.sentry.DefaultSentryClientFactory;
+import io.sentry.SentryClient;
 import io.sentry.android.event.helper.AndroidEventBuilderHelper;
 import io.sentry.buffer.Buffer;
 import io.sentry.buffer.DiskBuffer;
@@ -14,7 +16,6 @@
 import io.sentry.context.SingletonContextManager;
 import io.sentry.dsn.Dsn;
 import io.sentry.util.Util;
-
 import java.io.File;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -30,24 +31,40 @@ public class AndroidSentryClientFactory extends DefaultSentryClientFactory {
      * Logger tag.
      */
     public static final String TAG = AndroidSentryClientFactory.class.getName();
+
     /**
      * Default Buffer directory name.
      */
     private static final String DEFAULT_BUFFER_DIR = "sentry-buffered-events";
 
     private Context ctx;
 
+    /**
+     * Construct an AndroidSentryClientFactory using the base Context from the specified Android Application.
+     *
+     * @param app Android Application
+     */
+    public AndroidSentryClientFactory(Application app) {
+        Log.d(TAG, "Construction of Android Sentry from Android Application.");
+
+        this.ctx = app.getApplicationContext();
+    }
+
     /**
      * Construct an AndroidSentryClientFactory using the specified Android Context.
      *
      * @param ctx Android Context.
      */
     public AndroidSentryClientFactory(Context ctx) {
-        Log.d(TAG, "Construction of Android Sentry.");
+        Log.d(TAG, "Construction of Android Sentry from Android Context.");
 
         this.ctx = ctx.getApplicationContext();
+        if (this.ctx == null) {
+            this.ctx = ctx;
+        }
     }
 
+
     @Override
     public SentryClient createSentryClient(Dsn dsn) {
         if (!checkPermission(Manifest.permission.INTERNET)) {
@@ -123,11 +140,11 @@ protected ContextManager getContextManager(Dsn dsn) {
      * Check whether the application has been granted a certain permission.
      *
      * @param permission Permission as a string
+     *
      * @return true if permissions is granted
      */
     private boolean checkPermission(String permission) {
         int res = ctx.checkCallingOrSelfPermission(permission);
         return (res == PackageManager.PERMISSION_GRANTED);
     }
-
 }
diff --git a/sentry-android/src/test/java/io/sentry/android/SentryAndroidIT.java b/sentry-android/src/test/java/io/sentry/android/SentryAndroidIT.java
@@ -12,11 +12,31 @@
 public class SentryAndroidIT extends AndroidTest {
 
     @Test
-    public void test() throws Exception {
+    public void testInitializingUsingBaseContext() throws Exception {
         verifyProject1PostRequestCount(0);
         verifyStoredEventCount(0);
 
-        SentryITActivity activity = Robolectric.setupActivity(SentryITActivity.class);
+        SentryITActivityUsingBaseContext activity = Robolectric.setupActivity(SentryITActivityUsingBaseContext.class);
+        Assert.assertEquals(activity.getCustomFactoryUsed(), true);
+
+        activity.sendEvent();
+        waitUntilTrue(1000, new Callable<Boolean>() {
+            @Override
+            public Boolean call() throws Exception {
+                return getStoredEvents().size() == 1;
+            }
+        });
+
+        verifyProject1PostRequestCount(1);
+        verifyStoredEventCount(1);
+    }
+
+    @Test
+    public void testInitializingUsingApplication() throws Exception {
+        verifyProject1PostRequestCount(0);
+        verifyStoredEventCount(0);
+
+        SentryITActivityUsingApplication activity = Robolectric.setupActivity(SentryITActivityUsingApplication.class);
         Assert.assertEquals(activity.getCustomFactoryUsed(), true);
 
         activity.sendEvent();
diff --git a/sentry-android/src/test/java/io/sentry/android/SentryITActivityUsingApplication.java b/sentry-android/src/test/java/io/sentry/android/SentryITActivityUsingApplication.java
@@ -0,0 +1,42 @@
+package io.sentry.android;
+
+import android.app.Activity;
+import android.app.Application;
+import android.content.Context;
+import android.os.Bundle;
+import io.sentry.Sentry;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+public class SentryITActivityUsingApplication extends Activity {
+
+    private AtomicBoolean customFactoryUsed = new AtomicBoolean(false);
+
+    class CustomAndroidSentryClientFactory extends AndroidSentryClientFactory {
+
+        /**
+         * Construct an AndroidSentryClientFactory using the specified Android Context.
+         *
+         * @param app Android Application
+         */
+        CustomAndroidSentryClientFactory(Application app) {
+            super(app);
+            customFactoryUsed.set(true);
+        }
+    }
+
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        Sentry.init(
+            "http://8292bf61d620417282e68a72ae03154a:e3908e05ad874b24b7a168992bfa3577@localhost:8080/1",
+            new CustomAndroidSentryClientFactory(getApplication()));
+    }
+
+    public void sendEvent() {
+        Sentry.capture("sendEvent()");
+    }
+
+    public boolean getCustomFactoryUsed() {
+        return customFactoryUsed.get();
+    }
+}
diff --git a/sentry-android/src/test/java/io/sentry/android/SentryITActivityUsingBaseContext.java b/sentry-android/src/test/java/io/sentry/android/SentryITActivityUsingBaseContext.java
@@ -1,23 +1,24 @@
 package io.sentry.android;
 
 import android.app.Activity;
+import android.app.Application;
 import android.content.Context;
 import android.os.Bundle;
 import io.sentry.Sentry;
-
 import java.util.concurrent.atomic.AtomicBoolean;
 
-public class SentryITActivity extends Activity {
+public class SentryITActivityUsingBaseContext extends Activity {
 
     private AtomicBoolean customFactoryUsed = new AtomicBoolean(false);
 
     class CustomAndroidSentryClientFactory extends AndroidSentryClientFactory {
+
         /**
          * Construct an AndroidSentryClientFactory using the specified Android Context.
          *
-         * @param ctx Android Context.
+         * @param ctx Android Context
          */
-        public CustomAndroidSentryClientFactory(Context ctx) {
+        CustomAndroidSentryClientFactory(Context ctx) {
             super(ctx);
             customFactoryUsed.set(true);
         }
@@ -28,7 +29,7 @@ protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         Sentry.init(
             "http://8292bf61d620417282e68a72ae03154a:e3908e05ad874b24b7a168992bfa3577@localhost:8080/1",
-            new CustomAndroidSentryClientFactory(getApplicationContext()));
+            new CustomAndroidSentryClientFactory(getBaseContext()));
     }
 
     public void sendEvent() {
@@ -38,5 +39,4 @@ public void sendEvent() {
     public boolean getCustomFactoryUsed() {
         return customFactoryUsed.get();
     }
-
 }
