prebid.js 5.20.0 → 6.3.0

package/test/spec/modules/rubiconBidAdapter_spec.js

@@ -3343,6 +3343,23 @@ describe('the rubicon adapter', function () {
         type: 'iframe', url: `${emilyUrl}?gdpr_consent=foo&us_privacy=1NYN`
       });
     });
+
+    it('should pass gdprApplies', function () {
+      expect(spec.getUserSyncs({iframeEnabled: true}, {}, {
+        gdprApplies: true
+      }, '1NYN')).to.deep.equal({
+        type: 'iframe', url: `${emilyUrl}?gdpr=1&us_privacy=1NYN`
+      });
+    });
+
+    it('should pass all correctly', function () {
+      expect(spec.getUserSyncs({iframeEnabled: true}, {}, {
+        gdprApplies: true,
+        consentString: 'foo'
+      }, '1NYN')).to.deep.equal({
+        type: 'iframe', url: `${emilyUrl}?gdpr=1&gdpr_consent=foo&us_privacy=1NYN`
+      });
+    });
   });
 
   describe('get price granularity', function () {

package/test/spec/modules/seedtagBidAdapter_spec.js

@@ -274,6 +274,9 @@ describe('Seedtag Adapter', function() {
           expect(data.ga).to.equal(true)
           expect(data.cd).to.equal('consentString')
         })
+        it('should expose gvlid', function() {
+          expect(spec.gvlid).to.equal(157)
+        })
       })
     })
 

package/test/spec/modules/sharedIdSystem_spec.js

@@ -50,10 +50,10 @@ describe('SharedId System', function () {
       expect(callbackSpy.calledOnce).to.be.true;
       expect(callbackSpy.lastCall.lastArg).to.equal(UUID);
     });
-    it('should log message if coppa is set', function () {
+    it('should abort if coppa is set', function () {
       coppaDataHandlerDataStub.returns('true');
-      sharedIdSystemSubmodule.getId({});
-      expect(utils.logInfo.args[0][0]).to.exist.and.to.equal('PubCommonId: IDs not provided for coppa requests, exiting PubCommonId');
+      const result = sharedIdSystemSubmodule.getId({});
+      expect(result).to.be.undefined;
     });
   });
   describe('SharedId System extendId()', function () {
@@ -85,10 +85,56 @@ describe('SharedId System', function () {
       let pubcommId = sharedIdSystemSubmodule.extendId(config, undefined, 'TestId').id;
       expect(pubcommId).to.equal('TestId');
     });
-    it('should log message if coppa is set', function () {
+    it('should abort if coppa is set', function () {
       coppaDataHandlerDataStub.returns('true');
-      sharedIdSystemSubmodule.extendId({}, undefined, 'TestId');
-      expect(utils.logInfo.args[0][0]).to.exist.and.to.equal('PubCommonId: IDs not provided for coppa requests, exiting PubCommonId');
+      const result = sharedIdSystemSubmodule.extendId({params: {extend: true}}, undefined, 'TestId');
+      expect(result).to.be.undefined;
+    });
+  });
+
+  describe('SharedID System domainOverride', () => {
+    let sandbox, domain, cookies, rejectCookiesFor;
+
+    beforeEach(() => {
+      sandbox = sinon.createSandbox();
+      sandbox.stub(document, 'domain').get(() => domain);
+      cookies = {};
+      sandbox.stub(storage, 'getCookie').callsFake((key) => cookies[key]);
+      rejectCookiesFor = null;
+      sandbox.stub(storage, 'setCookie').callsFake((key, value, expires, sameSite, domain) => {
+        if (domain !== rejectCookiesFor) {
+          if (expires != null) {
+            expires = new Date(expires);
+          }
+          if (expires == null || expires > Date.now()) {
+            cookies[key] = value;
+          } else {
+            delete cookies[key];
+          }
+        }
+      });
+    });
+
+    afterEach(() => {
+      sandbox.restore();
+    });
+
+    it('should return TLD if cookies can be set there', () => {
+      domain = 'sub.domain.com';
+      rejectCookiesFor = 'com';
+      expect(sharedIdSystemSubmodule.domainOverride()).to.equal('domain.com');
+    });
+
+    it('should return undefined when cookies cannot be set', () => {
+      domain = 'sub.domain.com';
+      rejectCookiesFor = 'sub.domain.com';
+      expect(sharedIdSystemSubmodule.domainOverride()).to.be.undefined;
+    });
+
+    it('should return half-way domain if parent domain rejects cookies', () => {
+      domain = 'inner.outer.domain.com';
+      rejectCookiesFor = 'domain.com';
+      expect(sharedIdSystemSubmodule.domainOverride()).to.equal('outer.domain.com');
     });
   });
 });

package/test/spec/modules/smaatoBidAdapter_spec.js

@@ -287,6 +287,23 @@ describe('smaatoBidAdapterTest', () => {
         expect(req.regs.ext.us_privacy).to.equal('uspConsentString');
       });
 
+      it('sends no schain if no schain exists', () => {
+        const reqs = spec.buildRequests([singleBannerBidRequest], defaultBidderRequest);
+
+        const req = extractPayloadOfFirstAndOnlyRequest(reqs);
+        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);
 
@@ -435,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',
@@ -516,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) {
@@ -854,6 +892,29 @@ describe('smaatoBidAdapterTest', () => {
         expect(req.user.ext.eids).to.have.length(2);
       });
     });
+
+    describe('schain in request', () => {
+      it('schain is added to source.ext.schain', () => {
+        const schain = {
+          ver: '1.0',
+          complete: 1,
+          nodes: [
+            {
+              'asi': 'asi',
+              'sid': 'sid',
+              'rid': 'rid',
+              'hp': 1
+            }
+          ]
+        };
+        const bidRequestWithSchain = Object.assign({}, singleBannerBidRequest, {schain: schain});
+
+        const reqs = spec.buildRequests([bidRequestWithSchain], defaultBidderRequest);
+
+        const req = extractPayloadOfFirstAndOnlyRequest(reqs);
+        expect(req.source.ext.schain).to.deep.equal(schain);
+      });
+    });
   });
 
   describe('interpretResponse', () => {

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

@@ -518,6 +518,33 @@ describe('SSPBC adapter', function () {
       expect(payload.user).to.be.an('object').and.to.have.property('[ortb_extensions.consent]', bidRequest.gdprConsent.consentString);
     });
 
+    it('should send net info and pvid', function () {
+      expect(payload.user).to.be.an('object').and.to.have.property('data').that.is.an('array');
+
+      const userData = payload.user.data;
+      expect(userData.length).to.equal(2);
+
+      const netInfo = userData[0];
+      expect(netInfo.id).to.equal('12');
+      expect(netInfo.name).to.equal('NetInfo');
+      expect(netInfo).to.have.property('segment').that.is.an('array');
+
+      const pvid = userData[1];
+      expect(pvid.id).to.equal('7');
+      expect(pvid.name).to.equal('pvid');
+      expect(pvid).to.have.property('segment').that.is.an('array');
+      expect(pvid.segment[0]).to.have.property('value');
+    });
+
+    it('pvid should be constant on a single page view', function () {
+      const userData1 = payload.user.data;
+      const userData2 = payloadNative.user.data;
+      const pvid1 = userData1[1];
+      const pvid2 = userData2[1];
+
+      expect(pvid1.segment[0].value).to.equal(pvid2.segment[0].value);
+    });
+
     it('should build correct native payload', function () {
       const nativeAssets = payloadNative.imp && payloadNative.imp[0].native.request;
 
@@ -543,13 +570,16 @@ describe('SSPBC adapter', function () {
       expect(videoAssets).to.have.property('api').that.is.an('array');
     });
 
-    it('should create auxilary placement identifier (size_numUsed)', function () {
+    it('should create auxilary placement identifier (size_numUsed), that is constant for a given adUnit', function () {
       const extAssets1 = payload.imp && payload.imp[0].ext.data;
       const extAssets2 = payloadSingle.imp && payloadSingle.imp[0].ext.data;
 
-      // note that payload comes from first, and payloadSingle from second auction in the test run
+      /*
+        note that payload comes from first, and payloadSingle from second auction in the test run
+        also, since both have same adUnitName, value of pbsize property should be the same
+      */
       expect(extAssets1).to.have.property('pbsize').that.equals('750x200_1')
-      expect(extAssets2).to.have.property('pbsize').that.equals('750x200_2')
+      expect(extAssets2).to.have.property('pbsize').that.equals('750x200_1')
     });
   });
 

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/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}`
+        }
+      ])
+    });
   });
 });