prebid.js 7.19.0 → 7.20.0

package/test/spec/auctionmanager_spec.js

@@ -21,6 +21,7 @@ import {auctionManager} from '../../src/auctionManager.js';
 import 'modules/debugging/index.js' // some tests look for debugging side effects
 import {AuctionIndex} from '../../src/auctionIndex.js';
 import {expect} from 'chai';
+import {deepClone} from '../../src/utils.js';
 
 var assert = require('assert');
 
@@ -57,7 +58,16 @@ function mockBid(opts) {
     'currency': 'USD',
     'netRevenue': true,
     'ttl': 360,
-    getSize: () => '300x250'
+    getSize: () => '300x250',
+    getIdentifiers() {
+      return {
+        src: this.source,
+        bidder: this.bidderCode,
+        bidId: this.requestId,
+        transactionId: this.transactionId,
+        auctionId: this.auctionId
+      }
+    }
   };
 }
 
@@ -1323,6 +1333,7 @@ describe('auctionmanager.js', function () {
       getAdUnits: () => getBidRequests().flatMap(br => br.bids).map(br => ({ code: br.adUnitCode, transactionId: br.transactionId, mediaTypes: br.mediaTypes })),
       getAuctionId: () => '1',
       addBidReceived: () => true,
+      addBidRejected: () => true,
       getTimeout: () => 1000,
       getAuctionStart: () => start,
     }
@@ -1382,26 +1393,32 @@ describe('auctionmanager.js', function () {
       bidRequests = null;
     });
 
-    it('should call auction done after bid is added to auction for mediaType banner', function () {
-      let ADUNIT_CODE2 = 'adUnitCode2';
-      let BIDDER_CODE2 = 'sampleBidder2';
-
-      let bids1 = [mockBid({ bidderCode: BIDDER_CODE1, transactionId: ADUNIT_CODE1 })];
-      let bids2 = [mockBid({ bidderCode: BIDDER_CODE2, transactionId: ADUNIT_CODE2 })];
-      bidRequests = [
-        mockBidRequest(bids[0]),
-        mockBidRequest(bids1[0], { adUnitCode: ADUNIT_CODE1 }),
-        mockBidRequest(bids2[0], { adUnitCode: ADUNIT_CODE2 })
-      ];
-      let cbs = auctionCallbacks(doneSpy, auction);
-      cbs.addBidResponse.call(bidRequests[0], ADUNIT_CODE, bids[0]);
-      cbs.adapterDone.call(bidRequests[0]);
-      cbs.addBidResponse.call(bidRequests[1], ADUNIT_CODE1, bids1[0]);
-      cbs.adapterDone.call(bidRequests[1]);
-      cbs.addBidResponse.call(bidRequests[2], ADUNIT_CODE2, bids2[0]);
-      cbs.adapterDone.call(bidRequests[2]);
-      assert.equal(doneSpy.callCount, 1);
-    });
+    Object.entries({
+      'added to': (cbs) => cbs.addBidResponse,
+      'rejected from': (cbs) => cbs.addBidResponse.reject,
+    }).forEach(([t, getMethod]) => {
+      it(`should call auction done after bid is ${t} auction for mediaType banner`, function () {
+        let ADUNIT_CODE2 = 'adUnitCode2';
+        let BIDDER_CODE2 = 'sampleBidder2';
+
+        let bids1 = [mockBid({ bidderCode: BIDDER_CODE1, transactionId: ADUNIT_CODE1 })];
+        let bids2 = [mockBid({ bidderCode: BIDDER_CODE2, transactionId: ADUNIT_CODE2 })];
+        bidRequests = [
+          mockBidRequest(bids[0]),
+          mockBidRequest(bids1[0], { adUnitCode: ADUNIT_CODE1 }),
+          mockBidRequest(bids2[0], { adUnitCode: ADUNIT_CODE2 })
+        ];
+        let cbs = auctionCallbacks(doneSpy, auction);
+        const method = getMethod(cbs);
+        method(ADUNIT_CODE, bids[0]);
+        cbs.adapterDone.call(bidRequests[0]);
+        method(ADUNIT_CODE1, bids1[0]);
+        cbs.adapterDone.call(bidRequests[1]);
+        method(ADUNIT_CODE2, bids2[0]);
+        cbs.adapterDone.call(bidRequests[2]);
+        assert.equal(doneSpy.callCount, 1);
+      });
+    })
 
     it('should call auction done after prebid cache is complete for mediaType video', function() {
       bids[0].mediaType = 'video';
@@ -1543,6 +1560,77 @@ describe('auctionmanager.js', function () {
         });
       })
     });
+
+    describe('when bids are rejected', () => {
+      let cbs, bid, expectedRejection;
+      const onBidRejected = sinon.stub();
+      const REJECTION_REASON = 'Bid rejected';
+      const AU_CODE = 'au';
+
+      function rejectHook(fn, adUnitCode, bid, reject) {
+        reject(REJECTION_REASON);
+        reject(REJECTION_REASON); // second call should do nothing
+      }
+
+      before(() => {
+        addBidResponse.before(rejectHook, 999);
+        events.on(CONSTANTS.EVENTS.BID_REJECTED, onBidRejected);
+      });
+
+      after(() => {
+        addBidResponse.getHooks({hook: rejectHook}).remove();
+        events.off(CONSTANTS.EVENTS.BID_REJECTED, onBidRejected);
+      });
+
+      beforeEach(() => {
+        onBidRejected.reset();
+        bid = mockBid({bidderCode: BIDDER_CODE});
+        bidRequests = [
+          mockBidRequest(bid),
+        ];
+        cbs = auctionCallbacks(doneSpy, auction);
+        expectedRejection = sinon.match(Object.assign({}, bid, {
+          rejectionReason: REJECTION_REASON,
+          adUnitCode: AU_CODE
+        }));
+        auction.addBidRejected = sinon.stub();
+      });
+
+      Object.entries({
+        'with addBidResponse.reject': () => cbs.addBidResponse.reject(AU_CODE, deepClone(bid), REJECTION_REASON),
+        'from addBidResponse hooks': () => cbs.addBidResponse(AU_CODE, deepClone(bid))
+      }).forEach(([t, rejectBid]) => {
+        describe(t, () => {
+          it('should emit a BID_REJECTED event', () => {
+            rejectBid();
+            sinon.assert.calledWith(onBidRejected, expectedRejection);
+          });
+
+          it('should pass bid to auction.addBidRejected', () => {
+            rejectBid();
+            sinon.assert.calledWith(auction.addBidRejected, expectedRejection);
+          });
+        })
+      });
+
+      it('should return a NO_BID replacement', () => {
+        const noBid = cbs.addBidResponse.reject(AU_CODE, {...bid, statusMessage: 'Bid available', status: CONSTANTS.BID_STATUS.RENDERED}, 'Rejected');
+        sinon.assert.match(noBid, {
+          status: CONSTANTS.BID_STATUS.BID_REJECTED,
+          statusMessage: 'Bid returned empty or error response',
+          cpm: 0,
+          requestId: bid.requestId,
+          auctionId: bid.auctionId,
+          adUnitCode: AU_CODE,
+          rejectionReason: undefined,
+        });
+      });
+
+      it('addBidResponse hooks should not be able to reject the same bid twice', () => {
+        cbs.addBidResponse(AU_CODE, bid);
+        expect(auction.addBidRejected.calledOnce).to.be.true;
+      });
+    })
   });
 
   describe('auctionOptions', function() {

package/test/spec/modules/aolBidAdapter_spec.js

@@ -81,20 +81,46 @@ describe('AolAdapter', function () {
   const ONE_DISPLAY_TTL = 60;
   const ONE_MOBILE_TTL = 3600;
   const SUPPORTED_USER_ID_SOURCES = {
-    'adserver.org': '100',
-    'criteo.com': '200',
-    'id5-sync.com': '300',
-    'intentiq.com': '400',
-    'liveintent.com': '500',
-    'quantcast.com': '600',
-    'verizonmedia.com': '700',
-    'liveramp.com': '800'
+    'admixer.net': '100',
+    'adserver.org': '200',
+    'adtelligent.com': '300',
+    'amxrtb.com': '500',
+    'audigent.com': '600',
+    'britepool.com': '700',
+    'criteo.com': '800',
+    'crwdcntrl.net': '900',
+    'deepintent.com': '1000',
+    'epsilon.com': '1100',
+    'hcn.health': '1200',
+    'id5-sync.com': '1300',
+    'idx.lat': '1400',
+    'intentiq.com': '1500',
+    'intimatemerger.com': '1600',
+    'liveintent.com': '1700',
+    'liveramp.com': '1800',
+    'mediawallahscript.com': '1900',
+    'netid.de': '2100',
+    'neustar.biz': '2200',
+    'pubcid.org': '2600',
+    'quantcast.com': '2700',
+    'tapad.com': '2800',
+    'zeotap.com': '3200'
   };
 
   const USER_ID_DATA = {
+    admixerId: SUPPORTED_USER_ID_SOURCES['admixer.net'],
+    adtelligentId: SUPPORTED_USER_ID_SOURCES['adtelligent.com'],
+    amxId: SUPPORTED_USER_ID_SOURCES['amxrtb.com'],
+    britepoolid: SUPPORTED_USER_ID_SOURCES['britepool.com'],
     criteoId: SUPPORTED_USER_ID_SOURCES['criteo.com'],
     connectid: SUPPORTED_USER_ID_SOURCES['verizonmedia.com'],
+    dmdId: SUPPORTED_USER_ID_SOURCES['hcn.health'],
+    hadronId: SUPPORTED_USER_ID_SOURCES['audigent.com'],
+    lotamePanoramaId: SUPPORTED_USER_ID_SOURCES['crwdcntrl.net'],
+    deepintentId: SUPPORTED_USER_ID_SOURCES['deepintent.com'],
+    fabrickId: SUPPORTED_USER_ID_SOURCES['neustar.biz'],
     idl_env: SUPPORTED_USER_ID_SOURCES['liveramp.com'],
+    IDP: SUPPORTED_USER_ID_SOURCES['zeotap.com'],
     lipb: {
       lipbid: SUPPORTED_USER_ID_SOURCES['liveintent.com'],
       segments: ['100', '200']
@@ -104,8 +130,15 @@ describe('AolAdapter', function () {
       uid: SUPPORTED_USER_ID_SOURCES['id5-sync.com'],
       ext: {foo: 'bar'}
     },
+    idx: SUPPORTED_USER_ID_SOURCES['idx.lat'],
+    imuid: SUPPORTED_USER_ID_SOURCES['intimatemerger.com'],
     intentIqId: SUPPORTED_USER_ID_SOURCES['intentiq.com'],
-    quantcastId: SUPPORTED_USER_ID_SOURCES['quantcast.com']
+    mwOpenLinkId: SUPPORTED_USER_ID_SOURCES['mediawallahscript.com'],
+    netId: SUPPORTED_USER_ID_SOURCES['netid.de'],
+    quantcastId: SUPPORTED_USER_ID_SOURCES['quantcast.com'],
+    publinkId: SUPPORTED_USER_ID_SOURCES['epsilon.com'],
+    pubcid: SUPPORTED_USER_ID_SOURCES['pubcid.org'],
+    tapadId: SUPPORTED_USER_ID_SOURCES['tapad.com']
   };
 
   function createCustomBidRequest({bids, params} = {}) {

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -4,6 +4,7 @@ import { newBidder } from 'src/adapters/bidderFactory.js';
 import * as bidderFactory from 'src/adapters/bidderFactory.js';
 import { auctionManager } from 'src/auctionManager.js';
 import { deepClone } from 'src/utils.js';
+import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
 
 const ENDPOINT = 'https://ib.adnxs.com/ut/v3/prebid';
@@ -370,6 +371,29 @@ describe('AppNexusAdapter', function () {
       });
     });
 
+    it('should add debug params from query', function () {
+      let getParamStub = sinon.stub(utils, 'getParameterByName').callsFake(function(par) {
+        if (par === 'apn_debug_dongle') return 'abcdef';
+        if (par === 'apn_debug_member_id') return '1234';
+        if (par === 'apn_debug_timeout') return '1000';
+
+        return '';
+      });
+
+      let bidRequest = deepClone(bidRequests[0]);
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.debug).to.exist.and.to.deep.equal({
+        'dongle': 'abcdef',
+        'enabled': true,
+        'member_id': 1234,
+        'debug_timeout': 1000
+      });
+
+      getParamStub.restore();
+    });
+
     it('should attach reserve param when either bid param or getFloor function exists', function () {
       let getFloorResponse = { currency: 'USD', floor: 3 };
       let request, payload = null;

package/test/spec/modules/connectIdSystem_spec.js

@@ -76,6 +76,26 @@ describe('Yahoo ConnectID Submodule', () => {
       expect(result.callback).to.be.a('function');
     });
 
+    it('returns an undefined if the Yahoo specific opt-out key is present in local storage', () => {
+      localStorage.setItem('connectIdOptOut', '1');
+      expect(invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData)).to.be.undefined;
+      localStorage.removeItem('connectIdOptOut');
+    });
+
+    it('returns an object with the callback function if the correct params are passed and Yahoo opt-out value is not "1"', () => {
+      localStorage.setItem('connectIdOptOut', 'true');
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+      localStorage.removeItem('connectIdOptOut');
+    });
+
     it('Makes an ajax GET request to the production API endpoint with query params', () => {
       invokeGetIdAPI({
         he: HASHED_EMAIL,

package/test/spec/modules/currency_spec.js

@@ -351,6 +351,11 @@ describe('currency', function () {
   });
 
   describe('currency.addBidResponseDecorator', function () {
+    let reject;
+    beforeEach(() => {
+      reject = sinon.stub().returns({status: 'rejected'});
+    });
+
     it('should leave bid at 1 when currency support is not enabled and fromCurrency is USD', function () {
       setConfig({});
       var bid = makeBid({ 'cpm': 1, 'currency': 'USD' });
@@ -368,8 +373,9 @@ describe('currency', function () {
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
-      }, 'elementId', bid);
-      expect(innerBid.statusMessage).to.equal('Bid returned empty or error response');
+      }, 'elementId', bid, reject);
+      expect(innerBid.status).to.equal('rejected');
+      expect(reject.calledOnce).to.be.true;
     });
 
     it('should not buffer bid when currency is already in desired currency', function () {
@@ -395,8 +401,9 @@ describe('currency', function () {
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
-      }, 'elementId', bid);
-      expect(innerBid.statusMessage).to.equal('Bid returned empty or error response');
+      }, 'elementId', bid, reject);
+      expect(innerBid.status).to.equal('rejected');
+      expect(reject.calledOnce).to.be.true;
     });
 
     it('should result in NO_BID when adServerCurrency is not supported in file', function () {
@@ -407,8 +414,9 @@ describe('currency', function () {
       var innerBid;
       addBidResponseHook(function(adCodeId, bid) {
         innerBid = bid;
-      }, 'elementId', bid);
-      expect(innerBid.statusMessage).to.equal('Bid returned empty or error response');
+      }, 'elementId', bid, reject);
+      expect(innerBid.status).to.equal('rejected');
+      expect(reject.calledOnce).to.be.true;
     });
 
     it('should return 1 when currency support is enabled and same currency code is requested as is set to adServerCurrency', function () {