Support Vast Track

src/videoCache.js

@@ -60,12 +60,18 @@ function wrapURI(uri, impUrl) {
  */
 function toStorageRequest(bid) {
   const vastValue = bid.vastXml ? bid.vastXml : wrapURI(bid.vastUrl, bid.vastImpUrl);
+
   let payload = {
     type: 'xml',
     value: vastValue,
     ttlseconds: Number(bid.ttl)
   };
 
+  if (config.getConfig('cache.vasttrack')) {
+    payload.bidder = bid.bidder;
+    payload.bidid = bid.requestId;
+  }
+
   if (typeof bid.customCacheKey === 'string' && bid.customCacheKey !== '') {
     payload.key = bid.customCacheKey;
   }
@@ -94,7 +100,7 @@ function toStorageRequest(bid) {
  */
 function shimStorageCallback(done) {
   return {
-    success: function(responseBody) {
+    success: function (responseBody) {
       let ids;
       try {
         ids = JSON.parse(responseBody).responses
@@ -109,7 +115,7 @@ function shimStorageCallback(done) {
         done(new Error("The cache server didn't respond with a responses property."), []);
       }
     },
-    error: function(statusText, responseBody) {
+    error: function (statusText, responseBody) {
       done(new Error(`Error storing video ad in the cache: ${statusText}: ${JSON.stringify(responseBody)}`), []);
     }
   }

test/spec/videoCache_spec.js

@@ -32,7 +32,7 @@ describe('The video cache', function () {
 
     it('should execute the callback with an error when store() is called', function () {
       const callback = sinon.spy();
-      store([ { vastUrl: 'my-mock-url.com' } ], callback);
+      store([{ vastUrl: 'my-mock-url.com' }], callback);
 
       requests[0].respond(503, {
         'Content-Type': 'plain/text',
@@ -159,8 +159,61 @@ describe('The video cache', function () {
       JSON.parse(request.requestBody).should.deep.equal(payload);
     });
 
+    it('should include additional params in request payload should config.cache.vasttrack be true', () => {
+      config.setConfig({
+        cache: {
+          url: 'https://prebid.adnxs.com/pbc/v1/cache',
+          vasttrack: true
+        }
+      });
+
+      const customKey1 = 'vasttrack_123';
+      const customKey2 = 'vasttrack_abc';
+      const vastXml1 = '<VAST version="3.0">testvast1</VAST>';
+      const vastXml2 = '<VAST version="3.0">testvast2</VAST>';
+
+      const bids = [{
+        vastXml: vastXml1,
+        ttl: 25,
+        customCacheKey: customKey1,
+        requestId: '12345abc',
+        bidder: 'appnexus'
+      }, {
+        vastXml: vastXml2,
+        ttl: 25,
+        customCacheKey: customKey2,
+        requestId: 'cba54321',
+        bidder: 'rubicon'
+      }];
+
+      store(bids, function () { });
+      const request = requests[0];
+      request.method.should.equal('POST');
+      request.url.should.equal('https://prebid.adnxs.com/pbc/v1/cache');
+      request.requestHeaders['Content-Type'].should.equal('text/plain;charset=utf-8');
+      let payload = {
+        puts: [{
+          type: 'xml',
+          value: vastXml1,
+          ttlseconds: 25,
+          key: customKey1,
+          bidid: '12345abc',
+          bidder: 'appnexus'
+        }, {
+          type: 'xml',
+          value: vastXml2,
+          ttlseconds: 25,
+          key: customKey2,
+          bidid: 'cba54321',
+          bidder: 'rubicon'
+        }]
+      };
+
+      JSON.parse(request.requestBody).should.deep.equal(payload);
+    });
+
     function assertRequestMade(bid, expectedValue) {
-      store([bid], function() { });
+      store([bid], function () { });
 
       const request = requests[0];
       request.method.should.equal('POST');
@@ -178,7 +231,7 @@ describe('The video cache', function () {
 
     function fakeServerCall(bid, responseBody) {
       const callback = sinon.spy();
-      store([ bid ], callback);
+      store([bid], callback);
       requests[0].respond(
         200,
         {