prebid.js 6.1.0 → 6.2.0

package/test/spec/modules/relaidoBidAdapter_spec.js

@@ -57,23 +57,34 @@ describe('RelaidoAdapter', function () {
     serverResponse = {
       body: {
         status: 'ok',
-        price: 500,
-        model: 'vcpm',
-        currency: 'JPY',
-        creativeId: 1000,
-        uuid: relaido_uuid,
-        vast: '<VAST version="3.0"><Ad><InLine></InLine></Ad></VAST>',
+        ads: [{
+          placementId: 100000,
+          width: 640,
+          height: 360,
+          bidId: '2ed93003f7bb99',
+          price: 500,
+          model: 'vcpm',
+          currency: 'JPY',
+          creativeId: 1000,
+          vast: '<VAST version="3.0"><Ad><InLine></InLine></Ad></VAST>',
+          syncUrl: 'https://relaido/sync.html',
+          adomain: ['relaido.co.jp', 'www.cmertv.co.jp'],
+          mediaType: 'video'
+        }],
         playerUrl: 'https://relaido/player.js',
-        syncUrl: 'https://relaido/sync.html',
-        adomain: ['relaido.co.jp', 'www.cmertv.co.jp']
+        syncUrl: 'https://api-dev.ulizaex.com/tr/v1/prebid/sync.html',
+        uuid: relaido_uuid,
       }
     };
     serverRequest = {
-      method: 'GET',
-      bidId: bidRequest.bidId,
-      width: bidRequest.mediaTypes.video.playerSize[0][0],
-      height: bidRequest.mediaTypes.video.playerSize[0][1],
-      mediaType: 'video',
+      method: 'POST',
+      data: {
+        bids: [{
+          bidId: bidRequest.bidId,
+          width: bidRequest.mediaTypes.video.playerSize[0][0],
+          height: bidRequest.mediaTypes.video.playerSize[0][1],
+          mediaType: 'video'}]
+      }
     };
   });
 
@@ -195,28 +206,23 @@ describe('RelaidoAdapter', function () {
   describe('spec.buildRequests', function () {
     it('should build bid requests by video', function () {
       const bidRequests = spec.buildRequests([bidRequest], bidderRequest);
-      expect(bidRequests).to.have.lengthOf(1);
-      const request = bidRequests[0];
-      expect(request.method).to.equal('GET');
-      expect(request.url).to.equal('https://api.relaido.jp/bid/v1/prebid/100000');
-      expect(request.bidId).to.equal(bidRequest.bidId);
-      expect(request.width).to.equal(bidRequest.mediaTypes.video.playerSize[0][0]);
-      expect(request.height).to.equal(bidRequest.mediaTypes.video.playerSize[0][1]);
-      expect(request.mediaType).to.equal('video');
-      expect(request.data.ref).to.equal(bidderRequest.refererInfo.referer);
-      expect(request.data.timeout_ms).to.equal(bidderRequest.timeout);
-      expect(request.data.ad_unit_code).to.equal(bidRequest.adUnitCode);
-      expect(request.data.auction_id).to.equal(bidRequest.auctionId);
-      expect(request.data.bidder).to.equal(bidRequest.bidder);
-      expect(request.data.bidder_request_id).to.equal(bidRequest.bidderRequestId);
-      expect(request.data.bid_requests_count).to.equal(bidRequest.bidRequestsCount);
-      expect(request.data.bid_id).to.equal(bidRequest.bidId);
-      expect(request.data.transaction_id).to.equal(bidRequest.transactionId);
-      expect(request.data.media_type).to.equal('video');
-      expect(request.data.uuid).to.equal(relaido_uuid);
-      expect(request.data.width).to.equal(bidRequest.mediaTypes.video.playerSize[0][0]);
-      expect(request.data.height).to.equal(bidRequest.mediaTypes.video.playerSize[0][1]);
-      expect(request.data.pv).to.equal('$prebid.version$');
+      const data = JSON.parse(bidRequests.data);
+      expect(data.bids).to.have.lengthOf(1);
+      const request = data.bids[0];
+      expect(bidRequests.method).to.equal('POST');
+      expect(bidRequests.url).to.equal('https://api.relaido.jp/bid/v1/sprebid');
+      expect(data.ref).to.equal(bidderRequest.refererInfo.referer);
+      expect(data.timeout_ms).to.equal(bidderRequest.timeout);
+      expect(request.ad_unit_code).to.equal(bidRequest.adUnitCode);
+      expect(request.auction_id).to.equal(bidRequest.auctionId);
+      expect(data.bidder).to.equal(bidRequest.bidder);
+      expect(request.bidder_request_id).to.equal(bidRequest.bidderRequestId);
+      expect(data.bid_requests_count).to.equal(bidRequest.bidRequestsCount);
+      expect(request.bid_id).to.equal(bidRequest.bidId);
+      expect(request.transaction_id).to.equal(bidRequest.transactionId);
+      expect(request.media_type).to.equal('video');
+      expect(data.uuid).to.equal(relaido_uuid);
+      expect(data.pv).to.equal('$prebid.version$');
     });
 
     it('should build bid requests by banner', function () {
@@ -236,9 +242,10 @@ describe('RelaidoAdapter', function () {
         }
       };
       const bidRequests = spec.buildRequests([bidRequest], bidderRequest);
-      expect(bidRequests).to.have.lengthOf(1);
-      const request = bidRequests[0];
-      expect(request.mediaType).to.equal('banner');
+      const data = JSON.parse(bidRequests.data);
+      expect(data.bids).to.have.lengthOf(1);
+      const request = data.bids[0];
+      expect(request.media_type).to.equal('banner');
     });
 
     it('should take 1x1 size', function () {
@@ -258,17 +265,18 @@ describe('RelaidoAdapter', function () {
         }
       };
       const bidRequests = spec.buildRequests([bidRequest], bidderRequest);
-      expect(bidRequests).to.have.lengthOf(1);
-      const request = bidRequests[0];
+      const data = JSON.parse(bidRequests.data);
+      expect(data.bids).to.have.lengthOf(1);
+      const request = data.bids[0];
 
       expect(request.width).to.equal(1);
     });
 
     it('The referrer should be the last', function () {
       const bidRequests = spec.buildRequests([bidRequest], bidderRequest);
-      expect(bidRequests).to.have.lengthOf(1);
-      const request = bidRequests[0];
-      const keys = Object.keys(request.data);
+      const data = JSON.parse(bidRequests.data);
+      expect(data.bids).to.have.lengthOf(1);
+      const keys = Object.keys(data);
       expect(keys[0]).to.equal('version');
       expect(keys[keys.length - 1]).to.equal('ref');
     });
@@ -277,9 +285,9 @@ describe('RelaidoAdapter', function () {
       bidRequest.userId = {}
       bidRequest.userId.imuid = 'i.tjHcK_7fTcqnbrS_YA2vaw';
       const bidRequests = spec.buildRequests([bidRequest], bidderRequest);
-      expect(bidRequests).to.have.lengthOf(1);
-      const request = bidRequests[0];
-      expect(request.data.imuid).to.equal('i.tjHcK_7fTcqnbrS_YA2vaw');
+      const data = JSON.parse(bidRequests.data);
+      expect(data.bids).to.have.lengthOf(1);
+      expect(data.imuid).to.equal('i.tjHcK_7fTcqnbrS_YA2vaw');
     });
   });
 
@@ -288,29 +296,29 @@ describe('RelaidoAdapter', function () {
       const bidResponses = spec.interpretResponse(serverResponse, serverRequest);
       expect(bidResponses).to.have.lengthOf(1);
       const response = bidResponses[0];
-      expect(response.requestId).to.equal(serverRequest.bidId);
-      expect(response.width).to.equal(serverRequest.width);
-      expect(response.height).to.equal(serverRequest.height);
-      expect(response.cpm).to.equal(serverResponse.body.price);
-      expect(response.currency).to.equal(serverResponse.body.currency);
-      expect(response.creativeId).to.equal(serverResponse.body.creativeId);
-      expect(response.vastXml).to.equal(serverResponse.body.vast);
-      expect(response.meta.advertiserDomains).to.equal(serverResponse.body.adomain);
+      expect(response.requestId).to.equal(serverRequest.data.bids[0].bidId);
+      expect(response.width).to.equal(serverRequest.data.bids[0].width);
+      expect(response.height).to.equal(serverRequest.data.bids[0].height);
+      expect(response.cpm).to.equal(serverResponse.body.ads[0].price);
+      expect(response.currency).to.equal(serverResponse.body.ads[0].currency);
+      expect(response.creativeId).to.equal(serverResponse.body.ads[0].creativeId);
+      expect(response.vastXml).to.equal(serverResponse.body.ads[0].vast);
+      expect(response.meta.advertiserDomains).to.equal(serverResponse.body.ads[0].adomain);
       expect(response.meta.mediaType).to.equal(VIDEO);
       expect(response.ad).to.be.undefined;
     });
 
     it('should build bid response by banner', function () {
-      serverRequest.mediaType = 'banner';
+      serverResponse.body.ads[0].mediaType = 'banner';
       const bidResponses = spec.interpretResponse(serverResponse, serverRequest);
       expect(bidResponses).to.have.lengthOf(1);
       const response = bidResponses[0];
-      expect(response.requestId).to.equal(serverRequest.bidId);
-      expect(response.width).to.equal(serverRequest.width);
-      expect(response.height).to.equal(serverRequest.height);
-      expect(response.cpm).to.equal(serverResponse.body.price);
-      expect(response.currency).to.equal(serverResponse.body.currency);
-      expect(response.creativeId).to.equal(serverResponse.body.creativeId);
+      expect(response.requestId).to.equal(serverRequest.data.bids[0].bidId);
+      expect(response.width).to.equal(serverRequest.data.bids[0].width);
+      expect(response.height).to.equal(serverRequest.data.bids[0].height);
+      expect(response.cpm).to.equal(serverResponse.body.ads[0].price);
+      expect(response.currency).to.equal(serverResponse.body.ads[0].currency);
+      expect(response.creativeId).to.equal(serverResponse.body.ads[0].creativeId);
       expect(response.vastXml).to.be.undefined;
       expect(response.ad).to.include(`<div id="rop-prebid">`);
       expect(response.ad).to.include(`<script src="https://relaido/player.js"></script>`);
@@ -370,8 +378,8 @@ describe('RelaidoAdapter', function () {
     it('Should create nurl pixel if bid nurl', function () {
       let bid = {
         bidder: bidRequest.bidder,
-        creativeId: serverResponse.body.creativeId,
-        cpm: serverResponse.body.price,
+        creativeId: serverResponse.body.ads[0].creativeId,
+        cpm: serverResponse.body.ads[0].price,
         params: [bidRequest.params],
         auctionId: bidRequest.auctionId,
         requestId: bidRequest.bidId,

package/test/spec/modules/smaatoBidAdapter_spec.js

@@ -294,6 +294,16 @@ describe('smaatoBidAdapterTest', () => {
         expect(req.source.ext.schain).to.not.exist;
       });
 
+      it('sends instl if instl exists', () => {
+        const instl = { instl: 1 };
+        const bidRequestWithInstl = Object.assign({}, singleBannerBidRequest, {ortb2Imp: instl});
+
+        const reqs = spec.buildRequests([bidRequestWithInstl], defaultBidderRequest);
+
+        const req = extractPayloadOfFirstAndOnlyRequest(reqs);
+        expect(req.imp[0].instl).to.equal(1);
+      });
+
       it('sends tmax', () => {
         const reqs = spec.buildRequests([singleBannerBidRequest], defaultBidderRequest);
 
@@ -442,6 +452,16 @@ describe('smaatoBidAdapterTest', () => {
         expect(req.imp[0].bidfloor).to.be.equal(0.456);
       });
 
+      it('sends instl if instl exists', () => {
+        const instl = { instl: 1 };
+        const bidRequestWithInstl = Object.assign({}, singleVideoBidRequest, {ortb2Imp: instl});
+
+        const reqs = spec.buildRequests([bidRequestWithInstl], defaultBidderRequest);
+
+        const req = extractPayloadOfFirstAndOnlyRequest(reqs);
+        expect(req.imp[0].instl).to.equal(1);
+      });
+
       it('splits multi format bid requests', () => {
         const combinedBannerAndVideoBidRequest = {
           bidder: 'smaato',
@@ -523,6 +543,17 @@ describe('smaatoBidAdapterTest', () => {
             expect(req.imp[1].video.sequence).to.be.equal(2);
           });
 
+          it('sends instl if instl exists', () => {
+            const instl = { instl: 1 };
+            const bidRequestWithInstl = Object.assign({}, longFormVideoBidRequest, {ortb2Imp: instl});
+
+            const reqs = spec.buildRequests([bidRequestWithInstl], defaultBidderRequest);
+
+            const req = extractPayloadOfFirstAndOnlyRequest(reqs);
+            expect(req.imp[0].instl).to.equal(1);
+            expect(req.imp[1].instl).to.equal(1);
+          });
+
           it('sends bidfloor when configured', () => {
             const longFormVideoBidRequestWithFloor = Object.assign({}, longFormVideoBidRequest);
             longFormVideoBidRequestWithFloor.getFloor = function(arg) {

package/test/spec/modules/smartxBidAdapter_spec.js

@@ -189,6 +189,14 @@ describe('The smartx adapter', function () {
         domain: '',
         publisher: {
           id: '__name__'
+        },
+        content: {
+          ext: {
+            prebid: {
+              name: 'pbjs',
+              version: '$prebid.version$'
+            }
+          }
         }
       });
     });
@@ -525,6 +533,7 @@ describe('The smartx adapter', function () {
       bidderRequestObj.bidRequest.bids[0].params.outstream_options.title = 'abc';
       bidderRequestObj.bidRequest.bids[0].params.outstream_options.skipOffset = 2;
       bidderRequestObj.bidRequest.bids[0].params.outstream_options.desiredBitrate = 123;
+      bidderRequestObj.bidRequest.bids[0].params.outstream_options.visibilityThreshold = 30;
 
       responses[0].renderer.render(responses[0]);
 

package/test/spec/modules/tappxBidAdapter_spec.js

@@ -183,6 +183,10 @@ describe('Tappx bid adapter', function () {
       badBidRequest_v.bids.mediaTypes.video.playerSize = [320, 250];
       assert.isFalse(spec.isBidRequestValid(badBidRequest_v.bids));
     });
+
+    it('should export the TCF vendor ID', function () {
+      expect(spec.gvlid).to.equal(628);
+    })
   });
 
   /**

package/test/spec/modules/userId_spec.js

@@ -49,6 +49,7 @@ import {flocIdSubmodule} from 'modules/flocIdSystem.js'
 import {amxIdSubmodule} from '../../../modules/amxIdSystem.js';
 import {akamaiDAPIdSubmodule} from 'modules/akamaiDAPIdSystem.js'
 import {kinessoIdSubmodule} from 'modules/kinessoIdSystem.js'
+import * as mockGpt from '../integration/faker/googletag.js';
 
 let assert = require('chai').assert;
 let expect = require('chai').expect;
@@ -114,15 +115,21 @@ describe('User ID', function () {
 
   describe('Decorate Ad Units', function () {
     beforeEach(function () {
+      // reset mockGpt so nothing else interferes
+      mockGpt.disable();
+      mockGpt.enable();
       coreStorage.setCookie('pubcid', '', EXPIRED_COOKIE_DATE);
       coreStorage.setCookie('pubcid_alt', 'altpubcid200000', (new Date(Date.now() + 5000).toUTCString()));
       sinon.spy(coreStorage, 'setCookie');
+      sinon.stub(utils, 'logWarn');
     });
 
     afterEach(function () {
+      mockGpt.enable();
       $$PREBID_GLOBAL$$.requestBids.removeAll();
       config.resetConfig();
       coreStorage.setCookie.restore();
+      utils.logWarn.restore();
     });
 
     after(function () {
@@ -321,6 +328,50 @@ describe('User ID', function () {
       expect((getGlobal()).getUserIdsAsEids()).to.deep.equal(createEidsArray((getGlobal()).getUserIds()));
     });
 
+    it('should set googletag ppid correctly', function () {
+      let adUnits = [getAdUnitMock()];
+      setSubmoduleRegistry([amxIdSubmodule, sharedIdSystemSubmodule, identityLinkSubmodule]);
+      init(config);
+
+      config.setConfig({
+        userSync: {
+          ppid: 'pubcid.org',
+          userIds: [
+            { name: 'amxId', value: {'amxId': 'amx-id-value-amx-id-value-amx-id-value'} },
+            { name: 'pubCommonId', value: {'pubcid': 'pubCommon-id-value-pubCommon-id-value'} },
+            { name: 'identityLink', value: {'idl_env': 'identityLink-id-value-identityLink-id-value'} },
+          ]
+        }
+      });
+      // before ppid should not be set
+      expect(window.googletag._ppid).to.equal(undefined);
+      requestBidsHook(() => {}, {adUnits});
+      // ppid should have been set without dashes and stuff
+      expect(window.googletag._ppid).to.equal('pubCommonidvaluepubCommonidvalue');
+    });
+
+    it('should log a warning if PPID too big or small', function () {
+      let adUnits = [getAdUnitMock()];
+      setSubmoduleRegistry([sharedIdSystemSubmodule]);
+      init(config);
+
+      config.setConfig({
+        userSync: {
+          ppid: 'pubcid.org',
+          userIds: [
+            { name: 'pubCommonId', value: {'pubcid': 'pubcommonIdValue'} },
+          ]
+        }
+      });
+      // before ppid should not be set
+      expect(window.googletag._ppid).to.equal(undefined);
+      requestBidsHook(() => {}, {adUnits});
+      // ppid should NOT have been set
+      expect(window.googletag._ppid).to.equal(undefined);
+      // a warning should have been emmited
+      expect(utils.logWarn.args[0][0]).to.exist.and.to.contain('User ID - Googletag Publisher Provided ID for pubcid.org is not between 32 and 150 characters - pubcommonIdValue');
+    });
+
     it('pbjs.refreshUserIds refreshes', function() {
       let sandbox = sinon.createSandbox();
 

package/test/spec/modules/visxBidAdapter_spec.js

@@ -3,6 +3,7 @@ import { spec } from 'modules/visxBidAdapter.js';
 import { config } from 'src/config.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import * as utils from 'src/utils.js';
+import { makeSlot } from '../integration/faker/googletag.js';
 
 describe('VisxAdapter', function () {
   const adapter = newBidder(spec);
@@ -145,17 +146,17 @@ describe('VisxAdapter', function () {
     const expectedFullImps = [{
       'id': '30b31c1838de1e',
       'banner': {'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]},
-      'ext': {'bidder': {'uid': 903535}}
+      'ext': {'bidder': {'uid': 903535, 'adslotExists': false}}
     },
     {
       'id': '3150ccb55da321',
       'banner': {'format': [{'w': 728, 'h': 90}, {'w': 300, 'h': 250}]},
-      'ext': {'bidder': {'uid': 903535}}
+      'ext': {'bidder': {'uid': 903535, 'adslotExists': false}}
     },
     {
       'id': '42dbe3a7168a6a',
       'banner': {'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]},
-      'ext': {'bidder': {'uid': 903536}}
+      'ext': {'bidder': {'uid': 903536, 'adslotExists': false}}
     },
     {
       'id': '39a4e3a7168a6a',
@@ -452,7 +453,122 @@ describe('VisxAdapter', function () {
         'imp': [{
           'id': '39aff3a7169a6a',
           'banner': {'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]},
-          'ext': {'bidder': {'uid': 903538}}
+          'ext': {'bidder': {'uid': 903538, 'adslotExists': false}}
+        }],
+        'tmax': 3000,
+        'cur': ['EUR'],
+        'source': {
+          'ext': {
+            'wrapperType': 'Prebid_js',
+            'wrapperVersion': '$prebid.version$'
+          }
+        },
+        'site': {'page': referrer}
+      });
+    });
+  });
+
+  describe('buildRequests (check ad slot exists)', function () {
+    function parseRequest(url) {
+      const res = {};
+      (url.split('?')[1] || '').split('&').forEach((it) => {
+        const couple = it.split('=');
+        res[couple[0]] = decodeURIComponent(couple[1]);
+      });
+      return res;
+    }
+    const bidderRequest = {
+      timeout: 3000,
+      refererInfo: {
+        referer: 'https://example.com'
+      }
+    };
+    const referrer = bidderRequest.refererInfo.referer;
+    const bidRequests = [
+      {
+        'bidder': 'visx',
+        'params': {
+          'uid': 903535
+        },
+        'adUnitCode': 'visx-adunit-code-1',
+        'sizes': [[300, 250], [300, 600]],
+        'bidId': '30b31c1838de1e',
+        'bidderRequestId': '22edbae2733bf6',
+        'auctionId': '1d1a030790a475',
+      },
+      {
+        'bidder': 'visx',
+        'params': {
+          'uid': 903535
+        },
+        'adUnitCode': 'visx-adunit-code-2',
+        'sizes': [[300, 250], [300, 600]],
+        'bidId': '30b31c1838de1e',
+        'bidderRequestId': '22edbae2733bf6',
+        'auctionId': '1d1a030790a475',
+      }
+    ];
+    let sandbox;
+    let documentStub;
+
+    before(function() {
+      sandbox = sinon.sandbox.create();
+      documentStub = sandbox.stub(document, 'getElementById');
+      documentStub.withArgs('visx-adunit-code-1').returns({
+        id: 'visx-adunit-code-1'
+      });
+      documentStub.withArgs('visx-adunit-element-2').returns({
+        id: 'visx-adunit-element-2'
+      });
+    });
+
+    after(function() {
+      sandbox.restore();
+    });
+
+    it('should find ad slot by ad unit code as element id', function () {
+      const request = spec.buildRequests([bidRequests[0]], bidderRequest);
+      const payload = parseRequest(request.url);
+      expect(payload).to.be.an('object');
+      expect(payload).to.have.property('auids', '903535');
+
+      const postData = request.data;
+      expect(postData).to.be.an('object');
+      expect(postData).to.deep.equal({
+        'id': '22edbae2733bf6',
+        'imp': [{
+          'id': '30b31c1838de1e',
+          'banner': {'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]},
+          'ext': {'bidder': {'uid': 903535, 'adslotExists': true}}
+        }],
+        'tmax': 3000,
+        'cur': ['EUR'],
+        'source': {
+          'ext': {
+            'wrapperType': 'Prebid_js',
+            'wrapperVersion': '$prebid.version$'
+          }
+        },
+        'site': {'page': referrer}
+      });
+    });
+
+    it('should find ad slot by ad unit code as adUnitPath', function () {
+      makeSlot({code: 'visx-adunit-code-2', divId: 'visx-adunit-element-2'});
+
+      const request = spec.buildRequests([bidRequests[1]], bidderRequest);
+      const payload = parseRequest(request.url);
+      expect(payload).to.be.an('object');
+      expect(payload).to.have.property('auids', '903535');
+
+      const postData = request.data;
+      expect(postData).to.be.an('object');
+      expect(postData).to.deep.equal({
+        'id': '22edbae2733bf6',
+        'imp': [{
+          'id': '30b31c1838de1e',
+          'banner': {'format': [{'w': 300, 'h': 250}, {'w': 300, 'h': 600}]},
+          'ext': {'bidder': {'uid': 903535, 'adslotExists': true}}
         }],
         'tmax': 3000,
         'cur': ['EUR'],