prebid.js 6.4.0 → 6.8.0

package/test/spec/config_spec.js

@@ -7,8 +7,10 @@ const utils = require('src/utils');
 let getConfig;
 let setConfig;
 let readConfig;
+let mergeConfig;
 let getBidderConfig;
 let setBidderConfig;
+let mergeBidderConfig;
 let setDefaults;
 
 describe('config API', function () {
@@ -19,8 +21,10 @@ describe('config API', function () {
     getConfig = config.getConfig;
     setConfig = config.setConfig;
     readConfig = config.readConfig;
+    mergeConfig = config.mergeConfig;
     getBidderConfig = config.getBidderConfig;
     setBidderConfig = config.setBidderConfig;
+    mergeBidderConfig = config.mergeBidderConfig;
     setDefaults = config.setDefaults;
     logErrorSpy = sinon.spy(utils, 'logError');
     logWarnSpy = sinon.spy(utils, 'logWarn');
@@ -345,4 +349,279 @@ describe('config API', function () {
     const warning = 'Auction Options given an incorrect param: testing';
     assert.ok(logWarnSpy.calledWith(warning), 'expected warning was logged');
   });
+
+  it('should merge input with existing global config', function () {
+    const obj = {
+      ortb2: {
+        site: {
+          name: 'example',
+          domain: 'page.example.com',
+          cat: ['IAB2'],
+          sectioncat: ['IAB2-2'],
+          pagecat: ['IAB2-2']
+        }
+      }
+    };
+    setConfig({ ortb2: {
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    });
+    mergeConfig(obj);
+    const expected = {
+      site: {
+        name: 'example',
+        domain: 'page.example.com',
+        cat: ['IAB2'],
+        sectioncat: ['IAB2-2'],
+        pagecat: ['IAB2-2']
+      },
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    expect(getConfig('ortb2')).to.deep.equal(expected);
+  });
+
+  it('input should take precedence over existing config if keys are the same', function() {
+    const input = {
+      ortb2: {
+        user: {
+          ext: {
+            data: {
+              registered: true,
+              interests: ['cars']
+            }
+          }
+        }
+      }
+    }
+    setConfig({ ortb2: {
+      user: {
+        ext: {
+          data: {
+            registered: false
+          }
+        }
+      }
+    }});
+    mergeConfig(input);
+    const expected = {
+      user: {
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    }
+    expect(getConfig('ortb2')).to.deep.equal(expected);
+  });
+
+  it('should log error for a non-object value passed in', function () {
+    mergeConfig('invalid object');
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'mergeConfig input must be an object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should merge input with existing bidder config', function () {
+    const input = {
+      bidders: ['rubicon', 'appnexus'],
+      config: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['sports']
+              }
+            }
+          }
+        }
+      }
+    };
+    setBidderConfig({
+      bidders: ['rubicon'],
+      config: {
+        ortb2: {
+          user: {
+            ext: {
+              data: {
+                registered: true,
+                interests: ['cars']
+              }
+            }
+          }
+        }
+      }
+    });
+    mergeBidderConfig(input);
+    const expected = {
+      rubicon: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['cars', 'sports']
+              }
+            }
+          }
+        }
+      },
+      appnexus: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          },
+          user: {
+            ext: {
+              ssp: 'magnite',
+              data: {
+                registered: false,
+                interests: ['sports']
+              }
+            }
+          }
+        }
+      }
+    }
+    expect(getBidderConfig()).to.deep.equal(expected);
+  });
+
+  it('should log error for a non-object value passed in', function () {
+    mergeBidderConfig('invalid object');
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must be an object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should log error for empty bidders array', function () {
+    mergeBidderConfig({
+      bidders: [],
+      config: {
+        ortb2: {
+          site: {
+            name: 'example',
+            domain: 'page.example.com',
+            cat: ['IAB2'],
+            sectioncat: ['IAB2-2'],
+            pagecat: ['IAB2-2']
+          }
+        }
+      }
+    });
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must contain a bidders list with at least 1 bidder';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should log error for nonexistent config object', function () {
+    mergeBidderConfig({
+      bidders: ['appnexus']
+    });
+    expect(logErrorSpy.calledOnce).to.equal(true);
+    const error = 'setBidderConfig bidder options must contain a config object';
+    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+  });
+
+  it('should merge without array duplication', function() {
+    const userObj1 = {
+      name: 'www.dataprovider1.com',
+      ext: { taxonomyname: 'iab_audience_taxonomy' },
+      segment: [{
+        id: '1776'
+      }]
+    };
+
+    const userObj2 = {
+      name: 'www.dataprovider2.com',
+      ext: { taxonomyname: 'iab_audience_taxonomy' },
+      segment: [{
+        id: '1914'
+      }]
+    };
+
+    const siteObj1 = {
+      name: 'www.dataprovider3.com',
+      ext: {
+        taxonomyname: 'iab_audience_taxonomy'
+      },
+      segment: [
+        {
+          id: '1812'
+        },
+        {
+          id: '1955'
+        }
+      ]
+    }
+
+    setConfig({
+      ortb2: {
+        user: {
+          data: [userObj1, userObj2]
+        },
+        site: {
+          content: {
+            data: [siteObj1]
+          }
+        }
+      }
+    });
+
+    const rtd = {
+      ortb2: {
+        user: {
+          data: [userObj1]
+        },
+        site: {
+          content: {
+            data: [siteObj1]
+          }
+        }
+      }
+    };
+    mergeConfig(rtd);
+
+    let ortb2Config = getConfig('ortb2');
+
+    expect(ortb2Config.user.data).to.deep.include.members([userObj1, userObj2]);
+    expect(ortb2Config.site.content.data).to.deep.include.members([siteObj1]);
+    expect(ortb2Config.user.data).to.have.lengthOf(2);
+    expect(ortb2Config.site.content.data).to.have.lengthOf(1);
+  });
 });

package/test/spec/modules/adagioBidAdapter_spec.js

@@ -244,16 +244,6 @@ describe('Adagio bid adapter', () => {
       expect(spec.isBidRequestValid(bid03)).to.equal(false);
       expect(spec.isBidRequestValid(bid04)).to.equal(false);
     });
-
-    it('should return false when refererInfo.reachedTop is false', function() {
-      sandbox.spy(utils, 'logWarn');
-      sandbox.stub(adagio, 'getRefererInfo').returns({ reachedTop: false });
-      const bid = new BidRequestBuilder().withParams().build();
-
-      expect(spec.isBidRequestValid(bid)).to.equal(false);
-      sinon.assert.callCount(utils.logWarn, 1);
-      sinon.assert.calledWith(utils.logWarn, 'Adagio: the main page url is unreachabled.');
-    });
   });
 
   describe('buildRequests()', function() {

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

@@ -95,6 +95,40 @@ describe('Adyoulike Adapter', function () {
     }
   ];
 
+  const bidRequestWithMultipleMediatype = [
+    {
+      'bidId': 'bid_id_0',
+      'bidder': 'adyoulike',
+      'placementCode': 'adunit/hb-0',
+      'params': {
+        'placement': 'placement_0'
+      },
+      'sizes': '300x250',
+      'mediaTypes': {
+        'banner': {
+          'sizes': ['640x480']
+        },
+        'video': {
+          'playerSize': [640, 480],
+          'context': 'outstream'
+        },
+        'native': {
+          'image': {
+            'required': true,
+          },
+          'title': {
+            'required': true,
+            'len': 80
+          },
+          'cta': {
+            'required': false
+          },
+        }
+      },
+      'transactionId': 'bid_id_0_transaction_id'
+    }
+  ];
+
   const bidRequestWithNativeImageType = [
     {
       'bidId': 'bid_id_0',
@@ -647,6 +681,21 @@ describe('Adyoulike Adapter', function () {
       expect(payload.Bids['bid_id_0'].TransactionID).to.be.equal('bid_id_0_transaction_id');
     });
 
+    it('sends bid request to endpoint with single placement multiple mediatype', function () {
+      canonicalQuery.restore();
+      const request = spec.buildRequests(bidRequestWithMultipleMediatype, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      expect(request.url).to.contain(getEndpoint());
+      expect(request.method).to.equal('POST');
+
+      expect(request.url).to.not.contains('CanonicalUrl=' + encodeURIComponent(canonicalUrl));
+      expect(payload.Version).to.equal('1.0');
+      expect(payload.Bids['bid_id_0'].PlacementID).to.be.equal('placement_0');
+      expect(payload.PageRefreshed).to.equal(false);
+      expect(payload.Bids['bid_id_0'].TransactionID).to.be.equal('bid_id_0_transaction_id');
+    });
+
     it('sends bid request to endpoint with multiple placements', function () {
       const request = spec.buildRequests(bidRequestMultiPlacements, bidderRequest);
       const payload = JSON.parse(request.data);

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

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