Enable automatic session tracking by default

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
-## 4.4.1 (TBD)
+## 4.X.X (TBD)
+
+**Note**: this release alters the behaviour of the notifier to track sessions automatically. If you
+use Bugsnag On-Premise, it is now also recommended that you set your notify and session endpoints
+via `config.setEndpoints(String notify, String sessions)`.
+
+* Enable automatic session tracking by default [#314](https://github.com/bugsnag/bugsnag-android/pull/314)
 
 ### Bug fixes
 
@@ -35,7 +41,6 @@ and [class documentation for `Delivery`](https://bugsnag.github.io/bugsnag-andro
 * Use buffered streams for IO (perf improvement)
 [#307](https://github.com/bugsnag/bugsnag-android/pull/307)
 
-
 ## 4.3.4 (2018-05-02)
 
 ### Bug fixes

mazerunner/src/main/java/com/bugsnag/android/mazerunner/MainActivity.kt

@@ -42,8 +42,7 @@ class MainActivity : Activity() {
     private fun prepareConfig(): Configuration {
         val config = Configuration(intent.getStringExtra("BUGSNAG_API_KEY"))
         val port = intent.getStringExtra("BUGSNAG_PORT")
-        config.endpoint = "${findHostname()}:$port"
-        config.sessionEndpoint = "${findHostname()}:$port"
+        config.setEndpoints("${findHostname()}:$port", "${findHostname()}:$port")
         return config
     }
 

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/AutoContextScenario.kt

@@ -14,6 +14,7 @@ internal class AutoContextScenario(config: Configuration,
                                    context: Context) : Scenario(config, context) {
 
     override fun run() {
+        config.setAutoCaptureSessions(false)
         super.run()
         context.startActivity(Intent(context, SecondActivity::class.java))
 

mazerunner/src/main/java/com/bugsnag/android/mazerunner/scenarios/AutoSessionScenario.kt

@@ -14,7 +14,6 @@ internal class AutoSessionScenario(config: Configuration,
                                    context: Context) : Scenario(config, context) {
 
     override fun run() {
-        config.setAutoCaptureSessions(true)
         super.run()
         Bugsnag.setUser("123", "user@example.com", "Joe Bloggs")
         context.startActivity(Intent(context, SecondActivity::class.java))

sdk/src/androidTest/java/com/bugsnag/android/ConfigurationTest.java

@@ -29,6 +29,50 @@ public void setUp() throws Exception {
 
     @Test
     public void testEndpoints() {
+        String notify = "https://notify.myexample.com";
+        String sessions = "https://sessions.myexample.com";
+        config.setEndpoints(notify, sessions);
+
+        assertEquals(notify, config.getEndpoint());
+        assertEquals(sessions, config.getSessionEndpoint());
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testNullNotifyEndpoint() {
+        //noinspection ConstantConditions
+        config.setEndpoints(null, "http://example.com");
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testEmptyNotifyEndpoint() {
+        config.setEndpoints("", "http://example.com");
+    }
+
+    @Test
+    public void testInvalidSessionEndpoint() {
+        //noinspection ConstantConditions
+        config.setEndpoints("http://example.com", null);
+        assertFalse(config.shouldAutoCaptureSessions());
+        assertNull(config.getSessionEndpoint());
+
+        config.setEndpoints("http://example.com", "");
+        assertFalse(config.shouldAutoCaptureSessions());
+        assertNull(config.getSessionEndpoint());
+
+        config.setEndpoints("http://example.com", "http://sessions.example.com");
+        assertFalse(config.shouldAutoCaptureSessions());
+        assertEquals("http://sessions.example.com", config.getSessionEndpoint());
+    }
+
+    @Test
+    public void testAutoCaptureOverride() {
+        config.setAutoCaptureSessions(false);
+        config.setEndpoints("http://example.com", "http://example.com");
+        assertFalse(config.shouldAutoCaptureSessions());
+    }
+
+    @Test
+    public void testEndpoint() {
         // Default endpoints
         assertEquals("https://notify.bugsnag.com", config.getEndpoint());
 
@@ -39,7 +83,7 @@ public void testEndpoints() {
     }
 
     @Test
-    public void testSessionEndpoints() {
+    public void testSessionEndpoint() {
         // Default endpoints
         assertEquals("https://sessions.bugsnag.com", config.getSessionEndpoint());
 
@@ -110,7 +154,9 @@ public void testLaunchThreshold() throws Exception {
     }
 
     @Test
-    public void testDefaults() throws Exception {
+    public void testAutoCaptureSessions() throws Exception {
+        assertTrue(config.shouldAutoCaptureSessions());
+        config.setAutoCaptureSessions(false);
         assertFalse(config.shouldAutoCaptureSessions());
     }
 

sdk/src/androidTest/java/com/bugsnag/android/SessionTrackerTest.java

@@ -182,4 +182,26 @@ public void testSessionTimeout() throws Exception {
         assertNotEquals(firstSession, sessionTracker.getCurrentSession());
     }
 
+    @Test
+    public void startSessionNoEndpoint() throws Exception {
+        assertNull(sessionTracker.getCurrentSession());
+        configuration.setEndpoints("http://localhost:1234", "");
+        sessionTracker.startNewSession(new Date(), user, false);
+        assertNull(sessionTracker.getCurrentSession());
+    }
+
+    @Test
+    public void startSessionAutoCaptureEnabled() {
+        assertNull(sessionTracker.getCurrentSession());
+        sessionTracker.startNewSession(new Date(), user, false);
+        assertNotNull(sessionTracker.getCurrentSession());
+    }
+
+    @Test
+    public void startSessionAutoCaptureDisabled() {
+        configuration.setAutoCaptureSessions(false);
+        assertNull(sessionTracker.getCurrentSession());
+        sessionTracker.startNewSession(new Date(), user, false);
+        assertNotNull(sessionTracker.getCurrentSession());
+    }
 }

sdk/src/main/java/com/bugsnag/android/Bugsnag.java

@@ -117,7 +117,8 @@ public static void setContext(final String context) {
      * endpoint.
      *
      * @param endpoint the custom endpoint to send report to
-     * @deprecated use {@link com.bugsnag.android.Configuration#setEndpoint(String)} instead.
+     * @deprecated use {@link com.bugsnag.android.Configuration#setEndpoints(String, String)}
+     * instead.
      */
     @Deprecated
     public static void setEndpoint(final String endpoint) {

sdk/src/main/java/com/bugsnag/android/Client.java

@@ -310,21 +310,21 @@ static Configuration populateConfigFromManifest(@NonNull Configuration config,
         config.setAppVersion(data.getString(MF_APP_VERSION));
         config.setReleaseStage(data.getString(MF_RELEASE_STAGE));
 
-        String endpoint = data.getString(MF_ENDPOINT);
-
-        if (endpoint != null) {
-            config.setEndpoint(endpoint);
-        }
-        String sessionEndpoint = data.getString(MF_SESSIONS_ENDPOINT);
-
-        if (sessionEndpoint != null) {
-            config.setSessionEndpoint(sessionEndpoint);
+        if (data.containsKey(MF_ENDPOINT)) {
+            String endpoint = data.getString(MF_ENDPOINT);
+            String sessionEndpoint = data.getString(MF_SESSIONS_ENDPOINT);
+            //noinspection ConstantConditions (pass in null/empty as this function will warn)
+            config.setEndpoints(endpoint, sessionEndpoint);
         }
 
         config.setSendThreads(data.getBoolean(MF_SEND_THREADS, true));
         config.setPersistUserBetweenSessions(
             data.getBoolean(MF_PERSIST_USER_BETWEEN_SESSIONS, false));
-        config.setAutoCaptureSessions(data.getBoolean(MF_AUTO_CAPTURE_SESSIONS, false));
+
+        if (data.containsKey(MF_AUTO_CAPTURE_SESSIONS)) {
+            config.setAutoCaptureSessions(data.getBoolean(MF_AUTO_CAPTURE_SESSIONS));
+        }
+
         config.setEnableExceptionHandler(
             data.getBoolean(MF_ENABLE_EXCEPTION_HANDLER, true));
         return config;
@@ -388,7 +388,10 @@ public void setContext(String context) {
      * endpoint.
      *
      * @param endpoint the custom endpoint to send report to
+     * @deprecated use {@link com.bugsnag.android.Configuration#setEndpoints(String, String)}
+     * instead.
      */
+    @Deprecated
     public void setEndpoint(String endpoint) {
         config.setEndpoint(endpoint);
     }

sdk/src/main/java/com/bugsnag/android/Configuration.java

@@ -3,6 +3,7 @@
 import android.content.Context;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.text.TextUtils;
 
 import java.util.Arrays;
 import java.util.Collection;
@@ -29,8 +30,8 @@ public class Configuration extends Observable implements Observer {
     private String buildUuid;
     private String appVersion;
     private String context;
-    private String endpoint = "https://notify.bugsnag.com";
-    private String sessionEndpoint = "https://sessions.bugsnag.com";
+    private volatile String endpoint = "https://notify.bugsnag.com";
+    private volatile String sessionEndpoint = "https://sessions.bugsnag.com";
 
     private String[] ignoreClasses;
     @Nullable
@@ -41,7 +42,7 @@ public class Configuration extends Observable implements Observer {
     private boolean enableExceptionHandler = true;
     private boolean persistUserBetweenSessions = false;
     private long launchCrashThresholdMs = 5 * 1000;
-    private boolean autoCaptureSessions = false;
+    private boolean autoCaptureSessions = true;
     private boolean automaticallyCollectBreadcrumbs = true;
 
     @NonNull
@@ -135,11 +136,48 @@ public String getEndpoint() {
      * endpoint.
      *
      * @param endpoint the custom endpoint to send report to
+     * @deprecated use {@link com.bugsnag.android.Configuration#setEndpoints(String, String)}
      */
+    @Deprecated
     public void setEndpoint(String endpoint) {
         this.endpoint = endpoint;
     }
 
+    /**
+     * Set the endpoints to send data to. By default we'll send error reports to
+     * https://notify.bugsnag.com, and sessions to https://sessions.bugsnag.com, but you can
+     * override this if you are using Bugsnag Enterprise to point to your own Bugsnag endpoint.
+     *
+     * Please note that it is recommended that you set both endpoints. If the notify endpoint is
+     * missing, an exception will be thrown. If the session endpoint is missing, a warning will be
+     * logged and sessions will not be sent automatically.
+     *
+     * @param notify the notify endpoint
+     * @param sessions the sessions endpoint
+     *
+     * @throws IllegalArgumentException if the notify endpoint is empty or null
+     */
+    public void setEndpoints(@NonNull String notify, @NonNull String sessions)
+        throws IllegalArgumentException {
+
+        if (TextUtils.isEmpty(notify)) {
+            throw new IllegalArgumentException("Notify endpoint cannot be empty or null.");
+        } else {
+            this.endpoint = notify;
+        }
+
+        boolean invalidSessionsEndpoint = TextUtils.isEmpty(sessions);
+
+        if (invalidSessionsEndpoint) {
+            Logger.warn("The session tracking endpoint has not been set. "
+                + "Session tracking is disabled");
+            this.sessionEndpoint = null;
+            this.autoCaptureSessions = false;
+        } else {
+            this.sessionEndpoint = sessions;
+        }
+    }
+
     /**
      * Gets the Session Tracking API endpoint
      *
@@ -151,12 +189,14 @@ public String getSessionEndpoint() {
 
     /**
      * Set the endpoint to send Session Tracking data to. By default we'll send reports to
-     * the standard https://session.bugsnag.com endpoint, but you can override
+     * the standard https://sessions.bugsnag.com endpoint, but you can override
      * this if you are using Bugsnag Enterprise to point to your own Bugsnag
      * endpoint.
      *
      * @param endpoint the custom endpoint to send session data to
+     * @deprecated use {@link com.bugsnag.android.Configuration#setEndpoints(String, String)}
      */
+    @Deprecated
     public void setSessionEndpoint(String endpoint) {
         this.sessionEndpoint = endpoint;
     }

sdk/src/main/java/com/bugsnag/android/SessionTracker.java

@@ -61,6 +61,11 @@ class SessionTracker implements Application.ActivityLifecycleCallbacks {
      * @param user the session user (if any)
      */
     void startNewSession(@NonNull Date date, @Nullable User user, boolean autoCaptured) {
+        if (configuration.getSessionEndpoint() == null) {
+            Logger.warn("The session tracking endpoint has not been set. "
+                + "Session tracking is disabled");
+            return;
+        }
         Session session = new Session(UUID.randomUUID().toString(), date, user, autoCaptured);
         currentSession.set(session);
         trackSessionIfNeeded(session);