prebid.js 6.7.0 → 6.11.0

package/test/spec/unit/secureCreatives_spec.js

@@ -1,6 +1,7 @@
 import {
-  _sendAdToCreative, receiveMessage
+  _sendAdToCreative, getReplier, receiveMessage
 } from 'src/secureCreatives.js';
+import * as secureCreatives from 'src/secureCreatives.js';
 import * as utils from 'src/utils.js';
 import {getAdUnits, getBidRequests, getBidResponses} from 'test/fixtures/fixtures.js';
 import {auctionManager} from 'src/auctionManager.js';
@@ -9,12 +10,51 @@ import * as native from 'src/native.js';
 import {fireNativeTrackers, getAllAssetsMessage} from 'src/native.js';
 import events from 'src/events.js';
 import { config as configObj } from 'src/config.js';
+import 'src/prebid.js';
 
 import { expect } from 'chai';
 
 var CONSTANTS = require('src/constants.json');
 
 describe('secureCreatives', () => {
+  function makeEvent(ev) {
+    return Object.assign({origin: 'mock-origin', ports: []}, ev)
+  }
+
+  describe('getReplier', () => {
+    it('should use source.postMessage if no MessagePort is available', () => {
+      const ev = {
+        ports: [],
+        source: {
+          postMessage: sinon.spy()
+        },
+        origin: 'mock-origin'
+      };
+      getReplier(ev)('test');
+      sinon.assert.calledWith(ev.source.postMessage, JSON.stringify('test'));
+    });
+
+    it('should use MesagePort.postMessage if available', () => {
+      const ev = {
+        ports: [{
+          postMessage: sinon.spy()
+        }]
+      }
+      getReplier(ev)('test');
+      sinon.assert.calledWith(ev.ports[0].postMessage, JSON.stringify('test'));
+    });
+
+    it('should throw if origin is null and no MessagePort is available', () => {
+      const ev = {
+        origin: null,
+        ports: [],
+        postMessage: sinon.spy()
+      }
+      const reply = getReplier(ev);
+      expect(() => reply('test')).to.throw();
+    });
+  });
+
   describe('_sendAdToCreative', () => {
     beforeEach(function () {
       sinon.stub(utils, 'logError');
@@ -40,14 +80,10 @@ describe('secureCreatives', () => {
         cpm: '1.00',
         adUnitCode: 'some_dom_id'
       };
-      const event = {
-        source: { postMessage: sinon.stub() },
-        origin: 'origin.sf.com'
-      };
-
-      _sendAdToCreative(mockAdObject, event);
-      expect(JSON.parse(event.source.postMessage.args[0][0]).ad).to.equal('<script src="http://prebid.org/creative/1.00"></script>');
-      expect(JSON.parse(event.source.postMessage.args[0][0]).adUrl).to.equal('http://creative.prebid.org/1.00');
+      const reply = sinon.spy();
+      _sendAdToCreative(mockAdObject, reply);
+      expect(reply.args[0][0].ad).to.equal('<script src="http://prebid.org/creative/1.00"></script>');
+      expect(reply.args[0][0].adUrl).to.equal('http://creative.prebid.org/1.00');
       window.googletag = oldVal;
       window.apntag = oldapntag;
     });
@@ -141,9 +177,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
-          data: JSON.stringify(data)
-        };
+        const ev = makeEvent({
+          data: JSON.stringify(data),
+        });
 
         receiveMessage(ev);
 
@@ -168,9 +204,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -209,9 +245,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -237,6 +273,38 @@ describe('secureCreatives', () => {
 
         configObj.setConfig({'auctionOptions': {}});
       });
+
+      it('should emit AD_RENDER_FAILED if requested missing adId', () => {
+        const ev = makeEvent({
+          data: JSON.stringify({
+            message: 'Prebid Request',
+            adId: 'missing'
+          })
+        });
+        receiveMessage(ev);
+        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
+          reason: CONSTANTS.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+          adId: 'missing'
+        }));
+      });
+
+      it('should emit AD_RENDER_FAILED if creative can\'t be sent to rendering frame', () => {
+        pushBidResponseToAuction({});
+        const ev = makeEvent({
+          source: {
+            postMessage: sinon.stub().callsFake(() => { throw new Error(); })
+          },
+          data: JSON.stringify({
+            message: 'Prebid Request',
+            adId: bidId
+          })
+        });
+        receiveMessage(ev)
+        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
+          reason: CONSTANTS.AD_RENDER_FAILED_REASON.EXCEPTION,
+          adId: bidId
+        }));
+      });
     });
 
     describe('Prebid Native', function() {
@@ -249,13 +317,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -278,13 +346,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -322,13 +390,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -366,13 +434,13 @@ describe('secureCreatives', () => {
           action: 'click',
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -395,5 +463,56 @@ describe('secureCreatives', () => {
         expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
       });
     });
+
+    describe('Prebid Event', () => {
+      Object.entries({
+        'unrendered': [false, (bid) => { delete bid.status; }],
+        'rendered': [true, (bid) => { bid.status = CONSTANTS.BID_STATUS.RENDERED }]
+      }).forEach(([test, [shouldEmit, prepBid]]) => {
+        describe(`for ${test} bids`, () => {
+          beforeEach(() => {
+            prepBid(adResponse);
+            pushBidResponseToAuction(adResponse);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_FAILED`, () => {
+            const event = makeEvent({
+              data: JSON.stringify({
+                message: 'Prebid Event',
+                event: CONSTANTS.EVENTS.AD_RENDER_FAILED,
+                adId: bidId,
+                info: {
+                  reason: 'Fail reason',
+                  message: 'Fail message',
+                },
+              })
+            });
+            receiveMessage(event);
+            expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_FAILED, {
+              adId: bidId,
+              bid: adResponse,
+              reason: 'Fail reason',
+              message: 'Fail message'
+            })).to.equal(shouldEmit);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_SUCCEEDED`, () => {
+            const event = makeEvent({
+              data: JSON.stringify({
+                message: 'Prebid Event',
+                event: CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED,
+                adId: bidId,
+              })
+            });
+            receiveMessage(event);
+            expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, {
+              adId: bidId,
+              bid: adResponse,
+              doc: null
+            })).to.equal(shouldEmit);
+          });
+        });
+      });
+    });
   });
 });

package/test/spec/videoCache_spec.js

@@ -2,6 +2,8 @@ import chai from 'chai';
 import { getCacheUrl, store } from 'src/videoCache.js';
 import { config } from 'src/config.js';
 import { server } from 'test/mocks/xhr.js';
+import {auctionManager} from '../../src/auctionManager.js';
+import {AuctionIndex} from '../../src/auctionIndex.js';
 
 const should = chai.should();
 
@@ -32,23 +34,6 @@ function getMockBid(bidder, auctionId, bidderRequestId) {
   };
 }
 
-function getMockBidRequest(bidder = 'appnexus', auctionId = '173afb6d132ba3', bidderRequestId = '3d1063078dfcc8') {
-  return {
-    'bidderCode': bidder,
-    'auctionId': auctionId,
-    'bidderRequestId': bidderRequestId,
-    'tid': '437fbbf5-33f5-487a-8e16-a7112903cfe5',
-    'bids': [getMockBid(bidder, auctionId, bidderRequestId)],
-    'auctionStart': 1510852447530,
-    'timeout': 5000,
-    'src': 's2s',
-    'doneCbCallCount': 0,
-    'refererInfo': {
-      'referer': 'http://mytestpage.com'
-    }
-  }
-}
-
 describe('The video cache', function () {
   function assertError(callbackSpy) {
     callbackSpy.calledOnce.should.equal(true);
@@ -240,7 +225,7 @@ 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 and bidderRequest argument was defined', () => {
+    it('should include additional params in request payload should config.cache.vasttrack be true - with timestamp', () => {
       config.setConfig({
         cache: {
           url: 'https://prebid.adnxs.com/pbc/v1/cache',
@@ -269,7 +254,21 @@ describe('The video cache', function () {
         auctionId: '1234-56789-abcde'
       }];
 
-      store(bids, function () { }, getMockBidRequest());
+      const stub = sinon.stub(auctionManager, 'index');
+      stub.get(() => new AuctionIndex(() => [{
+        getAuctionId() {
+          return '1234-56789-abcde';
+        },
+        getAuctionStart() {
+          return 1510852447530;
+        }
+      }]))
+      try {
+        store(bids, function () { });
+      } finally {
+        stub.restore();
+      }
+
       const request = server.requests[0];
       request.method.should.equal('POST');
       request.url.should.equal('https://prebid.adnxs.com/pbc/v1/cache');

package/test/spec/video_spec.js

@@ -1,113 +1,103 @@
 import { isValidVideoBid } from 'src/video.js';
+import {hook} from '../../src/hook.js';
+import {stubAuctionIndex} from '../helpers/indexStub.js';
 
 describe('video.js', function () {
+  before(() => {
+    hook.ready();
+  });
+
   it('validates valid instream bids', function () {
     const bid = {
       adId: '456xyz',
       vastUrl: 'http://www.example.com/vastUrl',
-      requestId: '123abc'
+      transactionId: 'au'
     };
-    const bidRequests = [{
-      bids: [{
-        bidId: '123abc',
-        bidder: 'appnexus',
-        mediaTypes: {
-          video: { context: 'instream' }
-        }
-      }]
+    const adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {context: 'instream'}
+      }
     }];
-    const valid = isValidVideoBid(bid, bidRequests);
+    const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
     expect(valid).to.equal(true);
   });
 
   it('catches invalid instream bids', function () {
     const bid = {
-      requestId: '123abc'
+      transactionId: 'au'
     };
-    const bidRequests = [{
-      bids: [{
-        bidId: '123abc',
-        bidder: 'appnexus',
-        mediaTypes: {
-          video: { context: 'instream' }
-        }
-      }]
+    const adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {context: 'instream'}
+      }
     }];
-    const valid = isValidVideoBid(bid, bidRequests);
+    const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
     expect(valid).to.equal(false);
   });
 
   it('catches invalid bids when prebid-cache is disabled', function () {
-    const bidRequests = [{
-      bids: [{
-        bidder: 'vastOnlyVideoBidder',
-        mediaTypes: { video: {} },
-      }]
+    const adUnits = [{
+      transactionId: 'au',
+      bidder: 'vastOnlyVideoBidder',
+      mediaTypes: {video: {}},
     }];
 
-    const valid = isValidVideoBid({ vastXml: '<xml>vast</xml>' }, bidRequests);
+    const valid = isValidVideoBid({ transactionId: 'au', vastXml: '<xml>vast</xml>' }, {index: stubAuctionIndex({adUnits})});
 
     expect(valid).to.equal(false);
   });
 
   it('validates valid outstream bids', function () {
     const bid = {
-      requestId: '123abc',
+      transactionId: 'au',
       renderer: {
         url: 'render.url',
         render: () => true,
       }
     };
-    const bidRequests = [{
-      bids: [{
-        bidId: '123abc',
-        bidder: 'appnexus',
-        mediaTypes: {
-          video: { context: 'outstream' }
-        }
-      }]
+    const adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {context: 'outstream'}
+      }
     }];
-    const valid = isValidVideoBid(bid, bidRequests);
+    const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
     expect(valid).to.equal(true);
   });
 
   it('validates valid outstream bids with a publisher defined renderer', function () {
     const bid = {
-      requestId: '123abc',
+      transactionId: 'au',
     };
-    const bidRequests = [{
-      bids: [{
-        bidId: '123abc',
-        bidder: 'appnexus',
-        mediaTypes: {
-          video: {
-            context: 'outstream',
-            renderer: {
-              url: 'render.url',
-              render: () => true,
-            }
-          }
+    const adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {
+          context: 'outstream',
         }
-      }]
+      },
+      renderer: {
+        url: 'render.url',
+        render: () => true,
+      }
     }];
-    const valid = isValidVideoBid(bid, bidRequests);
+    const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
     expect(valid).to.equal(true);
   });
 
   it('catches invalid outstream bids', function () {
     const bid = {
-      requestId: '123abc'
+      transactionId: 'au',
     };
-    const bidRequests = [{
-      bids: [{
-        bidId: '123abc',
-        bidder: 'appnexus',
-        mediaTypes: {
-          video: { context: 'outstream' }
-        }
-      }]
+    const adUnits = [{
+      transactionId: 'au',
+      mediaTypes: {
+        video: {context: 'outstream'}
+      }
     }];
-    const valid = isValidVideoBid(bid, bidRequests);
+    const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
     expect(valid).to.equal(false);
   });
 });