add default payload keys before the custom transform runs (#1078)

Author: waltjones

src/browser/core.js

@@ -502,6 +502,7 @@ function addTransformsToNotifier(notifier, rollbar, gWindow) {
     .addTransform(sharedTransforms.addTelemetryData)
     .addTransform(sharedTransforms.addConfigToPayload)
     .addTransform(transforms.addScrubber(rollbar.scrub))
+    .addTransform(sharedTransforms.addPayloadOptions)
     .addTransform(sharedTransforms.userTransform(logger))
     .addTransform(sharedTransforms.addConfiguredOptions)
     .addTransform(sharedTransforms.addDiagnosticKeys)

src/react-native/rollbar.js

@@ -286,6 +286,7 @@ function addTransformsToNotifier(notifier) {
     .addTransform(sharedTransforms.addTelemetryData)
     .addTransform(sharedTransforms.addConfigToPayload)
     .addTransform(transforms.scrubPayload)
+    .addTransform(sharedTransforms.addPayloadOptions)
     .addTransform(sharedTransforms.userTransform(logger))
     .addTransform(sharedTransforms.addConfiguredOptions)
     .addTransform(sharedTransforms.addDiagnosticKeys)

src/server/rollbar.js

@@ -537,6 +537,7 @@ function addTransformsToNotifier(notifier) {
     .addTransform(transforms.addLambdaData)
     .addTransform(sharedTransforms.addConfigToPayload)
     .addTransform(transforms.scrubPayload)
+    .addTransform(sharedTransforms.addPayloadOptions)
     .addTransform(sharedTransforms.userTransform(logger))
     .addTransform(sharedTransforms.addConfiguredOptions)
     .addTransform(sharedTransforms.addDiagnosticKeys)

src/transforms.js

@@ -1,12 +1,8 @@
 var _ = require('./utility');
 
 function itemToPayload(item, options, callback) {
-  var payloadOptions = options.payload || {};
-  if (payloadOptions.body) {
-    delete payloadOptions.body;
-  }
+  var data = item.data;
 
-  var data = _.merge(item.data, payloadOptions);
   if (item._isUncaught) {
     data._isUncaught = true;
   }
@@ -16,6 +12,16 @@ function itemToPayload(item, options, callback) {
   callback(null, data);
 }
 
+function addPayloadOptions(item, options, callback) {
+  var payloadOptions = options.payload || {};
+  if (payloadOptions.body) {
+    delete payloadOptions.body;
+  }
+
+  item.data = _.merge(item.data, payloadOptions);
+  callback(null, item);
+}
+
 function addTelemetryData(item, options, callback) {
   if (item.telemetryEvents) {
     _.set(item, 'data.body.telemetry', item.telemetryEvents);
@@ -139,6 +145,7 @@ function addDiagnosticKeys(item, options, callback) {
 
 module.exports = {
   itemToPayload: itemToPayload,
+  addPayloadOptions: addPayloadOptions,
   addTelemetryData: addTelemetryData,
   addMessageWithError: addMessageWithError,
   userTransform: userTransform,

test/transforms.test.js

@@ -21,13 +21,20 @@ describe('itemToPayload', function() {
     var args = ['a message', {custom: 'stuff'}];
     var item = itemFromArgs(args);
     item.accessToken = 'abc123';
+    item._isUncaught = true;
+    item._originalArgs = ['c', 3];
+    item.data = {};
     var options = {
       endpoint: 'api.rollbar.com',
       payload: {body: 'hey', x: 42}
     };
     t.itemToPayload(item, options, function(e, i) {
+      expect(i._isUncaught).to.eql(item._isUncaught);
+      expect(i._originalArgs).to.eql(item._originalArgs);
+
+      // This transform shouldn't apply any payload keys.
       expect(i.body).to.not.eql('hey');
-      expect(i.x).to.eql(42);
+      expect(i.x).to.not.eql(42);
       done(e);
     });
   });
@@ -46,6 +53,23 @@ describe('itemToPayload', function() {
   });
 });
 
+describe('addPayloadOptions', function() {
+  it('ignores options.payload.body but merges in other payload options', function(done) {
+    var args = ['a message', {custom: 'stuff'}];
+    var item = itemFromArgs(args);
+    item.accessToken = 'abc123';
+    var options = {
+      endpoint: 'api.rollbar.com',
+      payload: {body: 'hey', x: 42}
+    };
+    t.addPayloadOptions(item, options, function(e, i) {
+      expect(i.data.body).to.not.eql('hey');
+      expect(i.data.x).to.eql(42);
+      done(e);
+    });
+  });
+});
+
 describe('addTelemetryData', function() {
   it('adds the data to the right place if events exist', function(done) {
     var item = {