prebid.js 6.5.0 → 6.9.0

package/test/spec/modules/adbookpspBidAdapter_spec.js

@@ -504,9 +504,11 @@ describe('adbookpsp bid adapter', () => {
           ad: '<div>ad</div>',
           adId: '5',
           adserverTargeting: {
+            hb_ad_ord_adbookpsp: '0_0', // the value to the left of the underscore represents the index of the ad id and the number to the right represents the order index
             hb_adid_c_adbookpsp: '5',
             hb_deal_adbookpsp: 'werwetwerw',
             hb_liid_adbookpsp: '2342345',
+            hb_ordid_adbookpsp: '567843',
           },
           referrer: 'http://prebid-test-page.io:8080/banner.html',
           lineItemId: '2342345',
@@ -516,9 +518,11 @@ describe('adbookpsp bid adapter', () => {
           adId: '10',
           adUnitCode: 'div-gpt-ad-837465923534-0',
           adserverTargeting: {
+            hb_ad_ord_adbookpsp: '0_0',
             hb_adid_c_adbookpsp: '10',
             hb_deal_adbookpsp: 'dsfxcxcvxc',
             hb_liid_adbookpsp: '2121221',
+            hb_ordid_adbookpsp: '5678234',
           },
           bidId: 'bid4321',
           bidderRequestId: '999ccceeee11',
@@ -556,14 +560,18 @@ describe('adbookpsp bid adapter', () => {
 
       expect(bids).to.have.length(2);
       expect(bids[0].adserverTargeting).to.deep.equal({
+        hb_ad_ord_adbookpsp: '0_0',
+        hb_adid_c_adbookpsp: '5',
         hb_deal_adbookpsp: 'werwetwerw',
         hb_liid_adbookpsp: '2342345',
-        hb_adid_c_adbookpsp: '5',
+        hb_ordid_adbookpsp: '567843',
       });
       expect(bids[1].adserverTargeting).to.deep.equal({
+        hb_ad_ord_adbookpsp: '0_0',
+        hb_adid_c_adbookpsp: '10',
         hb_deal_adbookpsp: 'dsfxcxcvxc',
         hb_liid_adbookpsp: '2121221',
-        hb_adid_c_adbookpsp: '10',
+        hb_ordid_adbookpsp: '5678234',
       });
     });
 
@@ -580,9 +588,11 @@ describe('adbookpsp bid adapter', () => {
       expect(bids).to.have.length(2);
       for (const bid of bids) {
         expect(bid.adserverTargeting).to.deep.equal({
+          hb_ad_ord_adbookpsp: '0_0,1_0',
+          hb_adid_c_adbookpsp: '5,10',
           hb_deal_adbookpsp: 'werwetwerw,dsfxcxcvxc',
           hb_liid_adbookpsp: '2342345,2121221',
-          hb_adid_c_adbookpsp: '5,10',
+          hb_ordid_adbookpsp: '567843,5678234',
         });
       }
     });
@@ -670,9 +680,11 @@ describe('adbookpsp bid adapter', () => {
       );
 
       expect(bids[0].adserverTargeting).to.deep.equal({
+        hb_ad_ord_adbookpsp: '0_0',
         hb_adid_c_adbookpsp: '10',
         hb_deal_adbookpsp: 'dsfxcxcvxc',
         hb_liid_adbookpsp: '2121221',
+        hb_ordid_adbookpsp: '5678234',
       });
     });
 
@@ -1279,6 +1291,7 @@ const exchangeResponse = {
           nurl: 'http://win.example.url',
           ext: {
             liid: '2342345',
+            ordid: '567843',
           },
           cat: ['IAB2-1', 'IAB2-2', 'IAB2-3'],
           adomain: ['advertiser.com'],
@@ -1301,6 +1314,7 @@ const exchangeResponse = {
           nurl: 'http://win.example.url',
           ext: {
             liid: '2121221',
+            ordid: '5678234',
           },
           cat: ['IAB2-3'],
           adomain: ['advertiser.com', 'campaign.advertiser.com'],

package/test/spec/modules/adhashBidAdapter_spec.js

@@ -77,7 +77,7 @@ describe('adhashBidAdapter', function () {
       );
       expect(result.length).to.equal(1);
       expect(result[0].method).to.equal('POST');
-      expect(result[0].url).to.equal('https://bidder.adhash.org/rtb?version=1.0&prebid=true');
+      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=1.0&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
       expect(result[0].bidRequest).to.equal(bidRequest);
       expect(result[0].data).to.have.property('timezone');
       expect(result[0].data).to.have.property('location');
@@ -93,7 +93,7 @@ describe('adhashBidAdapter', function () {
       const result = spec.buildRequests([ bidRequest ], { gdprConsent: true });
       expect(result.length).to.equal(1);
       expect(result[0].method).to.equal('POST');
-      expect(result[0].url).to.equal('https://bidder.adhash.org/rtb?version=1.0&prebid=true');
+      expect(result[0].url).to.equal('https://bidder.adhash.com/rtb?version=1.0&prebid=true&publisher=0xc3b09b27e9c6ef73957901aa729b9e69e5bbfbfb');
       expect(result[0].bidRequest).to.equal(bidRequest);
       expect(result[0].data).to.have.property('timezone');
       expect(result[0].data).to.have.property('location');

package/test/spec/modules/admanBidAdapter_spec.js

@@ -175,13 +175,13 @@ describe('AdmanAdapter', function () {
   });
 
   describe('getUserSyncs', function () {
-    let userSync = spec.getUserSyncs();
+    let userSync = spec.getUserSyncs({});
     it('Returns valid URL and type', function () {
       expect(userSync).to.be.an('array').with.lengthOf(1);
       expect(userSync[0].type).to.exist;
       expect(userSync[0].url).to.exist;
       expect(userSync[0].type).to.be.equal('image');
-      expect(userSync[0].url).to.be.equal('https://pub.admanmedia.com/?c=o&m=sync');
+      expect(userSync[0].url).to.be.equal('https://pub.admanmedia.com/image?pbjs=1&coppa=0');
     });
   });
 });

package/test/spec/modules/adomikAnalyticsAdapter_spec.js

@@ -1,5 +1,5 @@
 import adomikAnalytics from 'modules/adomikAnalyticsAdapter.js';
-import {expect} from 'chai';
+import { expect } from 'chai';
 
 let events = require('src/events');
 let adapterManager = require('src/adapterManager').default;
@@ -73,6 +73,7 @@ describe('Adomik Prebid Analytic', function () {
       expect(adomikAnalytics.currentContext).to.deep.equal({
         uid: '123456',
         url: 'testurl',
+        sampling: undefined,
         testId: '12345',
         testValue: '1000',
         id: '',
@@ -85,6 +86,7 @@ describe('Adomik Prebid Analytic', function () {
       expect(adomikAnalytics.currentContext).to.deep.equal({
         uid: '123456',
         url: 'testurl',
+        sampling: undefined,
         testId: '12345',
         testValue: '1000',
         id: 'test-test-test',

package/test/spec/modules/adqueryIdSystem_spec.js

@@ -0,0 +1,74 @@
+import { adqueryIdSubmodule, storage } from 'modules/adqueryIdSystem.js';
+import { server } from 'test/mocks/xhr.js';
+import {amxIdSubmodule} from '../../../modules/amxIdSystem';
+import * as utils from '../../../src/utils';
+
+const config = {
+  storage: {
+    type: 'html5',
+  },
+};
+
+describe('AdqueryIdSystem', function () {
+  describe('qid submodule', () => {
+    it('should expose a "name" property containing qid', () => {
+      expect(adqueryIdSubmodule.name).to.equal('qid');
+    });
+
+    it('should expose a "gvlid" property containing the GVL ID 902', () => {
+      expect(adqueryIdSubmodule.gvlid).to.equal(902);
+    });
+  });
+
+  describe('getId', function() {
+    let getDataFromLocalStorageStub;
+
+    beforeEach(function() {
+      getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage');
+    });
+
+    afterEach(function () {
+      getDataFromLocalStorageStub.restore();
+    });
+
+    it('gets a adqueryId', function() {
+      const config = {
+        params: {}
+      };
+      const callbackSpy = sinon.spy();
+      const callback = adqueryIdSubmodule.getId(config).callback;
+      callback(callbackSpy);
+      const request = server.requests[0];
+      expect(request.url).to.eq(`https://bidder.adquery.io/prebid/qid`);
+      request.respond(200, { 'Content-Type': 'application/json' }, JSON.stringify({ qid: 'qid' }));
+      expect(callbackSpy.lastCall.lastArg).to.deep.equal({qid: 'qid'});
+    });
+
+    it('gets a cached adqueryId', function() {
+      const config = {
+        params: {}
+      };
+      getDataFromLocalStorageStub.withArgs('qid').returns('qid');
+
+      const callbackSpy = sinon.spy();
+      const callback = adqueryIdSubmodule.getId(config).callback;
+      callback(callbackSpy);
+      expect(callbackSpy.lastCall.lastArg).to.deep.equal({qid: 'qid'});
+    });
+
+    it('allows configurable id url', function() {
+      const config = {
+        params: {
+          url: 'https://bidder.adquery.io'
+        }
+      };
+      const callbackSpy = sinon.spy();
+      const callback = adqueryIdSubmodule.getId(config).callback;
+      callback(callbackSpy);
+      const request = server.requests[0];
+      expect(request.url).to.eq('https://bidder.adquery.io');
+      request.respond(200, { 'Content-Type': 'application/json' }, JSON.stringify({ qid: 'testqid' }));
+      expect(callbackSpy.lastCall.lastArg).to.deep.equal({qid: 'testqid'});
+    });
+  });
+});

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -556,6 +556,33 @@ describe('AppNexusAdapter', function () {
       config.getConfig.restore();
     });
 
+    it('adds auction level keywords to request when set', function() {
+      let bidRequest = Object.assign({}, bidRequests[0]);
+      sinon
+        .stub(config, 'getConfig')
+        .withArgs('appnexusAuctionKeywords')
+        .returns({
+          gender: 'm',
+          music: ['rock', 'pop'],
+          test: ''
+        });
+
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.keywords).to.deep.equal([{
+        'key': 'gender',
+        'value': ['m']
+      }, {
+        'key': 'music',
+        'value': ['rock', 'pop']
+      }, {
+        'key': 'test'
+      }]);
+
+      config.getConfig.restore();
+    });
+
     it('should attach native params to the request', function () {
       let bidRequest = Object.assign({},
         bidRequests[0],

package/test/spec/modules/asealBidAdapter_spec.js

@@ -0,0 +1,144 @@
+import { expect } from 'chai';
+import { spec, BIDDER_CODE, API_ENDPOINT, HEADER_AOTTER_VERSION } from 'modules/asealBidAdapter.js';
+import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
+
+const TEST_CLIENT_ID = 'TEST_CLIENT_ID'
+
+describe('asealBidAdapter', () => {
+  const adapter = newBidder(spec);
+
+  describe('inherited functions', () => {
+    it('exists and is a function', () => {
+      expect(adapter.callBids).to.exist.and.to.be.a('function')
+    })
+  });
+
+  describe('isBidRequestValid', () => {
+    const bid = {
+      bidder: 'aseal',
+      params: {
+        placeUid: '123'
+      }
+    };
+
+    it('should return true when required params found', () => {
+      expect(spec.isBidRequestValid(bid)).to.equal(true)
+    });
+
+    it('should return false when required param placeUid is not passed', () => {
+      bid.params = {
+        placeUid: ''
+      }
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+    });
+
+    it('should return false when required param placeUid is wrong type', () => {
+      bid.params = {
+        placeUid: null
+      }
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+    });
+
+    it('should return false when required params are not passed', () => {
+      let bid = Object.assign({}, bid);
+      delete bid.params;
+      bid.params = {};
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+    })
+  });
+
+  describe('buildRequests', () => {
+    afterEach(() => {
+      config.resetConfig();
+    });
+
+    it('should return an empty array when there are no bid requests', () => {
+      const bidRequests = []
+      const request = spec.buildRequests(bidRequests)
+
+      expect(request).to.be.an('array').that.is.empty
+    });
+
+    it('should send `x-aotter-clientid` header as empty string when user not set config `clientId`', () => {
+      const bidRequests = [{
+        bidder: BIDDER_CODE,
+        params: {
+          placeUid: '123'
+        }
+      }]
+
+      const bidderRequest = {}
+      const request = spec.buildRequests(bidRequests, bidderRequest)[0];
+
+      expect(request.options.customHeaders['x-aotter-clientid']).equal('')
+    })
+
+    it('should send bid requests to ENDPOINT via POST', () => {
+      const bidRequests = [{
+        bidder: BIDDER_CODE,
+        params: {
+          placeUid: '123'
+        }
+      }]
+
+      const bidderRequest = {
+        refererInfo: {
+          referer: 'https://aseal.in/',
+        }
+      }
+
+      config.setConfig({
+        aseal: {
+          clientId: TEST_CLIENT_ID
+        }
+      });
+      const request = spec.buildRequests(bidRequests, bidderRequest)[0];
+
+      expect(request.url).to.equal(API_ENDPOINT);
+      expect(request.method).to.equal('POST')
+      expect(request.options).deep.equal({
+        contentType: 'application/json',
+        withCredentials: true,
+        customHeaders: {
+          'x-aotter-clientid': TEST_CLIENT_ID,
+          'x-aotter-version': HEADER_AOTTER_VERSION,
+        }
+      });
+      expect(request.data).deep.equal({
+        bids: bidRequests,
+        refererInfo: bidderRequest.refererInfo,
+      });
+    });
+  });
+
+  describe('interpretResponse', () => {
+    it('should return an empty array when there are no bids', () => {
+      const serverResponse = {}
+      const response = spec.interpretResponse(serverResponse);
+
+      expect(response).is.an('array').that.is.empty;
+    });
+
+    it('should get correct bid response', () => {
+      const serverResponse = {
+        body: [{
+          requestId: '2ef08f145b7a4f',
+          cpm: 3,
+          width: 300,
+          height: 250,
+          creativeId: '123abc',
+          dealId: '123abc',
+          currency: 'USD',
+          netRevenue: false,
+          mediaType: 'banner',
+          ttl: 300,
+          ad: '<!-- adtag -->'
+        }]
+      }
+      const response = spec.interpretResponse(serverResponse);
+
+      expect(response).deep.equal(serverResponse.body);
+    });
+  })
+});

package/test/spec/modules/bliinkBidAdapter_spec.js

@@ -477,6 +477,8 @@ const testsBuildRequests = [
         refererInfo: getConfigBuildRequest('banner').refererInfo
       },
       data: {
+        gdpr: false,
+        gdpr_consent: '',
         height: 250,
         width: 300,
         keywords: '',

package/test/spec/modules/brandmetricsRtdProvider_spec.js

@@ -0,0 +1,191 @@
+import * as brandmetricsRTD from '../../../modules/brandmetricsRtdProvider.js';
+import {config} from 'src/config.js';
+
+const VALID_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true,
+  params: {
+    scriptId: '00000000-0000-0000-0000-000000000000',
+    bidders: ['ozone']
+  }
+};
+
+const NO_BIDDERS_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true,
+  params: {
+    scriptId: '00000000-0000-0000-0000-000000000000'
+  }
+};
+
+const NO_SCRIPTID_CONFIG = {
+  name: 'brandmetrics',
+  waitForIt: true
+};
+
+const USER_CONSENT = {
+  gdpr: {
+    vendorData: {
+      vendor: {
+        consents: {
+          422: true
+        }
+      },
+      purpose: {
+        consents: {
+          1: true,
+          7: true
+        }
+      }
+    },
+    gdprApplies: true
+  }
+};
+
+const NO_TCF_CONSENT = {
+  gdpr: {
+    vendorData: {
+      vendor: {
+        consents: {
+          422: false
+        }
+      },
+      purpose: {
+        consents: {
+          1: false,
+          7: false
+        }
+      }
+    },
+    gdprApplies: true
+  }
+};
+
+const NO_USP_CONSENT = {
+  usp: '1NYY'
+};
+
+function mockSurveyLoaded(surveyConf) {
+  const commands = window._brandmetrics || [];
+  commands.forEach(command => {
+    if (command.cmd === '_addeventlistener') {
+      const conf = command.val;
+      if (conf.event === 'surveyloaded') {
+        conf.handler(surveyConf);
+      }
+    }
+  });
+}
+
+function scriptTagExists(url) {
+  const tags = document.getElementsByTagName('script');
+  for (let i = 0; i < tags.length; i++) {
+    if (tags[i].src === url) {
+      return true;
+    }
+  }
+  return false;
+}
+
+describe('BrandmetricsRTD module', () => {
+  beforeEach(function () {
+    const scriptTags = document.getElementsByTagName('script');
+    for (let i = 0; i < scriptTags.length; i++) {
+      if (scriptTags[i].src.indexOf('brandmetrics') !== -1) {
+        scriptTags[i].remove();
+      }
+    }
+  });
+
+  it('should init and return true', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should init and return true even if bidders is not included', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(NO_BIDDERS_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should init even if script- id is not configured', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(NO_SCRIPTID_CONFIG, USER_CONSENT)).to.equal(true);
+  });
+
+  it('should not init when there is no TCF- consent', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, NO_TCF_CONSENT)).to.equal(false);
+  });
+
+  it('should not init when there is no usp- consent', () => {
+    expect(brandmetricsRTD.brandmetricsSubmodule.init(VALID_CONFIG, NO_USP_CONSENT)).to.equal(false);
+  });
+});
+
+describe('getBidRequestData', () => {
+  beforeEach(function () {
+    config.resetConfig()
+  })
+
+  it('should set targeting keys for specified bidders', () => {
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {
+      const bidderConfig = config.getBidderConfig()
+      const expected = VALID_CONFIG.params.bidders
+
+      expected.forEach(exp => {
+        expect(bidderConfig[exp].ortb2.user.ext.data.mockTargetKey).to.equal('mockMeasurementId')
+      })
+    }, VALID_CONFIG);
+
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'pbjs',
+          targetKey: 'mockTargetKey'
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+  });
+
+  it('should only set targeting keys when the brandmetrics survey- type is "pbjs"', () => {
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'dfp',
+          targetKey: 'mockTargetKey'
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {}, VALID_CONFIG);
+    const bidderConfig = config.getBidderConfig()
+    expect(Object.keys(bidderConfig).length).to.equal(0)
+  });
+
+  it('should use a default targeting key name if the brandmetrics- configuration does not include one', () => {
+    mockSurveyLoaded({
+      available: true,
+      conf: {
+        displayOption: {
+          type: 'pbjs',
+        }
+      },
+      survey: {
+        measurementId: 'mockMeasurementId'
+      }
+    });
+
+    brandmetricsRTD.brandmetricsSubmodule.getBidRequestData({}, () => {}, VALID_CONFIG);
+
+    const bidderConfig = config.getBidderConfig()
+    const expected = VALID_CONFIG.params.bidders
+
+    expected.forEach(exp => {
+      expect(bidderConfig[exp].ortb2.user.ext.data.brandmetrics_survey).to.equal('mockMeasurementId')
+    })
+  });
+});

package/test/spec/modules/colossussspBidAdapter_spec.js

@@ -7,7 +7,8 @@ describe('ColossussspAdapter', function () {
     bidder: 'colossusssp',
     bidderRequestId: '145e1d6a7837c9',
     params: {
-      placement_id: 0
+      placement_id: 0,
+      group_id: 0
     },
     placementCode: 'placementid_0',
     auctionId: '74f78609-a92d-4cf1-869f-1b244bbfb5d2',
@@ -60,6 +61,7 @@ describe('ColossussspAdapter', function () {
     });
     it('Should return false when placement_id is not a number', function () {
       bid.params.placement_id = 'aaa';
+      delete bid.params.group_id;
       expect(spec.isBidRequestValid(bid)).to.be.false;
     });
   });
@@ -95,9 +97,10 @@ describe('ColossussspAdapter', function () {
       let placements = data['placements'];
       for (let i = 0; i < placements.length; i++) {
         let placement = placements[i];
-        expect(placement).to.have.all.keys('placementId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid');
+        expect(placement).to.have.all.keys('placementId', 'groupId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid');
         expect(placement.schain).to.be.an('object')
         expect(placement.placementId).to.be.a('number');
+        expect(placement.groupId).to.be.a('number');
         expect(placement.bidId).to.be.a('string');
         expect(placement.traffic).to.be.a('string');
         expect(placement.sizes).to.be.an('array');

package/test/spec/modules/compassBidAdapter_spec.js

@@ -143,6 +143,7 @@ describe('CompassBidAdapter', function () {
         expect(placement.bidId).to.be.a('string');
         expect(placement.schain).to.be.an('object');
         expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('publisher');
 
         if (placement.adFormat === BANNER) {
           expect(placement.sizes).to.be.an('array');