prebid.js 8.4.0 → 8.6.0

package/test/spec/modules/criteoBidAdapter_spec.js

@@ -9,11 +9,12 @@ import {
 } from 'modules/criteoBidAdapter.js';
 import * as utils from 'src/utils.js';
 import * as refererDetection from 'src/refererDetection.js';
+import * as ajax from 'src/ajax.js';
 import { config } from '../../../src/config.js';
 import { BANNER, NATIVE, VIDEO } from '../../../src/mediaTypes.js';
 
 describe('The Criteo bidding adapter', function () {
-  let utilsMock, sandbox;
+  let utilsMock, sandbox, ajaxStub;
 
   beforeEach(function () {
     $$PREBID_GLOBAL$$.bidderSettings = {
@@ -26,6 +27,7 @@ describe('The Criteo bidding adapter', function () {
     utilsMock = sinon.mock(utils);
 
     sandbox = sinon.sandbox.create();
+    ajaxStub = sandbox.stub(ajax, 'ajax');
   });
 
   afterEach(function () {
@@ -33,6 +35,7 @@ describe('The Criteo bidding adapter', function () {
     global.Criteo = undefined;
     utilsMock.restore();
     sandbox.restore();
+    ajaxStub.restore();
   });
 
   describe('getUserSyncs', function () {
@@ -56,7 +59,9 @@ describe('The Criteo bidding adapter', function () {
       cookiesAreEnabledStub,
       localStorageIsEnabledStub,
       getCookieStub,
-      getDataFromLocalStorageStub;
+      setCookieStub,
+      getDataFromLocalStorageStub,
+      removeDataFromLocalStorageStub;
 
     beforeEach(function () {
       getConfigStub = sinon.stub(config, 'getConfig');
@@ -75,8 +80,10 @@ describe('The Criteo bidding adapter', function () {
       localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
       localStorageIsEnabledStub.returns(true);
 
-      getCookieStub = sinon.stub(storage, 'getCookie')
+      getCookieStub = sinon.stub(storage, 'getCookie');
+      setCookieStub = sinon.stub(storage, 'setCookie');
       getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage');
+      removeDataFromLocalStorageStub = sinon.stub(storage, 'removeDataFromLocalStorage');
     });
 
     afterEach(function () {
@@ -86,7 +93,9 @@ describe('The Criteo bidding adapter', function () {
       cookiesAreEnabledStub.restore();
       localStorageIsEnabledStub.restore();
       getCookieStub.restore();
+      setCookieStub.restore();
       getDataFromLocalStorageStub.restore();
+      removeDataFromLocalStorageStub.restore();
     });
 
     it('should not trigger sync if publisher is using fast bid', function () {
@@ -198,6 +207,25 @@ describe('The Criteo bidding adapter', function () {
         url: `https://gum.criteo.com/syncframe?origin=criteoPrebidAdapter&topUrl=www.abc.com&us_privacy=ABC#${JSON.stringify(expectedHash).replace(/"/g, '%22')}`
       }]);
     });
+
+    it('should delete user data when calling onDataDeletionRequest', () => {
+      const cookieData = {
+        'cto_bundle': 'a'
+      };
+      const lsData = {
+        'cto_bundle': 'a'
+      }
+      getCookieStub.callsFake(cookieName => cookieData[cookieName]);
+      setCookieStub.callsFake((cookieName, value, expires) => cookieData[cookieName] = value);
+      removeDataFromLocalStorageStub.callsFake(name => lsData[name] = '');
+      spec.onDataDeletionRequest([]);
+      expect(getCookieStub.calledOnce).to.equal(true);
+      expect(setCookieStub.calledOnce).to.equal(true);
+      expect(removeDataFromLocalStorageStub.calledOnce).to.equal(true);
+      expect(cookieData.cto_bundle).to.equal('');
+      expect(lsData.cto_bundle).to.equal('');
+      expect(ajaxStub.calledOnce).to.equal(true);
+    });
   });
 
   describe('isBidRequestValid', function () {

package/test/spec/modules/cwireBidAdapter_spec.js

@@ -293,4 +293,51 @@ describe('C-WIRE bid adapter', () => {
       expect(bids[0].ad).to.exist;
     })
   });
+
+  describe('add user-syncs', function () {
+    it('empty user-syncs if no consent given', function () {
+      const userSyncs = spec.getUserSyncs({}, {}, {}, {});
+
+      expect(userSyncs).to.be.empty
+    })
+    it('empty user-syncs if no syncOption enabled', function () {
+      let gdprConsent = {
+        vendorData: {
+          purpose: {
+            consents: 1
+          }
+        }};
+      const userSyncs = spec.getUserSyncs({}, {}, gdprConsent, {});
+
+      expect(userSyncs).to.be.empty
+    })
+
+    it('user-syncs with enabled pixel option', function () {
+      let gdprConsent = {
+        vendorData: {
+          purpose: {
+            consents: 1
+          }
+        }};
+      let synOptions = {pixelEnabled: true, iframeEnabled: true};
+      const userSyncs = spec.getUserSyncs(synOptions, {}, gdprConsent, {});
+
+      expect(userSyncs[0].type).to.equal('image');
+      expect(userSyncs[0].url).to.equal('https://ib.adnxs.com/getuid?https://prebid.cwi.re/v1/cookiesync?xandrId=$UID');
+    })
+
+    it('user-syncs with enabled iframe option', function () {
+      let gdprConsent = {
+        vendorData: {
+          purpose: {
+            consents: 1
+          }
+        }};
+      let synOptions = {iframeEnabled: true};
+      const userSyncs = spec.getUserSyncs(synOptions, {}, gdprConsent, {});
+
+      expect(userSyncs[0].type).to.equal('iframe');
+      expect(userSyncs[0].url).to.equal('https://ib.adnxs.com/getuid?https://prebid.cwi.re/v1/cookiesync?xandrId=$UID');
+    })
+  })
 });

package/test/spec/modules/freewheel-sspBidAdapter_spec.js

@@ -135,11 +135,11 @@ describe('freewheelSSP BidAdapter Test', () => {
 
     it('should pass 3rd party IDs with the request when present', function () {
       const bidRequest = bidRequests[0];
-      bidRequest.userIdAsEids = createEidsArray({
-        tdid: 'TTD_ID_FROM_USER_ID_MODULE',
-        admixerId: 'admixerId_FROM_USER_ID_MODULE',
-        adtelligentId: 'adtelligentId_FROM_USER_ID_MODULE'
-      });
+      bidRequest.userIdAsEids = [
+        {source: 'adserver.org', uids: [{id: 'TTD_ID_FROM_USER_ID_MODULE', atype: 1, ext: {rtiPartner: 'TDID'}}]},
+        {source: 'admixer.net', uids: [{id: 'admixerId_FROM_USER_ID_MODULE', atype: 3}]},
+        {source: 'adtelligent.com', uids: [{id: 'adtelligentId_FROM_USER_ID_MODULE', atype: 3}]},
+      ];
       const request = spec.buildRequests(bidRequests);
       const payload = request[0].data;
       expect(payload._fw_prebid_3p_UID).to.deep.equal(JSON.stringify([

package/test/spec/modules/geolocationRtdProvider_spec.js

@@ -0,0 +1,119 @@
+import {config as _config, config} from 'src/config.js';
+import { expect } from 'chai';
+import * as events from 'src/events.js';
+import * as prebidGlobal from 'src/prebidGlobal.js';
+import { geolocationSubmodule } from 'modules/geolocationRtdProvider.js';
+import * as utils from 'src/utils.js';
+import {getGlobal} from 'src/prebidGlobal.js';
+import 'src/prebid.js';
+
+describe('Geolocation RTD Provider', function () {
+  let sandbox;
+  let placeholder;
+  const pbjs = getGlobal();
+  const adUnit = {
+    code: 'ad-slot-1',
+    mediaTypes: {
+      banner: {
+        sizes: [ [300, 250] ]
+      }
+    },
+    bids: [
+      {
+        bidder: 'fake'
+      }
+    ]
+  };
+  const providerConfig = {name: 'geolocation', waitForIt: true};
+  const rtdConfig = {realTimeData: {auctionDelay: 200, dataProviders: [providerConfig]}}
+  describe('Geolocation not supported', function() {
+    beforeEach(function() {
+      sandbox = sinon.sandbox.create();
+    });
+    afterEach(function() {
+      sandbox.restore();
+      sandbox = undefined;
+    });
+    it('init should return false', function () {
+      if (navigator.permissions) { sandbox.stub(navigator.permissions, 'query').value(undefined); expect(geolocationSubmodule.init({})).is.false; }
+    });
+  });
+  describe('Geolocation supported', function() {
+    beforeEach(function() {
+      sandbox = sinon.sandbox.create();
+      // placeholder = createDiv();
+      // append();
+      const __config = {};
+      sandbox.stub(_config, 'getConfig').callsFake(function (path) {
+        return utils.deepAccess(__config, path);
+      });
+      sandbox.stub(_config, 'setConfig').callsFake(function (obj) {
+        utils.mergeDeep(__config, obj);
+      });
+    });
+    afterEach(function() {
+      sandbox.restore();
+      // remove();
+      sandbox = undefined;
+      placeholder = undefined;
+      pbjs.removeAdUnit();
+    });
+    it('init should return true', function () {
+      navigator.permissions && expect(geolocationSubmodule.init({})).is.true;
+    });
+    it('should set geolocation. (request all)', function(done) {
+      navigator.permissions && sandbox.stub(navigator.permissions, 'query').value(() => Promise.resolve({
+        state: 'granted',
+      }));
+      navigator.geolocation && sandbox.stub(navigator.geolocation, 'getCurrentPosition').value((cb) => {
+        // eslint-disable-next-line standard/no-callback-literal
+        cb({coords: {latitude: 1, longitude: 1}});
+      });
+      pbjs.addAdUnits([utils.deepClone(adUnit)]);
+      config.setConfig(rtdConfig);
+      const onDone = sandbox.stub();
+      const requestBidObject = {};
+      geolocationSubmodule.init({});
+      geolocationSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        providerConfig
+      );
+      expect(pbjs.adUnits.length).to.eq(1);
+      setTimeout(function() {
+        // expect(requestBidObject?.ortb2Fragments?.global.device.geo?.type).to.eq(1);
+        done();
+      }, 300);
+    });
+    it('should call done due timeout', function(done) {
+      // sandbox.stub(navigator.permissions, 'query').value(() => new Promise(() => {}));
+      // sandbox.stub(navigator.geolocation, 'getCurrentPosition').value((cb) => {});
+      config.setConfig(rtdConfig);
+      // remove();
+      const onDone = sandbox.stub();
+      const requestBidObject = {adUnits: [utils.deepClone(adUnit)]};
+      geolocationSubmodule.init({});
+      geolocationSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        {...providerConfig, test: 1}
+      );
+      setTimeout(function() {
+        sinon.assert.calledOnce(onDone);
+        expect(requestBidObject).to.not.have.property('ortb2Fragments.global.device.geo');
+        done();
+      }, 300);
+    });
+  });
+  // function createDiv() {
+  //   const div = document.createElement('div');
+  //   div.id = adUnit.code;
+  //   return div;
+  // }
+  // function append() {
+  //   placeholder && document.body.appendChild(placeholder);
+  // }
+  // function remove() {
+  //   placeholder && placeholder.parentElement && placeholder.parentElement.removeChild(placeholder);
+  // }
+});

package/test/spec/modules/greenbidsRtdProvider_spec.js

@@ -18,7 +18,7 @@ describe('greenbidsRtdProvider', () => {
     server.restore();
   });
 
-  const endPoint = 'europe-west1-greenbids-357713.cloudfunctions.net';
+  const endPoint = 't.greenbids.ai';
 
   const SAMPLE_MODULE_CONFIG = {
     params: {

package/test/spec/modules/id5IdSystem_spec.js

@@ -407,6 +407,24 @@ describe('ID5 ID System', function () {
         })
     });
 
+    it('should call the ID5 server for config with partner id being a string', function () {
+      let xhrServerMock = new XhrServerMock(sinon.createFakeServer())
+      let id5FetchConfig = getId5FetchConfig();
+      id5FetchConfig.params.partner = '173';
+      let submoduleResponse = callSubmoduleGetId(id5FetchConfig, undefined, undefined);
+
+      return xhrServerMock.expectConfigRequest()
+        .then(configRequest => {
+          let requestBody = JSON.parse(configRequest.requestBody)
+          expect(requestBody.params.partner).is.eq(173)
+          return xhrServerMock.respondWithConfigAndExpectNext(configRequest)
+        })
+        .then(fetchRequest => {
+          fetchRequest.respond(200, responseHeader, JSON.stringify(ID5_JSON_RESPONSE));
+          return submoduleResponse
+        })
+    });
+
     it('should call the ID5 server for config with overridden url', function () {
       let xhrServerMock = new XhrServerMock(sinon.createFakeServer())
       let id5FetchConfig = getId5FetchConfig();

package/test/spec/modules/imdsBidAdapter_spec.js

@@ -192,12 +192,45 @@ describe('imdsBidAdapter ', function () {
       timeout: 3000
     };
 
-    let bidderRequestWithCCPA = {
+    let bidderRequestWithUSPInExt = {
       bidderRequestId: 'xyz123',
       refererInfo: {
         referer: 'https://test.com/foo/bar'
       },
-      uspConsent: '1YYY'
+      ortb2: {
+        regs: {
+          ext: {
+            us_privacy: '1YYY'
+          }
+        }
+      }
+    };
+
+    let bidderRequestWithUSPInRegs = {
+      bidderRequestId: 'xyz123',
+      refererInfo: {
+        referer: 'https://test.com/foo/bar'
+      },
+      ortb2: {
+        regs: {
+          us_privacy: '1YYY'
+        }
+      }
+    };
+
+    let bidderRequestWithUSPAndOthersInExt = {
+      bidderRequestId: 'xyz123',
+      refererInfo: {
+        referer: 'https://test.com/foo/bar'
+      },
+      ortb2: {
+        regs: {
+          ext: {
+            extra: 'extra item',
+            us_privacy: '1YYY'
+          }
+        }
+      }
     };
 
     let validBidRequestWithUserIds = {
@@ -391,7 +424,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([badFloorBidRequest], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -422,7 +455,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([badFloorBidRequest], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -454,7 +487,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([newPosBidRequest], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -485,7 +518,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([newPosBidRequest], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -577,7 +610,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([validBidRequestVideo], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -635,7 +668,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([validBidRequestVideo], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data.id).to.equal('xyz123');
       expect(req.data.imp).to.eql([
         {
@@ -701,16 +734,42 @@ describe('imdsBidAdapter ', function () {
         }
       ]);
     });
-    it('should contain the CCPA privacy string when UspConsent is in bidder request', function () {
+    it('should have us_privacy string in regs instead of regs.ext bidder request', function () {
+      let req = spec.buildRequests([validBidRequest], bidderRequestWithUSPInExt);
+      expect(req).be.an('object');
+      expect(req).to.have.property('method', 'POST');
+      expect(req).to.have.property('url');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?');
+      expect(req.data).to.exist.and.to.be.an('object');
+      expect(req.data.id).to.equal('xyz123');
+      expect(req.data.regs.us_privacy).to.equal('1YYY');
+      expect(req.data.regs.ext).to.not.exist;
+      expect(req.data.imp).to.eql([expectedDataImp1]);
+    });
+    it('should accept us_privacy string in regs', function () {
+      // banner test
+      let req = spec.buildRequests([validBidRequest], bidderRequestWithUSPInRegs);
+      expect(req).be.an('object');
+      expect(req).to.have.property('method', 'POST');
+      expect(req).to.have.property('url');
+      expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?');
+      expect(req.data).to.exist.and.to.be.an('object');
+      expect(req.data.id).to.equal('xyz123');
+      expect(req.data.regs.us_privacy).to.equal('1YYY');
+      expect(req.data.regs.ext).to.not.exist;
+      expect(req.data.imp).to.eql([expectedDataImp1]);
+    });
+    it('should not remove regs.ext when moving us_privacy if there are other things in regs.ext', function () {
       // banner test
-      let req = spec.buildRequests([validBidRequest], bidderRequestWithCCPA);
+      let req = spec.buildRequests([validBidRequest], bidderRequestWithUSPAndOthersInExt);
       expect(req).be.an('object');
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
       expect(req.url).to.contain('https://prebid.technoratimedia.com/openrtb/bids/prebid?');
       expect(req.data).to.exist.and.to.be.an('object');
       expect(req.data.id).to.equal('xyz123');
-      expect(req.data.regs.ext.us_privacy).to.equal('1YYY');
+      expect(req.data.regs.us_privacy).to.equal('1YYY');
+      expect(req.data.regs.ext.extra).to.equal('extra item');
       expect(req.data.imp).to.eql([expectedDataImp1]);
     });
     it('should contain user object when user ids are present in the bidder request', function () {
@@ -780,14 +839,14 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([validBannerBidRequest], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
     });
 
     it('should return valid bid request for video impression', function () {
       let req = spec.buildRequests([validVideoBidReq], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
     });
   });
 
@@ -887,7 +946,7 @@ describe('imdsBidAdapter ', function () {
       let req = spec.buildRequests([validBidReq], bidderRequest);
       expect(req).to.have.property('method', 'POST');
       expect(req).to.have.property('url');
-      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=$$REPO_AND_VERSION$$');
+      expect(req.url).to.contain('//prebid.technoratimedia.com/openrtb/bids/prebid?src=pbjs%2F$prebid.version$');
       expect(req.data).to.have.property('source');
       expect(req.data.source).to.have.property('ext');
       expect(req.data.source.ext).to.have.property('schain');
@@ -1293,20 +1352,42 @@ describe('imdsBidAdapter ', function () {
     });
   });
   describe('getUserSyncs', function () {
-    it('should return a usersync when iframes is enabled', function () {
+    it('should return an iframe usersync when iframes is enabled', function () {
       let usersyncs = spec.getUserSyncs({
         iframeEnabled: true
       }, null);
-      expect(usersyncs).to.be.an('array').that.is.not.empty;
+      expect(usersyncs).to.be.an('array').with.lengthOf(1);
       expect(usersyncs[0]).to.have.property('type', 'iframe');
       expect(usersyncs[0]).to.have.property('url');
       expect(usersyncs[0].url).to.contain('https://ad-cdn.technoratimedia.com/html/usersync.html');
     });
 
-    it('should not return a usersync when iframes are not enabled', function () {
+    it('should return a pixel usersync when pixels is enabled', function () {
       let usersyncs = spec.getUserSyncs({
         pixelEnabled: true
       }, null);
+      expect(usersyncs).to.be.an('array').with.lengthOf(1);
+      expect(usersyncs[0]).to.have.property('type', 'pixel');
+      expect(usersyncs[0]).to.have.property('url');
+      expect(usersyncs[0].url).to.contain('https://sync.technoratimedia.com/services');
+    });
+
+    it('should return an iframe usersync when both iframe and pixels is enabled', function () {
+      let usersyncs = spec.getUserSyncs({
+        iframeEnabled: true,
+        pixelEnabled: true
+      }, null);
+      expect(usersyncs).to.be.an('array').with.lengthOf(1);
+      expect(usersyncs[0]).to.have.property('type', 'iframe');
+      expect(usersyncs[0]).to.have.property('url');
+      expect(usersyncs[0].url).to.contain('https://ad-cdn.technoratimedia.com/html/usersync.html');
+    });
+
+    it('should not return a usersync when neither iframes nor pixel are enabled', function () {
+      let usersyncs = spec.getUserSyncs({
+        iframeEnabled: false,
+        pixelEnabled: false
+      }, null);
       expect(usersyncs).to.be.an('array').that.is.empty;
     });
   });