prebid.js 6.0.0 → 6.4.0

package/test/spec/modules/targetVideoBidAdapter_spec.js

@@ -0,0 +1,96 @@
+import { spec } from '../../../modules/targetVideoBidAdapter.js'
+
+describe('TargetVideo Bid Adapter', function() {
+  const bannerRequest = [{
+    bidder: 'targetVideo',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]],
+      }
+    },
+    params: {
+      placementId: 12345,
+    }
+  }];
+
+  it('Test the bid validation function', function() {
+    const validBid = spec.isBidRequestValid(bannerRequest[0]);
+    const invalidBid = spec.isBidRequestValid(null);
+
+    expect(validBid).to.be.true;
+    expect(invalidBid).to.be.false;
+  });
+
+  it('Test the request processing function', function () {
+    const request = spec.buildRequests(bannerRequest, bannerRequest[0]);
+    expect(request).to.not.be.empty;
+
+    const payload = JSON.parse(request.data);
+    expect(payload).to.not.be.empty;
+    expect(payload.sdk).to.deep.equal({
+      source: 'pbjs',
+      version: '$prebid.version$'
+    });
+    expect(payload.tags[0].id).to.equal(12345);
+    expect(payload.tags[0].gpid).to.equal('targetVideo');
+    expect(payload.tags[0].ad_types[0]).to.equal('video');
+  });
+
+  it('Handle nobid responses', function () {
+    const responseBody = {
+      'version': '0.0.1',
+      'tags': [{
+        'uuid': '84ab500420319d',
+        'tag_id': 5976557,
+        'auction_id': '297492697822162468',
+        'nobid': true
+      }]
+    };
+    const bidderRequest = null;
+
+    const bidResponse = spec.interpretResponse({ body: responseBody }, {bidderRequest});
+    expect(bidResponse.length).to.equal(0);
+  });
+
+  it('Test the response parsing function', function () {
+    const responseBody = {
+      'tags': [{
+        'uuid': '84ab500420319d',
+        'ads': [{
+          'ad_type': 'video',
+          'cpm': 0.500000,
+          'notify_url': 'https://www.target-video.com/',
+          'rtb': {
+            'video': {
+              'player_width': 640,
+              'player_height': 360,
+              'asset_url': 'https://www.target-video.com/'
+            }
+          }
+        }]
+      }]
+    };
+    const bidderRequest = {
+      bids: [{
+        bidId: '84ab500420319d',
+        adUnitCode: 'code',
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250]]
+          }
+        }
+      }]
+    };
+
+    const bidResponse = spec.interpretResponse({ body: responseBody }, {bidderRequest});
+    expect(bidResponse).to.not.be.empty;
+
+    const bid = bidResponse[0];
+    expect(bid).to.not.be.empty;
+    expect(bid.cpm).to.equal(0.675);
+    expect(bid.width).to.equal(300);
+    expect(bid.height).to.equal(250);
+    expect(bid.ad).to.include('<script src="https://player.target-video.com/custom/targetvideo-banner.js"></script>')
+    expect(bid.ad).to.include('initPlayer')
+  });
+});

package/test/spec/modules/trustxBidAdapter_spec.js

@@ -519,6 +519,48 @@ describe('TrustXAdapter', function () {
       expect(payload.tmax).to.equal(3000);
       getConfigStub.restore();
     });
+    it('should contain imp[].ext.data.adserver if available', function() {
+      const ortb2Imp = [{
+        ext: {
+          data: {
+            adserver: {
+              name: 'ad_server_name',
+              adslot: '/111111/slot'
+            },
+            pbadslot: '/111111/slot'
+          }
+        }
+      }, {
+        ext: {
+          data: {
+            adserver: {
+              name: 'ad_server_name',
+              adslot: '/222222/slot'
+            },
+            pbadslot: '/222222/slot'
+          }
+        }
+      }];
+      const bidRequestsWithOrtb2Imp = bidRequests.slice(0, 3).map((bid, ind) => {
+        return Object.assign(ortb2Imp[ind] ? { ortb2Imp: ortb2Imp[ind] } : {}, bid);
+      });
+      const request = spec.buildRequests(bidRequestsWithOrtb2Imp, bidderRequest);
+      expect(request.data).to.be.an('string');
+      const payload = parseRequest(request.data);
+      expect(payload.imp[0].ext).to.deep.equal({
+        divid: bidRequests[0].adUnitCode,
+        data: ortb2Imp[0].ext.data,
+        gpid: ortb2Imp[0].ext.data.adserver.adslot
+      });
+      expect(payload.imp[1].ext).to.deep.equal({
+        divid: bidRequests[1].adUnitCode,
+        data: ortb2Imp[1].ext.data,
+        gpid: ortb2Imp[1].ext.data.adserver.adslot
+      });
+      expect(payload.imp[2].ext).to.deep.equal({
+        divid: bidRequests[2].adUnitCode
+      });
+    });
     it('all id like request fields must be a string', function () {
       const bidderRequestWithNumId = Object.assign({}, bidderRequest, { bidderRequestId: 123123, auctionId: 345345543 });
 

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/vidoomyBidAdapter_spec.js

@@ -4,6 +4,7 @@ import { newBidder } from 'src/adapters/bidderFactory.js';
 import { INSTREAM } from '../../../src/video';
 
 const ENDPOINT = `https://d.vidoomy.com/api/rtbserver/prebid/`;
+const PIXELS = ['/test.png', '/test2.png?gdpr={{GDPR}}&gdpr_consent={{GDPR_CONSENT}}']
 
 describe('vidoomyBidAdapter', function() {
   const adapter = newBidder(spec);
@@ -101,24 +102,24 @@ describe('vidoomyBidAdapter', function() {
     });
 
     it('attaches source and version to endpoint URL as query params', function () {
-      expect(request[0].url).to.include(ENDPOINT);
-      expect(request[1].url).to.include(ENDPOINT);
+      expect(request[0].url).to.equal(ENDPOINT);
+      expect(request[1].url).to.equal(ENDPOINT);
     });
 
     it('only accepts first width and height sizes', function () {
-      expect(request[0].url).to.include('w=300');
-      expect(request[0].url).to.include('h=250');
-      expect(request[0].url).to.not.include('w=200');
-      expect(request[0].url).to.not.include('h=100');
-      expect(request[1].url).to.include('w=400');
-      expect(request[1].url).to.include('h=225');
+      expect('' + request[0].data.w).to.equal('300');
+      expect('' + request[0].data.h).to.equal('250');
+      expect('' + request[0].data.w).to.not.equal('200');
+      expect('' + request[0].data.h).to.not.equal('100');
+      expect('' + request[1].data.w).to.equal('400');
+      expect('' + request[1].data.h).to.equal('225');
     });
 
     it('should send id and pid parameters', function () {
-      expect(request[0].url).to.include('id=123123');
-      expect(request[0].url).to.include('pid=123123');
-      expect(request[1].url).to.include('id=456456');
-      expect(request[1].url).to.include('pid=456456');
+      expect('' + request[0].data.id).to.equal('123123');
+      expect('' + request[0].data.pid).to.equal('123123');
+      expect('' + request[1].data.id).to.equal('456456');
+      expect('' + request[1].data.pid).to.equal('456456');
     });
   });
 
@@ -182,7 +183,8 @@ describe('vidoomyBidAdapter', function() {
           'networkName': null,
           'primaryCatId': 'IAB3-1',
           'secondaryCatIds': null
-        }
+        },
+        'pixels': PIXELS
       }
     }
 
@@ -206,5 +208,22 @@ describe('vidoomyBidAdapter', function() {
 
       expect(result[0].requestId).to.equal(serverResponseBanner.body.requestId);
     });
+
+    it('should sync user cookies', function () {
+      const GDPR_CONSENT = 'GDPR_TEST'
+      const result = spec.getUserSyncs({
+        pixelEnabled: true
+      }, [serverResponseBanner], { consentString: GDPR_CONSENT, gdprApplies: 1 }, null)
+      expect(result).to.eql([
+        {
+          type: 'image',
+          url: PIXELS[0]
+        },
+        {
+          type: 'image',
+          url: `/test2.png?gdpr=1&gdpr_consent=${GDPR_CONSENT}`
+        }
+      ])
+    });
   });
 });

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'],
@@ -1149,7 +1265,7 @@ describe('VisxAdapter', function () {
     it('onTimeout', function () {
       const data = { timeout: 3000, bidId: '23423', params: { uid: 1 } };
       spec.onTimeout(data);
-      expect(utils.triggerPixel.calledOnceWith('https://t.visx.net/track/bid_timeout?data=' + JSON.stringify(data))).to.equal(true);
+      expect(utils.triggerPixel.calledOnceWith('https://t.visx.net/track/bid_timeout//' + JSON.stringify(data))).to.equal(true);
     });
   });