prebid.js 6.3.0 → 6.7.0

package/test/spec/modules/gptPreAuction_spec.js

@@ -20,7 +20,9 @@ describe('GPT pre-auction module', () => {
   const testSlots = [
     makeSlot({ code: 'slotCode1', divId: 'div1' }),
     makeSlot({ code: 'slotCode2', divId: 'div2' }),
-    makeSlot({ code: 'slotCode3', divId: 'div3' })
+    makeSlot({ code: 'slotCode3', divId: 'div3' }),
+    makeSlot({ code: 'slotCode4', divId: 'div4' }),
+    makeSlot({ code: 'slotCode4', divId: 'div5' })
   ];
 
   describe('appendPbAdSlot', () => {
@@ -172,7 +174,9 @@ describe('GPT pre-auction module', () => {
       expect(_currentConfig).to.deep.equal({
         enabled: true,
         customGptSlotMatching: false,
-        customPbAdSlot: false
+        customPbAdSlot: false,
+        customPreAuction: false,
+        useDefaultPreAuction: false
       });
     });
   });
@@ -266,5 +270,176 @@ describe('GPT pre-auction module', () => {
       runMakeBidRequests(testAdUnits);
       expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
     });
+
+    it('should use the passed customPreAuction logic', () => {
+      let counter = 0;
+      config.setConfig({
+        gptPreAuction: {
+          enabled: true,
+          customPreAuction: (adUnit, slotName) => {
+            counter += 1;
+            return `${adUnit.code}-${slotName || counter}`;
+          }
+        }
+      });
+      const testAdUnits = [
+        {
+          code: 'adUnit1',
+          ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
+        },
+        {
+          code: 'adUnit2',
+        },
+        {
+          code: 'slotCode3',
+        },
+        {
+          code: 'div4',
+        }
+      ];
+
+      // all slots should be passed in same time and have slot-${index}
+      const expectedAdUnits = [{
+        code: 'adUnit1',
+        ortb2Imp: {
+          ext: {
+            // no slotname match so uses adUnit.code-counter
+            data: {
+              pbadslot: 'adUnit1-1'
+            },
+            gpid: 'adUnit1-1'
+          }
+        }
+      },
+      // second adunit
+      {
+        code: 'adUnit2',
+        ortb2Imp: {
+          ext: {
+            // no slotname match so uses adUnit.code-counter
+            data: {
+              pbadslot: 'adUnit2-2'
+            },
+            gpid: 'adUnit2-2'
+          }
+        }
+      }, {
+        code: 'slotCode3',
+        ortb2Imp: {
+          ext: {
+            // slotname found, so uses code + slotname (which is same)
+            data: {
+              pbadslot: 'slotCode3-slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3-slotCode3'
+          }
+        }
+      }, {
+        code: 'div4',
+        ortb2Imp: {
+          ext: {
+            // slotname found, so uses code + slotname
+            data: {
+              pbadslot: 'div4-slotCode4',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode4'
+              }
+            },
+            gpid: 'div4-slotCode4'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
+
+    it('should use useDefaultPreAuction logic', () => {
+      config.setConfig({
+        gptPreAuction: {
+          enabled: true,
+          useDefaultPreAuction: true
+        }
+      });
+      const testAdUnits = [
+        // First adUnit should use the preset pbadslot
+        {
+          code: 'adUnit1',
+          ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
+        },
+        // Second adUnit should not match a gam slot, so no slot set
+        {
+          code: 'adUnit2',
+        },
+        // third adunit matches a single slot so uses it
+        {
+          code: 'slotCode3',
+        },
+        // fourth adunit matches multiple slots so combination
+        {
+          code: 'div4',
+        }
+      ];
+
+      const expectedAdUnits = [{
+        code: 'adUnit1',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '12345'
+            },
+            gpid: '12345'
+          }
+        }
+      },
+      // second adunit
+      {
+        code: 'adUnit2',
+        ortb2Imp: {
+          ext: {
+            data: {
+            },
+          }
+        }
+      }, {
+        code: 'slotCode3',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3'
+          }
+        }
+      }, {
+        code: 'div4',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode4#div4',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode4'
+              }
+            },
+            gpid: 'slotCode4#div4'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
   });
 });

package/test/spec/modules/idImportLibrary_spec.js

@@ -3,15 +3,20 @@ import * as idImportlibrary from 'modules/idImportLibrary.js';
 
 var expect = require('chai').expect;
 
-describe('currency', function () {
-  let fakeCurrencyFileServer;
+const mockMutationObserver = {
+  observe: () => {
+    return null
+  }
+}
+
+describe('IdImportLibrary Tests', function () {
+  let fakeServer;
   let sandbox;
   let clock;
-
   let fn = sinon.spy();
 
   beforeEach(function () {
-    fakeCurrencyFileServer = sinon.fakeServer.create();
+    fakeServer = sinon.fakeServer.create();
     sinon.stub(utils, 'logInfo');
     sinon.stub(utils, 'logError');
   });
@@ -19,7 +24,7 @@ describe('currency', function () {
   afterEach(function () {
     utils.logInfo.restore();
     utils.logError.restore();
-    fakeCurrencyFileServer.restore();
+    fakeServer.restore();
     idImportlibrary.setConfig({});
   });
 
@@ -34,28 +39,210 @@ describe('currency', function () {
       clock.restore();
     });
 
-    it('results when no config available', function () {
+    it('results when no config is set', function () {
+      idImportlibrary.setConfig();
+      sinon.assert.called(utils.logError);
+    });
+    it('results when config is empty', function () {
       idImportlibrary.setConfig({});
       sinon.assert.called(utils.logError);
     });
-    it('results with config available', function () {
-      idImportlibrary.setConfig({ 'url': 'URL' });
+    it('results with config available with url and debounce', function () {
+      idImportlibrary.setConfig({ 'url': 'URL', 'debounce': 0 });
       sinon.assert.called(utils.logInfo);
     });
+    it('results with config debounce ', function () {
+      let config = { 'url': 'URL', 'debounce': 300 }
+      idImportlibrary.setConfig(config);
+      expect(config.debounce).to.be.equal(300);
+    });
+
     it('results with config default debounce ', function () {
       let config = { 'url': 'URL' }
       idImportlibrary.setConfig(config);
       expect(config.debounce).to.be.equal(250);
     });
     it('results with config default fullscan ', function () {
-      let config = { 'url': 'URL' }
+      let config = { 'url': 'URL', 'debounce': 0 }
       idImportlibrary.setConfig(config);
       expect(config.fullscan).to.be.equal(false);
     });
     it('results with config fullscan ', function () {
-      let config = { 'url': 'URL', 'fullscan': true }
+      let config = { 'url': 'URL', 'fullscan': true, 'debounce': 0 }
+      idImportlibrary.setConfig(config);
+      expect(config.fullscan).to.be.equal(true);
+      expect(config.inputscan).to.be.equal(false);
+    });
+    it('results with config inputscan ', function () {
+      let config = { 'inputscan': true, 'debounce': 0 }
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+    });
+  });
+  describe('Test with email is found', function () {
+    let mutationObserverStub;
+    let userId;
+    let refreshUserIdSpy;
+    beforeEach(function() {
+      let sandbox = sinon.createSandbox();
+      refreshUserIdSpy = sinon.spy(window.$$PREBID_GLOBAL$$, 'refreshUserIds');
+      clock = sinon.useFakeTimers(1046952000000); // 2003-03-06T12:00:00Z
+      mutationObserverStub = sinon.stub(window, 'MutationObserver').returns(mockMutationObserver);
+      userId = sandbox.stub(window.$$PREBID_GLOBAL$$, 'getUserIds').returns({id: {'MOCKID': '1111'}});
+      fakeServer.respondWith('POST', 'URL', [200,
+        {
+          'Content-Type': 'application/json',
+          'Access-Control-Allow-Origin': '*'
+        },
+        ''
+      ]);
+    });
+    afterEach(function () {
+      sandbox.restore();
+      clock.restore();
+      userId.restore();
+      refreshUserIdSpy.restore();
+      mutationObserverStub.restore();
+      document.body.innerHTML = '';
+    });
+
+    it('results with config fullscan with email found in html ', function () {
+      document.body.innerHTML = '<body><div>test@test.com</div></body>';
+      let config = { 'url': 'URL', 'fullscan': true, 'debounce': 0 }
+      idImportlibrary.setConfig(config);
+      expect(config.fullscan).to.be.equal(true);
+      expect(config.inputscan).to.be.equal(false);
+      expect(refreshUserIdSpy.calledOnce).to.equal(true);
+    });
+
+    it('results with config fullscan with no email found in html ', function () {
+      document.body.innerHTML = '<body><div>test</div></body>';
+      let config = { 'url': 'URL', 'fullscan': true, 'debounce': 0 }
+      idImportlibrary.setConfig(config);
+      expect(config.fullscan).to.be.equal(true);
+      expect(config.inputscan).to.be.equal(false);
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+
+    it('results with config formElementId without listner ', function () {
+      let config = { url: 'testUrl', 'formElementId': 'userid', 'debounce': 0 }
+      document.body.innerHTML = '<body><input type="text" id="userid" value="test@test.com"></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.formElementId).to.be.equal('userid');
+      expect(refreshUserIdSpy.calledOnce).to.equal(true);
+    });
+
+    it('results with config formElementId with listner ', function () {
+      let config = { url: 'testUrl', 'formElementId': 'userid', 'debounce': 0 }
+      document.body.innerHTML = '<body><input type="text" id="userid" value=""></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.formElementId).to.be.equal('userid');
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+
+    it('results with config target without listner ', function () {
+      let config = { url: 'testUrl', 'target': 'userid', 'debounce': 0 }
+      document.body.innerHTML = '<body><div id="userid">test@test.com<div></div></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.target).to.be.equal('userid');
+      expect(refreshUserIdSpy.calledOnce).to.equal(true);
+    });
+    it('results with config target with listner ', function () {
+      let config = { url: 'testUrl', 'target': 'userid', 'debounce': 0 }
+      document.body.innerHTML = '<body><div id="userid"><div></div></body>';
+      idImportlibrary.setConfig(config);
+
+      expect(config.target).to.be.equal('userid');
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+
+    it('results with config target with listner', function () {
+      let config = { url: 'testUrl', 'target': 'userid', 'debounce': 0 }
+      idImportlibrary.setConfig(config);
+      document.body.innerHTML = '<body><div id="userid">test@test.com<div></div></body>';
+      expect(config.target).to.be.equal('userid');
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+    it('results with config fullscan ', function () {
+      let config = { url: 'testUrl', 'fullscan': true, 'debounce': 0 }
       idImportlibrary.setConfig(config);
+      document.body.innerHTML = '<body><div id="userid"><div></div></body>';
       expect(config.fullscan).to.be.equal(true);
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+    it('results with config inputscan with listner', function () {
+      let config = { url: 'testUrl', 'inputscan': true, 'debounce': 0 }
+      var input = document.createElement('input');
+      input.setAttribute('type', 'text');
+      document.body.appendChild(input);
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      input.setAttribute('value', 'text@text.com');
+      const inputEvent = new InputEvent('blur');
+      input.dispatchEvent(inputEvent);
+      expect(refreshUserIdSpy.calledOnce).to.equal(true);
+    });
+
+    it('results with config inputscan with listner and no user ids ', function () {
+      let config = { 'url': 'testUrl', 'inputscan': true, 'debounce': 0 }
+      document.body.innerHTML = '<body><input  id="userid" value=""></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+
+    it('results with config inputscan with listner ', function () {
+      let config = { 'url': 'testUrl', 'inputscan': true, 'debounce': 0 }
+      document.body.innerHTML = '<body><input  id="userid" type=text value=""></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      expect(refreshUserIdSpy.calledOnce).to.equal(false);
+    });
+
+    it('results with config inputscan without listner ', function () {
+      let config = { 'url': 'testUrl', 'inputscan': true, 'debounce': 0 }
+      document.body.innerHTML = '<body><input  id="userid" value="test@test.com"></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      expect(refreshUserIdSpy.calledOnce).to.equal(true);
+    });
+  });
+  describe('Tests with no user ids', function () {
+    let mutationObserverStub;
+    let userId;
+    let jsonSpy;
+    beforeEach(function() {
+      let sandbox = sinon.createSandbox();
+      clock = sinon.useFakeTimers(1046952000000); // 2003-03-06T12:00:00Z
+      mutationObserverStub = sinon.stub(window, 'MutationObserver');
+      jsonSpy = sinon.spy(JSON, 'stringify');
+      fakeServer.respondWith('POST', 'URL', [200,
+        {
+          'Content-Type': 'application/json',
+          'Access-Control-Allow-Origin': '*'
+        },
+        ''
+      ]);
+    });
+    afterEach(function () {
+      sandbox.restore();
+      clock.restore();
+      jsonSpy.restore();
+      mutationObserverStub.restore();
+    });
+    it('results with config inputscan without listner with no user ids ', function () {
+      let config = { 'url': 'testUrl', 'inputscan': true, 'debounce': 0 }
+      document.body.innerHTML = '<body><input  id="userid" value="test@test.com"></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      expect(jsonSpy.calledOnce).to.equal(false);
+    });
+    it('results with config inputscan without listner with no user ids ', function () {
+      let config = { 'url': 'testUrl', 'inputscan': true, 'debounce': 0 }
+      document.body.innerHTML = '<body><input  id="userid"></body>';
+      idImportlibrary.setConfig(config);
+      expect(config.inputscan).to.be.equal(true);
+      expect(jsonSpy.calledOnce).to.equal(false);
     });
   });
 });

package/test/spec/modules/improvedigitalBidAdapter_spec.js

@@ -92,7 +92,8 @@ describe('Improve Digital Adapter Tests', function () {
     gdprConsent: {
       consentString: 'BOJ/P2HOJ/P2HABABMAAAAAZ+A==',
       vendorData: {},
-      gdprApplies: true
+      gdprApplies: true,
+      addtlConsent: '1~1.35.41.101',
     },
   };
 
@@ -278,6 +279,7 @@ describe('Improve Digital Adapter Tests', function () {
       const request = spec.buildRequests([bidRequest], bidderRequestGdpr)[0];
       const params = JSON.parse(decodeURIComponent(request.data.substring(PARAM_PREFIX.length)));
       expect(params.bid_request.gdpr).to.equal('BOJ/P2HOJ/P2HABABMAAAAAZ+A==');
+      expect(params.bid_request.user.ext.consented_providers_settings.consented_providers).to.exist.and.to.deep.equal([1, 35, 41, 101]);
     });
 
     it('should add CCPA consent string', function () {
@@ -513,6 +515,48 @@ describe('Improve Digital Adapter Tests', function () {
       });
       getConfigStub.restore();
     });
+
+    it('should set pagecat and genre ➞ fpd:ortb2.site', function() {
+      config.setConfig(JSON.parse('{"ortb2":{"site":{"cat":["IAB2"],"pagecat":["IAB2-2"],"content":{"genre":"Adventure"}}}}'));
+      const bidRequest = Object.assign({}, simpleBidRequest);
+      const request = spec.buildRequests([bidRequest], bidderRequestReferrer)[0];
+      const params = JSON.parse(decodeURIComponent(request.data.substring(PARAM_PREFIX.length)));
+      expect(params.bid_request.pagecat).to.be.an('array');
+      expect(params.bid_request.pagecat).to.deep.equal(['IAB2-2']);
+      expect(params.bid_request.genre).to.be.a('string');
+      expect(params.bid_request.genre).be.equal('Adventure');
+    });
+
+    it('should not set pagecat and genre when malformed data provided ➞ fpd:ortb2.site', function() {
+      config.setConfig(JSON.parse('{"ortb2":{"site":{"pagecat":"IAB2-2","content":{"genre":["Adventure"]}}}}'));
+      const bidRequest = Object.assign({}, simpleBidRequest);
+      const request = spec.buildRequests([bidRequest], bidderRequestReferrer)[0];
+      const params = JSON.parse(decodeURIComponent(request.data.substring(PARAM_PREFIX.length)));
+      expect(params.bid_request.pagecat).does.not.exist;
+      expect(params.bid_request.genre).does.not.exist;
+    });
+
+    it('should use cat when pagecat not available ➞ fpd:ortb2.site', function() {
+      config.setConfig(JSON.parse('{"ortb2":{"site":{"cat":["IAB2"]}}}'));
+      const bidRequest = Object.assign({}, simpleBidRequest);
+      const request = spec.buildRequests([bidRequest], bidderRequestReferrer)[0];
+      const params = JSON.parse(decodeURIComponent(request.data.substring(PARAM_PREFIX.length)));
+      expect(params.bid_request.pagecat).to.be.an('array');
+      expect(params.bid_request.pagecat).to.deep.equal(['IAB2']);
+    });
+
+    it('should format pagecat correctly ➞ fpd:ortb2.site', function() {
+      config.setConfig(JSON.parse('{"ortb2":{"site":{"cat":["IAB2", ["IAB-1"], "IAB3", 123, ""]}}}'));
+      const bidRequest = Object.assign({}, simpleBidRequest);
+      const request = spec.buildRequests([bidRequest], bidderRequestReferrer)[0];
+      const params = JSON.parse(decodeURIComponent(request.data.substring(PARAM_PREFIX.length)));
+      expect(params.bid_request.pagecat).to.be.an('array');
+      expect(params.bid_request.pagecat).to.deep.equal([
+        'IAB2',
+        'IAB3'
+      ]
+      );
+    });
   });
 
   const serverResponse = {

package/test/spec/modules/invibesBidAdapter_spec.js

@@ -158,6 +158,125 @@ describe('invibesBidAdapter:', function () {
       expect(request.method).to.equal('GET');
     });
 
+    it('sends bid request to custom endpoint via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'placement',
+          customEndpoint: 'sub.domain.com/Bid/VideoAdContent'
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('sub.domain.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to default endpoint when no placement', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal(ENDPOINT);
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to default endpoint when null placement', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: null
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal(ENDPOINT);
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to default endpoint 1 via GET', function () {
+	  const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'placement'
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to network id endpoint 1 via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'placement',
+          domainId: 1001
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to network id endpoint 2 via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'placement',
+          domainId: 1002
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid2.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to network id by placement 1 via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'infeed_ivbs1'
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to network id by placement 2 via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'infeed_ivbs2'
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid2.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
+    it('sends bid request to network id by placement 10 via GET', function () {
+      const request = spec.buildRequests([{
+        bidId: 'b1',
+        bidder: BIDDER_CODE,
+        params: {
+          placementId: 'infeed_ivbs10'
+        },
+        adUnitCode: 'test-div1'
+      }]);
+      expect(request.url).to.equal('https://bid10.videostep.com/Bid/VideoAdContent');
+      expect(request.method).to.equal('GET');
+    });
+
     it('sends cookies with the bid request', function () {
       const request = spec.buildRequests(bidRequests);
       expect(request.options.withCredentials).to.equal(true);