prebid.js 7.22.0 → 7.24.0

package/test/spec/modules/aaxBlockmeter_spec.js

@@ -0,0 +1,58 @@
+import {aaxBlockmeterRtdModule} from '../../../modules/aaxBlockmeterRtdProvider.js';
+import * as sinon from 'sinon';
+import {assert} from 'chai';
+
+let sandbox;
+let getTargetingDataSpy;
+
+const config = {
+  dataProviders: [{
+    'name': 'aaxBlockmeter',
+    'params': {
+      'pub': 'publisher_id',
+    }
+  }]
+};
+
+describe('aaxBlockmeter realtime module', function () {
+  beforeEach(function () {
+    sandbox = sinon.sandbox.create();
+    window.aax = window.aax || {};
+    window.aax.getTargetingData = getTargetingDataSpy = sandbox.spy();
+  });
+
+  afterEach(function () {
+    sandbox.restore();
+    window.aax = {};
+  });
+
+  it('init should return false when config is empty', function () {
+    assert.equal(aaxBlockmeterRtdModule.init({}), false);
+  });
+
+  it('init should return false when config.params id is empty', function () {
+    assert.equal(aaxBlockmeterRtdModule.init({params: {}}), false);
+  });
+
+  it('init should return true when config.params.pub is not string', function () {
+    assert.equal(aaxBlockmeterRtdModule.init({params: {pub: 12345}}), false);
+  });
+
+  it('init should return true when config.params.pub id is passed and is string typed', function () {
+    assert.equal(aaxBlockmeterRtdModule.init(config.dataProviders[0]), true);
+  });
+
+  describe('getTargetingData should work correctly', function () {
+    it('should return ad unit codes when ad units are present', function () {
+      const codes = ['code1', 'code2'];
+      assert.deepEqual(aaxBlockmeterRtdModule.getTargetingData(codes), {
+        code1: {'atk': 'code1'},
+        code2: {'atk': 'code2'},
+      });
+    });
+
+    it('should call aax.getTargetingData if loaded', function () {
+      aaxBlockmeterRtdModule.getTargetingData([], config.dataProviders[0], null);
+    });
+  });
+});

package/test/spec/modules/admaticBidAdapter_spec.js

@@ -0,0 +1,46 @@
+import {expect} from 'chai';
+import {spec, storage} from 'modules/admaticBidAdapter.js';
+import {newBidder} from 'src/adapters/bidderFactory.js';
+import {getStorageManager} from 'src/storageManager';
+
+const ENDPOINT = 'https://layer.serve.admatic.com.tr/v1';
+
+describe('admaticBidAdapter', () => {
+  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', function() {
+    let bid = {
+      'bidder': 'admatic',
+      'params': {
+        'networkId': 10433394
+      },
+      'adUnitCode': 'adunit-code',
+      'sizes': [[300, 250], [300, 600]],
+      'bidId': '30b31c1838de1e',
+      'bidderRequestId': '22edbae2733bf6',
+      'auctionId': '1d1a030790a475',
+      'creativeId': 'er2ee'
+    };
+
+    it('should return true when required params found', function() {
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
+    });
+
+    it('should return false when required params are not passed', function() {
+      let bid = Object.assign({}, bid);
+      delete bid.params;
+
+      bid.params = {
+        'networkId': 0
+      };
+
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
+  });
+});

package/test/spec/modules/chtnwBidAdapter_spec.js

@@ -0,0 +1,105 @@
+import { expect } from 'chai';
+import { spec } from '../../../modules/chtnwBidAdapter.js';
+import * as utils from '../../../src/utils.js';
+
+describe('ChtnwAdapter', function () {
+  describe('isBidRequestValid', function () {
+    const bid = {
+      code: 'adunit-code',
+      bidder: 'chtnw',
+      params: {
+        placementId: '38EL412LO82XR9O6'
+      },
+      sizes: [
+        [300, 250]
+      ],
+    };
+
+    it('should return true when required params found', function () {
+      const bidRequest = utils.deepClone(bid);
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(true);
+    });
+
+    it('should return false when required params are missing', function () {
+      const bidRequest = utils.deepClone(bid);
+      delete bidRequest.params;
+      expect(spec.isBidRequestValid(bidRequest)).to.equal(false);
+    });
+  });
+
+  describe('buildRequests', function () {
+    let bidRequests = [{
+      code: 'adunit-code',
+      bidder: 'chtnw',
+      params: {
+        placementId: '38EL412LO82XR9O6'
+      },
+      sizes: [
+        [300, 250]
+      ],
+    }];
+
+    const request = spec.buildRequests(bidRequests);
+
+    it('Returns POST method', function () {
+      expect(request.method).to.equal('POST');
+    });
+
+    it('Returns general data valid', function () {
+      let data = request.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('bids');
+      expect(data).to.have.property('uuid');
+      expect(data).to.have.property('device');
+      expect(data).to.have.property('site');
+    });
+  });
+
+  describe('interpretResponse', function () {
+    let responseBody = [{
+      'requestId': 'test',
+      'cpm': 0.5,
+      'currency': 'USD',
+      'width': 300,
+      'height': 250,
+      'netRevenue': true,
+      'ttl': 60,
+      'creativeId': 'AD',
+      'ad': '<h1>AD<h1>',
+      'mediaType': 'banner',
+      'meta': {
+        'advertiserDomains': [
+          'www.example.com'
+        ]
+      }
+    }];
+
+    it('handles empty bid response', function () {
+      let response = {
+        body: responseBody
+      };
+      let result = spec.interpretResponse(response);
+      expect(result.length).to.not.equal(0);
+      expect(result[0].meta.advertiserDomains).to.be.an('array');
+    });
+
+    it('handles empty bid response', function () {
+      let response = {
+        body: []
+      };
+      let result = spec.interpretResponse(response);
+      expect(result.length).to.equal(0);
+    });
+  });
+
+  describe('getUserSyncs', function () {
+    it('should register type is image', function () {
+      const syncOptions = {
+        'pixelEnabled': 'true'
+      }
+      let userSync = spec.getUserSyncs(syncOptions);
+      expect(userSync[0].type).to.equal('image');
+      expect(userSync[0].url).to.have.string('ssp');
+    });
+  });
+});

package/test/spec/modules/concertBidAdapter_spec.js

@@ -7,11 +7,33 @@ describe('ConcertAdapter', function () {
   let bidRequests;
   let bidRequest;
   let bidResponse;
+  let element;
+  let sandbox;
 
   afterEach(function () {
     $$PREBID_GLOBAL$$.bidderSettings = {};
+    sandbox.restore();
   });
+
   beforeEach(function () {
+    element = {
+      x: 0,
+      y: 0,
+      width: 0,
+      height: 0,
+      getBoundingClientRect: () => {
+        return {
+          width: element.width,
+          height: element.height,
+
+          left: element.x,
+          top: element.y,
+          right: element.x + element.width,
+          bottom: element.y + element.height
+        };
+      }
+    };
+
     $$PREBID_GLOBAL$$.bidderSettings = {
       concert: {
         storageAllowed: true
@@ -56,6 +78,9 @@ describe('ConcertAdapter', function () {
         ]
       }
     }
+
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(document, 'getElementById').withArgs('desktop_leaderboard_variable').returns(element)
   });
 
   describe('spec.isBidRequestValid', function() {
@@ -119,6 +144,37 @@ describe('ConcertAdapter', function () {
 
       expect(payload.meta.uid).to.equal('foo');
     });
+
+    it('should add uid2 to eids list if available', function() {
+      bidRequests[0].userId = { uid2: { id: 'uid123' } }
+
+      const request = spec.buildRequests(bidRequests, bidRequest);
+      const payload = JSON.parse(request.data);
+      const meta = payload.meta
+
+      expect(meta.eids.length).to.equal(1);
+      expect(meta.eids[0].uids[0].id).to.equal('uid123')
+      expect(meta.eids[0].uids[0].atype).to.equal(3)
+    })
+
+    it('should return empty eids list if none are available', function() {
+      bidRequests[0].userId = { testId: { id: 'uid123' } }
+      const request = spec.buildRequests(bidRequests, bidRequest);
+      const payload = JSON.parse(request.data);
+      const meta = payload.meta
+
+      expect(meta.eids.length).to.equal(0);
+    });
+
+    it('should return x/y offset coordiantes when element is present', function() {
+      Object.assign(element, { x: 100, y: 0, width: 400, height: 400 })
+      const request = spec.buildRequests(bidRequests, bidRequest);
+      const payload = JSON.parse(request.data);
+      const slot = payload.slots[0];
+
+      expect(slot.offsetCoordinates.x).to.equal(100)
+      expect(slot.offsetCoordinates.y).to.equal(0)
+    })
   });
 
   describe('spec.interpretResponse', function() {

package/test/spec/modules/connectIdSystem_spec.js

@@ -4,6 +4,7 @@ import {connectIdSubmodule} from 'modules/connectIdSystem.js';
 
 describe('Yahoo ConnectID Submodule', () => {
   const HASHED_EMAIL = '6bda6f2fa268bf0438b5423a9861a2cedaa5dec163c03f743cfe05c08a8397b2';
+  const PUBLISHER_USER_ID = '975484817';
   const PIXEL_ID = '1234';
   const PROD_ENDPOINT = `https://ups.analytics.yahoo.com/ups/${PIXEL_ID}/fed`;
   const OVERRIDE_ENDPOINT = 'https://foo/bar';
@@ -48,26 +49,55 @@ describe('Yahoo ConnectID Submodule', () => {
       return result;
     }
 
-    it('returns undefined if he and pixelId params are not passed', () => {
+    it('returns undefined if he, pixelId and puid params are not passed', () => {
       expect(invokeGetIdAPI({}, consentData)).to.be.undefined;
       expect(ajaxStub.callCount).to.equal(0);
     });
 
     it('returns undefined if the pixelId param is not passed', () => {
       expect(invokeGetIdAPI({
-        he: HASHED_EMAIL
+        he: HASHED_EMAIL,
+        puid: PUBLISHER_USER_ID
       }, consentData)).to.be.undefined;
       expect(ajaxStub.callCount).to.equal(0);
     });
 
-    it('returns undefined if the he param is not passed', () => {
+    it('returns undefined if the pixelId param is passed, but the he and puid param are not passed', () => {
       expect(invokeGetIdAPI({
         pixelId: PIXEL_ID
       }, consentData)).to.be.undefined;
       expect(ajaxStub.callCount).to.equal(0);
     });
 
-    it('returns an object with the callback function if the correct params are passed', () => {
+    it('returns an object with the callback function if the endpoint override param and the he params are passed', () => {
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        endpoint: OVERRIDE_ENDPOINT
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+    });
+
+    it('returns an object with the callback function if the endpoint override param and the puid params are passed', () => {
+      let result = invokeGetIdAPI({
+        puid: PUBLISHER_USER_ID,
+        endpoint: OVERRIDE_ENDPOINT
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+    });
+
+    it('returns an object with the callback function if the endpoint override param and the puid and he params are passed', () => {
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        puid: PUBLISHER_USER_ID,
+        endpoint: OVERRIDE_ENDPOINT
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+    });
+
+    it('returns an object with the callback function if the pixelId and he params are passed', () => {
       let result = invokeGetIdAPI({
         he: HASHED_EMAIL,
         pixelId: PIXEL_ID
@@ -76,6 +106,25 @@ describe('Yahoo ConnectID Submodule', () => {
       expect(result.callback).to.be.a('function');
     });
 
+    it('returns an object with the callback function if the pixelId and puid params are passed', () => {
+      let result = invokeGetIdAPI({
+        puid: PUBLISHER_USER_ID,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      expect(result.callback).to.be.a('function');
+    });
+
+    it('returns an object with the callback function if the pixelId, he and puid params are passed', () => {
+      let result = invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        puid: PUBLISHER_USER_ID,
+        pixelId: PIXEL_ID
+      }, consentData);
+      expect(result).to.be.an('object').that.has.all.keys('callback');
+      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({
@@ -96,13 +145,57 @@ describe('Yahoo ConnectID Submodule', () => {
       localStorage.removeItem('connectIdOptOut');
     });
 
-    it('Makes an ajax GET request to the production API endpoint with query params', () => {
+    it('Makes an ajax GET request to the production API endpoint with pixelId and he query params', () => {
+      invokeGetIdAPI({
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID
+      }, consentData);
+
+      const expectedParams = {
+        he: HASHED_EMAIL,
+        pixelId: PIXEL_ID,
+        '1p': '0',
+        gdpr: '1',
+        gdpr_consent: consentData.gdpr.consentString,
+        us_privacy: consentData.uspConsent
+      };
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+
+      expect(ajaxStub.firstCall.args[0].indexOf(`${PROD_ENDPOINT}?`)).to.equal(0);
+      expect(requestQueryParams).to.deep.equal(expectedParams);
+      expect(ajaxStub.firstCall.args[3]).to.deep.equal({method: 'GET', withCredentials: true});
+    });
+
+    it('Makes an ajax GET request to the production API endpoint with pixelId and puid query params', () => {
       invokeGetIdAPI({
+        puid: PUBLISHER_USER_ID,
+        pixelId: PIXEL_ID
+      }, consentData);
+
+      const expectedParams = {
+        puid: PUBLISHER_USER_ID,
+        pixelId: PIXEL_ID,
+        '1p': '0',
+        gdpr: '1',
+        gdpr_consent: consentData.gdpr.consentString,
+        us_privacy: consentData.uspConsent
+      };
+      const requestQueryParams = parseQS(ajaxStub.firstCall.args[0].split('?')[1]);
+
+      expect(ajaxStub.firstCall.args[0].indexOf(`${PROD_ENDPOINT}?`)).to.equal(0);
+      expect(requestQueryParams).to.deep.equal(expectedParams);
+      expect(ajaxStub.firstCall.args[3]).to.deep.equal({method: 'GET', withCredentials: true});
+    });
+
+    it('Makes an ajax GET request to the production API endpoint with pixelId, puid and he query params', () => {
+      invokeGetIdAPI({
+        puid: PUBLISHER_USER_ID,
         he: HASHED_EMAIL,
         pixelId: PIXEL_ID
       }, consentData);
 
       const expectedParams = {
+        puid: PUBLISHER_USER_ID,
         he: HASHED_EMAIL,
         pixelId: PIXEL_ID,
         '1p': '0',
@@ -185,6 +278,16 @@ describe('Yahoo ConnectID Submodule', () => {
   });
 
   describe('decode()', () => {
+    let userHasOptedOutStub;
+    beforeEach(() => {
+      userHasOptedOutStub = sinon.stub(connectIdSubmodule, 'userHasOptedOut');
+      userHasOptedOutStub.returns(false);
+    });
+
+    afterEach(() => {
+      userHasOptedOutStub.restore()
+    });
+
     const VALID_API_RESPONSES = [{
       key: 'connectid',
       expected: '4567',
@@ -205,5 +308,72 @@ describe('Yahoo ConnectID Submodule', () => {
         expect(connectIdSubmodule.decode(response)).to.be.undefined;
       });
     });
+
+    it('should return undefined if user has utilised the easy opt-out mechanism', () => {
+      userHasOptedOutStub.returns(true);
+      expect(connectIdSubmodule.decode(VALID_API_RESPONSES[0].payload)).to.be.undefined;
+    })
+  });
+
+  describe('getAjaxFn()', () => {
+    it('should return a function', () => {
+      expect(connectIdSubmodule.getAjaxFn()).to.be.a('function');
+    });
+  });
+
+  describe('isEUConsentRequired()', () => {
+    it('should return a function', () => {
+      expect(connectIdSubmodule.isEUConsentRequired).to.be.a('function');
+    });
+
+    it('should be false if consent data is empty', () => {
+      expect(connectIdSubmodule.isEUConsentRequired({})).to.be.false;
+    });
+
+    it('should be false if consent data.gdpr object is empty', () => {
+      expect(connectIdSubmodule.isEUConsentRequired({
+        gdpr: {}
+      })).to.be.false;
+    });
+
+    it('should return false if consent data.gdpr.applies is false', () => {
+      expect(connectIdSubmodule.isEUConsentRequired({
+        gdpr: {
+          gdprApplies: false
+        }
+      })).to.be.false;
+    });
+
+    it('should return true if consent data.gdpr.applies is true', () => {
+      expect(connectIdSubmodule.isEUConsentRequired({
+        gdpr: {
+          gdprApplies: true
+        }
+      })).to.be.true;
+    });
+  });
+
+  describe('userHasOptedOut()', () => {
+    afterEach(() => {
+      localStorage.removeItem('connectIdOptOut');
+    });
+
+    it('should return a function', () => {
+      expect(connectIdSubmodule.userHasOptedOut).to.be.a('function');
+    });
+
+    it('should return false when local storage key has not been set function', () => {
+      expect(connectIdSubmodule.userHasOptedOut()).to.be.false;
+    });
+
+    it('should return true when local storage key has been set to "1"', () => {
+      localStorage.setItem('connectIdOptOut', '1');
+      expect(connectIdSubmodule.userHasOptedOut()).to.be.true;
+    });
+
+    it('should return false when local storage key has not been set to "1"', () => {
+      localStorage.setItem('connectIdOptOut', 'hello');
+      expect(connectIdSubmodule.userHasOptedOut()).to.be.false;
+    });
   });
 });

package/test/spec/modules/consentManagementUsp_spec.js

@@ -8,8 +8,9 @@ import {
 } from 'modules/consentManagementUsp.js';
 import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
-import {uspDataHandler} from 'src/adapterManager.js';
+import adapterManager, {uspDataHandler} from 'src/adapterManager.js';
 import 'src/prebid.js';
+import {defer} from '../../../src/utils/promise.js';
 
 let expect = require('chai').expect;
 
@@ -23,6 +24,16 @@ function createIFrameMarker() {
 }
 
 describe('consentManagement', function () {
+  let sandbox;
+  beforeEach(() => {
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(adapterManager, 'callDataDeletionRequest');
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
   it('should enable itself on requestBids using default values', (done) => {
     requestBidsHook(() => {
       expect(uspDataHandler.enabled).to.be.true;
@@ -301,8 +312,11 @@ describe('consentManagement', function () {
     describe('USPAPI workflow for iframed page', function () {
       let ifr = null;
       let stringifyResponse = false;
+      let mockApi, replySent;
 
       beforeEach(function () {
+        mockApi = sinon.stub();
+        replySent = defer();
         sinon.stub(utils, 'logError');
         sinon.stub(utils, 'logWarn');
         ifr = createIFrameMarker();
@@ -322,17 +336,21 @@ describe('consentManagement', function () {
 
       function uspapiMessageHandler(event) {
         if (event && event.data) {
-          var data = event.data;
+          const data = event.data;
           if (data.__uspapiCall) {
-            var callId = data.__uspapiCall.callId;
-            var response = {
-              __uspapiReturn: {
-                callId,
-                returnValue: { uspString: '1YY' },
-                success: true
+            const {command, version, callId} = data.__uspapiCall;
+            let response = mockApi(command, version, callId);
+            if (response) {
+              response = {
+                __uspapiReturn: {
+                  callId,
+                  returnValue: response,
+                  success: true
+                }
               }
-            };
-            event.source.postMessage(stringifyResponse ? JSON.stringify(response) : response, '*');
+              event.source.postMessage(stringifyResponse ? JSON.stringify(response) : response, '*');
+              replySent.resolve();
+            }
           }
         }
       }
@@ -345,6 +363,11 @@ describe('consentManagement', function () {
       function testIFramedPage(testName, messageFormatString) {
         it(`should return the consent string from a postmessage + addEventListener response - ${testName}`, (done) => {
           stringifyResponse = messageFormatString;
+          mockApi.callsFake((cmd) => {
+            if (cmd === 'getUSPData') {
+              return { uspString: '1YY' }
+            }
+          })
           setConsentConfig(goodConfig);
           requestBidsHook(() => {
             let consent = uspDataHandler.getConsentData();
@@ -355,6 +378,20 @@ describe('consentManagement', function () {
           }, {});
         });
       }
+
+      it('fires deletion request on registerDeletion', (done) => {
+        mockApi.callsFake((cmd) => {
+          return cmd === 'registerDeletion'
+        })
+        sinon.assert.notCalled(adapterManager.callDataDeletionRequest);
+        setConsentConfig(goodConfig);
+        replySent.promise.then(() => {
+          setTimeout(() => { // defer again to give time for the message to get through
+            sinon.assert.calledOnce(adapterManager.callDataDeletionRequest);
+            done()
+          }, 200)
+        })
+      });
     });
 
     describe('test without iframe locater', function() {
@@ -400,23 +437,19 @@ describe('consentManagement', function () {
     });
 
     describe('USPAPI workflow for normal pages:', function () {
-      let uspapiStub = sinon.stub();
       let ifr = null;
 
       beforeEach(function () {
         didHookReturn = false;
         ifr = createIFrameMarker();
-        sinon.stub(utils, 'logError');
-        sinon.stub(utils, 'logWarn');
+        sandbox.stub(utils, 'logError');
+        sandbox.stub(utils, 'logWarn');
         window.__uspapi = function() {};
       });
 
       afterEach(function () {
         config.resetConfig();
         $$PREBID_GLOBAL$$.requestBids.removeAll();
-        uspapiStub.restore();
-        utils.logError.restore();
-        utils.logWarn.restore();
         document.body.removeChild(ifr);
         delete window.__uspapi;
         resetConsentData();
@@ -427,7 +460,7 @@ describe('consentManagement', function () {
           uspString: '1NY'
         };
 
-        uspapiStub = sinon.stub(window, '__uspapi').callsFake((...args) => {
+        sandbox.stub(window, '__uspapi').callsFake((...args) => {
           args[2](testConsentData, true);
         });
 
@@ -448,7 +481,7 @@ describe('consentManagement', function () {
           uspString: '1NY'
         };
 
-        uspapiStub = sinon.stub(window, '__uspapi').callsFake((...args) => {
+        sandbox.stub(window, '__uspapi').callsFake((...args) => {
           args[2](testConsentData, true);
         });
 
@@ -463,6 +496,19 @@ describe('consentManagement', function () {
         expect(consentMeta.usp).to.equal(testConsentData.uspString);
         expect(consentMeta.generatedAt).to.be.above(1644367751709);
       });
+
+      it('registers deletion request event listener', () => {
+        let listener;
+        sandbox.stub(window, '__uspapi').callsFake((cmd, _, cb) => {
+          if (cmd === 'registerDeletion') {
+            listener = cb;
+          }
+        });
+        setConsentConfig(goodConfig);
+        sinon.assert.notCalled(adapterManager.callDataDeletionRequest);
+        listener();
+        sinon.assert.calledOnce(adapterManager.callDataDeletionRequest);
+      })
     });
   });
 });