prebid.js 7.31.0 → 7.32.0

package/test/spec/modules/smartxBidAdapter_spec.js

@@ -374,6 +374,16 @@ describe('The smartx adapter', function () {
         }
       })
     });
+
+    it('should pass sitekey param', function () {
+      var request;
+
+      bid.params.sitekey = 'foo'
+
+      request = spec.buildRequests([bid], bidRequestObj)[0];
+
+      expect(request.data.site.content.ext.sitekey).to.equal('foo');
+    });
   });
 
   describe('interpretResponse', function () {

package/test/spec/modules/taboolaBidAdapter_spec.js

@@ -2,6 +2,7 @@ import {expect} from 'chai';
 import {spec, internal, END_POINT_URL, userData} from 'modules/taboolaBidAdapter.js';
 import {config} from '../../../src/config'
 import * as utils from '../../../src/utils'
+import {server} from '../../mocks/xhr'
 
 describe('Taboola Adapter', function () {
   let hasLocalStorage, cookiesAreEnabled, getDataFromLocalStorage, localStorageIsEnabled, getCookie, commonBidRequest;
@@ -91,6 +92,31 @@ describe('Taboola Adapter', function () {
     })
   })
 
+  describe('onBidWon', function () {
+    it('onBidWon exist as a function', () => {
+      expect(spec.onBidWon).to.exist.and.to.be.a('function');
+    });
+
+    it('should resolve price macro in nurl', function () {
+      const nurl = 'http://win.example.com/${AUCTION_PRICE}';
+      const bid = {
+        requestId: 1,
+        cpm: 2,
+        originalCpm: 3.4,
+        creativeId: 1,
+        ttl: 60,
+        netRevenue: true,
+        mediaType: 'banner',
+        ad: '...',
+        width: 300,
+        height: 250,
+        nurl: nurl
+      }
+      spec.onBidWon(bid);
+      expect(server.requests[0].url).to.equals('http://win.example.com/3.4')
+    });
+  });
+
   describe('buildRequests', function () {
     const defaultBidRequest = {
       ...createBidRequest(),
@@ -122,7 +148,8 @@ describe('Taboola Adapter', function () {
           },
           'tagid': commonBidRequest.params.tagId,
           'bidfloor': null,
-          'bidfloorcur': 'USD'
+          'bidfloorcur': 'USD',
+          'ext': {}
         }],
         'site': {
           'id': commonBidRequest.params.publisherId,
@@ -137,11 +164,13 @@ describe('Taboola Adapter', function () {
         'source': {'fd': 1},
         'bcat': [],
         'badv': [],
+        'wlang': [],
         'user': {
           'buyeruid': 0,
           'ext': {},
         },
-        'regs': {'coppa': 0, 'ext': {}}
+        'regs': {'coppa': 0, 'ext': {}},
+        'ext': {}
       };
 
       const res = spec.buildRequests([defaultBidRequest], commonBidderRequest);
@@ -184,7 +213,7 @@ describe('Taboola Adapter', function () {
       expect(resData.imp[0].bidfloorcur).to.deep.equal('USD');
     });
 
-    it('should pass bid floor even if they is a bid floor param', function () {
+    it('should pass bid floor even if it is a bid floor param', function () {
       const optionalParams = {
         bidfloor: 0.25,
         bidfloorcur: 'EUR'
@@ -206,6 +235,38 @@ describe('Taboola Adapter', function () {
       expect(resData.imp[0].bidfloorcur).to.deep.equal('USD');
     });
 
+    it('should pass impression position', function () {
+      const optionalParams = {
+        position: 2
+      };
+
+      const bidRequest = {
+        ...defaultBidRequest,
+        params: {...commonBidRequest.params, ...optionalParams}
+      };
+
+      const res = spec.buildRequests([bidRequest], commonBidderRequest);
+      const resData = JSON.parse(res.data);
+      expect(resData.imp[0].banner.pos).to.deep.equal(2);
+    });
+
+    it('should pass gpid if configured', function () {
+      const ortb2Imp = {
+        ext: {
+          gpid: '/homepage/#1'
+        }
+      }
+      const bidRequest = {
+        ...defaultBidRequest,
+        ortb2Imp: ortb2Imp,
+        params: {...commonBidRequest.params}
+      };
+
+      const res = spec.buildRequests([bidRequest], commonBidderRequest);
+      const resData = JSON.parse(res.data);
+      expect(resData.imp[0].ext.gpid).to.deep.equal('/homepage/#1');
+    });
+
     it('should pass bidder timeout', function () {
       const bidderRequest = {
         ...commonBidderRequest,
@@ -216,6 +277,40 @@ describe('Taboola Adapter', function () {
       expect(resData.tmax).to.equal(500);
     });
 
+    describe('first party data', function () {
+      it('should parse first party data', function () {
+        const bidderRequest = {
+          ...commonBidderRequest,
+          ortb2: {
+            bcat: ['EX1', 'EX2', 'EX3'],
+            badv: ['site.com'],
+            wlang: ['de'],
+          }
+        }
+        const res = spec.buildRequests([defaultBidRequest], bidderRequest);
+        const resData = JSON.parse(res.data);
+        expect(resData.bcat).to.deep.equal(bidderRequest.ortb2.bcat)
+        expect(resData.badv).to.deep.equal(bidderRequest.ortb2.badv)
+        expect(resData.wlang).to.deep.equal(bidderRequest.ortb2.wlang)
+      });
+
+      it('should pass pageType if exists in ortb2', function () {
+        const bidderRequest = {
+          ...commonBidderRequest,
+          ortb2: {
+            ext: {
+              data: {
+                pageType: 'news'
+              }
+            }
+          }
+        }
+        const res = spec.buildRequests([defaultBidRequest], bidderRequest);
+        const resData = JSON.parse(res.data);
+        expect(resData.ext.pageType).to.deep.equal(bidderRequest.ortb2.ext.data.pageType);
+      });
+    });
+
     describe('handle privacy segments when building request', function () {
       it('should pass GDPR consent', function () {
         const bidderRequest = {
@@ -234,6 +329,20 @@ describe('Taboola Adapter', function () {
         expect(resData.regs.ext.gdpr).to.equal(1)
       });
 
+      it('should pass GPP consent if exist in ortb2', function () {
+        const ortb2 = {
+          regs: {
+            gpp: 'testGpp',
+            gpp_sid: [1, 2, 3]
+          }
+        }
+
+        const res = spec.buildRequests([defaultBidRequest], {...commonBidderRequest, ortb2})
+        const resData = JSON.parse(res.data)
+        expect(resData.regs.ext.gpp).to.equal('testGpp')
+        expect(resData.regs.ext.gpp_sid).to.deep.equal([1, 2, 3])
+      });
+
       it('should pass us privacy consent', function () {
         const bidderRequest = {
           refererInfo: {
@@ -552,8 +661,36 @@ describe('Taboola Adapter', function () {
     });
   })
 
-  describe('userData', function () {
-    // todo: add UT for getUserSyncs
+  describe('getUserSyncs', function () {
+    const usersyncUrl = 'https://trc.taboola.com/sg/prebidJS/1/cm';
+
+    it('should not return user sync if pixelEnabled is false', function () {
+      const res = spec.getUserSyncs({pixelEnabled: false});
+      expect(res).to.be.an('array').that.is.empty;
+    });
+
+    it('should return user sync if pixelEnabled is true', function () {
+      const res = spec.getUserSyncs({pixelEnabled: true});
+      expect(res).to.deep.equal([{type: 'image', url: usersyncUrl}]);
+    });
+
+    it('should pass consent tokens values', function() {
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'GDPR_CONSENT'}, 'USP_CONSENT')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=1&gdpr_consent=GDPR_CONSENT&us_privacy=USP_CONSENT`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: undefined}, undefined)).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=0&gdpr_consent=`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: undefined}, undefined)).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?gdpr=0&gdpr_consent=`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, 'USP_CONSENT')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?us_privacy=USP_CONSENT`
+      }]);
+      expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, 'USP_CONSENT', 'GPP_STRING')).to.deep.equal([{
+        type: 'image', url: `${usersyncUrl}?us_privacy=USP_CONSENT&gpp=GPP_STRING`
+      }]);
+    });
   })
 
   describe('internal functions', function () {

package/test/spec/modules/videoModule/submodules/jwplayerVideoProvider_spec.js

@@ -66,7 +66,28 @@ function getUtilsMock() {
 
 const sharedUtils = { videoEvents };
 
+function addDiv() {
+  const div = document.createElement('div');
+  div.setAttribute('id', 'test');
+  document.body.appendChild(div);
+}
+
+function removeDiv() {
+  const div = document.getElementById('test');
+  if (div) {
+    div.remove();
+  }
+}
+
 describe('JWPlayerProvider', function () {
+  beforeEach(() => {
+    addDiv();
+  });
+
+  afterEach(() => {
+    removeDiv();
+  });
+
   describe('init', function () {
     let config;
     let adState;
@@ -75,7 +96,7 @@ describe('JWPlayerProvider', function () {
     let utilsMock;
 
     beforeEach(() => {
-      config = {};
+      config = { divId: 'test' };
       adState = adStateFactory();
       timeState = timeStateFactory();
       callbackStorage = callbackStorageFactory();
@@ -104,7 +125,21 @@ describe('JWPlayerProvider', function () {
       expect(payload.errorCode).to.be.equal(-2);
     });
 
-    it('should instantiate the player when uninstantied', function () {
+    it('should trigger failure when div is missing', function () {
+      removeDiv();
+      let jwplayerMock = () => {};
+      const provider = JWPlayerProvider(config, jwplayerMock, adState, timeState, callbackStorage, utilsMock, sharedUtils);
+      const setupFailed = sinon.spy();
+      provider.onEvent(SETUP_FAILED, setupFailed, {});
+      provider.init();
+      expect(setupFailed.calledOnce).to.be.true;
+      const payload = setupFailed.args[0][1];
+      expect(payload.errorCode).to.be.equal(-3);
+      addDiv();
+      addDiv();
+    });
+
+    it('should instantiate the player when uninstantiated', function () {
       const player = getPlayerMock();
       config.playerConfig = {};
       const setupSpy = player.setup = sinon.spy();
@@ -113,7 +148,7 @@ describe('JWPlayerProvider', function () {
       expect(setupSpy.calledOnce).to.be.true;
     });
 
-    it('should trigger setup complete when player is already instantied', function () {
+    it('should trigger setup complete when player is already instantiated', function () {
       const player = getPlayerMock();
       player.getState = () => 'idle';
       const provider = JWPlayerProvider(config, makePlayerFactoryMock(player), adState, timeState, callbackStorage, utilsMock, sharedUtils);
@@ -151,7 +186,7 @@ describe('JWPlayerProvider', function () {
       const test_playback_method = PLAYBACK_METHODS.CLICK_TO_PLAY;
       const test_skip = 0;
 
-      const config = {};
+      const config = { divId: 'test' };
       const player = getPlayerMock();
       const utils = getUtilsMock();
 
@@ -230,9 +265,9 @@ describe('JWPlayerProvider', function () {
           duration: test_duration,
           playbackMode: test_playback_mode
         })
-      }
+      };
 
-      const provider = JWPlayerProvider({}, makePlayerFactoryMock(player), adStateFactory(), timeState, {}, utils, sharedUtils);
+      const provider = JWPlayerProvider({ divId: 'test' }, makePlayerFactoryMock(player), adStateFactory(), timeState, {}, utils, sharedUtils);
       provider.init();
 
       let content = provider.getOrtbContent();
@@ -260,7 +295,7 @@ describe('JWPlayerProvider', function () {
     it('should call playAd', function () {
       const player = getPlayerMock();
       const playAdSpy = player.playAd = sinon.spy();
-      const provider = JWPlayerProvider({}, makePlayerFactoryMock(player), {}, {}, {}, {}, sharedUtils);
+      const provider = JWPlayerProvider({ divId: 'test' }, makePlayerFactoryMock(player), {}, {}, {}, {}, sharedUtils);
       provider.init();
       provider.setAdTagUrl('tag');
       expect(playAdSpy.called).to.be.true;
@@ -273,7 +308,7 @@ describe('JWPlayerProvider', function () {
     it('should register event listener on player', function () {
       const player = getPlayerMock();
       const onSpy = player.on = sinon.spy();
-      const provider = JWPlayerProvider({}, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), getUtilsMock(), sharedUtils);
+      const provider = JWPlayerProvider({ divId: 'test' }, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), getUtilsMock(), sharedUtils);
       provider.init();
       const callback = () => {};
       provider.onEvent(PLAY, callback, {});
@@ -285,7 +320,7 @@ describe('JWPlayerProvider', function () {
     it('should remove event listener on player', function () {
       const player = getPlayerMock();
       const offSpy = player.off = sinon.spy();
-      const provider = JWPlayerProvider({}, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), utils, sharedUtils);
+      const provider = JWPlayerProvider({ divId: 'test' }, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), utils, sharedUtils);
       provider.init();
       const callback = () => {};
       provider.onEvent(AD_IMPRESSION, callback, {});
@@ -301,7 +336,7 @@ describe('JWPlayerProvider', function () {
       const player = getPlayerMock();
       const removeSpy = player.remove = sinon.spy();
       player.remove = removeSpy;
-      const provider = JWPlayerProvider({}, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), getUtilsMock(), sharedUtils);
+      const provider = JWPlayerProvider({ divId: 'test' }, makePlayerFactoryMock(player), adStateFactory(), timeStateFactory(), callbackStorageFactory(), getUtilsMock(), sharedUtils);
       provider.init();
       provider.destroy();
       provider.destroy();

package/test/spec/modules/yahoosspBidAdapter_spec.js

@@ -3,6 +3,7 @@ import { config } from 'src/config.js';
 import { BANNER, VIDEO } from 'src/mediaTypes.js';
 import { spec } from 'modules/yahoosspBidAdapter.js';
 import {createEidsArray} from '../../../modules/userId/eids';
+import {deepClone} from '../../../src/utils';
 
 const DEFAULT_BID_ID = '84ab500420319d';
 const DEFAULT_BID_DCN = '2093845709823475';
@@ -713,7 +714,7 @@ describe('YahooSSP Bid Adapter:', () => {
     });
   });
 
-  describe('GDPR & Consent:', () => {
+  describe('GDPR & Consent & GPP:', () => {
     it('should return request objects that do not send cookies if purpose 1 consent is not provided', () => {
       const { validBidRequests, bidderRequest } = generateBuildRequestMock({});
       bidderRequest.gdprConsent = {
@@ -731,6 +732,20 @@ describe('YahooSSP Bid Adapter:', () => {
       const options = spec.buildRequests(validBidRequests, bidderRequest)[0].options;
       expect(options.withCredentials).to.be.false;
     });
+
+    it('adds the ortb2 gpp consent info to the request', function () {
+      const { validBidRequests, bidderRequest } = generateBuildRequestMock({});
+      const ortb2 = {
+        regs: {
+          gpp: 'somegppstring',
+          gpp_sid: [6, 7]
+        }
+      };
+      let clonedBidderRequest = {...bidderRequest, ortb2};
+      const data = spec.buildRequests(validBidRequests, clonedBidderRequest)[0].data;
+      expect(data.regs.ext.gpp).to.equal('somegppstring');
+      expect(data.regs.ext.gpp_sid).to.eql([6, 7]);
+    });
   });
 
   describe('Endpoint & Impression Request Mode:', () => {