prebid.js 6.0.0 → 6.4.0

package/test/spec/modules/nextMillenniumBidAdapter_spec.js

@@ -4,6 +4,7 @@ import { spec } from 'modules/nextMillenniumBidAdapter.js';
 describe('nextMillenniumBidAdapterTests', function() {
   const bidRequestData = [
     {
+      adUnitCode: 'test-div',
       bidId: 'bid1234',
       auctionId: 'b06c5141-fe8f-4cdf-9d7d-54415490a917',
       bidder: 'nextMillennium',
@@ -17,19 +18,43 @@ describe('nextMillenniumBidAdapterTests', function() {
     }
   ];
 
-  it('Request params check with GDPR Consent', function () {
+  it('Request params check with GDPR and USP Consent', function () {
     const request = spec.buildRequests(bidRequestData, bidRequestData[0]);
     expect(JSON.parse(request[0].data).user.ext.consent).to.equal('kjfdniwjnifwenrif3');
     expect(JSON.parse(request[0].data).regs.ext.us_privacy).to.equal('1---');
     expect(JSON.parse(request[0].data).regs.ext.gdpr).to.equal(1);
   });
 
+  it('Request params check without GDPR Consent', function () {
+    delete bidRequestData[0].gdprConsent
+    const request = spec.buildRequests(bidRequestData, bidRequestData[0]);
+    expect(JSON.parse(request[0].data).regs.ext.gdpr).to.be.undefined;
+    expect(JSON.parse(request[0].data).regs.ext.us_privacy).to.equal('1---');
+  });
+
   it('validate_generated_params', function() {
     const request = spec.buildRequests(bidRequestData);
     expect(request[0].bidId).to.equal('bid1234');
     expect(JSON.parse(request[0].data).id).to.equal('b06c5141-fe8f-4cdf-9d7d-54415490a917');
   });
 
+  it('Check if refresh_count param is incremented', function() {
+    const request = spec.buildRequests(bidRequestData);
+    expect(JSON.parse(request[0].data).refresh_count).to.equal(3);
+  });
+
+  it('Test getUserSyncs function', function () {
+    const syncOptions = {
+      'iframeEnabled': true
+    }
+    const userSync = spec.getUserSyncs(syncOptions);
+    expect(userSync).to.be.an('array').with.lengthOf(1);
+    expect(userSync[0].type).to.exist;
+    expect(userSync[0].url).to.exist;
+    expect(userSync[0].type).to.be.equal('iframe');
+    expect(userSync[0].url).to.be.equal('https://statics.nextmillmedia.com/load-cookie.html?v=4');
+  });
+
   it('validate_response_params', function() {
     const serverResponse = {
       body: {

package/test/spec/modules/oguryBidAdapter_spec.js

@@ -119,7 +119,7 @@ describe('OguryBidAdapter', function () {
       };
     });
 
-    it('should return sync array with two elements of type image', () => {
+    it('should return syncs array with two elements of type image', () => {
       const userSyncs = spec.getUserSyncs(syncOptions, [], gdprConsent);
 
       expect(userSyncs).to.have.lengthOf(2);
@@ -129,7 +129,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.contain('https://ms-cookie-sync.presage.io/ttd/init-sync');
     });
 
-    it('should set the same source as query param', () => {
+    it('should set the source as query param', () => {
       const userSyncs = spec.getUserSyncs(syncOptions, [], gdprConsent);
       expect(userSyncs[0].url).to.contain('source=prebid');
       expect(userSyncs[1].url).to.contain('source=prebid');
@@ -146,7 +146,7 @@ describe('OguryBidAdapter', function () {
       expect(spec.getUserSyncs(syncOptions, [], gdprConsent)).to.have.lengthOf(0);
     });
 
-    it('should return sync array with two elements of type image when consentString is undefined', () => {
+    it('should return syncs array with two elements of type image when consentString is undefined', () => {
       gdprConsent = {
         gdprApplies: true,
         consentString: undefined
@@ -160,7 +160,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.equal('https://ms-cookie-sync.presage.io/ttd/init-sync?iab_string=&source=prebid')
     });
 
-    it('should return sync array with two elements of type image when consentString is null', () => {
+    it('should return syncs array with two elements of type image when consentString is null', () => {
       gdprConsent = {
         gdprApplies: true,
         consentString: null
@@ -174,7 +174,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.equal('https://ms-cookie-sync.presage.io/ttd/init-sync?iab_string=&source=prebid')
     });
 
-    it('should return sync array with two elements of type image when gdprConsent is undefined', () => {
+    it('should return syncs array with two elements of type image when gdprConsent is undefined', () => {
       gdprConsent = undefined;
 
       const userSyncs = spec.getUserSyncs(syncOptions, [], gdprConsent);
@@ -185,7 +185,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.equal('https://ms-cookie-sync.presage.io/ttd/init-sync?iab_string=&source=prebid')
     });
 
-    it('should return sync array with two elements of type image when gdprConsent is null', () => {
+    it('should return syncs array with two elements of type image when gdprConsent is null', () => {
       gdprConsent = null;
 
       const userSyncs = spec.getUserSyncs(syncOptions, [], gdprConsent);
@@ -196,7 +196,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.equal('https://ms-cookie-sync.presage.io/ttd/init-sync?iab_string=&source=prebid')
     });
 
-    it('should return sync array with two elements of type image when gdprConsent is null and gdprApplies is false', () => {
+    it('should return syncs array with two elements of type image when gdprConsent is null and gdprApplies is false', () => {
       gdprConsent = {
         gdprApplies: false,
         consentString: null
@@ -210,7 +210,7 @@ describe('OguryBidAdapter', function () {
       expect(userSyncs[1].url).to.equal('https://ms-cookie-sync.presage.io/ttd/init-sync?iab_string=&source=prebid')
     });
 
-    it('should return sync array with two elements of type image when gdprConsent is empty string and gdprApplies is false', () => {
+    it('should return syncs array with two elements of type image when gdprConsent is empty string and gdprApplies is false', () => {
       gdprConsent = {
         gdprApplies: false,
         consentString: ''
@@ -240,7 +240,8 @@ describe('OguryBidAdapter', function () {
             w: 300,
             h: 250
           }]
-        }
+        },
+        ext: bidRequests[0].params
       }, {
         id: bidRequests[1].bidId,
         tagid: bidRequests[1].params.adUnitId,
@@ -250,7 +251,8 @@ describe('OguryBidAdapter', function () {
             w: 600,
             h: 500
           }]
-        }
+        },
+        ext: bidRequests[1].params
       }],
       regs: {
         ext: {
@@ -549,7 +551,7 @@ describe('OguryBidAdapter', function () {
       xhr.restore()
     })
 
-    it('should send notification on bid timeout', function() {
+    it('should send on bid timeout notification', function() {
       const bid = {
         ad: '<img style="width: 300px; height: 250px;" src="https://assets.afcdn.com/recipe/20190529/93153_w1024h768c1cx2220cy1728cxt0cyt0cxb4441cyb3456.jpg" alt="cookies" />',
         cpm: 3

package/test/spec/modules/openxBidAdapter_spec.js

@@ -1102,6 +1102,11 @@ describe('OpenxAdapter', function () {
         mwOpenLinkId: '1111-mwopenlinkid',
         dapId: '1111-dapId',
         amxId: '1111-amxid',
+        kpuid: '1111-kpuid',
+        publinkId: '1111-publinkid',
+        naveggId: '1111-naveggid',
+        imuid: '1111-imuid',
+        adtelligentId: '1111-adtelligentid'
       };
 
       // generates the same set of tests for each id provider

package/test/spec/modules/prebidServerBidAdapter_spec.js

@@ -8,6 +8,7 @@ import events from 'src/events.js';
 import CONSTANTS from 'src/constants.json';
 import { server } from 'test/mocks/xhr.js';
 import { createEidsArray } from 'modules/userId/eids.js';
+import {deepAccess, deepClone} from 'src/utils.js';
 
 let CONFIG = {
   accountId: '1',
@@ -507,6 +508,17 @@ describe('S2S Adapter', function () {
       resetSyncedStatus();
     });
 
+    it('should set id to auction ID and source.tid to tid', function () {
+      config.setConfig({ s2sConfig: CONFIG });
+
+      adapter.callBids(OUTSTREAM_VIDEO_REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+
+      const requestBid = JSON.parse(server.requests[0].requestBody);
+      expect(requestBid.id).to.equal('173afb6d132ba3');
+      expect(requestBid.source).to.be.an('object');
+      expect(requestBid.source.tid).to.equal('437fbbf5-33f5-487a-8e16-a7112903cfe5');
+    });
+
     it('should block request if config did not define p1Consent URL in endpoint object config', function() {
       let badConfig = utils.deepClone(CONFIG);
       badConfig.endpoint = { noP1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' };
@@ -1081,6 +1093,18 @@ describe('S2S Adapter', function () {
       });
     });
 
+    it('should not include ext.aspectratios if adunit\'s aspect_ratios do not define radio_width and ratio_height', () => {
+      const req = deepClone(REQUEST);
+      req.ad_units[0].mediaTypes.native.icon.aspect_ratios[0] = {'min_width': 1, 'min_height': 2};
+      adapter.callBids(req, BID_REQUESTS, addBidResponse, done, ajax);
+      const nativeReq = JSON.parse(JSON.parse(server.requests[0].requestBody).imp[0].native.request);
+      const icons = nativeReq.assets.map((a) => a.img).filter((img) => img && img.type === 1);
+      expect(icons).to.have.length(1);
+      expect(icons[0].hmin).to.equal(2);
+      expect(icons[0].wmin).to.equal(1);
+      expect(deepAccess(icons[0], 'ext.aspectratios')).to.be.undefined;
+    })
+
     it('adds site if app is not present', function () {
       const _config = {
         s2sConfig: CONFIG,
@@ -1705,7 +1729,7 @@ describe('S2S Adapter', function () {
       expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({name: 'pbjs', version: 'v$prebid.version$'});
     });
 
-    it('does not set pbjs version in request if channel does exist in s2sConfig', () => {
+    it('extPrebid is now mergedDeep -> should include default channel as well', () => {
       const s2sBidRequest = utils.deepClone(REQUEST);
       const bidRequests = utils.deepClone(BID_REQUESTS);
 
@@ -1714,7 +1738,13 @@ describe('S2S Adapter', function () {
       adapter.callBids(s2sBidRequest, bidRequests, addBidResponse, done, ajax);
 
       const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
-      expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({test: 1});
+
+      // extPrebid is now deep merged with
+      expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({
+        name: 'pbjs',
+        test: 1,
+        version: 'v$prebid.version$'
+      });
     });
 
     it('passes first party data in request', () => {
@@ -2403,6 +2433,36 @@ describe('S2S Adapter', function () {
 
       utils.getBidRequest.restore();
     });
+
+    describe('on sync requested with no cookie', () => {
+      let cfg, req, csRes;
+
+      beforeEach(() => {
+        cfg = utils.deepClone(CONFIG);
+        req = utils.deepClone(REQUEST);
+        cfg.syncEndpoint = { p1Consent: 'https://prebid.adnxs.com/pbs/v1/cookie_sync' };
+        req.s2sConfig = cfg;
+        config.setConfig({ s2sConfig: cfg });
+        csRes = utils.deepClone(RESPONSE_NO_COOKIE);
+      });
+
+      afterEach(() => {
+        resetSyncedStatus();
+      })
+
+      Object.entries({
+        iframe: () => utils.insertUserSyncIframe,
+        image: () => utils.triggerPixel,
+      }).forEach(([type, syncer]) => {
+        it(`passes timeout to ${type} syncs`, () => {
+          cfg.syncTimeout = 123;
+          csRes.bidder_status[0].usersync.type = type;
+          adapter.callBids(req, BID_REQUESTS, addBidResponse, done, ajax);
+          server.requests[0].respond(200, {}, JSON.stringify(csRes));
+          expect(syncer().args[0]).to.include.members([123]);
+        });
+      });
+    });
   });
 
   describe('bid won events', function () {

package/test/spec/modules/pubgeniusBidAdapter_spec.js

@@ -173,7 +173,7 @@ describe('pubGENIUS adapter', () => {
 
       expectedRequest = {
         method: 'POST',
-        url: 'https://ortb.adpearl.io/prebid/auction',
+        url: 'https://auction.adpearl.io/prebid/auction',
         data: {
           id: 'fake-auction-id',
           imp: [
@@ -493,7 +493,7 @@ describe('pubGENIUS adapter', () => {
       };
       expectedSync = {
         type: 'iframe',
-        url: 'https://ortb.adpearl.io/usersync/pixels.html?',
+        url: 'https://auction.adpearl.io/usersync/pixels.html?',
       };
     });
 
@@ -551,7 +551,7 @@ describe('pubGENIUS adapter', () => {
       onTimeout(timeoutData);
 
       expect(server.requests[0].method).to.equal('POST');
-      expect(server.requests[0].url).to.equal('https://ortb.adpearl.io/prebid/events?type=timeout');
+      expect(server.requests[0].url).to.equal('https://auction.adpearl.io/prebid/events?type=timeout');
       expect(JSON.parse(server.requests[0].requestBody)).to.deep.equal(timeoutData);
     });
   });

package/test/spec/modules/pubmaticBidAdapter_spec.js

@@ -3457,7 +3457,7 @@ describe('PubMatic adapter', function () {
                 'h': 0,
                 'dealId': 'ASEA-MS-KLY-TTD-DESKTOP-ID-VID-6S-030420',
                 'ext': {
-                  'BidType': 1
+                  'bidtype': 1
                 }
               }],
               'ext': {

package/test/spec/modules/pubxaiAnalyticsAdapter_spec.js

@@ -28,6 +28,7 @@ describe('pubxai analytics adapter', function() {
     };
 
     let location = utils.getWindowLocation();
+    let storage = window.top['sessionStorage'];
 
     let prebidEvent = {
       'auctionInit': {
@@ -514,6 +515,11 @@ describe('pubxai analytics adapter', function() {
         'path': location.pathname,
         'search': location.search
       },
+      'pmcDetail': {
+        'bidDensity': storage.getItem('pbx:dpbid'),
+        'maxBid': storage.getItem('pbx:mxbid'),
+        'auctionId': storage.getItem('pbx:aucid')
+      }
     };
 
     let expectedAfterBid = {
@@ -577,6 +583,11 @@ describe('pubxai analytics adapter', function() {
         'deviceOS': getOS(),
         'browser': getBrowser()
       },
+      'pmcDetail': {
+        'bidDensity': storage.getItem('pbx:dpbid'),
+        'maxBid': storage.getItem('pbx:mxbid'),
+        'auctionId': storage.getItem('pbx:aucid')
+      },
       'initOptions': initOptions
     };
 

package/test/spec/modules/realTimeDataModule_spec.js

@@ -1,6 +1,8 @@
 import * as rtdModule from 'modules/rtdModule/index.js';
-import { config } from 'src/config.js';
+import {config} from 'src/config.js';
 import * as sinon from 'sinon';
+import {default as CONSTANTS} from '../../../src/constants.json';
+import {default as events} from '../../../src/events.js';
 
 const getBidRequestDataSpy = sinon.spy();
 
@@ -58,33 +60,87 @@ const conf = {
 };
 
 describe('Real time module', function () {
-  before(function () {
-    rtdModule.attachRealTimeDataProvider(validSM);
-    rtdModule.attachRealTimeDataProvider(invalidSM);
-    rtdModule.attachRealTimeDataProvider(failureSM);
-    rtdModule.attachRealTimeDataProvider(nonConfSM);
-    rtdModule.attachRealTimeDataProvider(validSMWait);
-  });
+  let eventHandlers;
+  let sandbox;
 
-  after(function () {
-    config.resetConfig();
-  });
+  function mockEmitEvent(event, ...args) {
+    (eventHandlers[event] || []).forEach((h) => h(...args));
+  }
 
-  beforeEach(function () {
-    config.setConfig(conf);
+  before(() => {
+    eventHandlers = {};
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(events, 'on').callsFake((event, handler) => {
+      if (!eventHandlers.hasOwnProperty(event)) {
+        eventHandlers[event] = [];
+      }
+      eventHandlers[event].push(handler);
+    });
   });
 
-  it('should use only valid modules', function () {
-    rtdModule.init(config);
-    expect(rtdModule.subModules).to.eql([validSMWait, validSM]);
+  after(() => {
+    sandbox.restore();
   });
 
-  it('should be able to modify bid request', function (done) {
-    rtdModule.setBidRequestsData(() => {
-      assert(getBidRequestDataSpy.calledTwice);
-      assert(getBidRequestDataSpy.calledWith({bidRequest: {}}));
+  describe('', () => {
+    const PROVIDERS = [validSM, invalidSM, failureSM, nonConfSM, validSMWait];
+    let _detachers;
+
+    beforeEach(function () {
+      _detachers = PROVIDERS.map(rtdModule.attachRealTimeDataProvider);
+      rtdModule.init(config);
+      config.setConfig(conf);
+    });
+
+    afterEach(function () {
+      _detachers.forEach((f) => f());
+      config.resetConfig();
+    });
+
+    it('should use only valid modules', function () {
+      expect(rtdModule.subModules).to.eql([validSMWait, validSM]);
+    });
+
+    it('should be able to modify bid request', function (done) {
+      rtdModule.setBidRequestsData(() => {
+        assert(getBidRequestDataSpy.calledTwice);
+        assert(getBidRequestDataSpy.calledWith({bidRequest: {}}));
+        done();
+      }, {bidRequest: {}})
+    });
+
+    it('sould place targeting on adUnits', function (done) {
+      const auction = {
+        adUnitCodes: ['ad1', 'ad2'],
+        adUnits: [
+          {
+            code: 'ad1'
+          },
+          {
+            code: 'ad2',
+            adserverTargeting: {preKey: 'preValue'}
+          }
+        ]
+      };
+
+      const expectedAdUnits = [
+        {
+          code: 'ad1',
+          adserverTargeting: {key: 'validSMWait'}
+        },
+        {
+          code: 'ad2',
+          adserverTargeting: {
+            preKey: 'preValue',
+            key: 'validSM'
+          }
+        }
+      ];
+
+      const adUnits = rtdModule.getAdUnitTargeting(auction);
+      assert.deepEqual(expectedAdUnits, adUnits)
       done();
-    }, {bidRequest: {}})
+    })
   });
 
   it('deep merge object', function () {
@@ -125,36 +181,66 @@ describe('Real time module', function () {
     assert.deepEqual(expected, merged);
   });
 
-  it('sould place targeting on adUnits', function (done) {
-    const auction = {
-      adUnitCodes: ['ad1', 'ad2'],
-      adUnits: [
-        {
-          code: 'ad1'
-        },
-        {
-          code: 'ad2',
-          adserverTargeting: {preKey: 'preValue'}
-        }
-      ]
+  describe('event', () => {
+    const EVENTS = {
+      [CONSTANTS.EVENTS.AUCTION_INIT]: 'onAuctionInitEvent',
+      [CONSTANTS.EVENTS.AUCTION_END]: 'onAuctionEndEvent',
+      [CONSTANTS.EVENTS.BID_RESPONSE]: 'onBidResponseEvent',
+      [CONSTANTS.EVENTS.BID_REQUESTED]: 'onBidRequestEvent'
+    }
+    const conf = {
+      'realTimeData': {
+        dataProviders: [
+          {
+            'name': 'tp1',
+          },
+          {
+            'name': 'tp2'
+          }
+        ]
+      }
     };
+    let providers;
+    let _detachers;
 
-    const expectedAdUnits = [
-      {
-        code: 'ad1',
-        adserverTargeting: {key: 'validSMWait'}
-      },
-      {
-        code: 'ad2',
-        adserverTargeting: {
-          preKey: 'preValue',
-          key: 'validSM'
-        }
+    function eventHandlingProvider(name) {
+      const provider = {
+        name: name,
+        init: () => true
       }
-    ];
-
-    const adUnits = rtdModule.getAdUnitTargeting(auction);
-    assert.deepEqual(expectedAdUnits, adUnits)
-    done();
+      Object.values(EVENTS).forEach((ev) => provider[ev] = sinon.spy());
+      return provider;
+    }
+
+    beforeEach(() => {
+      providers = [eventHandlingProvider('tp1'), eventHandlingProvider('tp2')];
+      _detachers = providers.map(rtdModule.attachRealTimeDataProvider);
+      rtdModule.init(config);
+      config.setConfig(conf);
+    });
+
+    afterEach(() => {
+      _detachers.forEach((d) => d())
+      config.resetConfig();
+    })
+
+    Object.entries(EVENTS).forEach(([event, hook]) => {
+      it(`'${event}' should be propagated to providers through '${hook}'`, () => {
+        const eventArg = {};
+        mockEmitEvent(event, eventArg);
+        providers.forEach((provider) => {
+          const providerConf = conf.realTimeData.dataProviders.find((cfg) => cfg.name === provider.name);
+          expect(provider[hook].called).to.be.true;
+          expect(provider[hook].args).to.have.length(1);
+          expect(provider[hook].args[0]).to.include.members([eventArg, providerConf])
+        })
+      });
+
+      it(`${event} should not fail to propagate elsewhere if a provider throws in its event handler`, () => {
+        providers[0][hook] = function () { throw new Error() };
+        mockEmitEvent(event);
+        expect(providers[1][hook].called).to.be.true;
+      });
+    });
   })
 });