prebid.js 5.18.0 → 5.20.2

package/test/spec/modules/videobyteBidAdapter_spec.js

@@ -153,7 +153,7 @@ describe('VideoByteBidAdapter', function () {
     it('should create a POST request for every bid', function () {
       const requests = spec.buildRequests([bidRequest], bidderRequest);
       expect(requests[0].method).to.equal('POST');
-      expect(requests[0].url).to.equal(spec.ENDPOINT + bidRequest.params.pubId);
+      expect(requests[0].url).to.equal(spec.ENDPOINT + '?pid=' + bidRequest.params.pubId);
     });
 
     it('should attach request data', function () {
@@ -172,7 +172,7 @@ describe('VideoByteBidAdapter', function () {
       bidRequest.params.video.e2etest = true;
       const requests = spec.buildRequests([bidRequest], bidderRequest);
       expect(requests[0].method).to.equal('POST');
-      expect(requests[0].url).to.equal(spec.ENDPOINT + 'e2etest');
+      expect(requests[0].url).to.equal(spec.ENDPOINT + '?pid=e2etest');
     });
 
     it('should attach End 2 End test data', function () {

package/test/spec/modules/yieldmoSyntheticInventoryModule_spec.js

@@ -0,0 +1,89 @@
+import { expect } from 'chai';
+import {
+  init,
+  MODULE_NAME,
+  validateConfig
+} from 'modules/yieldmoSyntheticInventoryModule';
+
+const mockedYmConfig = {
+  placementId: '123456',
+  adUnitPath: '/6355419/ad_unit_name_used_in_gam'
+};
+
+const setGoogletag = () => {
+  window.googletag = {
+    cmd: [],
+    defineSlot: sinon.stub(),
+    addService: sinon.stub(),
+    pubads: sinon.stub(),
+    setTargeting: sinon.stub(),
+    enableServices: sinon.stub(),
+    display: sinon.stub(),
+  };
+  window.googletag.defineSlot.returns(window.googletag);
+  window.googletag.addService.returns(window.googletag);
+  window.googletag.pubads.returns({getSlots: sinon.stub()});
+  return window.googletag;
+}
+
+describe('Yieldmo Synthetic Inventory Module', function() {
+  let config = Object.assign({}, mockedYmConfig);
+  let googletagBkp;
+
+  beforeEach(function () {
+    googletagBkp = window.googletag;
+    delete window.googletag;
+  });
+
+  afterEach(function () {
+    window.googletag = googletagBkp;
+  });
+
+  it('should be enabled with valid required params', function() {
+    expect(function () {
+      init(mockedYmConfig);
+    }).not.to.throw()
+  });
+
+  it('should throw an error if placementId is missed', function() {
+    const {placementId, ...config} = mockedYmConfig;
+
+    expect(function () {
+      validateConfig(config);
+    }).throw(`${MODULE_NAME}: placementId required`)
+  });
+
+  it('should throw an error if adUnitPath is missed', function() {
+    const {adUnitPath, ...config} = mockedYmConfig;
+
+    expect(function () {
+      validateConfig(config);
+    }).throw(`${MODULE_NAME}: adUnitPath required`)
+  });
+
+  it('should add correct googletag.cmd', function() {
+    const containerName = 'ym_sim_container_' + mockedYmConfig.placementId;
+    const gtag = setGoogletag();
+
+    init(mockedYmConfig);
+
+    expect(gtag.cmd.length).to.equal(1);
+
+    gtag.cmd[0]();
+
+    expect(gtag.addService.getCall(0)).to.not.be.null;
+    expect(gtag.setTargeting.getCall(0)).to.not.be.null;
+    expect(gtag.setTargeting.getCall(0).args[0]).to.exist.and.to.equal('ym_sim_p_id');
+    expect(gtag.setTargeting.getCall(0).args[1]).to.exist.and.to.equal(mockedYmConfig.placementId);
+    expect(gtag.defineSlot.getCall(0)).to.not.be.null;
+    expect(gtag.enableServices.getCall(0)).to.not.be.null;
+    expect(gtag.display.getCall(0)).to.not.be.null;
+    expect(gtag.display.getCall(0).args[0]).to.exist.and.to.equal(containerName);
+    expect(gtag.pubads.getCall(0)).to.not.be.null;
+
+    const gamContainerEl = window.document.getElementById(containerName);
+    expect(gamContainerEl).to.not.be.null;
+
+    gamContainerEl.parentNode.removeChild(gamContainerEl);
+  });
+});

package/test/spec/unit/core/adapterManager_spec.js

@@ -436,6 +436,38 @@ describe('adapterManager tests', function () {
     });
   }); // end onBidViewable
 
+  describe('onBidderError', function () {
+    const bidder = 'appnexus';
+    const appnexusSpec = { onBidderError: sinon.stub() };
+    const appnexusAdapter = {
+      bidder,
+      getSpec: function() { return appnexusSpec; },
+    }
+    before(function () {
+      config.setConfig({s2sConfig: { enabled: false }});
+    });
+
+    beforeEach(function () {
+      adapterManager.bidderRegistry[bidder] = appnexusAdapter;
+    });
+
+    afterEach(function () {
+      delete adapterManager.bidderRegistry[bidder];
+    });
+
+    it('should call spec\'s onBidderError callback when callBidderError is called', function () {
+      const bidRequests = getBidRequests();
+      const bidderRequest = find(bidRequests, bidRequest => bidRequest.bidderCode === bidder);
+      const xhrErrorMock = {
+        status: 500,
+        statusText: 'Internal Server Error'
+      };
+      adapterManager.callBidderError(bidder, xhrErrorMock, bidderRequest);
+      sinon.assert.calledOnce(appnexusSpec.onBidderError);
+      sinon.assert.calledWithExactly(appnexusSpec.onBidderError, { error: xhrErrorMock, bidderRequest });
+    });
+  }); // end onBidderError
+
   describe('S2S tests', function () {
     beforeEach(function () {
       config.setConfig({s2sConfig: CONFIG});
@@ -1665,14 +1697,17 @@ describe('adapterManager tests', function () {
     });
 
     describe('sizeMapping', function () {
+      let sandbox;
       beforeEach(function () {
+        sandbox = sinon.sandbox.create();
         allS2SBidders.length = 0;
         clientTestAdapters.length = 0;
-        sinon.stub(window, 'matchMedia').callsFake(() => ({matches: true}));
+        // always have matchMedia return true for us
+        sandbox.stub(utils.getWindowTop(), 'matchMedia').callsFake(() => ({matches: true}));
       });
 
       afterEach(function () {
-        matchMedia.restore();
+        sandbox.restore();
         config.resetConfig();
         setSizeConfig([]);
       });

package/test/spec/unit/core/bidderFactory_spec.js

@@ -552,17 +552,27 @@ describe('bidders created by newBidder', function () {
 
   describe('when the ajax call fails', function () {
     let ajaxStub;
+    let callBidderErrorStub;
+    let eventEmitterStub;
+    let xhrErrorMock = {
+      status: 500,
+      statusText: 'Internal Server Error'
+    };
 
     beforeEach(function () {
       ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
-        callbacks.error('ajax call failed.');
+        callbacks.error('ajax call failed.', xhrErrorMock);
       });
+      callBidderErrorStub = sinon.stub(adapterManager, 'callBidderError');
+      eventEmitterStub = sinon.stub(events, 'emit');
       addBidResponseStub.reset();
       doneStub.reset();
     });
 
     afterEach(function () {
       ajaxStub.restore();
+      callBidderErrorStub.restore();
+      eventEmitterStub.restore();
     });
 
     it('should not spec.interpretResponse()', function () {
@@ -580,6 +590,14 @@ describe('bidders created by newBidder', function () {
 
       expect(spec.interpretResponse.called).to.equal(false);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
 
     it('should not add bids for each adunit code into the auction', function () {
@@ -598,6 +616,14 @@ describe('bidders created by newBidder', function () {
 
       expect(addBidResponseStub.callCount).to.equal(0);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
 
     it('should call spec.getUserSyncs() with no responses', function () {
@@ -616,6 +642,40 @@ describe('bidders created by newBidder', function () {
       expect(spec.getUserSyncs.calledOnce).to.equal(true);
       expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
       expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
+    });
+
+    it('should call spec.getUserSyncs() with no responses', function () {
+      const bidder = newBidder(spec);
+
+      spec.isBidRequestValid.returns(true);
+      spec.buildRequests.returns({
+        method: 'POST',
+        url: 'test.url.com',
+        data: {}
+      });
+      spec.getUserSyncs.returns([]);
+
+      bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+      expect(spec.getUserSyncs.calledOnce).to.equal(true);
+      expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
+      expect(doneStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.calledOnce).to.equal(true);
+      expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+      expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+      expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+      sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+        error: xhrErrorMock,
+        bidderRequest: MOCK_BIDS_REQUEST
+      });
     });
   });
 });

package/test/spec/unit/pbjs_api_spec.js

@@ -98,7 +98,6 @@ var createSlotArrayScenario2 = function createSlotArrayScenario2() {
   var slot1 = new Slot(config.adUnitElementIDs[0], config.adUnitCodes[0]);
   slot1.setTargeting('pos1', '750x350');
   var slot2 = new Slot(config.adUnitElementIDs[1], config.adUnitCodes[0]);
-  slot2.setTargeting('gender', ['male', 'female']);
   return [
     slot1,
     slot2
@@ -862,6 +861,9 @@ describe('Unit: Prebid Module', function () {
 
     it('should set googletag targeting keys after calling setTargetingForGPTAsync function', function () {
       var slots = createSlotArrayScenario2();
+
+      // explicitly setting some PBJS key value pairs to verify whether these are removed befor new keys are set
+
       window.googletag.pubads().setSlots(slots);
       $$PREBID_GLOBAL$$.setTargetingForGPTAsync([config.adUnitCodes[0]]);
 
@@ -869,7 +871,7 @@ describe('Unit: Prebid Module', function () {
       // googletag's targeting structure
       // googletag setTargeting will override old value if invoked with same key
 
-      const targeting = [];
+      let targeting = [];
       slots[1].getTargetingKeys().map(function (key) {
         const value = slots[1].getTargeting(key);
         targeting.push([key, value]);
@@ -887,6 +889,39 @@ describe('Unit: Prebid Module', function () {
         invokedTargeting.push([key, value]);
       });
       assert.deepEqual(targeting, invokedTargeting, 'google tag targeting options not matching');
+
+      // resetPresetTargeting: initiate a new auction with no winning bids, now old targeting should be removed
+
+      resetAuction();
+      auction.getBidsReceived = function() { return [] };
+
+      var slots = createSlotArrayScenario2();
+      window.googletag.pubads().setSlots(slots);
+
+      $$PREBID_GLOBAL$$.setTargetingForGPTAsync([config.adUnitCodes[0]]);
+
+      targeting = [];
+      slots[1].getTargetingKeys().map(function (key) {
+        const value = slots[1].getTargeting(key);
+        targeting.push([key, value]);
+      });
+
+      invokedTargetingMap = {};
+      slots[1].spySetTargeting.args.map(function (entry) {
+        invokedTargetingMap[entry[0]] = entry[1];
+      });
+
+      var invokedTargeting = [];
+
+      Object.getOwnPropertyNames(invokedTargetingMap).map(function (key) {
+        const value = Array.isArray(invokedTargetingMap[key]) ? invokedTargetingMap[key] : [invokedTargetingMap[key]]; // values are always returned as array in googletag
+        invokedTargeting.push([key, value]);
+      });
+      assert.deepEqual(targeting, invokedTargeting, 'google tag targeting options not matching');
+      targeting.forEach(function(e) {
+        // here e[0] is key and e[1] is value in array that should be [null] as we are un-setting prebid keys in resetPresetTargeting
+        assert.deepEqual(e[1], [null], 'resetPresetTargeting: the value of the key ' + e[0] + ' should be [null]');
+      });
     });
 
     it('should set googletag targeting keys to specific slot with customSlotMatching', function () {

package/test/spec/unit/secureCreatives_spec.js

@@ -116,7 +116,7 @@ describe('secureCreatives', () => {
     beforeEach(function() {
       spyAddWinningBid = sinon.spy(auctionManager, 'addWinningBid');
       spyLogWarn = sinon.spy(utils, 'logWarn');
-      stubFireNativeTrackers = sinon.stub(native, 'fireNativeTrackers');
+      stubFireNativeTrackers = sinon.stub(native, 'fireNativeTrackers').callsFake(message => { return message.action; });
       stubGetAllAssetsMessage = sinon.stub(native, 'getAllAssetsMessage');
       stubEmit = sinon.stub(events, 'emit');
     });
@@ -263,10 +263,9 @@ describe('secureCreatives', () => {
         sinon.assert.calledOnce(stubGetAllAssetsMessage);
         sinon.assert.calledWith(stubGetAllAssetsMessage, data, adResponse);
         sinon.assert.calledOnce(ev.source.postMessage);
-        sinon.assert.calledOnce(stubFireNativeTrackers);
-        sinon.assert.calledWith(stubFireNativeTrackers, data, adResponse);
-        sinon.assert.calledOnce(spyAddWinningBid);
-        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.notCalled(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
         sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.STALE_RENDER);
       });
 
@@ -293,14 +292,11 @@ describe('secureCreatives', () => {
         sinon.assert.calledOnce(stubGetAllAssetsMessage);
         sinon.assert.calledWith(stubGetAllAssetsMessage, data, adResponse);
         sinon.assert.calledOnce(ev.source.postMessage);
-        sinon.assert.calledOnce(stubFireNativeTrackers);
-        sinon.assert.calledWith(stubFireNativeTrackers, data, adResponse);
-        sinon.assert.calledOnce(spyAddWinningBid);
-        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.notCalled(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
         sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.STALE_RENDER);
 
-        expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
-
         resetHistories(ev.source.postMessage);
 
         receiveMessage(ev);
@@ -309,10 +305,9 @@ describe('secureCreatives', () => {
         sinon.assert.calledOnce(stubGetAllAssetsMessage);
         sinon.assert.calledWith(stubGetAllAssetsMessage, data, adResponse);
         sinon.assert.calledOnce(ev.source.postMessage);
-        sinon.assert.calledOnce(stubFireNativeTrackers);
-        sinon.assert.calledWith(stubFireNativeTrackers, data, adResponse);
-        sinon.assert.calledOnce(spyAddWinningBid);
-        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.notCalled(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
         sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.STALE_RENDER);
       });
 
@@ -341,14 +336,11 @@ describe('secureCreatives', () => {
         sinon.assert.calledOnce(stubGetAllAssetsMessage);
         sinon.assert.calledWith(stubGetAllAssetsMessage, data, adResponse);
         sinon.assert.calledOnce(ev.source.postMessage);
-        sinon.assert.calledOnce(stubFireNativeTrackers);
-        sinon.assert.calledWith(stubFireNativeTrackers, data, adResponse);
-        sinon.assert.calledOnce(spyAddWinningBid);
-        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.notCalled(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
         sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.STALE_RENDER);
 
-        expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
-
         resetHistories(ev.source.postMessage);
 
         receiveMessage(ev);
@@ -357,14 +349,51 @@ describe('secureCreatives', () => {
         sinon.assert.calledOnce(stubGetAllAssetsMessage);
         sinon.assert.calledWith(stubGetAllAssetsMessage, data, adResponse);
         sinon.assert.calledOnce(ev.source.postMessage);
-        sinon.assert.calledOnce(stubFireNativeTrackers);
-        sinon.assert.calledWith(stubFireNativeTrackers, data, adResponse);
-        sinon.assert.calledOnce(spyAddWinningBid);
-        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.notCalled(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
         sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.STALE_RENDER);
 
         configObj.setConfig({'auctionOptions': {}});
       });
+
+      it('Prebid native should fire trackers', function () {
+        pushBidResponseToAuction({});
+
+        const data = {
+          adId: bidId,
+          message: 'Prebid Native',
+          action: 'click',
+        };
+
+        const ev = {
+          data: JSON.stringify(data),
+          source: {
+            postMessage: sinon.stub()
+          },
+          origin: 'any origin'
+        };
+
+        receiveMessage(ev);
+
+        sinon.assert.neverCalledWith(spyLogWarn, warning);
+        sinon.assert.calledOnce(stubFireNativeTrackers);
+        sinon.assert.neverCalledWith(stubEmit, CONSTANTS.EVENTS.BID_WON);
+        sinon.assert.notCalled(spyAddWinningBid);
+
+        resetHistories(ev.source.postMessage);
+
+        delete data.action;
+        ev.data = JSON.stringify(data);
+        receiveMessage(ev);
+
+        sinon.assert.neverCalledWith(spyLogWarn, warning);
+        sinon.assert.calledOnce(stubFireNativeTrackers);
+        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.BID_WON, adResponse);
+        sinon.assert.calledOnce(spyAddWinningBid);
+
+        expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
+      });
     });
   });
 });