prebid.js 7.6.0 → 7.7.0

package/test/spec/modules/consumableBidAdapter_spec.js

@@ -33,6 +33,22 @@ const BIDDER_REQUEST_1 = {
       transactionId: '92489f71-1bf2-49a0-adf9-000cea934729'
     }
   ],
+  schain: {
+    'ver': '1.0',
+    'complete': 1,
+    'nodes': [
+      {
+        'asi': 'indirectseller.com',
+        'sid': '00001',
+        'hp': 1
+      },
+      {
+        'asi': 'indirectseller-2.com',
+        'sid': '00002',
+        'hp': 2
+      },
+    ]
+  },
   gdprConsent: {
     consentString: 'consent-test',
     gdprApplies: false
@@ -335,7 +351,37 @@ describe('Consumable BidAdapter', function () {
       let request = spec.buildRequests(BIDDER_REQUEST_1.bidRequest, BIDDER_REQUEST_1);
 
       expect(request.bidderRequest).to.equal(BIDDER_REQUEST_1);
-    })
+    });
+
+    it('should contain schain if it exists in the bidRequest', function () {
+      let request = spec.buildRequests(BIDDER_REQUEST_1.bidRequest, BIDDER_REQUEST_1);
+      let data = JSON.parse(request.data);
+
+      expect(data.schain).to.deep.equal(BIDDER_REQUEST_1.schain)
+    });
+
+    it('should not contain schain if it does not exist in the bidRequest', function () {
+      let request = spec.buildRequests(BIDDER_REQUEST_2.bidRequest, BIDDER_REQUEST_2);
+      let data = JSON.parse(request.data);
+
+      expect(data.schain).to.be.undefined;
+    });
+
+    it('should contain coppa if configured', function () {
+      config.setConfig({ coppa: true });
+      let request = spec.buildRequests(BIDDER_REQUEST_1.bidRequest, BIDDER_REQUEST_1);
+      let data = JSON.parse(request.data);
+
+      expect(data.coppa).to.be.true;
+    });
+
+    it('should not contain coppa if not configured', function () {
+      config.setConfig({ coppa: false });
+      let request = spec.buildRequests(BIDDER_REQUEST_1.bidRequest, BIDDER_REQUEST_1);
+      let data = JSON.parse(request.data);
+
+      expect(data.coppa).to.be.undefined;
+    });
   });
   describe('interpretResponse validation', function () {
     it('response should have valid bidderCode', function () {

package/test/spec/modules/idxIdSystem_spec.js

@@ -94,8 +94,8 @@ describe('IDx ID System', () => {
       adUnits = [getAdUnitMock()];
       init(config);
       setSubmoduleRegistry([idxIdSubmodule]);
-      config.setConfig(getConfigMock());
       getCookieStub.withArgs(IDX_COOKIE_NAME).returns(IDX_COOKIE_STORED);
+      config.setConfig(getConfigMock());
     });
 
     afterEach(() => {

package/test/spec/modules/ixBidAdapter_spec.js

@@ -290,6 +290,7 @@ describe('IndexexchangeAdapter', function () {
     {
       bidder: 'ix',
       params: {
+        tagId: '123',
         siteId: '123',
         size: [300, 250],
       },
@@ -304,7 +305,10 @@ describe('IndexexchangeAdapter', function () {
       },
       ortb2Imp: {
         ext: {
-          tid: '173f49a8-7549-4218-a23c-e7ba59b47230'
+          tid: '173f49a8-7549-4218-a23c-e7ba59b47230',
+          data: {
+            pbadslot: 'div-gpt-ad-1460505748562-0'
+          }
         }
       },
       adUnitCode: 'div-gpt-ad-1460505748562-0',
@@ -320,6 +324,7 @@ describe('IndexexchangeAdapter', function () {
     {
       bidder: 'ix',
       params: {
+        tagId: '123',
         siteId: '456',
         video: {
           skippable: false,
@@ -344,7 +349,10 @@ describe('IndexexchangeAdapter', function () {
       },
       ortb2Imp: {
         ext: {
-          tid: '173f49a8-7549-4218-a23c-e7ba59b47230'
+          tid: '173f49a8-7549-4218-a23c-e7ba59b47230',
+          data: {
+            pbadslot: 'div-gpt-ad-1460505748562-0'
+          }
         }
       },
       adUnitCode: 'div-gpt-ad-1460505748562-0',
@@ -1649,6 +1657,70 @@ describe('IndexexchangeAdapter', function () {
       expect(gpid).to.equal(GPID);
     });
 
+    it('should still build gpid in request if ortb2Imp.ext.gpid does not exist', function () {
+      const AD_UNIT_CODE = '/1111/home';
+      const validBids = utils.deepClone(DEFAULT_BANNER_VALID_BID);
+      sinon.stub(utils, 'getGptSlotInfoForAdUnitCode')
+        .returns({ gptSlot: AD_UNIT_CODE, divId: 'adunit-code-3-div-id' });
+      validBids[0].ortb2Imp = {
+        ext: {
+          data: {
+            adserver: {
+              name: 'gam',
+              adslot: AD_UNIT_CODE
+            }
+          }
+        }
+      }
+      const requests = spec.buildRequests(validBids, DEFAULT_OPTION);
+      const { ext: { gpid } } = JSON.parse(requests[0].data.r).imp[0];
+      utils.getGptSlotInfoForAdUnitCode.restore();
+      expect(gpid).to.equal(`${AD_UNIT_CODE}#adunit-code-3-div-id`);
+    });
+
+    it('should not build gpid if divid doesnt exist when ortb2Imp.ext.gpid does not exist', function () {
+      const AD_UNIT_CODE = '/1111/home';
+      const validBids = utils.deepClone(DEFAULT_BANNER_VALID_BID);
+      sinon.stub(utils, 'getGptSlotInfoForAdUnitCode')
+        .returns({ gptSlot: AD_UNIT_CODE });
+      validBids[0].ortb2Imp = {
+        ext: {
+          data: {
+            adserver: {
+              name: 'gam',
+              adslot: AD_UNIT_CODE
+            }
+          }
+        }
+      }
+      const requests = spec.buildRequests(validBids, DEFAULT_OPTION);
+      const imp = JSON.parse(requests[0].data.r).imp[0];
+      utils.getGptSlotInfoForAdUnitCode.restore();
+      expect(imp.ext.gpid).to.be.undefined;
+      expect(imp.ext.dfp_ad_unit_code).to.equal(AD_UNIT_CODE)
+    });
+
+    it('should not build gpid if dfp ad unit code / divid doesnt exist when ortb2Imp.ext.gpid does not exist', function () {
+      const AD_UNIT_CODE = '/1111/home';
+      const validBids = utils.deepClone(DEFAULT_BANNER_VALID_BID);
+      sinon.stub(utils, 'getGptSlotInfoForAdUnitCode')
+        .returns({});
+      validBids[0].ortb2Imp = {
+        ext: {
+          data: {
+            adserver: {
+              name: 'gam',
+            }
+          }
+        }
+      }
+      const requests = spec.buildRequests(validBids, DEFAULT_OPTION);
+
+      const imp = JSON.parse(requests[0].data.r).imp[0];
+      utils.getGptSlotInfoForAdUnitCode.restore();
+      expect(imp.ext).to.be.undefined;
+    });
+
     it('should send gpid in request if ortb2Imp.ext.gpid exists when no size present', function () {
       const validBids = utils.deepClone(DEFAULT_BANNER_VALID_BID_PARAM_NO_SIZE);
       validBids[0].ortb2Imp = {
@@ -2614,6 +2686,9 @@ describe('IndexexchangeAdapter', function () {
         expect(diagObj.allu).to.equal(2);
         expect(diagObj.version).to.equal('$prebid.version$');
         expect(diagObj.url).to.equal('http://localhost:9876/context.html')
+        expect(diagObj.pbadslot).to.equal(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0].ortb2Imp.ext.data.pbadslot)
+        expect(diagObj.tagid).to.equal(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0].params.tagId)
+        expect(diagObj.adunitcode).to.equal(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0].adUnitCode)
       });
     });
   });

package/test/spec/modules/jixieBidAdapter_spec.js

@@ -199,16 +199,16 @@ describe('jixie Adapter', function () {
       let getCookieStub = sinon.stub(storage, 'getCookie');
       let getLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage');
       getCookieStub
-        .withArgs('_jx')
+        .withArgs('_jxx')
         .returns(clientIdTest1_);
       getCookieStub
-        .withArgs('_jxs')
+        .withArgs('_jxxs')
         .returns(sessionIdTest1_);
       getLocalStorageStub
-        .withArgs('_jx')
+        .withArgs('_jxx')
         .returns(clientIdTest1_);
       getLocalStorageStub
-        .withArgs('_jxs')
+        .withArgs('_jxxs')
         .returns(sessionIdTest1_
         );
       let miscDimsStub = sinon.stub(jixieaux, 'getMiscDims');
@@ -528,10 +528,10 @@ describe('jixie Adapter', function () {
       let setCookieSpy = sinon.spy(storage, 'setCookie');
       let setLocalStorageSpy = sinon.spy(storage, 'setDataInLocalStorage');
       const result = spec.interpretResponse({body: responseBody_}, requestObj_)
-      expect(setLocalStorageSpy.calledWith('_jx', '43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
-      expect(setLocalStorageSpy.calledWith('_jxs', '1600057934-43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
-      expect(setCookieSpy.calledWith('_jxs', '1600057934-43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
-      expect(setCookieSpy.calledWith('_jx', '43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
+      expect(setLocalStorageSpy.calledWith('_jxx', '43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
+      expect(setLocalStorageSpy.calledWith('_jxxs', '1600057934-43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
+      expect(setCookieSpy.calledWith('_jxxs', '1600057934-43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
+      expect(setCookieSpy.calledWith('_jxx', '43aacc10-f643-11ea-8a10-c5fe2d394e7e')).to.equal(true);
 
       // video ad with vastUrl returned by adserver
       expect(result[0].requestId).to.equal('62847e4c696edcb')

package/test/spec/modules/onetagBidAdapter_spec.js

@@ -1,4 +1,4 @@
-import { spec, isValid, hasTypeVideo } from 'modules/onetagBidAdapter.js';
+import { spec, isValid, hasTypeVideo, isSchainValid } from 'modules/onetagBidAdapter.js';
 import { expect } from 'chai';
 import {find} from 'src/polyfill.js';
 import { BANNER, VIDEO } from 'src/mediaTypes.js';
@@ -15,7 +15,21 @@ describe('onetag', function () {
       'bidId': '30b31c1838de1e',
       'bidderRequestId': '22edbae2733bf6',
       'auctionId': '1d1a030790a475',
-      'transactionId': 'qwerty123'
+      'transactionId': 'qwerty123',
+      'schain': {
+        'validation': 'off',
+        'config': {
+          'ver': '1.0',
+          'complete': 1,
+          'nodes': [
+            {
+              'asi': 'indirectseller.com',
+              'sid': '00001',
+              'hp': 1
+            }
+          ]
+        }
+      },
     };
   }
 
@@ -193,7 +207,8 @@ describe('onetag', function () {
               'context',
               'playerSize',
               'mediaTypeInfo',
-              'type'
+              'type',
+              'priceFloors'
             );
           } else if (isValid(BANNER, bid)) {
             expect(bid).to.have.all.keys(
@@ -205,9 +220,13 @@ describe('onetag', function () {
               'transactionId',
               'mediaTypeInfo',
               'sizes',
-              'type'
+              'type',
+              'priceFloors'
             );
           }
+          if (bid.schain && isSchainValid(bid.schain)) {
+            expect(data).to.have.all.keys('schain');
+          }
           expect(bid.bidId).to.be.a('string');
           expect(bid.pubId).to.be.a('string');
         }
@@ -358,6 +377,36 @@ describe('onetag', function () {
       expect(syncs[0].url).to.match(/(?:[?&](?:us_privacy=us_foo(?:[&][^&]*)*))+$/);
     });
   });
+  describe('isSchainValid', function () {
+    it('Should return false when schain is null or undefined', function () {
+      expect(isSchainValid(null)).to.be.false;
+      expect(isSchainValid(undefined)).to.be.false;
+    });
+    it('Should return false when schain is missing nodes key', function () {
+      const schain = {'otherKey': 'otherValue'};
+      expect(isSchainValid(schain)).to.be.false;
+    });
+    it('Should return false when schain is missing one of the required SupplyChainNode attribute', function () {
+      const missingAsiNode = {'sid': '00001', 'hp': 1};
+      const missingSidNode = {'asi': 'indirectseller.com', 'hp': 1};
+      const missingHpNode = {'asi': 'indirectseller.com', 'sid': '00001'};
+      expect(isSchainValid({'config': {'nodes': [missingAsiNode]}})).to.be.false;
+      expect(isSchainValid({'config': {'nodes': [missingSidNode]}})).to.be.false;
+      expect(isSchainValid({'config': {'nodes': [missingHpNode]}})).to.be.false;
+    });
+    it('Should return true when schain contains all required attributes', function () {
+      const validSchain = {
+        'nodes': [
+          {
+            'asi': 'indirectseller.com',
+            'sid': '00001',
+            'hp': 1
+          }
+        ]
+      };
+      expect(isSchainValid(validSchain)).to.be.true;
+    })
+  });
 });
 
 function getBannerVideoResponse() {

package/test/spec/modules/parrableIdSystem_spec.js

@@ -655,7 +655,6 @@ describe('Parrable ID System', function() {
       writeParrableCookie({ eid: P_COOKIE_EID, ibaOptout: true });
       init(config);
       setSubmoduleRegistry([parrableIdSubmodule]);
-      config.setConfig(getConfigMock());
     });
 
     afterEach(function() {
@@ -665,6 +664,7 @@ describe('Parrable ID System', function() {
     });
 
     it('when a stored Parrable ID exists it is added to bids', function(done) {
+      config.setConfig(getConfigMock());
       requestBidsHook(function() {
         adUnits.forEach(unit => {
           unit.bids.forEach(bid => {
@@ -691,6 +691,7 @@ describe('Parrable ID System', function() {
     it('supplies an optout reason when the EID is missing due to CCPA non-consent', function(done) {
       // the ID system itself will not write a cookie with an EID when CCPA=true
       writeParrableCookie({ ccpaOptout: true });
+      config.setConfig(getConfigMock());
 
       requestBidsHook(function() {
         adUnits.forEach(unit => {

package/test/spec/modules/prebidServerBidAdapter_spec.js

@@ -2692,6 +2692,26 @@ describe('S2S Adapter', function () {
       sinon.assert.match(actual.imp[0], sinon.match(ortb2Imp));
     });
 
+    it('setting adapterCode for default bidder', function () {
+      config.setConfig({ CONFIG });
+      adapter.callBids(REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+      server.requests[0].respond(200, {}, JSON.stringify(RESPONSE_OPENRTB));
+
+      const response = addBidResponse.firstCall.args[1];
+      expect(response).to.have.property('adapterCode', 'appnexus');
+    });
+
+    it('setting adapterCode for alternate bidder', function () {
+      config.setConfig({ CONFIG });
+      let RESPONSE_OPENRTB2 = deepClone(RESPONSE_OPENRTB);
+      RESPONSE_OPENRTB2.seatbid[0].bid[0].ext.prebid.meta.adaptercode = 'appnexus2'
+      adapter.callBids(REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+      server.requests[0].respond(200, {}, JSON.stringify(RESPONSE_OPENRTB2));
+
+      const response = addBidResponse.firstCall.args[1];
+      expect(response).to.have.property('adapterCode', 'appnexus2');
+    });
+
     describe('on sync requested with no cookie', () => {
       let cfg, req, csRes;
 

package/test/spec/modules/rubiconBidAdapter_spec.js

@@ -2139,6 +2139,33 @@ describe('the rubicon adapter', function () {
           expect(request.data.imp[0].ext.data.pbadslot).to.equal('1234567890');
         });
 
+        it('should NOT include storedrequests in pbs payload', function () {
+          createVideoBidderRequest();
+          bidderRequest.bids[0].ortb2 = {
+            ext: {
+              prebid: {
+                storedrequest: 'no-send-top-level-sr'
+              }
+            }
+          }
+
+          bidderRequest.bids[0].ortb2Imp = {
+            ext: {
+              prebid: {
+                storedrequest: 'no-send-imp-sr'
+              }
+            }
+          }
+
+          sandbox.stub(Date, 'now').callsFake(() =>
+            bidderRequest.auctionStart + 100
+          );
+
+          const [request] = spec.buildRequests(bidderRequest.bids, bidderRequest);
+          expect(request.data.ext.prebid.storedrequest).to.be.undefined;
+          expect(request.data.imp[0].ext.prebid.storedrequest).to.be.undefined;
+        });
+
         it('should include GAM ad unit in bid request', function () {
           createVideoBidderRequest();
           bidderRequest.bids[0].ortb2Imp = {

package/test/spec/modules/targetVideoBidAdapter_spec.js

@@ -93,4 +93,47 @@ describe('TargetVideo Bid Adapter', function() {
     expect(bid.ad).to.include('<script src="https://player.target-video.com/custom/targetvideo-banner.js"></script>')
     expect(bid.ad).to.include('initPlayer')
   });
+
+  it('Test GDPR consent information is present in the request', function () {
+    let consentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
+    let bidderRequest = {
+      'bidderCode': 'targetVideo',
+      'auctionId': '1d1a030790a475',
+      'bidderRequestId': '22edbae2733bf6',
+      'timeout': 3000,
+      'gdprConsent': {
+        consentString: consentString,
+        gdprApplies: true,
+        addtlConsent: '1~7.12.35.62.66.70.89.93.108'
+      }
+    };
+    bidderRequest.bids = bannerRequest;
+
+    const request = spec.buildRequests(bannerRequest, bidderRequest);
+    expect(request.options).to.deep.equal({withCredentials: true});
+    const payload = JSON.parse(request.data);
+
+    expect(payload.gdpr_consent).to.exist;
+    expect(payload.gdpr_consent.consent_string).to.exist.and.to.equal(consentString);
+    expect(payload.gdpr_consent.consent_required).to.exist.and.to.be.true;
+    expect(payload.gdpr_consent.addtl_consent).to.exist.and.to.deep.equal([7, 12, 35, 62, 66, 70, 89, 93, 108]);
+  });
+
+  it('Test US Privacy string is present in the request', function() {
+    let consentString = '1YA-';
+    let bidderRequest = {
+      'bidderCode': 'targetVideo',
+      'auctionId': '1d1a030790a475',
+      'bidderRequestId': '22edbae2733bf6',
+      'timeout': 3000,
+      'uspConsent': consentString
+    };
+    bidderRequest.bids = bannerRequest;
+
+    const request = spec.buildRequests(bannerRequest, bidderRequest);
+    const payload = JSON.parse(request.data);
+
+    expect(payload.us_privacy).to.exist;
+    expect(payload.us_privacy).to.exist.and.to.equal(consentString);
+  });
 });

package/test/spec/modules/userId_spec.js

@@ -466,6 +466,7 @@ describe('User ID', function () {
     describe('refreshing before init is complete', () => {
       const MOCK_ID = {'MOCKID': '1111'};
       let mockIdCallback;
+      let startInit;
 
       beforeEach(() => {
         mockIdCallback = sinon.stub();
@@ -480,7 +481,7 @@ describe('User ID', function () {
         };
         init(config);
         setSubmoduleRegistry([mockIdSystem]);
-        config.setConfig({
+        startInit = () => config.setConfig({
           userSync: {
             auctionDelay: 10,
             userIds: [{
@@ -492,6 +493,7 @@ describe('User ID', function () {
       });
 
       it('should still resolve promises returned by getUserIdsAsync', () => {
+        startInit();
         let result = null;
         getGlobal().getUserIdsAsync().then((val) => { result = val; });
         return clearStack().then(() => {
@@ -506,6 +508,7 @@ describe('User ID', function () {
       it('should not stop auctions', (done) => {
         // simulate an infinite `auctionDelay`; refreshing should still allow the auction to continue
         // as soon as ID submodules have completed init
+        startInit();
         requestBidsHook(() => {
           done();
         }, {adUnits: [getAdUnitMock()]}, {delay: delay()});
@@ -519,6 +522,7 @@ describe('User ID', function () {
       it('should not get stuck when init fails', () => {
         const err = new Error();
         mockIdCallback.callsFake(() => { throw err; });
+        startInit();
         return getGlobal().getUserIdsAsync().catch((e) =>
           expect(e).to.equal(err)
         );
@@ -2531,7 +2535,6 @@ describe('User ID', function () {
 
         // init id system
         attachIdSystem(mockIdSystem);
-        config.setConfig(userIdConfig);
       });
 
       afterEach(function () {
@@ -2542,6 +2545,8 @@ describe('User ID', function () {
         coreStorage.setCookie(mockIdCookieName, JSON.stringify({id: '1234'}), expStr);
         coreStorage.setCookie(`${mockIdCookieName}_last`, (new Date(Date.now() - 1 * 1000).toUTCString()), expStr);
 
+        config.setConfig(userIdConfig);
+
         let innerAdUnits;
         return runBidsHook((config) => {
           innerAdUnits = config.adUnits
@@ -2556,6 +2561,8 @@ describe('User ID', function () {
         coreStorage.setCookie(mockIdCookieName, JSON.stringify({id: '1234'}), expStr);
         coreStorage.setCookie(`${mockIdCookieName}_last`, (new Date(Date.now() - 60 * 1000).toUTCString()), expStr);
 
+        config.setConfig(userIdConfig);
+
         let innerAdUnits;
         return runBidsHook((config) => {
           innerAdUnits = config.adUnits
@@ -2572,6 +2579,8 @@ describe('User ID', function () {
 
         setStoredConsentData();
 
+        config.setConfig(userIdConfig);
+
         let innerAdUnits;
         return runBidsHook((config) => {
           innerAdUnits = config.adUnits
@@ -2588,6 +2597,8 @@ describe('User ID', function () {
 
         setStoredConsentData({...consentData, consentString: 'different'});
 
+        config.setConfig(userIdConfig);
+
         let innerAdUnits;
         return runBidsHook((config) => {
           innerAdUnits = config.adUnits
@@ -2604,6 +2615,8 @@ describe('User ID', function () {
 
         setStoredConsentData({...consentData});
 
+        config.setConfig(userIdConfig);
+
         let innerAdUnits;
         return runBidsHook((config) => {
           innerAdUnits = config.adUnits

package/test/spec/unit/pbjs_api_spec.js

@@ -16,7 +16,6 @@ import * as auctionModule from 'src/auction.js';
 import { registerBidder } from 'src/adapters/bidderFactory.js';
 import { _sendAdToCreative } from 'src/secureCreatives.js';
 import {find} from 'src/polyfill.js';
-import {synchronizePromise} from '../../helpers/syncPromise.js';
 import * as pbjsModule from 'src/prebid.js';
 import {hook} from '../../../src/hook.js';
 import {reset as resetDebugging} from '../../../src/debugging.js';
@@ -195,7 +194,7 @@ window.apntag = {
 }
 
 describe('Unit: Prebid Module', function () {
-  let bidExpiryStub, promiseSandbox;
+  let bidExpiryStub
 
   before(() => {
     hook.ready();
@@ -204,15 +203,12 @@ describe('Unit: Prebid Module', function () {
   });
 
   beforeEach(function () {
-    promiseSandbox = sinon.createSandbox();
-    synchronizePromise(promiseSandbox);
     bidExpiryStub = sinon.stub(filters, 'isBidNotExpired').callsFake(() => true);
     configObj.setConfig({ useBidCache: true });
     resetAuctionState();
   });
 
   afterEach(function() {
-    promiseSandbox.restore();
     $$PREBID_GLOBAL$$.adUnits = [];
     bidExpiryStub.restore();
     configObj.setConfig({ useBidCache: false });