prebid.js 5.18.0 → 6.1.0

package/test/spec/modules/outbrainBidAdapter_spec.js

@@ -2,6 +2,7 @@ import {expect} from 'chai';
 import {spec} from 'modules/outbrainBidAdapter.js';
 import {config} from 'src/config.js';
 import {server} from 'test/mocks/xhr';
+import { createEidsArray } from 'modules/userId/eids.js';
 
 describe('Outbrain Adapter', function () {
   describe('Bid request and response', function () {
@@ -344,6 +345,23 @@ describe('Outbrain Adapter', function () {
 
         config.resetConfig()
       });
+
+      it('should pass extended ids', function () {
+        let bidRequest = {
+          bidId: 'bidId',
+          params: {},
+          userIdAsEids: createEidsArray({
+            idl_env: 'id-value',
+          }),
+          ...commonBidRequest,
+        };
+
+        let res = spec.buildRequests([bidRequest], commonBidderRequest);
+        const resData = JSON.parse(res.data)
+        expect(resData.user.ext.eids).to.deep.equal([
+          {source: 'liveramp.com', uids: [{id: 'id-value', atype: 3}]}
+        ]);
+      });
     })
 
     describe('interpretResponse', function () {

package/test/spec/modules/prebidServerBidAdapter_spec.js

@@ -507,6 +507,17 @@ describe('S2S Adapter', function () {
       resetSyncedStatus();
     });
 
+    it('should set id to auction ID and source.tid to tid', function () {
+      config.setConfig({ s2sConfig: CONFIG });
+
+      adapter.callBids(OUTSTREAM_VIDEO_REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+
+      const requestBid = JSON.parse(server.requests[0].requestBody);
+      expect(requestBid.id).to.equal('173afb6d132ba3');
+      expect(requestBid.source).to.be.an('object');
+      expect(requestBid.source.tid).to.equal('437fbbf5-33f5-487a-8e16-a7112903cfe5');
+    });
+
     it('should block request if config did not define p1Consent URL in endpoint object config', function() {
       let badConfig = utils.deepClone(CONFIG);
       badConfig.endpoint = { noP1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction' };
@@ -1705,7 +1716,7 @@ describe('S2S Adapter', function () {
       expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({name: 'pbjs', version: 'v$prebid.version$'});
     });
 
-    it('does not set pbjs version in request if channel does exist in s2sConfig', () => {
+    it('extPrebid is now mergedDeep -> should include default channel as well', () => {
       const s2sBidRequest = utils.deepClone(REQUEST);
       const bidRequests = utils.deepClone(BID_REQUESTS);
 
@@ -1714,7 +1725,13 @@ describe('S2S Adapter', function () {
       adapter.callBids(s2sBidRequest, bidRequests, addBidResponse, done, ajax);
 
       const parsedRequestBody = JSON.parse(server.requests[0].requestBody);
-      expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({test: 1});
+
+      // extPrebid is now deep merged with
+      expect(parsedRequestBody.ext.prebid.channel).to.deep.equal({
+        name: 'pbjs',
+        test: 1,
+        version: 'v$prebid.version$'
+      });
     });
 
     it('passes first party data in request', () => {

package/test/spec/modules/publinkIdSystem_spec.js

@@ -47,12 +47,6 @@ describe('PublinkIdSystem', () => {
       expect(result.id).to.equal(LOCAL_VALUE.publink);
       storage.removeDataFromLocalStorage(PUBLINK_COOKIE);
     });
-    it('ignore expired cookie', () => {
-      storage.setDataInLocalStorage(PUBLINK_COOKIE, JSON.stringify({publink: 'value', exp: Date.now() - 60 * 60 * 24 * 1000}));
-      const result = publinkIdSubmodule.getId();
-      expect(result.id).to.be.undefined;
-      storage.removeDataFromLocalStorage(PUBLINK_COOKIE);
-    });
     it('priority goes to publink_srv cookie', () => {
       storage.setCookie(PUBLINK_SRV_COOKIE, JSON.stringify(COOKIE_VALUE), COOKIE_EXPIRATION);
       storage.setDataInLocalStorage(PUBLINK_COOKIE, JSON.stringify(LOCAL_VALUE));
@@ -61,6 +55,12 @@ describe('PublinkIdSystem', () => {
       storage.setCookie(PUBLINK_SRV_COOKIE, '', DELETE_COOKIE);
       storage.removeDataFromLocalStorage(PUBLINK_COOKIE);
     });
+    it('publink non-json cookie', () => {
+      storage.setCookie(PUBLINK_COOKIE, COOKIE_VALUE.publink, COOKIE_EXPIRATION);
+      const result = publinkIdSubmodule.getId();
+      expect(result.id).to.equal(COOKIE_VALUE.publink);
+      storage.setCookie(PUBLINK_COOKIE, '', DELETE_COOKIE);
+    });
   });
 
   describe('getId', () => {

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

@@ -287,6 +287,13 @@ 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 tmax', () => {
         const reqs = spec.buildRequests([singleBannerBidRequest], defaultBidderRequest);
 
@@ -854,6 +861,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/sonobiBidAdapter_spec.js

@@ -238,14 +238,17 @@ describe('SonobiBidAdapter', function () {
   });
 
   describe('.buildRequests', function () {
+    let sandbox;
     beforeEach(function() {
       sinon.stub(userSync, 'canBidderRegisterSync');
       sinon.stub(utils, 'getGptSlotInfoForAdUnitCode')
-        .onFirstCall().returns({gptSlot: '/123123/gpt_publisher/adunit-code-3', divId: 'adunit-code-3-div-id'})
+        .onFirstCall().returns({gptSlot: '/123123/gpt_publisher/adunit-code-3', divId: 'adunit-code-3-div-id'});
+      sandbox = sinon.createSandbox();
     });
     afterEach(function() {
       userSync.canBidderRegisterSync.restore();
       utils.getGptSlotInfoForAdUnitCode.restore();
+      sandbox.restore();
     });
     let bidRequest = [{
       'schain': {
@@ -333,6 +336,36 @@ describe('SonobiBidAdapter', function () {
       uspConsent: 'someCCPAString'
     };
 
+    it('should set fpd if there is any data in ortb2', function() {
+      const ortb2 = {
+        site: {
+          ext: {
+            data: {
+              pageType: 'article',
+              category: 'tools'
+            }
+          }
+        },
+        user: {
+          ext: {
+            data: {
+              registered: true,
+              interests: ['cars']
+            }
+          }
+        }
+      };
+
+      sandbox.stub(config, 'getConfig').callsFake(key => {
+        const config = {
+          ortb2: ortb2
+        };
+        return utils.deepAccess(config, key);
+      });
+      const bidRequests = spec.buildRequests(bidRequest, bidderRequests);
+      expect(bidRequests.data.fpd).to.equal(JSON.stringify(ortb2));
+    });
+
     it('should populate coppa as 1 if set in config', function () {
       config.setConfig({coppa: true});
       const bidRequests = spec.buildRequests(bidRequest, bidderRequests);

package/test/spec/modules/sortableBidAdapter_spec.js

@@ -112,6 +112,13 @@ describe('sortableBidAdapter', function() {
           'key2': 'val2'
         }
       },
+      'ortb2Imp': {
+        'ext': {
+          'data': {
+            'pbadslot': 'abc/123'
+          }
+        }
+      },
       'sizes': [
         [300, 250]
       ],
@@ -176,6 +183,10 @@ describe('sortableBidAdapter', function() {
       expect(requestBody.imp[0].floor).to.equal(0.21);
     });
 
+    it('includes pbadslot in the bid request', function () {
+      expect(requestBody.imp[0].ext.gpid).to.equal('abc/123');
+    });
+
     it('sets domain and href correctly', function () {
       expect(requestBody.site.domain).to.equal('example.com');
       expect(requestBody.site.page).to.equal('http://example.com/page?param=val');

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

@@ -582,6 +582,138 @@ describe('teadsBidAdapter', () => {
       });
     });
 
+    describe('Global Placement Id', function () {
+      let bidRequests = [
+        {
+          'bidder': 'teads',
+          'params': {
+            'placementId': 10433394,
+            'pageId': 1234
+          },
+          'adUnitCode': 'adunit-code-1',
+          'sizes': [[300, 250], [300, 600]],
+          'bidId': '30b31c1838de1e',
+          'bidderRequestId': '22edbae2733bf6',
+          'auctionId': '1d1a030790a475',
+          'creativeId': 'er2ee',
+          'deviceWidth': 1680
+        },
+        {
+          'bidder': 'teads',
+          'params': {
+            'placementId': 10433395,
+            'pageId': 1234
+          },
+          'adUnitCode': 'adunit-code-2',
+          'sizes': [[300, 250], [300, 600]],
+          'bidId': '30b31c1838de1f',
+          'bidderRequestId': '22edbae2733bf6',
+          'auctionId': '1d1a030790a475',
+          'creativeId': 'er2ef',
+          'deviceWidth': 1680
+        }
+      ];
+
+      it('should add gpid if ortb2Imp.ext.data.pbadslot is present and is non empty (and ortb2Imp.ext.data.adserver.adslot is not present)', function () {
+        const updatedBidRequests = bidRequests.map(function(bidRequest, index) {
+          return {
+            ...bidRequest,
+            ortb2Imp: {
+              ext: {
+                data: {
+                  pbadslot: '1111/home-left-' + index
+                }
+              }
+            }
+          };
+        }
+        );
+        const request = spec.buildRequests(updatedBidRequests, bidderResquestDefault);
+        const payload = JSON.parse(request.data);
+
+        expect(payload.data[0].gpid).to.equal('1111/home-left-0');
+        expect(payload.data[1].gpid).to.equal('1111/home-left-1');
+      });
+
+      it('should add gpid if ortb2Imp.ext.data.pbadslot is present and is non empty (even if ortb2Imp.ext.data.adserver.adslot is present and is non empty too)', function () {
+        const updatedBidRequests = bidRequests.map(function(bidRequest, index) {
+          return {
+            ...bidRequest,
+            ortb2Imp: {
+              ext: {
+                data: {
+                  pbadslot: '1111/home-left-' + index,
+                  adserver: {
+                    adslot: '1111/home-left/div-' + index
+                  }
+                }
+              }
+            }
+          };
+        }
+        );
+        const request = spec.buildRequests(updatedBidRequests, bidderResquestDefault);
+        const payload = JSON.parse(request.data);
+
+        expect(payload.data[0].gpid).to.equal('1111/home-left-0');
+        expect(payload.data[1].gpid).to.equal('1111/home-left-1');
+      });
+
+      it('should not add gpid if both ortb2Imp.ext.data.pbadslot and ortb2Imp.ext.data.adserver.adslot are present but empty', function () {
+        const updatedBidRequests = bidRequests.map(bidRequest => ({
+          ...bidRequest,
+          ortb2Imp: {
+            ext: {
+              data: {
+                pbadslot: '',
+                adserver: {
+                  adslot: ''
+                }
+              }
+            }
+          }
+        }));
+
+        const request = spec.buildRequests(updatedBidRequests, bidderResquestDefault);
+        const payload = JSON.parse(request.data);
+
+        return payload.data.forEach(bid => {
+          expect(bid).not.to.have.property('gpid');
+        });
+      });
+
+      it('should not add gpid if both ortb2Imp.ext.data.pbadslot and ortb2Imp.ext.data.adserver.adslot are not present', function () {
+        const request = spec.buildRequests(bidRequests, bidderResquestDefault);
+        const payload = JSON.parse(request.data);
+
+        return payload.data.forEach(bid => {
+          expect(bid).not.to.have.property('gpid');
+        });
+      });
+
+      it('should add gpid if ortb2Imp.ext.data.pbadslot is not present but ortb2Imp.ext.data.adserver.adslot is present and is non empty', function () {
+        const updatedBidRequests = bidRequests.map(function(bidRequest, index) {
+          return {
+            ...bidRequest,
+            ortb2Imp: {
+              ext: {
+                data: {
+                  adserver: {
+                    adslot: '1111/home-left-' + index
+                  }
+                }
+              }
+            }
+          };
+        });
+        const request = spec.buildRequests(updatedBidRequests, bidderResquestDefault);
+        const payload = JSON.parse(request.data);
+
+        expect(payload.data[0].gpid).to.equal('1111/home-left-0');
+        expect(payload.data[1].gpid).to.equal('1111/home-left-1');
+      });
+    });
+
     function checkMediaTypesSizes(mediaTypes, expectedSizes) {
       const bidRequestWithBannerSizes = Object.assign(bidRequests[0], mediaTypes);
       const requestWithBannerSizes = spec.buildRequests([bidRequestWithBannerSizes], bidderResquestDefault);

package/test/spec/modules/tripleliftBidAdapter_spec.js

@@ -568,6 +568,134 @@ describe('triplelift adapter', function () {
       expect(payload.user.ext.eids).to.have.lengthOf(4);
     });
 
+    it('should remove malformed ids that would otherwise break call', function () {
+      let tdidId = '6bca7f6b-a98a-46c0-be05-6020f7604598';
+      let idlEnvId = null; // fail; can't be null
+      let criteoId = '53e30ea700424f7bbdd793b02abc5d7';
+      let pubcid = ''; // fail; can't be empty string
+
+      let bidRequestsMultiple = [
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } }
+      ];
+
+      let request = tripleliftAdapterSpec.buildRequests(bidRequestsMultiple, bidderRequest);
+      let payload = request.data;
+
+      expect(payload.user).to.deep.equal({
+        ext: {
+          eids: [
+            {
+              source: 'adserver.org',
+              uids: [
+                {
+                  id: tdidId,
+                  ext: { rtiPartner: 'TDID' }
+                }
+              ],
+            },
+            {
+              source: 'criteo.com',
+              uids: [
+                {
+                  id: criteoId,
+                  ext: { rtiPartner: 'criteoId' }
+                }
+              ]
+            }
+          ]
+        }
+      });
+
+      expect(payload.user.ext.eids).to.be.an('array');
+      expect(payload.user.ext.eids).to.have.lengthOf(2);
+
+      tdidId = {}; // fail; can't be empty object
+      idlEnvId = { id: '987654' }; // pass
+      criteoId = [{ id: '123456' }]; // fail; can't be an array
+      pubcid = '3261d8ad-435d-481d-abd1-9f1a9ec99f0e'; // pass
+
+      bidRequestsMultiple = [
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } }
+      ];
+
+      request = tripleliftAdapterSpec.buildRequests(bidRequestsMultiple, bidderRequest);
+      payload = request.data;
+
+      expect(payload.user).to.deep.equal({
+        ext: {
+          eids: [
+            {
+              source: 'liveramp.com',
+              uids: [
+                {
+                  id: '987654',
+                  ext: { rtiPartner: 'idl' }
+                }
+              ]
+            },
+            {
+              source: 'pubcid.org',
+              uids: [
+                {
+                  id: pubcid,
+                  ext: { rtiPartner: 'pubcid' }
+                }
+              ]
+            }
+          ]
+        }
+      });
+
+      expect(payload.user.ext.eids).to.be.an('array');
+      expect(payload.user.ext.eids).to.have.lengthOf(2);
+
+      tdidId = { id: '987654' }; // pass
+      idlEnvId = { id: 987654 }; // fail; can't be an int
+      criteoId = '53e30ea700424f7bbdd793b02abc5d7'; // pass
+      pubcid = { id: '' }; // fail; can't be an empty string
+
+      bidRequestsMultiple = [
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } },
+        { ...bidRequests[0], userId: { tdid: tdidId, idl_env: idlEnvId, criteoId, pubcid } }
+      ];
+
+      request = tripleliftAdapterSpec.buildRequests(bidRequestsMultiple, bidderRequest);
+      payload = request.data;
+
+      expect(payload.user).to.deep.equal({
+        ext: {
+          eids: [
+            {
+              source: 'adserver.org',
+              uids: [
+                {
+                  id: '987654',
+                  ext: { rtiPartner: 'TDID' }
+                }
+              ],
+            },
+            {
+              source: 'criteo.com',
+              uids: [
+                {
+                  id: criteoId,
+                  ext: { rtiPartner: 'criteoId' }
+                }
+              ]
+            }
+          ]
+        }
+      });
+
+      expect(payload.user.ext.eids).to.be.an('array');
+      expect(payload.user.ext.eids).to.have.lengthOf(2);
+    });
+
     it('should return a query string for TL call', function () {
       const request = tripleliftAdapterSpec.buildRequests(bidRequests, bidderRequest);
       const url = request.url;

package/test/spec/modules/trustxBidAdapter_spec.js

@@ -402,7 +402,7 @@ describe('TrustXAdapter', function () {
     });
 
     it('if segment is present in permutive targeting, payload must have right params', function () {
-      const permSegments = ['test_perm_1', 'test_perm_2'];
+      const permSegments = [{id: 'test_perm_1'}, {id: 'test_perm_2'}];
       const bidRequestsWithPermutiveTargeting = bidRequests.map((bid) => {
         return Object.assign({
           rtd: {
@@ -421,8 +421,8 @@ describe('TrustXAdapter', function () {
       expect(payload.user.data).to.deep.equal([{
         name: 'permutive',
         segment: [
-          {name: 'p_standard', value: permSegments[0]},
-          {name: 'p_standard', value: permSegments[1]}
+          {name: 'p_standard', value: permSegments[0].id},
+          {name: 'p_standard', value: permSegments[1].id}
         ]
       }]);
     });
@@ -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 });