rollbar 2.26.4 → 3.0.0-alpha.2

package/src/tracing/tracer.js

@@ -0,0 +1,46 @@
+import { Span } from './span.js';
+import id from './id.js';
+
+export class Tracer {
+  constructor(tracing, spanProcessor) {
+    this.spanProcessor = spanProcessor;
+    this.tracing = tracing;
+  }
+
+  startSpan(
+    name,
+    options = {},
+    context = this.tracing.contextManager.active()
+  ) {
+    const parentSpan = this.tracing.getSpan(context);
+    const parentSpanContext = parentSpan?.spanContext();
+    const spanId = id.gen(8);
+    let traceId;
+    let traceFlags = 0;
+    let traceState = null;
+    let parentSpanId;
+    if (parentSpanContext) {
+      traceId = parentSpanContext.traceId;
+      traceState = parentSpanContext.traceState;
+      parentSpanId = parentSpanContext.spanId;
+    } else {
+      traceId = id.gen(16);
+    }
+
+    const kind = 0;
+    const spanContext = { traceId, spanId, traceFlags, traceState };
+
+    const span = new Span({
+      resource: this.tracing.resource,
+      scope: this.tracing.scope,
+      session: this.tracing.session.session,
+      context,
+      spanContext,
+      name,
+      kind,
+      parentSpanId,
+      spanProcessor: this.spanProcessor,
+    });
+    return span;
+  }
+}

package/src/tracing/tracing.js

@@ -0,0 +1,89 @@
+import { ContextManager, createContextKey } from './contextManager.js';
+import { Session } from './session.js';
+import { SpanExporter } from './exporter.js';
+import { SpanProcessor } from './spanProcessor.js';
+import { Tracer } from './tracer.js';
+import id from './id.js';
+
+const SPAN_KEY = createContextKey('Rollbar Context Key SPAN');
+
+export default class Tracing {
+  constructor(gWindow, options) {
+    this.options = options;
+    this.window = gWindow;
+
+    this.session = new Session(this, options);
+    this.createTracer();
+  }
+
+  initSession() {
+    if (this.session) {
+      this.session.init();
+    }
+  }
+
+  get sessionId() {
+    if (this.session) {
+      return this.session.session.id;
+    }
+    return null;
+  }
+
+  get resource() {
+    return {
+      attributes: {
+        ...(this.options.resource || {}),
+        'rollbar.environment':
+          this.options.payload?.environment ?? this.options.environment,
+      },
+    };
+  }
+
+  get scope() {
+    return {
+      name: 'rollbar-browser-js',
+      version: this.options.version,
+    };
+  }
+
+  idGen(bytes = 16) {
+    return id.gen(bytes);
+  }
+
+  createTracer() {
+    this.contextManager = new ContextManager();
+    this.exporter = new SpanExporter();
+    this.spanProcessor = new SpanProcessor(this.exporter);
+    this.tracer = new Tracer(this, this.spanProcessor);
+  }
+
+  getTracer() {
+    return this.tracer;
+  }
+
+  getSpan(context = this.contextManager.active()) {
+    return context.getValue(SPAN_KEY);
+  }
+
+  setSpan(context = this.contextManager.active(), span) {
+    return context.setValue(SPAN_KEY, span);
+  }
+
+  startSpan(name, options = {}, context = this.contextManager.active()) {
+    return this.tracer.startSpan(name, options, context);
+  }
+
+  with(context, fn, thisArg, ...args) {
+    return this.contextManager.with(context, fn, thisArg, ...args);
+  }
+
+  withSpan(name, options, fn, thisArg) {
+    const span = this.startSpan(name, options);
+    return this.with(
+      this.setSpan(this.contextManager.active(), span),
+      fn,
+      thisArg,
+      span,
+    );
+  }
+}

package/src/utility.js

@@ -167,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 '********';
 }
@@ -535,6 +544,8 @@ function createItem(args, logger, notifier, requestKeys, lambdaContext) {
     uuid: uuid4(),
   };
 
+  item.data = item.data || {};
+
   setCustomItemKeys(item, custom);
 
   if (requestKeys && request) {
@@ -632,6 +643,26 @@ function createTelemetryEvent(args) {
   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.
@@ -785,6 +816,8 @@ module.exports = {
   createItem: createItem,
   addErrorContext: addErrorContext,
   createTelemetryEvent: createTelemetryEvent,
+  addItemAttributes: addItemAttributes,
+  getItemAttribute: getItemAttribute,
   filterIp: filterIp,
   formatArgsAsString: formatArgsAsString,
   formatUrl: formatUrl,
@@ -799,6 +832,7 @@ module.exports = {
   isString: isString,
   isType: isType,
   isPromise: isPromise,
+  isBrowser: isBrowser,
   jsonParse: jsonParse,
   LEVELS: LEVELS,
   makeUnhandledStackInfo: makeUnhandledStackInfo,

package/test/api.test.js

@@ -3,8 +3,8 @@
 /* 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() {
@@ -34,10 +34,9 @@ describe('Api()', function () {
         expect(false).to.be.ok();
       },
     };
-    var backup = null;
     var accessToken = 'abc123';
     var options = { accessToken: accessToken };
-    var api = new API(options, transport, url, backup);
+    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);
@@ -60,10 +59,9 @@ describe('Api()', function () {
         };
       },
     };
-    var backup = null;
     var accessToken = 'abc123';
     var options = { accessToken: accessToken, endpoint: endpoint };
-    var api = new API(options, transport, url, backup);
+    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/);
@@ -81,10 +79,9 @@ describe('postItem', function () {
         expect(false).to.be.ok();
       },
     };
-    var backup = null;
     var accessToken = 'abc123';
     var options = { accessToken: accessToken };
-    var api = new API(options, transport, url, backup);
+    var api = new API(options, transport, url);
 
     var data = { a: 1 };
     api.postItem(data, function (err, resp) {
@@ -93,7 +90,6 @@ describe('postItem', function () {
       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();
     });
@@ -106,10 +102,9 @@ describe('postItem', function () {
         expect(false).to.be.ok();
       },
     };
-    var backup = null;
     var accessToken = 'abc123';
     var options = { accessToken: accessToken };
-    var api = new API(options, transport, url, backup);
+    var api = new API(options, transport, url);
 
     var data = { a: 1, context: { some: [1, 2, 'stuff'] } };
     api.postItem(data, function (err, resp) {
@@ -119,7 +114,6 @@ describe('postItem', function () {
       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"]}',
@@ -128,3 +122,54 @@ describe('postItem', function () {
     });
   });
 });
+
+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);
+  });
+});

package/test/apiUtility.test.js

@@ -3,17 +3,16 @@
 /* globals it */
 /* globals sinon */
 
-var u = require('../src/apiUtility');
-var utility = require('../src/utility');
+import u from '../src/apiUtility.js';
+import utility from '../src/utility.js';
 utility.setupJSON();
 
 describe('buildPayload', function () {
   it('should package up the input into a payload', function () {
     var token = 'abc123';
     var data = { context: 'not an object', other: 'stuff' };
-    var payload = u.buildPayload(token, data);
+    var payload = u.buildPayload(data);
 
-    expect(payload.access_token).to.eql(token);
     expect(payload.data).to.eql(data);
   });
   it('should stringify context', function () {
@@ -23,7 +22,7 @@ describe('buildPayload', function () {
       context: context,
       other: 'stuff',
     };
-    var payload = u.buildPayload(token, data);
+    var payload = u.buildPayload(data);
 
     expect(payload.data.context).to.not.eql(context);
     expect(payload.data.context).to.eql('{"a":1,"b":"other"}');
@@ -38,7 +37,7 @@ describe('buildPayload', function () {
       context: context,
       other: 'stuff',
     };
-    var payload = u.buildPayload(token, data);
+    var payload = u.buildPayload(data);
 
     expect(payload.data.context).to.not.eql(context);
     expect(payload.data.context.length).to.eql(255);

package/test/browser.core.test.js

@@ -4,7 +4,7 @@
 /* globals sinon */
 
 // Use minimal browser package, with no optional components added.
-var Rollbar = require('../src/browser/core');
+import Rollbar from '../src/browser/core.js';
 
 describe('options.captureUncaught', function () {
   beforeEach(function (done) {
@@ -47,7 +47,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('test error');
       expect(body.data.notifier.diagnostic.raw_error.message).to.eql(
         'test error',
@@ -95,7 +94,6 @@ describe('options.captureUncaught', function () {
 
         var body = JSON.parse(server.requests[0].requestBody);
 
-        expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
         expect(body.data.body.trace.exception.message).to.eql('test error');
         expect(body.data.notifier.diagnostic.is_anonymous).to.not.be.ok();
 
@@ -149,7 +147,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('anon error');
       expect(body.data.notifier.diagnostic.is_anonymous).to.eql(true);
 
@@ -190,7 +187,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('test error');
 
       // karma doesn't unload the browser between tests, so the onerror handler
@@ -231,7 +227,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('test error');
 
       // karma doesn't unload the browser between tests, so the onerror handler
@@ -263,7 +258,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace_chain[0].exception.message).to.eql(
         'test DOMException',
       );
@@ -300,7 +294,6 @@ describe('options.captureUncaught', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('deep stack error');
       expect(body.data.body.trace.frames.length).to.be.above(20);
 
@@ -354,7 +347,6 @@ describe('options.captureUnhandledRejections', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('test reject');
       expect(body.data.notifier.diagnostic.is_uncaught).to.eql(true);
 
@@ -389,7 +381,6 @@ describe('options.captureUnhandledRejections', function () {
 
       var body = JSON.parse(server.requests[0].requestBody);
 
-      expect(body.access_token).to.eql('POST_CLIENT_ITEM_TOKEN');
       expect(body.data.body.trace.exception.message).to.eql('test reject');
 
       server.requests.length = 0;

package/test/browser.domUtility.test.js

@@ -3,7 +3,7 @@
 /* globals it */
 /* globals sinon */
 
-var d = require('../src/browser/domUtility');
+import * as d from '../src/browser/domUtility.js';
 
 function fullElement() {
   return {

package/test/browser.predicates.test.js

@@ -3,7 +3,7 @@
 /* globals it */
 /* globals sinon */
 
-var p = require('../src/browser/predicates');
+import * as p from '../src/browser/predicates.js';
 
 describe('checkIgnore', function () {
   it('should return false if is ajax and ignoring ajax errors is on', function () {