Refine session tracking

- migrate option name `sessionTrackingEnabled`->`autoCaptureSessions`
 for consistency with other notifiers
- session reporting now respects the `notifyReleaseStages` and will
 only send if error reports will

lib/bugsnag.js

@@ -158,7 +158,7 @@ Bugsnag.configure = function(options) {
         });
     }
 
-    if (Configuration.sessionTrackingEnabled) {
+    if (Configuration.sessionTrackingEnabled || Configuration.autoCaptureSessions) {
         Bugsnag._sessionDelegate = createSessionDelegate(Configuration);
     }
 };
@@ -314,7 +314,7 @@ Bugsnag.onBeforeNotify = function (callback) {
 };
 
 Bugsnag.startSession = function () {
-    if (!Configuration.sessionTrackingEnabled) return null;
+    if (!Configuration.autoCaptureSessions) return null;
     return Bugsnag._sessionDelegate.startSession();
 };
 

lib/configuration.js

@@ -23,7 +23,7 @@ var Configuration = {
     metaData: {},
     logger: new Logger(),
     sendCode: true,
-    sessionTrackingEnabled: false,
+    autoCaptureSessions: false,
     sessionEndpoint: "https://sessions.bugsnag.com",
 
     beforeNotifyCallbacks: [],
@@ -71,7 +71,7 @@ var Configuration = {
             Configuration.appVersion = Utils.getPackageVersion(Utils.fullPath(options.packageJSON));
         }
         Configuration.sendCode = options.sendCode || Configuration.sendCode;
-        Configuration.sessionTrackingEnabled = options.sessionTrackingEnabled || Configuration.sessionTrackingEnabled;
+        Configuration.autoCaptureSessions = options.autoCaptureSessions || options.sessionTrackingEnabled || Configuration.autoCaptureSessions;
         Configuration.sessionEndpoint = options.sessionEndpoint || Configuration.sessionEndpoint;
     }
 }

lib/sessions/index.js

@@ -7,12 +7,18 @@ const Utils = require('../utils')
 const Backoff = require('backo')
 
 module.exports = (Configuration) => {
+  const shouldSend =
+    Configuration.notifyReleaseStages === null ||
+    Configuration.notifyReleaseStages.indexOf(Configuration.releaseStage) !== -1
   const sessions = new SessionTracker()
   sessions.on('summary', sendSessionSummary)
   sessions.start()
 
   function sendSessionSummary (sessions) {
     if (!sessions.length) return
+    if (!shouldSend) {
+      return Configuration.logger.warn("Current release stage prevented session report from being sent.")
+    }
 
     const payload = {
       notifier: notifier,

test/sessions/delegate.js

@@ -1,11 +1,10 @@
 'use strict'
 
 const proxyquire = require('proxyquire').noCallThru().noPreserveCache()
-
 const Emitter = require('events')
 
 describe('session delegate', () => {
-  it('should', done => {
+  it('should send the session report', done => {
     class TrackerMock extends Emitter {
       start () {
         this.emit('summary', [
@@ -25,8 +24,40 @@ describe('session delegate', () => {
       }
     })
     createSessionDelegate({
-      logger: { info: () => {} },
-      sessionEndpoint: 'blah'
+      logger: { info: () => {}, warn: () => {} },
+      sessionEndpoint: 'blah',
+      notifyReleaseStages: null
+    }).startSession({})
+  })
+
+  it('should not send the session report when releaseStage is not in notifyReleaseStages', done => {
+    class TrackerMock extends Emitter {
+      start () {
+        this.emit('summary', [
+          { startedAt: '2017-12-12T13:54:00.000Z', sessionsStarted: 123 }
+        ])
+      }
+      stop () {}
+      track () {}
+    }
+    const createSessionDelegate = proxyquire('../../lib/sessions', {
+      './tracker': TrackerMock,
+      'request': (opts) => {
+        true.should.equal(false)
+        done()
+      }
+    })
+    createSessionDelegate({
+      logger: {
+        info: () => {},
+        warn: (msg) => {
+          msg.should.equal('Current release stage prevented session report from being sent.')
+          setTimeout(done, 150)
+        }
+      },
+      sessionEndpoint: 'blah',
+      releaseStage: 'qa',
+      notifyReleaseStages: [ 'production' ]
     }).startSession({})
   })
 })