fix: deprecate whitelist/blacklist in favor of safelist/blocklist (#911)

Author: waltjones

src/browser/core.js

@@ -14,7 +14,7 @@ var sharedPredicates = require('../predicates');
 var errorParser = require('../errorParser');
 
 function Rollbar(options, client) {
-  this.options = _.handleOptions(defaultOptions, options);
+  this.options = _.handleOptions(defaultOptions, options, null, logger);
   this.options._configuredOptions = options;
   var Telemeter = this.components.telemeter;
   var Instrumenter = this.components.instrumenter;
@@ -84,7 +84,7 @@ Rollbar.prototype.configure = function(options, payloadData) {
   if (payloadData) {
     payload = {payload: payloadData};
   }
-  this.options = _.handleOptions(oldOptions, options, payload);
+  this.options = _.handleOptions(oldOptions, options, payload, logger);
   this.options._configuredOptions = _.handleOptions(oldOptions._configuredOptions, options, payload);
   this.client.configure(this.options, payloadData);
   this.instrumenter && this.instrumenter.configure(this.options);
@@ -511,8 +511,8 @@ function addPredicatesToQueue(queue) {
     .addPredicate(sharedPredicates.checkLevel)
     .addPredicate(predicates.checkIgnore)
     .addPredicate(sharedPredicates.userCheckIgnore(logger))
-    .addPredicate(sharedPredicates.urlIsNotBlacklisted(logger))
-    .addPredicate(sharedPredicates.urlIsWhitelisted(logger))
+    .addPredicate(sharedPredicates.urlIsNotBlockListed(logger))
+    .addPredicate(sharedPredicates.urlIsSafeListed(logger))
     .addPredicate(sharedPredicates.messageIsIgnored(logger));
 }
 

src/predicates.js

@@ -38,24 +38,24 @@ function userCheckIgnore(logger) {
   }
 }
 
-function urlIsNotBlacklisted(logger) {
+function urlIsNotBlockListed(logger) {
   return function(item, settings) {
-    return !urlIsOnAList(item, settings, 'blacklist', logger);
+    return !urlIsOnAList(item, settings, 'blocklist', logger);
   }
 }
 
-function urlIsWhitelisted(logger) {
+function urlIsSafeListed(logger) {
   return function(item, settings) {
-    return urlIsOnAList(item, settings, 'whitelist', logger);
+    return urlIsOnAList(item, settings, 'safelist', logger);
   }
 }
 
-function matchFrames(trace, list, black) {
-  if (!trace) { return !black }
+function matchFrames(trace, list, block) {
+  if (!trace) { return !block }
 
   var frames = trace.frames;
 
-  if (!frames || frames.length === 0) { return !black; }
+  if (!frames || frames.length === 0) { return !block; }
 
   var frame, filename, url, urlRegex;
   var listLength = list.length;
@@ -64,7 +64,7 @@ function matchFrames(trace, list, black) {
     frame = frames[i];
     filename = frame.filename;
 
-    if (!_.isType(filename, 'string')) { return !black; }
+    if (!_.isType(filename, 'string')) { return !block; }
 
     for (var j = 0; j < listLength; j++) {
       url = list[j];
@@ -78,44 +78,44 @@ function matchFrames(trace, list, black) {
   return false;
 }
 
-function urlIsOnAList(item, settings, whiteOrBlack, logger) {
-  // whitelist is the default
-  var black = false;
-  if (whiteOrBlack === 'blacklist') {
-    black = true;
+function urlIsOnAList(item, settings, safeOrBlock, logger) {
+  // safelist is the default
+  var block = false;
+  if (safeOrBlock === 'blocklist') {
+    block = true;
   }
 
   var list, traces;
   try {
-    list = black ? settings.hostBlackList : settings.hostWhiteList;
+    list = block ? settings.hostBlockList : settings.hostSafeList;
     traces = _.get(item, 'body.trace_chain') || [_.get(item, 'body.trace')];
 
     // These two checks are important to come first as they are defaults
     // in case the list is missing or the trace is missing or not well-formed
     if (!list || list.length === 0) {
-      return !black;
+      return !block;
     }
     if (traces.length === 0 || !traces[0]) {
-      return !black;
+      return !block;
     }
 
     var tracesLength = traces.length;
     for (var i = 0; i < tracesLength; i++) {
-      if(matchFrames(traces[i], list, black)) {
+      if(matchFrames(traces[i], list, block)) {
         return true;
       }
     }
   } catch (e)
   /* istanbul ignore next */
   {
-    if (black) {
-      settings.hostBlackList = null;
+    if (block) {
+      settings.hostBlockList = null;
     } else {
-      settings.hostWhiteList = null;
+      settings.hostSafeList = null;
     }
-    var listName = black ? 'hostBlackList' : 'hostWhiteList';
+    var listName = block ? 'hostBlockList' : 'hostSafeList';
     logger.error('Error while reading your configuration\'s ' + listName + ' option. Removing custom ' + listName + '.', e);
-    return !black;
+    return !block;
   }
   return false;
 }
@@ -167,7 +167,7 @@ function messageIsIgnored(logger) {
 module.exports = {
   checkLevel: checkLevel,
   userCheckIgnore: userCheckIgnore,
-  urlIsNotBlacklisted: urlIsNotBlacklisted,
-  urlIsWhitelisted: urlIsWhitelisted,
+  urlIsNotBlockListed: urlIsNotBlockListed,
+  urlIsSafeListed: urlIsSafeListed,
   messageIsIgnored: messageIsIgnored
 };

src/react-native/rollbar.js

@@ -20,7 +20,7 @@ function Rollbar(options, client) {
     options = {};
     options.accessToken = accessToken;
   }
-  this.options = _.handleOptions(Rollbar.defaultOptions, options);
+  this.options = _.handleOptions(Rollbar.defaultOptions, options, null, logger);
   this.options._configuredOptions = options;
   // This makes no sense in a long running app
   delete this.options.maxItems;
@@ -70,7 +70,7 @@ Rollbar.prototype.configure = function(options, payloadData) {
   if (payloadData) {
     payload = {payload: payloadData};
   }
-  this.options = _.handleOptions(oldOptions, options, payload);
+  this.options = _.handleOptions(oldOptions, options, payload, logger);
   this.options._configuredOptions = _.handleOptions(oldOptions._configuredOptions, options, payload);
   this.client.configure(options, payloadData);
   return this;

src/server/rollbar.js

@@ -28,7 +28,7 @@ function Rollbar(options, client) {
     options.reportLevel = options.minimumLevel;
     delete options.minimumLevel;
   }
-  this.options = _.handleOptions(Rollbar.defaultOptions, options);
+  this.options = _.handleOptions(Rollbar.defaultOptions, options, null, logger);
   this.options._configuredOptions = options;
   // On the server we want to ignore any maxItems setting
   delete this.options.maxItems;
@@ -84,7 +84,7 @@ Rollbar.prototype.configure = function (options, payloadData) {
   if (payloadData) {
     payload = { payload: payloadData };
   }
-  this.options = _.handleOptions(oldOptions, options, payload);
+  this.options = _.handleOptions(oldOptions, options, payload, logger);
   this.options._configuredOptions = _.handleOptions(oldOptions._configuredOptions, options, payload);
   // On the server we want to ignore any maxItems setting
   delete this.options.maxItems;
@@ -514,8 +514,8 @@ function addPredicatesToQueue(queue) {
   queue
     .addPredicate(sharedPredicates.checkLevel)
     .addPredicate(sharedPredicates.userCheckIgnore(logger))
-    .addPredicate(sharedPredicates.urlIsNotBlacklisted(logger))
-    .addPredicate(sharedPredicates.urlIsWhitelisted(logger))
+    .addPredicate(sharedPredicates.urlIsNotBlockListed(logger))
+    .addPredicate(sharedPredicates.urlIsSafeListed(logger))
     .addPredicate(sharedPredicates.messageIsIgnored(logger));
 }
 

src/utility.js

@@ -665,8 +665,9 @@ function filterIp(requestData, captureIp) {
   requestData['user_ip'] = newIp;
 }
 
-function handleOptions(current, input, payload) {
+function handleOptions(current, input, payload, logger) {
   var result = merge(current, input, payload);
+  result = updateDeprecatedOptions(result, logger);
   if (!input || input.overwriteScrubFields) {
     return result;
   }
@@ -676,6 +677,20 @@ function handleOptions(current, input, payload) {
   return result;
 }
 
+function updateDeprecatedOptions(options, logger) {
+  if(options.hostWhiteList && !options.hostSafeList) {
+    options.hostSafeList = options.hostWhiteList;
+    options.hostWhiteList = undefined;
+    logger && logger.log('hostWhiteList is deprecated. Use hostSafeList.');
+  }
+  if(options.hostBlackList && !options.hostBlockList) {
+    options.hostBlockList = options.hostBlackList;
+    options.hostBlackList = undefined;
+    logger && logger.log('hostBlackList is deprecated. Use hostBlockList.');
+  }
+  return options;
+}
+
 module.exports = {
   addParamsAndAccessTokenToPath: addParamsAndAccessTokenToPath,
   createItem: createItem,

test/browser.rollbar.test.js

@@ -140,6 +140,21 @@ describe('Rollbar()', function() {
     done();
   });
 
+  it ('should replace deprecated options', function(done) {
+    var client = new (TestClientGen())();
+    var options = {
+      hostWhiteList: ['foo'],
+      hostBlackList: ['bar']
+    };
+    var rollbar = window.rollbar = new Rollbar(options, client);
+
+    expect(rollbar.options.hostWhiteList).to.eql(undefined);
+    expect(rollbar.options.hostBlackList).to.eql(undefined);
+    expect(rollbar.options.hostSafeList).to.contain('foo');
+    expect(rollbar.options.hostBlockList).to.contain('bar');
+    done();
+  });
+
   it('should return a uuid when logging', function(done) {
     var client = new (TestClientGen())();
     var options = {};
@@ -254,6 +269,21 @@ describe('configure', function() {
     expect(client.payloadData.b).to.eql(97);
     done();
   });
+  it ('should replace deprecated options', function(done) {
+    var client = new (TestClientGen())();
+    var options = {
+      hostWhiteList: ['foo'],
+      hostBlackList: ['bar']
+    };
+    var rollbar = window.rollbar = new Rollbar({ autoInstrument: false }, client);
+    rollbar.configure(options);
+
+    expect(rollbar.options.hostWhiteList).to.eql(undefined);
+    expect(rollbar.options.hostBlackList).to.eql(undefined);
+    expect(rollbar.options.hostSafeList).to.contain('foo');
+    expect(rollbar.options.hostBlockList).to.contain('bar');
+    done();
+  });
   it('should store configured options', function(done) {
     var client = new (TestClientGen())();
     var options = {