prebid.js 6.0.0 → 6.4.0

package/test/spec/modules/gptPreAuction_spec.js

@@ -197,15 +197,69 @@ describe('GPT pre-auction module', () => {
         code: 'slotCode3',
       }];
 
+      // first two adUnits directly pass in pbadslot => gpid is same
       const expectedAdUnits = [{
         code: 'adUnit1',
-        ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
-      }, {
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '12345'
+            },
+            gpid: '12345'
+          }
+        }
+      },
+      // second adunit
+      {
         code: 'slotCode1',
-        ortb2Imp: { ext: { data: { pbadslot: '67890', adserver: { name: 'gam', adslot: 'slotCode1' } } } }
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '67890',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode1'
+              }
+            },
+            gpid: '67890'
+          }
+        }
       }, {
         code: 'slotCode3',
-        ortb2Imp: { ext: { data: { pbadslot: 'slotCode3', adserver: { name: 'gam', adslot: 'slotCode3' } } } }
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
+
+    it('should not apply gpid if pbadslot was set by adUnitCode', () => {
+      const testAdUnits = [{
+        code: 'noMatchCode',
+      }];
+
+      // first two adUnits directly pass in pbadslot => gpid is same
+      const expectedAdUnits = [{
+        code: 'noMatchCode',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'noMatchCode'
+            },
+          }
+        }
       }];
 
       window.googletag.pubads().setSlots(testSlots);

package/test/spec/modules/gumgumBidAdapter_spec.js

@@ -152,6 +152,12 @@ describe('gumgumAdapter', function () {
     const zoneParam = { 'zone': '123a' };
     const pubIdParam = { 'pubId': 123 };
 
+    it('should set aun if the adUnitCode is available', function () {
+      const request = { ...bidRequests[0] };
+      const bidRequest = spec.buildRequests([request])[0];
+      expect(bidRequest.data.aun).to.equal(bidRequests[0].adUnitCode);
+    });
+
     it('should set pubId param if found', function () {
       const request = { ...bidRequests[0], params: pubIdParam };
       const bidRequest = spec.buildRequests([request])[0];

package/test/spec/modules/imRtdProvider_spec.js

@@ -1,6 +1,7 @@
 import {
   imRtdSubmodule,
   storage,
+  getBidderFunction,
   getCustomBidderFunction,
   setRealTimeData,
   getRealTimeData,
@@ -47,6 +48,30 @@ describe('imRtdProvider', function () {
     })
   })
 
+  describe('getBidderFunction', function () {
+    const assumedBidder = [
+      'ix',
+      'pubmatic'
+    ];
+    assumedBidder.forEach(bidderName => {
+      it(`should return bidderFunction with assumed bidder: ${bidderName}`, function () {
+        expect(getBidderFunction(bidderName)).to.exist.and.to.be.a('function');
+      });
+
+      it(`should return bid with correct key data: ${bidderName}`, function () {
+        const bid = {bidder: bidderName};
+        expect(getBidderFunction(bidderName)(bid, {'im_segments': ['12345', '67890']})).to.equal(bid);
+      });
+      it(`should return bid without data: ${bidderName}`, function () {
+        const bid = {bidder: bidderName};
+        expect(getBidderFunction(bidderName)(bid, '')).to.equal(bid);
+      });
+    });
+    it(`should return null with unexpected bidder`, function () {
+      expect(getBidderFunction('test')).to.equal(null);
+    });
+  })
+
   describe('getCustomBidderFunction', function () {
     it('should return config function', function () {
       const config = {

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 () {

package/test/spec/modules/intersectionRtdProvider_spec.js

@@ -0,0 +1,141 @@
+import {config as _config, config} from 'src/config.js';
+import { expect } from 'chai';
+import events from 'src/events.js';
+import * as prebidGlobal from 'src/prebidGlobal.js';
+import { intersectionSubmodule } from 'modules/intersectionRtdProvider.js';
+import * as utils from 'src/utils.js';
+import {getGlobal} from 'src/prebidGlobal.js';
+import 'src/prebid.js';
+
+describe('Intersection 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: 'intersection', waitForIt: true};
+  const rtdConfig = {realTimeData: {auctionDelay: 200, dataProviders: [providerConfig]}}
+  describe('IntersectionObserver not supported', function() {
+    beforeEach(function() {
+      sandbox = sinon.sandbox.create();
+    });
+    afterEach(function() {
+      sandbox.restore();
+      sandbox = undefined;
+    });
+    it('init should return false', function () {
+      sandbox.stub(window, 'IntersectionObserver').value(undefined);
+      expect(intersectionSubmodule.init({})).is.false;
+    });
+  });
+  describe('IntersectionObserver 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 () {
+      expect(intersectionSubmodule.init({})).is.true;
+    });
+    it('should set intersection. (request with "adUnitCodes")', function(done) {
+      pbjs.addAdUnits([utils.deepClone(adUnit)]);
+      config.setConfig(rtdConfig);
+      const onDone = sandbox.stub();
+      const requestBidObject = {adUnitCodes: [adUnit.code]};
+      intersectionSubmodule.init({});
+      intersectionSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        providerConfig
+      );
+      setTimeout(function() {
+        expect(pbjs.adUnits[0].bids[0]).to.have.property('intersection');
+        done();
+      }, 200);
+    });
+    it('should set intersection. (request with "adUnits")', function(done) {
+      config.setConfig(rtdConfig);
+      const onDone = sandbox.stub();
+      const requestBidObject = {adUnits: [utils.deepClone(adUnit)]};
+      intersectionSubmodule.init();
+      intersectionSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        providerConfig
+      );
+      setTimeout(function() {
+        expect(requestBidObject.adUnits[0].bids[0]).to.have.property('intersection');
+        done();
+      }, 200);
+    });
+    it('should set intersection. (request all)', function(done) {
+      pbjs.addAdUnits([utils.deepClone(adUnit)]);
+      config.setConfig(rtdConfig);
+      const onDone = sandbox.stub();
+      const requestBidObject = {};
+      intersectionSubmodule.init({});
+      intersectionSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        providerConfig
+      );
+      setTimeout(function() {
+        expect(pbjs.adUnits[0].bids[0]).to.have.property('intersection');
+        done();
+      }, 200);
+    });
+    it('should call done due timeout', function(done) {
+      config.setConfig(rtdConfig);
+      remove();
+      const onDone = sandbox.stub();
+      const requestBidObject = {adUnits: [utils.deepClone(adUnit)]};
+      intersectionSubmodule.init({});
+      intersectionSubmodule.getBidRequestData(
+        requestBidObject,
+        onDone,
+        {...providerConfig, test: 1}
+      );
+      setTimeout(function() {
+        sinon.assert.calledOnce(onDone);
+        expect(requestBidObject.adUnits[0].bids[0]).to.not.have.property('intersection');
+        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/invibesBidAdapter_spec.js

@@ -15,7 +15,7 @@ describe('invibesBidAdapter:', function () {
       params: {
         placementId: PLACEMENT_ID
       },
-      adUnitCode: 'test-div',
+      adUnitCode: 'test-div1',
       auctionId: 'a1',
       sizes: [
         [300, 250],
@@ -30,7 +30,7 @@ describe('invibesBidAdapter:', function () {
       params: {
         placementId: 'abcde'
       },
-      adUnitCode: 'test-div',
+      adUnitCode: 'test-div2',
       auctionId: 'a2',
       sizes: [
         [300, 250],
@@ -48,7 +48,7 @@ describe('invibesBidAdapter:', function () {
       params: {
         placementId: PLACEMENT_ID
       },
-      adUnitCode: 'test-div',
+      adUnitCode: 'test-div1',
       auctionId: 'a1',
       sizes: [
         [300, 250],
@@ -67,7 +67,7 @@ describe('invibesBidAdapter:', function () {
       params: {
         placementId: 'abcde'
       },
-      adUnitCode: 'test-div',
+      adUnitCode: 'test-div2',
       auctionId: 'a2',
       sizes: [
         [300, 250],
@@ -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);
@@ -223,6 +342,12 @@ describe('invibesBidAdapter:', function () {
       expect(JSON.parse(request.data.bidParamsJson).placementIds).to.contain(bidRequests[1].params.placementId);
     });
 
+    it('sends all adUnitCodes', function () {
+      const request = spec.buildRequests(bidRequests);
+      expect(JSON.parse(request.data.bidParamsJson).adUnitCodes).to.contain(bidRequests[0].adUnitCode);
+      expect(JSON.parse(request.data.bidParamsJson).adUnitCodes).to.contain(bidRequests[1].adUnitCode);
+    });
+
     it('sends all Placement Ids and userId', function () {
       const request = spec.buildRequests(bidRequestsWithUserId);
       expect(JSON.parse(request.data.bidParamsJson).userId).to.exist;
@@ -823,6 +948,20 @@ describe('invibesBidAdapter:', function () {
       }
     };
 
+    let responseWithAdUnit = {
+      Ads: [{
+        BidPrice: 0.5,
+        VideoExposedId: 123
+      }],
+      BidModel: {
+        BidVersion: 1,
+        PlacementId: '12345_test-div1',
+        AuctionStartTime: Date.now(),
+        CreativeHtml: '<!-- Creative -->'
+      },
+	  UseAdUnitCode: true
+    };
+
     var buildResponse = function(placementId, cid, blcids, creativeId) {
       return {
         MultipositionEnabled: true,
@@ -911,6 +1050,11 @@ describe('invibesBidAdapter:', function () {
         let secondResult = spec.interpretResponse({body: response}, {bidRequests});
         expect(secondResult).to.be.empty;
       });
+
+      it('bids using the adUnitCode', function () {
+        let result = spec.interpretResponse({body: responseWithAdUnit}, {bidRequests});
+        expect(Object.keys(result[0])).to.have.members(Object.keys(expectedResponse[0]));
+      });
     });
 
     context('when the response has meta', function () {

package/test/spec/modules/ipromBidAdapter_spec.js

@@ -0,0 +1,195 @@
+import {expect} from 'chai';
+import {spec} from 'modules/ipromBidAdapter.js';
+
+describe('iPROM Adapter', function () {
+  let bidRequests;
+  let bidderRequest;
+
+  beforeEach(function () {
+    bidRequests = [
+      {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: '300x250',
+        },
+        adUnitCode: '/19966331/header-bid-tag-1',
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250], [300, 600]],
+          }
+        },
+        bidId: '29a72b151f7bd3',
+        auctionId: 'e36abb27-g3b1-1ad6-8a4c-701c8919d3hh',
+        bidderRequestId: '2z76da40m1b3cb8',
+        transactionId: 'j51lhf58-1ad6-g3b1-3j6s-912c9493g0gu'
+      }
+    ];
+
+    bidderRequest = {
+      timeout: 3000,
+      refererInfo: {
+        referer: 'https://adserver.si/index.html',
+        reachedTop: true,
+        numIframes: 1,
+        stack: [
+          'https://adserver.si/index.html',
+          'https://adserver.si/iframe1.html',
+        ]
+      }
+    }
+  });
+
+  describe('validating bids', function () {
+    it('should accept valid bid', function () {
+      let validBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: '300x250',
+        },
+      };
+
+      const isValid = spec.isBidRequestValid(validBid);
+
+      expect(isValid).to.equal(true);
+    });
+
+    it('should reject bid if missing dimension and id', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {}
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if missing dimension', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if dimension is not a string', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: 404,
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if missing id', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          dimension: '300x250',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if id is not a string', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: 1234,
+          dimension: '300x250',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+  });
+
+  describe('building requests', function () {
+    it('should go to correct endpoint', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+
+      expect(request.method).to.exist;
+      expect(request.method).to.equal('POST');
+      expect(request.url).to.exist;
+      expect(request.url).to.equal('https://core.iprom.net/programmatic');
+    });
+
+    it('should add referer info', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.referer).to.exist;
+      expect(requestparse.referer.referer).to.equal('https://adserver.si/index.html');
+    });
+
+    it('should add adapter version', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.version).to.exist;
+    });
+
+    it('should contain id and dimension', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.bids[0].params.id).to.equal('1234');
+      expect(requestparse.bids[0].params.dimension).to.equal('300x250');
+    });
+  });
+
+  describe('handling responses', function () {
+    it('should return complete bid response', function () {
+      const serverResponse = {
+        body: [{
+          requestId: '29a72b151f7bd3',
+          cpm: 0.5,
+          width: '300',
+          height: '250',
+          creativeId: 1234,
+          ad: '<html><head><title>Iprom Header bidding example</title></head><body><img src="https://iprom.si/files/2015/08/iprom-logo.svg"></body></html>',
+          aDomains: ['https://example.com'],
+        }
+        ]};
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const bids = spec.interpretResponse(serverResponse, request);
+
+      expect(bids).to.be.lengthOf(1);
+      expect(bids[0].requestId).to.equal('29a72b151f7bd3');
+      expect(bids[0].cpm).to.equal(0.5);
+      expect(bids[0].width).to.equal('300');
+      expect(bids[0].height).to.equal('250');
+      expect(bids[0].ad).to.have.length.above(1);
+      expect(bids[0].meta.advertiserDomains).to.deep.equal(['https://example.com']);
+    });
+
+    it('should return empty bid response', function () {
+      const emptyServerResponse = {
+        body: []
+      };
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const bids = spec.interpretResponse(emptyServerResponse, request);
+
+      expect(bids).to.be.lengthOf(0);
+    });
+  });
+});