Add ability to inject stubbed payloads into sampleNotifications

I use the sampleNotifications function in the WebhookTestingGateway https://developers.braintreepayments.com/guides/webhooks/testing-go-live/node, which are great, but I’ve noticed that the subjectXmlForSubscription contains no data, which makes it difficult to test for specific scenarios.

https://github.com/braintree/braintree_node/blob/master/lib/braintree/webhook_testing_gateway.js#L251

What would be excellent, is if there was an option to inject stub payloads into the sampleNotification method. They could either be xml, or even go a step further allow injection of a javascript object, which would then need to be converted into xml.

This would mean a developer could easily set up a suite of unit test for specific scenarios and would be a massive help when integrating.

e.g. instead of

const sampleNotification = gateway.webhookTesting.sampleNotification(
  braintree.WebhookNotification.Kind.SubscriptionWentPastDue,
  "myId"
);

Something like:

const stubbedPayload = {
    kind: 'subscription_created',
    timestamp: '2017-03-14T15:47:33Z',
    subject: {
      subscription: {
        billingPeriodEndDate: '2017-03-21',
        billingPeriodStartDate: '2017-03-14',
        paidThroughDate: '2017-03-21',
        price: '19.99',
        status: 'Trialing',
        trialPeriod: true,
        transactions: [
          {
            currencyIsoCode: 'USD',
            customer: { id: 'my-user-id' }
          }
        ]
      }
    }
};
const sampleNotification = gateway.webhookTesting.sampleNotification(
  braintree.WebhookNotification.Kind.SubscriptionWentActive,
  stubbedPayload
);

[jthegedus]

I initially implemented it that way, but quickly found that using the Braintree production webhook responses would throw errors because of the attributes after the <subject> element. EG:

{
   timestamp:dateFormat(new Date(), dateFormat.masks.isoUtcDateTime, true),
   kind:WebhookNotification.Kind.SubscriptionChargedSuccessfully,
   subject:{
      subscription:{
         id:'mySubscription',
         transactions:[
            {
               status:'submitted_for_settlement',
               amount:'49.99'
            }
         ],
         addOns:[ ],
         discounts:[ ]
      }
   },
   subscription:{
      id:'mySubscription',
      transactions:[
         {
            status:'submitted_for_settlement',
            amount:'49.99',
            creditCard:{
               maskedNumber:'undefined******undefined',
               expirationDate:'undefined/undefined'
            },
            paypalAccount:{ },
            coinbaseAccount:{ },
            applePayCard:{ },
            androidPayCard:{ },
            disbursementDetails:{ },
            visaCheckoutCard:{ },
            masterpassCard:{ }
         }
      ],
      addOns:[ ],
      discounts:[ ]
   }
};

The accounts information is separated into this second part and it’s not clear without running the webhooks what the true response format will be (as the testing ones are not complete).

Feedback from the Braintree team will help clarify what’s necessary and maybe it’ll change back to the split method. Time will tell.

[crookedneighbor]

We’re not going to add this feature at this time. (See https://github.com/braintree/braintree_node/pull/111#issuecomment-356122013)