prebid.js 7.18.0 → 7.20.0

package/test/spec/fpd/sua_spec.js

@@ -0,0 +1,244 @@
+import {
+  highEntropySUAAccessor,
+  lowEntropySUAAccessor,
+  SUA_SOURCE_HIGH_ENTROPY,
+  SUA_SOURCE_LOW_ENTROPY,
+  SUA_SOURCE_UNKNOWN,
+  suaFromUAData,
+  uaDataToSUA
+} from '../../../libraries/fpd/sua.js';
+
+describe('uaDataToSUA', () => {
+  Object.entries({
+    'platform': 'platform',
+    'browsers': 'brands',
+    'mobile': 'mobile',
+    'architecture': 'architecture',
+    'model': 'model',
+    'bitness': 'bitness'
+  }).forEach(([suaKey, uaKey]) => {
+    it(`should not set ${suaKey} if ${uaKey} is missing from UAData`, () => {
+      const example = {
+        platform: 'Windows',
+        brands: [{brand: 'Mock', version: 'mk'}],
+        mobile: true,
+        model: 'mockModel',
+        bitness: '64',
+        architecture: 'arm'
+      }
+      delete example[uaKey];
+      const sua = uaDataToSUA(SUA_SOURCE_UNKNOWN, example);
+      expect(sua.hasOwnProperty(suaKey)).to.be.false;
+    })
+  });
+
+  it('should convert low-entropy userAgentData', () => {
+    const sua = uaDataToSUA(SUA_SOURCE_LOW_ENTROPY, {
+      'brands': [
+        {
+          'brand': '.Not/A)Brand',
+          'version': '99'
+        },
+        {
+          'brand': 'Google Chrome',
+          'version': '103'
+        },
+        {
+          'brand': 'Chromium',
+          'version': '103'
+        }
+      ],
+      'mobile': false,
+      'platform': 'Linux'
+    });
+
+    expect(sua).to.eql({
+      source: SUA_SOURCE_LOW_ENTROPY,
+      mobile: 0,
+      platform: {
+        brand: 'Linux',
+      },
+      browsers: [
+        {
+          brand: '.Not/A)Brand',
+          version: [
+            '99'
+          ]
+        },
+        {
+          brand: 'Google Chrome',
+          version: [
+            '103'
+          ]
+        },
+        {
+          brand: 'Chromium',
+          version: [
+            '103'
+          ]
+        }
+      ]
+    })
+  });
+
+  it('should convert high entropy properties', () => {
+    const uaData = {
+      architecture: 'x86',
+      bitness: '64',
+      fullVersionList: [
+        {
+          'brand': '.Not/A)Brand',
+          'version': '99.0.0.0'
+        },
+        {
+          'brand': 'Google Chrome',
+          'version': '103.0.5060.134'
+        },
+        {
+          'brand': 'Chromium',
+          'version': '103.0.5060.134'
+        }
+      ],
+      brands: [
+        {
+          'brand': '.Not/A)Brand',
+          'version': '99'
+        },
+        {
+          'brand': 'Google Chrome',
+          'version': '103'
+        },
+        {
+          'brand': 'Chromium',
+          'version': '103'
+        }
+      ],
+      model: 'mockModel',
+      platform: 'Linux',
+      platformVersion: '5.14.0'
+    }
+
+    expect(uaDataToSUA(SUA_SOURCE_HIGH_ENTROPY, uaData)).to.eql({
+      source: SUA_SOURCE_HIGH_ENTROPY,
+      architecture: 'x86',
+      bitness: '64',
+      model: 'mockModel',
+      platform: {
+        brand: 'Linux',
+        version: [
+          '5',
+          '14',
+          '0'
+        ]
+      },
+      browsers: [
+        {
+          brand: '.Not/A)Brand',
+          version: [
+            '99',
+            '0',
+            '0',
+            '0'
+          ]
+        },
+        {
+          brand: 'Google Chrome',
+          version: [
+            '103',
+            '0',
+            '5060',
+            '134'
+          ]
+        },
+        {
+          brand: 'Chromium',
+          version: [
+            '103',
+            '0',
+            '5060',
+            '134'
+          ]
+        }
+      ]
+    })
+  })
+});
+
+describe('lowEntropySUAAccessor', () => {
+  function getSUA(uaData) {
+    return lowEntropySUAAccessor(uaData)();
+  }
+
+  it('should not be modifiable', () => {
+    const sua = getSUA({});
+    expect(() => { sua.prop = 'value'; }).to.throw();
+  });
+
+  it('should return null if no uaData is available', () => {
+    expect(getSUA(null)).to.eql(null);
+  })
+
+  it('should return null if uaData is empty', () => {
+    expect(getSUA({})).to.eql(null);
+  })
+});
+
+describe('highEntropySUAAccessor', () => {
+  let userAgentData, uaResult, getSUA;
+  beforeEach(() => {
+    uaResult = {};
+    userAgentData = {
+      getHighEntropyValues: sinon.stub().callsFake(() => Promise.resolve(uaResult))
+    };
+    getSUA = highEntropySUAAccessor(userAgentData);
+  });
+
+  describe('should resolve to null if', () => {
+    it('uaData is not available', () => {
+      getSUA = highEntropySUAAccessor(null);
+      return getSUA().then((result) => {
+        expect(result).to.eql(null);
+      })
+    });
+    it('getHighEntropyValues is not avialable', () => {
+      delete userAgentData.getHighEntropyValues;
+      return getSUA().then((result) => {
+        expect(result).to.eql(null);
+      })
+    });
+    it('getHighEntropyValues throws', () => {
+      userAgentData.getHighEntropyValues.callsFake(() => { throw new Error() });
+      return getSUA().then((result) => {
+        expect(result).to.eql(null);
+      })
+    });
+    it('getHighEntropyValues rejects', () => {
+      userAgentData.getHighEntropyValues.callsFake(() => Promise.reject(new Error()));
+      return getSUA().then((result) => {
+        expect(result).to.eql(null);
+      })
+    });
+    it('getHighEntropyValues returns an empty object', () => {
+      userAgentData.getHighEntropyValues.callsFake(() => Promise.resolve({}));
+      return getSUA().then((result) => {
+        expect(result).to.eql(null);
+      });
+    })
+  });
+  it('should pass hints to userAgentData', () => {
+    getSUA(['h1', 'h2']);
+    sinon.assert.calledWith(userAgentData.getHighEntropyValues, ['h1', 'h2']);
+  });
+
+  it('should cache results for a set of hints', () => {
+    getSUA(['h1', 'h2']);
+    getSUA(['h2', 'h1']);
+    sinon.assert.calledOnce(userAgentData.getHighEntropyValues);
+  });
+
+  it('should return unmodifiable objects', () => {
+    return getSUA().then(result => {
+      expect(() => { result.prop = 'value'; }).to.throw();
+    })
+  })
+})

package/test/spec/modules/adfBidAdapter_spec.js

@@ -170,11 +170,10 @@ describe('Adf adapter', function () {
       let validBidRequests = [{
         bidId: 'bidId',
         params: { siteId: 'siteId' },
-        transactionId: 'transactionId'
       }];
-      let request = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { page: 'page' } }).data);
+      let request = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { page: 'page' }, auctionId: 'tid' }).data);
 
-      assert.equal(request.source.tid, validBidRequests[0].transactionId);
+      assert.equal(request.source.tid, 'tid');
       assert.equal(request.source.fd, 1);
     });
 

package/test/spec/modules/adqueryIdSystem_spec.js

@@ -1,7 +1,5 @@
 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: {

package/test/spec/modules/adxcgBidAdapter_spec.js

@@ -164,11 +164,10 @@ describe('Adxcg adapter', function () {
       let validBidRequests = [{
         bidId: 'bidId',
         params: {siteId: 'siteId'},
-        transactionId: 'transactionId'
       }];
-      let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
+      let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}, auctionId: 'tid'}).data);
 
-      assert.equal(request.source.tid, validBidRequests[0].transactionId);
+      assert.equal(request.source.tid, 'tid');
       assert.equal(request.source.fd, 1);
     });
 

package/test/spec/modules/amxBidAdapter_spec.js

@@ -359,6 +359,7 @@ describe('AmxBidAdapter', () => {
             bidId: sampleRequestId + '_2',
             params: {
               ...sampleBidRequestBase.params,
+              adUnitId: '',
               tagId: 'example',
             },
           },
@@ -404,12 +405,12 @@ describe('AmxBidAdapter', () => {
 
     it('can build a video request', () => {
       const { data } = spec.buildRequests(
-        [sampleBidRequestVideo],
+        [{...sampleBidRequestVideo, params: { ...sampleBidRequestVideo.params, adUnitId: 'custom-auid' }}],
         sampleBidderRequest
       );
       expect(Object.keys(data.m).length).to.equal(1);
       expect(data.m[sampleRequestId + '_video']).to.deep.equal({
-        au: 'div-gpt-ad-example',
+        au: 'custom-auid',
         ms: [[[300, 150]], [], [[360, 250]]],
         av: true,
         aw: 360,

package/test/spec/modules/aolBidAdapter_spec.js

@@ -81,20 +81,46 @@ describe('AolAdapter', function () {
   const ONE_DISPLAY_TTL = 60;
   const ONE_MOBILE_TTL = 3600;
   const SUPPORTED_USER_ID_SOURCES = {
-    'adserver.org': '100',
-    'criteo.com': '200',
-    'id5-sync.com': '300',
-    'intentiq.com': '400',
-    'liveintent.com': '500',
-    'quantcast.com': '600',
-    'verizonmedia.com': '700',
-    'liveramp.com': '800'
+    'admixer.net': '100',
+    'adserver.org': '200',
+    'adtelligent.com': '300',
+    'amxrtb.com': '500',
+    'audigent.com': '600',
+    'britepool.com': '700',
+    'criteo.com': '800',
+    'crwdcntrl.net': '900',
+    'deepintent.com': '1000',
+    'epsilon.com': '1100',
+    'hcn.health': '1200',
+    'id5-sync.com': '1300',
+    'idx.lat': '1400',
+    'intentiq.com': '1500',
+    'intimatemerger.com': '1600',
+    'liveintent.com': '1700',
+    'liveramp.com': '1800',
+    'mediawallahscript.com': '1900',
+    'netid.de': '2100',
+    'neustar.biz': '2200',
+    'pubcid.org': '2600',
+    'quantcast.com': '2700',
+    'tapad.com': '2800',
+    'zeotap.com': '3200'
   };
 
   const USER_ID_DATA = {
+    admixerId: SUPPORTED_USER_ID_SOURCES['admixer.net'],
+    adtelligentId: SUPPORTED_USER_ID_SOURCES['adtelligent.com'],
+    amxId: SUPPORTED_USER_ID_SOURCES['amxrtb.com'],
+    britepoolid: SUPPORTED_USER_ID_SOURCES['britepool.com'],
     criteoId: SUPPORTED_USER_ID_SOURCES['criteo.com'],
     connectid: SUPPORTED_USER_ID_SOURCES['verizonmedia.com'],
+    dmdId: SUPPORTED_USER_ID_SOURCES['hcn.health'],
+    hadronId: SUPPORTED_USER_ID_SOURCES['audigent.com'],
+    lotamePanoramaId: SUPPORTED_USER_ID_SOURCES['crwdcntrl.net'],
+    deepintentId: SUPPORTED_USER_ID_SOURCES['deepintent.com'],
+    fabrickId: SUPPORTED_USER_ID_SOURCES['neustar.biz'],
     idl_env: SUPPORTED_USER_ID_SOURCES['liveramp.com'],
+    IDP: SUPPORTED_USER_ID_SOURCES['zeotap.com'],
     lipb: {
       lipbid: SUPPORTED_USER_ID_SOURCES['liveintent.com'],
       segments: ['100', '200']
@@ -104,8 +130,15 @@ describe('AolAdapter', function () {
       uid: SUPPORTED_USER_ID_SOURCES['id5-sync.com'],
       ext: {foo: 'bar'}
     },
+    idx: SUPPORTED_USER_ID_SOURCES['idx.lat'],
+    imuid: SUPPORTED_USER_ID_SOURCES['intimatemerger.com'],
     intentIqId: SUPPORTED_USER_ID_SOURCES['intentiq.com'],
-    quantcastId: SUPPORTED_USER_ID_SOURCES['quantcast.com']
+    mwOpenLinkId: SUPPORTED_USER_ID_SOURCES['mediawallahscript.com'],
+    netId: SUPPORTED_USER_ID_SOURCES['netid.de'],
+    quantcastId: SUPPORTED_USER_ID_SOURCES['quantcast.com'],
+    publinkId: SUPPORTED_USER_ID_SOURCES['epsilon.com'],
+    pubcid: SUPPORTED_USER_ID_SOURCES['pubcid.org'],
+    tapadId: SUPPORTED_USER_ID_SOURCES['tapad.com']
   };
 
   function createCustomBidRequest({bids, params} = {}) {

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -4,6 +4,7 @@ import { newBidder } from 'src/adapters/bidderFactory.js';
 import * as bidderFactory from 'src/adapters/bidderFactory.js';
 import { auctionManager } from 'src/auctionManager.js';
 import { deepClone } from 'src/utils.js';
+import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
 
 const ENDPOINT = 'https://ib.adnxs.com/ut/v3/prebid';
@@ -370,6 +371,29 @@ describe('AppNexusAdapter', function () {
       });
     });
 
+    it('should add debug params from query', function () {
+      let getParamStub = sinon.stub(utils, 'getParameterByName').callsFake(function(par) {
+        if (par === 'apn_debug_dongle') return 'abcdef';
+        if (par === 'apn_debug_member_id') return '1234';
+        if (par === 'apn_debug_timeout') return '1000';
+
+        return '';
+      });
+
+      let bidRequest = deepClone(bidRequests[0]);
+      const request = spec.buildRequests([bidRequest]);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.debug).to.exist.and.to.deep.equal({
+        'dongle': 'abcdef',
+        'enabled': true,
+        'member_id': 1234,
+        'debug_timeout': 1000
+      });
+
+      getParamStub.restore();
+    });
+
     it('should attach reserve param when either bid param or getFloor function exists', function () {
       let getFloorResponse = { currency: 'USD', floor: 3 };
       let request, payload = null;

package/test/spec/modules/{andBeyondMediaBidAdapter_spec.js → beyondmediaBidAdapter_spec.js}

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { spec } from '../../../modules/andBeyondMediaBidAdapter.js';
+import { spec } from '../../../modules/beyondmediaBidAdapter.js';
 import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
 import { getUniqueIdentifierStr } from '../../../src/utils.js';
 

package/test/spec/modules/colossussspBidAdapter_spec.js

@@ -101,7 +101,7 @@ 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', 'groupId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid');
+        expect(placement).to.have.all.keys('placementId', 'groupId', 'eids', 'bidId', 'traffic', 'sizes', 'schain', 'floor', 'gpid', 'tid');
         expect(placement.schain).to.be.an('object')
         expect(placement.placementId).to.be.a('number');
         expect(placement.groupId).to.be.a('number');
@@ -110,6 +110,7 @@ describe('ColossussspAdapter', function () {
         expect(placement.sizes).to.be.an('array');
         expect(placement.floor).to.be.an('object');
         expect(placement.gpid).to.be.an('string');
+        expect(placement.tid).to.be.an('string');
       }
     });
 
@@ -143,7 +144,7 @@ describe('ColossussspAdapter', function () {
         let placement = placements[i];
         expect(placement).to.have.all.keys('placementId', 'groupId', 'eids', 'bidId', 'traffic', 'schain', 'floor', 'gpid', 'sizes',
           'playerSize', 'minduration', 'maxduration', 'mimes', 'protocols', 'startdelay', 'placement', 'skip', 'skipafter',
-          'minbitrate', 'maxbitrate', 'delivery', 'playbackmethod', 'api', 'linearity'
+          'minbitrate', 'maxbitrate', 'delivery', 'playbackmethod', 'api', 'linearity', 'tid'
         );
         expect(placement.schain).to.be.an('object')
         expect(placement.placementId).to.be.a('number');
@@ -155,6 +156,7 @@ describe('ColossussspAdapter', function () {
         expect(placement.playerSize).to.be.an('array');
         expect(placement.minduration).to.be.an('number');
         expect(placement.maxduration).to.be.an('number');
+        expect(placement.tid).to.be.an('string');
       }
     });
 

package/test/spec/modules/connectIdSystem_spec.js

@@ -76,6 +76,26 @@ describe('Yahoo ConnectID Submodule', () => {
       expect(result.callback).to.be.a('function');
     });
 
+    it('returns an undefined if the Yahoo specific opt-out key is present in local storage', () => {
+      localStorage.setItem('connectIdOptOut', '1');
+      expect(invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData)).to.be.undefined;
+      localStorage.removeItem('connectIdOptOut');
+    });
+
+    it('returns an object with the callback function if the correct params are passed and Yahoo opt-out value is not "1"', () => {
+      localStorage.setItem('connectIdOptOut', 'true');
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+      localStorage.removeItem('connectIdOptOut');
+    });
+
     it('Makes an ajax GET request to the production API endpoint with query params', () => {
       invokeGetIdAPI({
         he: HASHED_EMAIL,