prebid.js 9.2.0 → 9.4.0

package/test/spec/modules/shinezRtbBidAdapter_spec.js

@@ -2,6 +2,9 @@ import {expect} from 'chai';
 import {
   spec as adapter,
   createDomain,
+  storage
+} from 'modules/shinezRtbBidAdapter';
+import {
   hashCode,
   extractPID,
   extractCID,
@@ -10,13 +13,12 @@ import {
   setStorageItem,
   tryParseJSON,
   getUniqueDealId,
-} from 'modules/shinezRtbBidAdapter';
-import * as utils from 'src/utils.js';
+} from '../../../libraries/vidazooUtils/bidderUtils.js';
+import {parseUrl, deepClone} from 'src/utils.js';
 import {version} from 'package.json';
 import {useFakeTimers} from 'sinon';
 import {BANNER, VIDEO} from '../../../src/mediaTypes';
 import {config} from '../../../src/config';
-import {deepAccess} from 'src/utils.js';
 
 export const TEST_ID_SYSTEMS = ['criteoId', 'id5id', 'idl_env', 'lipb', 'netId', 'pubcid', 'tdid', 'pubProvidedId'];
 
@@ -181,7 +183,7 @@ const REQUEST = {
 
 function getTopWindowQueryParams() {
   try {
-    const parsedUrl = utils.parseUrl(window.top.document.URL, {decodeSearchAsString: true});
+    const parsedUrl = parseUrl(window.top.document.URL, {decodeSearchAsString: true});
     return parsedUrl.search;
   } catch (e) {
     return '';
@@ -328,7 +330,12 @@ describe('ShinezRtbBidAdapter', function () {
               startdelay: 0
             }
           },
-          gpid: '0123456789'
+          gpid: '0123456789',
+          cat: [],
+          contentData: [],
+          isStorageAllowed: true,
+          pagecat: [],
+          userData: []
         }
       });
     });
@@ -390,6 +397,11 @@ describe('ShinezRtbBidAdapter', function () {
           uqs: getTopWindowQueryParams(),
           'ext.param1': 'loremipsum',
           'ext.param2': 'dolorsitamet',
+          cat: [],
+          contentData: [],
+          isStorageAllowed: true,
+          pagecat: [],
+          userData: []
         }
       });
     });
@@ -463,7 +475,7 @@ describe('ShinezRtbBidAdapter', function () {
     });
 
     it('should get meta from response metaData', function () {
-      const serverResponse = utils.deepClone(SERVER_RESPONSE);
+      const serverResponse = deepClone(SERVER_RESPONSE);
       serverResponse.body.results[0].metaData = {
         advertiserDomains: ['sweetgum.io'],
         agencyName: 'Agency Name',
@@ -496,7 +508,7 @@ describe('ShinezRtbBidAdapter', function () {
     });
 
     it('should take default TTL', function () {
-      const serverResponse = utils.deepClone(SERVER_RESPONSE);
+      const serverResponse = deepClone(SERVER_RESPONSE);
       delete serverResponse.body.results[0].exp;
       const responses = adapter.interpretResponse(serverResponse, REQUEST);
       expect(responses).to.have.length(1);
@@ -507,7 +519,7 @@ describe('ShinezRtbBidAdapter', function () {
   describe('user id system', function () {
     TEST_ID_SYSTEMS.forEach((idSystemProvider) => {
       const id = Date.now().toString();
-      const bid = utils.deepClone(BID);
+      const bid = deepClone(BID);
 
       const userId = (function () {
         switch (idSystemProvider) {
@@ -565,13 +577,13 @@ describe('ShinezRtbBidAdapter', function () {
     const key = 'myKey';
     let uniqueDealId;
     beforeEach(() => {
-      uniqueDealId = getUniqueDealId(key, 0);
+      uniqueDealId = getUniqueDealId(storage, key, 0);
     })
 
     it('should get current unique deal id', function (done) {
       // waiting some time so `now` will become past
       setTimeout(() => {
-        const current = getUniqueDealId(key);
+        const current = getUniqueDealId(storage, key);
         expect(current).to.be.equal(uniqueDealId);
         done();
       }, 200);
@@ -579,7 +591,7 @@ describe('ShinezRtbBidAdapter', function () {
 
     it('should get new unique deal id on expiration', function (done) {
       setTimeout(() => {
-        const current = getUniqueDealId(key, 100);
+        const current = getUniqueDealId(storage, key, 100);
         expect(current).to.not.be.equal(uniqueDealId);
         done();
       }, 200)
@@ -603,8 +615,8 @@ describe('ShinezRtbBidAdapter', function () {
         shouldAdvanceTime: true,
         now
       });
-      setStorageItem('myKey', 2020);
-      const {value, created} = getStorageItem('myKey');
+      setStorageItem(storage, 'myKey', 2020);
+      const {value, created} = getStorageItem(storage, 'myKey');
       expect(created).to.be.equal(now);
       expect(value).to.be.equal(2020);
       expect(typeof value).to.be.equal('number');
@@ -615,7 +627,7 @@ describe('ShinezRtbBidAdapter', function () {
     it('should get external stored value', function () {
       const value = 'superman'
       window.localStorage.setItem('myExternalKey', value);
-      const item = getStorageItem('myExternalKey');
+      const item = getStorageItem(storage, 'myExternalKey');
       expect(item).to.be.equal(value);
     });
 

package/test/spec/modules/smartadserverBidAdapter_spec.js

@@ -458,6 +458,13 @@ describe('Smart bid adapter tests', function () {
     expect(syncs).to.have.lengthOf(0);
   });
 
+  it('should set browsingTopics=false in request.options', () => {
+    const requests = spec.buildRequests(DEFAULT_PARAMS_WO_OPTIONAL);
+    expect(requests[0]).to.have.property('options').and.to.deep.equal({
+      browsingTopics: false
+    });
+  });
+
   describe('gdpr tests', function () {
     afterEach(function () {
       config.setConfig({ ortb2: undefined });

package/test/spec/modules/smartyadsBidAdapter_spec.js

@@ -61,12 +61,10 @@ describe('SmartyadsAdapter', function () {
     it('Returns valid data if array of bids is valid', function () {
       let data = serverRequest.data;
       expect(data).to.be.an('object');
-      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'coppa', 'eeid', 'ifa');
+      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'host', 'page', 'placements', 'coppa', 'eeid', 'ifa');
       expect(data.deviceWidth).to.be.a('number');
       expect(data.deviceHeight).to.be.a('number');
       expect(data.coppa).to.be.a('number');
-      expect(data.language).to.be.a('string');
-      expect(data.secure).to.be.within(0, 1);
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
       let placement = data['placements'][0];
@@ -126,8 +124,8 @@ describe('SmartyadsAdapter', function () {
       expect(dataItem.width).to.equal(300);
       expect(dataItem.height).to.equal(250);
       expect(dataItem.ad).to.equal('Test');
-      expect(dataItem.meta).to.have.property('advertiserDomains')
-      expect(dataItem.meta.advertiserDomains).to.deep.equal(['example.com']);
+      expect(dataItem.meta).to.have.property('advertiserDomains');
+      expect(dataItem.meta.advertiserDomains).to.be.an('array');
       expect(dataItem.ttl).to.equal(120);
       expect(dataItem.creativeId).to.equal('2');
       expect(dataItem.netRevenue).to.be.true;
@@ -152,7 +150,7 @@ describe('SmartyadsAdapter', function () {
 
       let dataItem = videoResponses[0];
       expect(dataItem).to.have.all.keys('requestId', 'cpm', 'vastUrl', 'ttl', 'creativeId',
-        'netRevenue', 'currency', 'dealId', 'mediaType');
+        'netRevenue', 'currency', 'dealId', 'mediaType', 'meta');
       expect(dataItem.requestId).to.equal('23fhj33i987f');
       expect(dataItem.cpm).to.equal(0.5);
       expect(dataItem.vastUrl).to.equal('test.com');
@@ -183,7 +181,7 @@ describe('SmartyadsAdapter', function () {
       expect(nativeResponses).to.be.an('array').that.is.not.empty;
 
       let dataItem = nativeResponses[0];
-      expect(dataItem).to.have.keys('requestId', 'cpm', 'ttl', 'creativeId', 'netRevenue', 'currency', 'mediaType', 'native');
+      expect(dataItem).to.have.keys('requestId', 'cpm', 'ttl', 'creativeId', 'netRevenue', 'currency', 'mediaType', 'native', 'meta');
       expect(dataItem.native).to.have.keys('clickUrl', 'impressionTrackers', 'title', 'image')
       expect(dataItem.requestId).to.equal('23fhj33i987f');
       expect(dataItem.cpm).to.equal(0.4);
@@ -263,7 +261,7 @@ describe('SmartyadsAdapter', function () {
     });
   });
   describe('getUserSyncs', function () {
-    const syncUrl = 'https://as.ck-ie.com/prebidjs?p=7c47322e527cf8bdeb7facc1bb03387a&gdpr=0&gdpr_consent=&type=iframe&us_privacy=&gpp=';
+    const syncUrl = 'https://as.ck-ie.com/prebidjs?p=7c47322e527cf8bdeb7facc1bb03387a/iframe?pbjs=1&coppa=0';
     const syncOptions = {
       iframeEnabled: true
     };
@@ -277,79 +275,4 @@ describe('SmartyadsAdapter', function () {
       ]);
     });
   });
-
-  describe('onBidWon', function () {
-    it('should exists', function () {
-      expect(spec.onBidWon).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bid won notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'winTest': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onBidWon(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
-
-  describe('onTimeout', function () {
-    it('should exists', function () {
-      expect(spec.onTimeout).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bid timeout notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'bidTimeout': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onTimeout(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
-
-  describe('onBidderError', function () {
-    it('should exists', function () {
-      expect(spec.onBidderError).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bidder error notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'bidderError': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onBidderError(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
 });

package/test/spec/modules/tagorasBidAdapter_spec.js

@@ -2,6 +2,14 @@ import {expect} from 'chai';
 import {
   spec as adapter,
   createDomain,
+  storage
+} from 'modules/tagorasBidAdapter';
+import * as utils from 'src/utils.js';
+import {version} from 'package.json';
+import {useFakeTimers} from 'sinon';
+import {BANNER, VIDEO} from '../../../src/mediaTypes';
+import {config} from '../../../src/config';
+import {
   hashCode,
   extractPID,
   extractCID,
@@ -10,12 +18,7 @@ import {
   setStorageItem,
   tryParseJSON,
   getUniqueDealId,
-} from 'modules/tagorasBidAdapter';
-import * as utils from 'src/utils.js';
-import {version} from 'package.json';
-import {useFakeTimers} from 'sinon';
-import {BANNER, VIDEO} from '../../../src/mediaTypes';
-import {config} from '../../../src/config';
+} from '../../../libraries/vidazooUtils/bidderUtils.js';
 
 export const TEST_ID_SYSTEMS = ['britepoolid', 'criteoId', 'id5id', 'idl_env', 'lipb', 'netId', 'parrableId', 'pubcid', 'tdid', 'pubProvidedId'];
 
@@ -324,7 +327,12 @@ describe('TagorasBidAdapter', function () {
               startdelay: 0
             }
           },
-          gpid: ''
+          gpid: '',
+          cat: [],
+          contentData: [],
+          isStorageAllowed: true,
+          pagecat: [],
+          userData: []
         }
       });
     });
@@ -385,6 +393,11 @@ describe('TagorasBidAdapter', function () {
           uqs: getTopWindowQueryParams(),
           'ext.param1': 'loremipsum',
           'ext.param2': 'dolorsitamet',
+          cat: [],
+          contentData: [],
+          isStorageAllowed: true,
+          pagecat: [],
+          userData: []
         }
       });
     });
@@ -527,8 +540,6 @@ describe('TagorasBidAdapter', function () {
         switch (idSystemProvider) {
           case 'lipb':
             return {lipbid: id};
-          case 'parrableId':
-            return {eid: id};
           case 'id5id':
             return {uid: id};
           default:
@@ -581,13 +592,13 @@ describe('TagorasBidAdapter', function () {
     const key = 'myKey';
     let uniqueDealId;
     beforeEach(() => {
-      uniqueDealId = getUniqueDealId(key, 0);
+      uniqueDealId = getUniqueDealId(storage, key, 0);
     })
 
     it('should get current unique deal id', function (done) {
       // waiting some time so `now` will become past
       setTimeout(() => {
-        const current = getUniqueDealId(key);
+        const current = getUniqueDealId(storage, key);
         expect(current).to.be.equal(uniqueDealId);
         done();
       }, 200);
@@ -595,7 +606,7 @@ describe('TagorasBidAdapter', function () {
 
     it('should get new unique deal id on expiration', function (done) {
       setTimeout(() => {
-        const current = getUniqueDealId(key, 100);
+        const current = getUniqueDealId(storage, key, 100);
         expect(current).to.not.be.equal(uniqueDealId);
         done();
       }, 200)
@@ -619,8 +630,8 @@ describe('TagorasBidAdapter', function () {
         shouldAdvanceTime: true,
         now
       });
-      setStorageItem('myKey', 2020);
-      const {value, created} = getStorageItem('myKey');
+      setStorageItem(storage, 'myKey', 2020);
+      const {value, created} = getStorageItem(storage, 'myKey');
       expect(created).to.be.equal(now);
       expect(value).to.be.equal(2020);
       expect(typeof value).to.be.equal('number');
@@ -631,7 +642,7 @@ describe('TagorasBidAdapter', function () {
     it('should get external stored value', function () {
       const value = 'superman'
       window.localStorage.setItem('myExternalKey', value);
-      const item = getStorageItem('myExternalKey');
+      const item = getStorageItem(storage, 'myExternalKey');
       expect(item).to.be.equal(value);
     });
 

package/test/spec/modules/twistDigitalBidAdapter_spec.js

@@ -2,15 +2,7 @@ import {expect} from 'chai';
 import {
   spec as adapter,
   createDomain,
-  hashCode,
-  extractPID,
-  extractCID,
-  extractSubDomain,
-  getStorageItem,
-  setStorageItem,
-  tryParseJSON,
-  getUniqueDealId,
-  webSessionId
+  storage
 } from 'modules/twistDigitalBidAdapter.js';
 import * as utils from 'src/utils.js';
 import {version} from 'package.json';
@@ -18,6 +10,16 @@ import {useFakeTimers} from 'sinon';
 import {BANNER, VIDEO} from '../../../src/mediaTypes';
 import {config} from '../../../src/config';
 import {deepSetValue} from 'src/utils.js';
+import {
+  extractPID,
+  extractCID,
+  extractSubDomain,
+  hashCode,
+  getStorageItem,
+  setStorageItem,
+  tryParseJSON,
+  getUniqueDealId
+} from '../../../libraries/vidazooUtils/bidderUtils.js';
 
 export const TEST_ID_SYSTEMS = ['britepoolid', 'criteoId', 'id5id', 'idl_env', 'lipb', 'netId', 'parrableId', 'pubcid', 'tdid', 'pubProvidedId'];
 
@@ -355,7 +357,6 @@ describe('TwistDigitalBidAdapter', function () {
           uniqueDealId: `${hashUrl}_${Date.now().toString()}`,
           uqs: getTopWindowQueryParams(),
           isStorageAllowed: true,
-          webSessionId: webSessionId,
           mediaTypes: {
             video: {
               api: [2],
@@ -453,8 +454,7 @@ describe('TwistDigitalBidAdapter', function () {
               name: 'example.com',
               segment: [{id: '243'}],
             },
-          ],
-          webSessionId: webSessionId
+          ]
         }
       });
     });
@@ -540,8 +540,7 @@ describe('TwistDigitalBidAdapter', function () {
             name: 'example.com',
             segment: [{id: '243'}],
           },
-        ],
-        webSessionId: webSessionId
+        ]
       };
 
       const REQUEST_DATA2 = utils.deepClone(REQUEST_DATA);
@@ -738,8 +737,6 @@ describe('TwistDigitalBidAdapter', function () {
         switch (idSystemProvider) {
           case 'lipb':
             return {lipbid: id};
-          case 'parrableId':
-            return {eid: id};
           case 'id5id':
             return {uid: id};
           default:
@@ -805,13 +802,13 @@ describe('TwistDigitalBidAdapter', function () {
     const key = 'myKey';
     let uniqueDealId;
     beforeEach(() => {
-      uniqueDealId = getUniqueDealId(key, 0);
+      uniqueDealId = getUniqueDealId(storage, key, 0);
     })
 
     it('should get current unique deal id', function (done) {
       // waiting some time so `now` will become past
       setTimeout(() => {
-        const current = getUniqueDealId(key);
+        const current = getUniqueDealId(storage, key);
         expect(current).to.be.equal(uniqueDealId);
         done();
       }, 200);
@@ -819,7 +816,7 @@ describe('TwistDigitalBidAdapter', function () {
 
     it('should get new unique deal id on expiration', function (done) {
       setTimeout(() => {
-        const current = getUniqueDealId(key, 100);
+        const current = getUniqueDealId(storage, key, 100);
         expect(current).to.not.be.equal(uniqueDealId);
         done();
       }, 200)
@@ -843,8 +840,8 @@ describe('TwistDigitalBidAdapter', function () {
         shouldAdvanceTime: true,
         now
       });
-      setStorageItem('myKey', 2020);
-      const {value, created} = getStorageItem('myKey');
+      setStorageItem(storage, 'myKey', 2020);
+      const {value, created} = getStorageItem(storage, 'myKey');
       expect(created).to.be.equal(now);
       expect(value).to.be.equal(2020);
       expect(typeof value).to.be.equal('number');
@@ -855,7 +852,7 @@ describe('TwistDigitalBidAdapter', function () {
     it('should get external stored value', function () {
       const value = 'superman'
       window.localStorage.setItem('myExternalKey', value);
-      const item = getStorageItem('myExternalKey');
+      const item = getStorageItem(storage, 'myExternalKey');
       expect(item).to.be.equal(value);
     });
 

package/test/spec/modules/userId_spec.js

@@ -4,7 +4,7 @@ import {
   coreStorage,
   dep,
   findRootDomain,
-  getConsentHash,
+  getConsentHash, getValidSubmoduleConfigs,
   init,
   PBJS_USER_ID_OPTOUT_NAME,
   requestBidsHook,
@@ -190,6 +190,65 @@ describe('User ID', function () {
     })
   })
 
+  describe('userId config validation', () => {
+    beforeEach(() => {
+      sandbox.stub(utils, 'logWarn');
+    });
+
+    function mockConfig(storageConfig = {}) {
+      return {
+        name: 'mockModule',
+        storage: {
+          name: 'mockStorage',
+          type: 'cookie',
+          ...storageConfig
+        }
+      }
+    }
+
+    Object.entries({
+      'not an object': 'garbage',
+      'missing name': {},
+      'empty name': {name: ''},
+      'empty storage config': {name: 'mockId', storage: {}},
+      'storage type, but no storage name': mockConfig({name: ''}),
+      'storage name, but no storage type': mockConfig({type: undefined}),
+    }).forEach(([t, config]) => {
+      it(`should log a warning and reject configuration with ${t}`, () => {
+        expect(getValidSubmoduleConfigs([config]).length).to.equal(0);
+        sinon.assert.called(utils.logWarn);
+      });
+    });
+
+    it('should reject non-array userId configuration', () => {
+      expect(getValidSubmoduleConfigs({})).to.eql([]);
+      sinon.assert.called(utils.logWarn);
+    });
+
+    it('should accept null configuration', () => {
+      expect(getValidSubmoduleConfigs()).to.eql([]);
+      sinon.assert.notCalled(utils.logWarn);
+    });
+
+    ['refreshInSeconds', 'expires'].forEach(param => {
+      describe(`${param} parameter`, () => {
+        it('should be made a number, when possible', () => {
+          expect(getValidSubmoduleConfigs([mockConfig({[param]: '123'})])[0].storage[param]).to.equal(123);
+        });
+
+        it('should log a warning when not a number', () => {
+          expect(getValidSubmoduleConfigs([mockConfig({[param]: 'garbage'})])[0].storage[param]).to.not.exist;
+          sinon.assert.called(utils.logWarn)
+        });
+
+        it('should be left untouched when not specified', () => {
+          expect(getValidSubmoduleConfigs([mockConfig()])[0].storage[param]).to.not.exist;
+          sinon.assert.notCalled(utils.logWarn);
+        });
+      })
+    })
+  })
+
   describe('Decorate Ad Units', function () {
     beforeEach(function () {
       // reset mockGpt so nothing else interferes
@@ -2173,60 +2232,40 @@ describe('User ID', function () {
       });
     });
 
-    describe('Set cookie behavior', function () {
-      let cookie, cookieStub;
-
-      beforeEach(function () {
-        setSubmoduleRegistry([sharedIdSystemSubmodule]);
-        init(config);
-        cookie = document.cookie;
-        cookieStub = sinon.stub(document, 'cookie');
-        cookieStub.get(() => cookie);
-        cookieStub.set((val) => cookie = val);
-      });
-
-      afterEach(function () {
-        cookieStub.restore();
-      });
-
-      it('should allow submodules to override the domain', function () {
-        const submodule = {
-          submodule: {
-            domainOverride: function () {
-              return 'foo.com'
-            }
-          },
+    describe('Submodule ID storage', () => {
+      let submodule;
+      beforeEach(() => {
+        submodule = {
+          submodule: {},
           config: {
             name: 'mockId',
-            storage: {
-              type: 'cookie'
-            }
           },
           storageMgr: {
-            setCookie: sinon.stub()
+            setCookie: sinon.stub(),
+            setDataInLocalStorage: sinon.stub()
           },
-          enabledStorageTypes: [ 'cookie' ]
+          enabledStorageTypes: ['cookie', 'html5']
         }
-        setStoredValue(submodule, 'bar');
-        expect(submodule.storageMgr.setCookie.getCall(0).args[4]).to.equal('foo.com');
       });
 
-      it('should pass no domain if submodule does not override the domain', function () {
-        const submodule = {
-          submodule: {},
-          config: {
-            name: 'mockId',
-            storage: {
-              type: 'cookie'
-            }
-          },
-          storageMgr: {
-            setCookie: sinon.stub()
-          },
-          enabledStorageTypes: [ 'cookie' ]
-        }
-        setStoredValue(submodule, 'bar');
-        expect(submodule.storageMgr.setCookie.getCall(0).args[4]).to.equal(null);
+      describe('Set cookie behavior', function () {
+        beforeEach(() => {
+          submodule.config.storage = {
+            type: 'cookie'
+          }
+        });
+        it('should allow submodules to override the domain', function () {
+          submodule.submodule.domainOverride = function() {
+            return 'foo.com'
+          }
+          setStoredValue(submodule, 'bar');
+          expect(submodule.storageMgr.setCookie.getCall(0).args[4]).to.equal('foo.com');
+        });
+
+        it('should pass no domain if submodule does not override the domain', function () {
+          setStoredValue(submodule, 'bar');
+          expect(submodule.storageMgr.setCookie.getCall(0).args[4]).to.equal(null);
+        });
       });
     });