rollbar 2.26.3 → 3.0.0-alpha.1

package/src/utility.js

@@ -8,14 +8,15 @@ function setupJSON(polyfillJSON) {
 
   if (isDefined(JSON)) {
     // If polyfill is provided, prefer it over existing non-native shims.
-    if(polyfillJSON) {
+    if (polyfillJSON) {
       if (isNativeFunction(JSON.stringify)) {
         RollbarJSON.stringify = JSON.stringify;
       }
       if (isNativeFunction(JSON.parse)) {
         RollbarJSON.parse = JSON.parse;
       }
-    } else { // else accept any interface that is present.
+    } else {
+      // else accept any interface that is present.
       if (isFunction(JSON.stringify)) {
         RollbarJSON.stringify = JSON.stringify;
       }
@@ -65,7 +66,10 @@ function typeName(x) {
   if (x instanceof Error) {
     return 'error';
   }
-  return ({}).toString.call(x).match(/\s([a-zA-Z]+)/)[1].toLowerCase();
+  return {}.toString
+    .call(x)
+    .match(/\s([a-zA-Z]+)/)[1]
+    .toLowerCase();
 }
 
 /* isFunction - a convenience function for checking if a value is a function
@@ -84,7 +88,8 @@ function isFunction(f) {
  */
 function isNativeFunction(f) {
   var reRegExpChar = /[\\^$.*+?()[\]{}|]/g;
-  var funcMatchString = Function.prototype.toString.call(Object.prototype.hasOwnProperty)
+  var funcMatchString = Function.prototype.toString
+    .call(Object.prototype.hasOwnProperty)
     .replace(reRegExpChar, '\\$&')
     .replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g, '$1.*?');
   var reIsNative = RegExp('^' + funcMatchString + '$');
@@ -95,7 +100,7 @@ function isNativeFunction(f) {
  *
  * @param value - any value
  * @returns true is value is an object function is an object)
-*/
+ */
 function isObject(value) {
   var type = typeof value;
   return value != null && (type == 'object' || type == 'function');
@@ -105,9 +110,9 @@ function isObject(value) {
  *
  * @param value - any value
  * @returns true if value is a string
-*/
+ */
 function isString(value) {
-  return typeof value === 'string' || value instanceof String
+  return typeof value === 'string' || value instanceof String;
 }
 
 /**
@@ -116,7 +121,7 @@ function isString(value) {
  * @param {*} n - any value
  * @returns true if value is a finite number
  */
- function isFiniteNumber(n) {
+function isFiniteNumber(n) {
   return Number.isFinite(n);
 }
 
@@ -139,7 +144,7 @@ function isDefined(u) {
  */
 function isIterable(i) {
   var type = typeName(i);
-  return (type === 'object' || type === 'array');
+  return type === 'object' || type === 'array';
 }
 
 /*
@@ -162,6 +167,15 @@ function isPromise(p) {
   return isObject(p) && isType(p.then, 'function');
 }
 
+/**
+ * isBrowser - a convenience function for checking if the code is running in a browser
+ *
+ * @returns true if the code is running in a browser environment
+ */
+function isBrowser() {
+  return typeof window !== 'undefined';
+}
+
 function redact() {
   return '********';
 }
@@ -169,11 +183,14 @@ function redact() {
 // from http://stackoverflow.com/a/8809472/1138191
 function uuid4() {
   var d = now();
-  var uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) {
-    var r = (d + Math.random() * 16) % 16 | 0;
-    d = Math.floor(d / 16);
-    return (c === 'x' ? r : (r & 0x7 | 0x8)).toString(16);
-  });
+  var uuid = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(
+    /[xy]/g,
+    function (c) {
+      var r = (d + Math.random() * 16) % 16 | 0;
+      d = Math.floor(d / 16);
+      return (c === 'x' ? r : (r & 0x7) | 0x8).toString(16);
+    },
+  );
   return uuid;
 }
 
@@ -182,7 +199,7 @@ var LEVELS = {
   info: 1,
   warning: 2,
   error: 3,
-  critical: 4
+  critical: 4,
 };
 
 function sanitizeUrl(url) {
@@ -216,16 +233,18 @@ var parseUriOptions = {
     'directory',
     'file',
     'query',
-    'anchor'
+    'anchor',
   ],
   q: {
     name: 'queryKey',
-    parser: /(?:^|&)([^&=]*)=?([^&]*)/g
+    parser: /(?:^|&)([^&=]*)=?([^&]*)/g,
   },
   parser: {
-    strict: /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
-    loose: /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/
-  }
+    strict:
+      /^(?:([^:\/?#]+):)?(?:\/\/((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?))?((((?:[^?#\/]*\/)*)([^?#]*))(?:\?([^#]*))?(?:#(.*))?)/,
+    loose:
+      /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?((?:(([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)(((\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?([^?#\/]*))(?:\?([^#]*))?(?:#(.*))?)/,
+  },
 };
 
 function parseUri(str) {
@@ -270,11 +289,11 @@ function addParamsAndAccessTokenToPath(accessToken, options, params) {
   var p;
   if (qs !== -1 && (h === -1 || h > qs)) {
     p = options.path;
-    options.path = p.substring(0,qs) + query + '&' + p.substring(qs+1);
+    options.path = p.substring(0, qs) + query + '&' + p.substring(qs + 1);
   } else {
     if (h !== -1) {
       p = options.path;
-      options.path = p.substring(0,h) + query + p.substring(h);
+      options.path = p.substring(0, h) + query + p.substring(h);
     } else {
       options.path = options.path + query;
     }
@@ -320,7 +339,7 @@ function stringify(obj, backup) {
       error = jsonError;
     }
   }
-  return {error: error, value: value};
+  return { error: error, value: value };
 }
 
 function maxByteSize(string) {
@@ -338,11 +357,14 @@ function maxByteSize(string) {
 
   for (var i = 0; i < length; i++) {
     var code = string.charCodeAt(i);
-    if (code < 128) { // up to 7 bits
+    if (code < 128) {
+      // up to 7 bits
       count = count + 1;
-    } else if (code < 2048) { // up to 11 bits
+    } else if (code < 2048) {
+      // up to 11 bits
       count = count + 2;
-    } else if (code < 65536) { // up to 16 bits
+    } else if (code < 65536) {
+      // up to 16 bits
       count = count + 3;
     }
   }
@@ -357,7 +379,7 @@ function jsonParse(s) {
   } catch (e) {
     error = e;
   }
-  return {error: error, value: value};
+  return { error: error, value: value };
 }
 
 function makeUnhandledStackInfo(
@@ -368,28 +390,36 @@ function makeUnhandledStackInfo(
   error,
   mode,
   backupMessage,
-  errorParser
+  errorParser,
 ) {
   var location = {
     url: url || '',
     line: lineno,
-    column: colno
+    column: colno,
   };
   location.func = errorParser.guessFunctionName(location.url, location.line);
   location.context = errorParser.gatherContext(location.url, location.line);
-  var href = typeof document !== 'undefined' && document && document.location && document.location.href;
-  var useragent = typeof window !== 'undefined' && window && window.navigator && window.navigator.userAgent;
+  var href =
+    typeof document !== 'undefined' &&
+    document &&
+    document.location &&
+    document.location.href;
+  var useragent =
+    typeof window !== 'undefined' &&
+    window &&
+    window.navigator &&
+    window.navigator.userAgent;
   return {
-    'mode': mode,
-    'message': error ? String(error) : (message || backupMessage),
-    'url': href,
-    'stack': [location],
-    'useragent': useragent
+    mode: mode,
+    message: error ? String(error) : message || backupMessage,
+    url: href,
+    stack: [location],
+    useragent: useragent,
   };
 }
 
 function wrapCallback(logger, f) {
-  return function(err, resp) {
+  return function (err, resp) {
     try {
       f(err, resp);
     } catch (e) {
@@ -402,7 +432,10 @@ function nonCircularClone(obj) {
   var seen = [obj];
 
   function clone(obj, seen) {
-    var value, name, newSeen, result = {};
+    var value,
+      name,
+      newSeen,
+      result = {};
 
     try {
       for (name in obj) {
@@ -445,7 +478,7 @@ function createItem(args, logger, notifier, requestKeys, lambdaContext) {
       case 'undefined':
         break;
       case 'string':
-        message ? extraArgs.push(arg) : message = arg;
+        message ? extraArgs.push(arg) : (message = arg);
         break;
       case 'function':
         callback = wrapCallback(logger, arg);
@@ -456,12 +489,15 @@ function createItem(args, logger, notifier, requestKeys, lambdaContext) {
       case 'error':
       case 'domexception':
       case 'exception': // Firefox Exception type
-        err ? extraArgs.push(arg) : err = arg;
+        err ? extraArgs.push(arg) : (err = arg);
         break;
       case 'object':
       case 'array':
-        if (arg instanceof Error || (typeof DOMException !== 'undefined' && arg instanceof DOMException)) {
-          err ? extraArgs.push(arg) : err = arg;
+        if (
+          arg instanceof Error ||
+          (typeof DOMException !== 'undefined' && arg instanceof DOMException)
+        ) {
+          err ? extraArgs.push(arg) : (err = arg);
           break;
         }
         if (requestKeys && typ === 'object' && !request) {
@@ -475,11 +511,14 @@ function createItem(args, logger, notifier, requestKeys, lambdaContext) {
             break;
           }
         }
-        custom ? extraArgs.push(arg) : custom = arg;
+        custom ? extraArgs.push(arg) : (custom = arg);
         break;
       default:
-        if (arg instanceof Error || (typeof DOMException !== 'undefined' && arg instanceof DOMException)) {
-          err ? extraArgs.push(arg) : err = arg;
+        if (
+          arg instanceof Error ||
+          (typeof DOMException !== 'undefined' && arg instanceof DOMException)
+        ) {
+          err ? extraArgs.push(arg) : (err = arg);
           break;
         }
         extraArgs.push(arg);
@@ -502,9 +541,11 @@ function createItem(args, logger, notifier, requestKeys, lambdaContext) {
     callback: callback,
     notifier: notifier,
     diagnostic: diagnostic,
-    uuid: uuid4()
+    uuid: uuid4(),
   };
 
+  item.data = item.data || {};
+
   setCustomItemKeys(item, custom);
 
   if (requestKeys && request) {
@@ -550,7 +591,14 @@ function addErrorContext(item, errors) {
   }
 }
 
-var TELEMETRY_TYPES = ['log', 'network', 'dom', 'navigation', 'error', 'manual'];
+var TELEMETRY_TYPES = [
+  'log',
+  'network',
+  'dom',
+  'navigation',
+  'error',
+  'manual',
+];
 var TELEMETRY_LEVELS = ['critical', 'error', 'warning', 'info', 'debug'];
 
 function arrayIncludes(arr, val) {
@@ -589,12 +637,32 @@ function createTelemetryEvent(args) {
   var event = {
     type: type || 'manual',
     metadata: metadata || {},
-    level: level
+    level: level,
   };
 
   return event;
 }
 
+function addItemAttributes(itemData, attributes) {
+  itemData.attributes = itemData.attributes || [];
+  for (const a of attributes) {
+    if (a.value === undefined) {
+      continue;
+    }
+    itemData.attributes.push(a);
+  }
+}
+
+function getItemAttribute(itemData, key) {
+  const attributes = itemData.attributes || [];
+  for (let i = 0; i < attributes.length; ++i) {
+    if (attributes[i].key === key) {
+      return attributes[i].value;
+    }
+  }
+  return undefined;
+}
+
 /*
  * get - given an obj/array and a keypath, return the value at that keypath or
  *       undefined if not possible.
@@ -639,7 +707,7 @@ function set(obj, path, value) {
       temp[keys[i]] = temp[keys[i]] || {};
       temp = temp[keys[i]];
     }
-    temp[keys[len-1]] = value;
+    temp[keys[len - 1]] = value;
     obj[keys[0]] = replacement;
   } catch (e) {
     return;
@@ -730,12 +798,12 @@ function handleOptions(current, input, payload, logger) {
 }
 
 function updateDeprecatedOptions(options, logger) {
-  if(options.hostWhiteList && !options.hostSafeList) {
+  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) {
+  if (options.hostBlackList && !options.hostBlockList) {
     options.hostBlockList = options.hostBlackList;
     options.hostBlackList = undefined;
     logger && logger.log('hostBlackList is deprecated. Use hostBlockList.');
@@ -748,6 +816,8 @@ module.exports = {
   createItem: createItem,
   addErrorContext: addErrorContext,
   createTelemetryEvent: createTelemetryEvent,
+  addItemAttributes: addItemAttributes,
+  getItemAttribute: getItemAttribute,
   filterIp: filterIp,
   formatArgsAsString: formatArgsAsString,
   formatUrl: formatUrl,
@@ -762,6 +832,7 @@ module.exports = {
   isString: isString,
   isType: isType,
   isPromise: isPromise,
+  isBrowser: isBrowser,
   jsonParse: jsonParse,
   LEVELS: LEVELS,
   makeUnhandledStackInfo: makeUnhandledStackInfo,
@@ -775,5 +846,5 @@ module.exports = {
   stringify: stringify,
   maxByteSize: maxByteSize,
   typeName: typeName,
-  uuid4: uuid4
+  uuid4: uuid4,
 };

package/test/api.test.js

@@ -3,21 +3,21 @@
 /* globals it */
 /* globals sinon */
 
-var API = require('../src/api');
-var utility = require('../src/utility');
+import API from '../src/api.js';
+import utility from '../src/utility.js';
 utility.setupJSON();
 
 function TestTransportGenerator() {
-  var TestTransport = function(callbackError, callbackResponse) {
+  var TestTransport = function (callbackError, callbackResponse) {
     this.postArgs = [];
     this.callbackError = callbackError;
     this.callbackResponse = callbackResponse;
   };
 
-  TestTransport.prototype.post = function() {
+  TestTransport.prototype.post = function () {
     var args = arguments;
     this.postArgs.push(args);
-    var callback = args[args.length-1];
+    var callback = args[args.length - 1];
     if (typeof callback === 'function') {
       callback(this.callbackError, this.callbackResponse);
     }
@@ -26,18 +26,17 @@ function TestTransportGenerator() {
   return TestTransport;
 }
 
-describe('Api()', function() {
-  it('use the defaults if no custom endpoint is given', function(done) {
+describe('Api()', function () {
+  it('use the defaults if no custom endpoint is given', function (done) {
     var transport = new (TestTransportGenerator())();
     var url = {
-      parse: function(e) {
+      parse: function (e) {
         expect(false).to.be.ok();
-      }
+      },
     };
-    var backup = null;
     var accessToken = 'abc123';
-    var options = {accessToken: accessToken};
-    var api = new API(options, transport, url, backup);
+    var options = { accessToken: accessToken };
+    var api = new API(options, transport, url);
     // I know this is testing internal state but it
     // is the most expedient way to do this
     expect(api.accessToken).to.eql(accessToken);
@@ -46,24 +45,23 @@ describe('Api()', function() {
     expect(api.transportOptions.protocol).to.eql('https:');
     done();
   });
-  it('should parse the endpoint and use that if given', function(done) {
+  it('should parse the endpoint and use that if given', function (done) {
     var transport = new (TestTransportGenerator())();
     var endpoint = 'http://woo.foo.com/api/42';
     var url = {
-      parse: function(e) {
+      parse: function (e) {
         expect(e).to.eql(endpoint);
         return {
           hostname: 'woo.foo.com',
           protocol: 'http:',
           pathname: '/api/42',
-          path: '/api/42'
+          path: '/api/42',
         };
-      }
+      },
     };
-    var backup = null;
     var accessToken = 'abc123';
-    var options = {accessToken: accessToken, endpoint: endpoint};
-    var api = new API(options, transport, url, backup);
+    var options = { accessToken: accessToken, endpoint: endpoint };
+    var api = new API(options, transport, url);
     expect(api.accessToken).to.eql(accessToken);
     expect(api.transportOptions.hostname).to.eql('woo.foo.com');
     expect(api.transportOptions.path).to.match(/\/api\/42/);
@@ -72,57 +70,106 @@ describe('Api()', function() {
   });
 });
 
-describe('postItem', function() {
-  it('should call post on the transport object', function(done) {
-    var response = 'yes'
+describe('postItem', function () {
+  it('should call post on the transport object', function (done) {
+    var response = 'yes';
     var transport = new (TestTransportGenerator())(null, response);
     var url = {
-      parse: function(e) {
+      parse: function (e) {
         expect(false).to.be.ok();
-      }
+      },
     };
-    var backup = null;
     var accessToken = 'abc123';
-    var options = {accessToken: accessToken};
-    var api = new API(options, transport, url, backup);
+    var options = { accessToken: accessToken };
+    var api = new API(options, transport, url);
 
-    var data = {a: 1};
-    api.postItem(data, function(err, resp) {
+    var data = { a: 1 };
+    api.postItem(data, function (err, resp) {
       expect(err).to.not.be.ok();
       expect(resp).to.eql(response);
       expect(transport.postArgs.length).to.eql(1);
       expect(transport.postArgs[0][0]).to.eql(accessToken);
       expect(transport.postArgs[0][1].path).to.match(/\/item\//);
-      expect(transport.postArgs[0][2].access_token).to.eql(accessToken);
       expect(transport.postArgs[0][2].data.a).to.eql(1);
       done();
     });
   });
-  it('should stringify context', function(done) {
-    var response = 'yes'
+  it('should stringify context', function (done) {
+    var response = 'yes';
     var transport = new (TestTransportGenerator())(null, response);
     var url = {
-      parse: function(e) {
+      parse: function (e) {
         expect(false).to.be.ok();
-      }
+      },
     };
-    var backup = null;
     var accessToken = 'abc123';
-    var options = {accessToken: accessToken};
-    var api = new API(options, transport, url, backup);
+    var options = { accessToken: accessToken };
+    var api = new API(options, transport, url);
 
-    var data = {a: 1, context: {some: [1, 2, 'stuff']}};
-    api.postItem(data, function(err, resp) {
+    var data = { a: 1, context: { some: [1, 2, 'stuff'] } };
+    api.postItem(data, function (err, resp) {
       expect(err).to.not.be.ok();
       expect(resp).to.eql(response);
       expect(transport.postArgs.length).to.eql(1);
       expect(transport.postArgs[0][0]).to.eql(accessToken);
       expect(transport.postArgs[0][1].path).to.match(/\/item\//);
       expect(transport.postArgs[0][1].method).to.eql('POST');
-      expect(transport.postArgs[0][2].access_token).to.eql(accessToken);
       expect(transport.postArgs[0][2].data.a).to.eql(1);
-      expect(transport.postArgs[0][2].data.context).to.eql('{"some":[1,2,"stuff"]}');
+      expect(transport.postArgs[0][2].data.context).to.eql(
+        '{"some":[1,2,"stuff"]}',
+      );
       done();
     });
   });
 });
+
+describe('postSpans', function () {
+  let transport;
+
+  beforeEach(function () {
+    // Create mock transport
+    transport = {
+      post: sinon
+        .stub()
+        .callsFake((accessToken, options, payload, callback) => {
+          callback(null, { result: 'ok' });
+        }),
+      postJsonPayload: sinon.stub(),
+    };
+  });
+
+  afterEach(function () {
+    sinon.restore();
+  });
+
+  it('should call post on the transport object', async function () {
+    const urllib = await import('../src/browser/url.js');
+    const response = 'yes';
+    const url = {
+      parse: function (e) {
+        expect(false).to.be.ok();
+      },
+    };
+    const accessToken = 'abc123';
+    const options = {
+      accessToken: accessToken,
+      tracing: {
+        enabled: true,
+        endpoint: 'https://api.rollbar.com/api/1/session/',
+      },
+    };
+    const api = new API(options, transport, urllib);
+
+    const data = { a: 1 };
+    await api.postSpans(data)
+
+    expect(transport.post.called).to.be.true;
+
+    expect(transport.post.callCount).to.eql(1);
+    expect(transport.post.firstCall.args.length).to.eql(4);
+    expect(transport.post.firstCall.args[0]).to.eql(accessToken);
+    expect(transport.post.firstCall.args[1].path).to.match(/\/session\//);
+    expect(transport.post.firstCall.args[1].method).to.eql('POST');
+    expect(transport.post.firstCall.args[2].a).to.eql(1);
+  });
+});