add rollbar.occurrence.uuids attribute via a transform fn (#1375)

Author: waltjones

src/browser/replay/replay.js

@@ -1,4 +1,5 @@
 import * as _ from '../../utility.js';
+import hrtime from '../../tracing/hrtime.js';
 import id from '../../tracing/id.js';
 import logger from '../../logger.js';
 import Recorder from './recorder.js';
@@ -62,6 +63,7 @@ export default class Replay {
       shouldSend: this._shouldSendScheduled.bind(this),
       onComplete: this._onScheduledComplete.bind(this),
     });
+    this._tracing.addSpanTransform(this.uuidsTransform.bind(this));
   }
 
   /**
@@ -357,6 +359,15 @@ export default class Replay {
     return true;
   }
 
+  uuidsTransform(span) {
+    const startTime = hrtime.toMillis(span.startTime);
+    const uuidEvents = this._telemeter.queue.filter((e) => {
+      return e.timestamp_ms >= startTime && e.uuid;
+    });
+    const uuids = uuidEvents.map((e) => e.uuid);
+    span.attributes['rollbar.occurrence.uuids'] = JSON.stringify(uuids);
+  }
+
   /**
    * Gets spans for the given replay ID
    *

src/tracing/spanProcessor.js

@@ -5,20 +5,35 @@ export class SpanProcessor {
     this.exporter = exporter;
     this.options = options;
     this.pendingSpans = new Map();
+    this.transforms = [this.userTransform.bind(this)];
+  }
+
+  addTransform(transformFn) {
+    this.transforms.unshift(transformFn);
+  }
+
+  userTransform(span) {
+    if (this.options.transformSpan) {
+      this.options.transformSpan({ span: span });
+    }
+  }
+
+  applyTransforms(span) {
+    for (const transform of this.transforms) {
+      try {
+        transform(span);
+      } catch (e) {
+        logger.error('Error running span transform callback', e);
+      }
+    }
   }
 
   onStart(span, _parentContext) {
     this.pendingSpans.set(span.span.spanContext.spanId, span);
   }
 
   onEnd(span) {
-    try {
-      if (this.options.transformSpan) {
-        this.options.transformSpan({ span: span.span });
-      }
-    } catch (e) {
-      logger.error('Error running transformSpan callback', e);
-    }
+    this.applyTransforms(span.span);
     this.exporter.export([span.export()]);
     this.pendingSpans.delete(span.span.spanContext.spanId);
   }

src/tracing/tracing.js

@@ -69,6 +69,10 @@ export default class Tracing {
     return this.tracer;
   }
 
+  addSpanTransform(transformFn) {
+    this.spanProcessor.addTransform(transformFn);
+  }
+
   getSpan(context = this.contextManager.active()) {
     return context.getValue(SPAN_KEY);
   }

test/replay/integration/e2e.test.js

@@ -178,7 +178,7 @@ describe('Session Replay E2E', function () {
           expect(span_r).to.have.property('events');
           expect(span_r.events).to.be.an('array');
           expect(span_r).to.have.property('attributes').that.is.an('array');
-          expect(span_r.attributes).to.have.lengthOf(15);
+          expect(span_r.attributes).to.have.lengthOf(16);
 
           expect(span_r.attributes).to.deep.include({
             key: 'rollbar.replay.id',

test/replay/integration/replay.bufferIndex.checkoutResilience.test.js

@@ -31,6 +31,7 @@ describe('Replay - Buffer Index Checkout Resilience', function () {
         post: sinon.stub(),
       },
       session: { attributes: {} },
+      addSpanTransform() {},
     };
 
     telemeter = { exportTelemetrySpan: sinon.stub() };

test/replay/integration/replay.bufferIndex.test.js

@@ -48,6 +48,7 @@ describe('Replay buffer-index integration', function () {
       session: {
         attributes: {},
       },
+      addSpanTransform() {},
     };
 
     api = {

test/replay/unit/replay.test.js

@@ -29,6 +29,8 @@ class MockTracing {
       post: sinon.stub().resolves({ success: true }),
     };
   }
+
+  addSpanTransform() {}
 }
 
 class MockTelemeter {

test/tracing/spanProcessor.test.js

@@ -75,8 +75,12 @@ describe('SpanProcessor()', function () {
         span.resource.attributes['rollbar.environment'] = 'prod-3';
       },
     };
+    const otherTransform = (span) => {
+      span.attributes['test-id'] = '1234';
+    };
     const exporter = new SpanExporter();
     const spanProcessor = new SpanProcessor(exporter, tracingOptions);
+    spanProcessor.addTransform(otherTransform);
 
     expect(spanProcessor.pendingSpans.size).to.equal(0);
 
@@ -93,6 +97,7 @@ describe('SpanProcessor()', function () {
     expect(span.span.resource.attributes['rollbar.environment']).to.equal(
       'prod-3',
     );
+    expect(span.span.attributes['test-id']).to.equal('1234');
     expect(spanProcessor.pendingSpans.size).to.equal(0);
 
     done();