prebid.js 8.0.0 → 8.2.0

package/test/spec/modules/byDataAnalyticsAdapter_spec.js

@@ -96,7 +96,7 @@ let expectedDataArgs = {
     aus: '300x250',
     bidadv: 'appnexus',
     bid: '14480e9832f2d2b',
-    inb: 0,
+    inb: 1,
     ito: 0,
     ipwb: 0,
     iwb: 0,
@@ -107,7 +107,7 @@ let expectedDataArgs = {
     aus: '250x250',
     bidadv: 'appnexus',
     bid: '14480e9832f2d2b',
-    inb: 0,
+    inb: 1,
     ito: 0,
     ipwb: 0,
     iwb: 0,
@@ -167,11 +167,13 @@ describe('byData Analytics Adapter ', () => {
   });
 
   describe('track-events', function () {
-    ascAdapter.enableAnalytics(initOptions)
-    // Step 1: Initialize adapter
-    adapterManager.enableAnalytics({
-      provider: 'bydata',
-      options: initOptions
+    before(() => {
+      ascAdapter.enableAnalytics(initOptions)
+      // Step 1: Initialize adapter
+      adapterManager.enableAnalytics({
+        provider: 'bydata',
+        options: initOptions
+      });
     });
     it('sends and formatted auction data ', function () {
       events.emit(constants.EVENTS.BID_TIMEOUT, bidTimeoutArgs);

package/test/spec/modules/chtnwBidAdapter_spec.js

@@ -39,7 +39,10 @@ describe('ChtnwAdapter', function () {
       ],
     }];
 
-    const request = spec.buildRequests(bidRequests);
+    let request;
+    before(() => {
+      request = spec.buildRequests(bidRequests);
+    })
 
     it('Returns POST method', function () {
       expect(request.method).to.equal('POST');

package/test/spec/modules/colossussspBidAdapter_spec.js

@@ -283,6 +283,35 @@ describe('ColossussspAdapter', function () {
     });
   });
 
+  describe('gpp consent', function () {
+    it('bidderRequest.gppConsent', () => {
+      bidderRequest.gppConsent = {
+        gppString: 'abc123',
+        applicableSections: [8]
+      };
+
+      let serverRequest = spec.buildRequests([bid], bidderRequest);
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      delete bidderRequest.gppConsent;
+    })
+
+    it('bidderRequest.ortb2.regs.gpp', () => {
+      bidderRequest.ortb2.regs = bidderRequest.ortb2.regs || {};
+      bidderRequest.ortb2.regs.gpp = 'abc123';
+      bidderRequest.ortb2.regs.gpp_sid = [8];
+
+      let serverRequest = spec.buildRequests([bid], bidderRequest);
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+    })
+  });
+
   describe('interpretResponse', function () {
     let resObject = {
       body: [{

package/test/spec/modules/consentManagementGpp_spec.js

@@ -1,4 +1,11 @@
-import { setConsentConfig, requestBidsHook, resetConsentData, userCMP, consentTimeout, staticConsentData } from 'modules/consentManagementGpp.js';
+import {
+  setConsentConfig,
+  requestBidsHook,
+  resetConsentData,
+  userCMP,
+  consentTimeout,
+  storeConsentData, lookupIabConsent
+} from 'modules/consentManagementGpp.js';
 import { gppDataHandler } from 'src/adapterManager.js';
 import * as utils from 'src/utils.js';
 import { config } from 'src/config.js';
@@ -94,16 +101,79 @@ describe('consentManagementGpp', function () {
       });
     });
 
+    describe('lookupIABConsent', () => {
+      let mockCmp, mockCmpEvent, gppData, sectionData
+      beforeEach(() => {
+        gppData = {
+          gppString: 'mockString',
+          applicableSections: [],
+          pingData: {}
+        };
+        sectionData = {};
+        mockCmp = sinon.stub().callsFake(({command, callback, parameter}) => {
+          let res;
+          switch (command) {
+            case 'addEventListener':
+              mockCmpEvent = callback;
+              break;
+            case 'getGPPData':
+              res = gppData;
+              break;
+            case 'getSection':
+              res = sectionData[parameter];
+              break;
+          }
+          return Promise.resolve(res);
+        });
+      })
+
+      function runLookup() {
+        return new Promise((resolve, reject) => lookupIabConsent({onSuccess: resolve, onError: reject}, () => mockCmp));
+      }
+
+      function oneShotLookup() {
+        const pm = runLookup();
+        mockCmpEvent({eventName: 'sectionChange'});
+        return pm;
+      }
+
+      it('fetches all sections', () => {
+        gppData.pingData.supportedAPIs = ['usnat', 'usca']
+        sectionData = {
+          usnat: {mock: 'usnat'},
+          usca: {mock: 'usca'}
+        };
+        return oneShotLookup().then((res) => {
+          expect(res.sectionData).to.eql(sectionData);
+        });
+      });
+
+      it('does not choke if some section data is not available', () => {
+        gppData.pingData.supportedAPIs = ['usnat', 'usca']
+        sectionData = {
+          usca: {mock: 'data'}
+        };
+        return oneShotLookup().then((res) => {
+          expect(res.sectionData).to.eql(sectionData);
+        })
+      });
+    })
+
     describe('static consent string setConsentConfig value', () => {
       afterEach(() => {
         config.resetConfig();
       });
 
-      it('results in user settings overriding system defaults for v2 spec', () => {
+      it('results in user settings overriding system defaults', () => {
         let staticConfig = {
           gpp: {
             cmpApi: 'static',
             timeout: 7500,
+            sectionData: {
+              usnat: {
+                MockUsnatParsedFlag: true
+              }
+            },
             consentData: {
               applicableSections: [7],
               gppString: 'ABCDEFG1234',
@@ -116,11 +186,10 @@ describe('consentManagementGpp', function () {
 
         setConsentConfig(staticConfig);
         expect(userCMP).to.be.equal('static');
-        expect(consentTimeout).to.be.equal(0); // should always return without a timeout when config is used
         const consent = gppDataHandler.getConsentData();
         expect(consent.gppString).to.eql(staticConfig.gpp.consentData.gppString);
-        expect(consent.fullGppData).to.eql(staticConfig.gpp.consentData);
-        expect(staticConsentData).to.be.equal(staticConfig.gpp.consentData);
+        expect(consent.gppData).to.eql(staticConfig.gpp.consentData);
+        expect(consent.sectionData).to.eql(staticConfig.gpp.sectionData);
       });
     });
   });
@@ -334,6 +403,14 @@ describe('consentManagementGpp', function () {
                     success: true
                   }
                 }
+              } else if (data[`${prefix}Call`].command === 'getSection') {
+                response = {
+                  [`${prefix}Return`]: {
+                    callId,
+                    returnValue: {},
+                    success: true
+                  }
+                }
               }
               event.source.postMessage(stringifyResponse ? JSON.stringify(response) : response, '*');
             }
@@ -367,7 +444,7 @@ describe('consentManagementGpp', function () {
         resetConsentData();
       });
 
-      describe('v2 CMP workflow for iframe pages:', function () {
+      describe('workflow for iframe pages:', function () {
         stringifyResponse = false;
         let ifr2 = null;
 
@@ -410,7 +487,7 @@ describe('consentManagementGpp', function () {
         resetConsentData();
       });
 
-      describe('v2 CMP workflow for normal pages:', function () {
+      describe('CMP workflow for normal pages:', function () {
         beforeEach(function () {
           window.__gpp = function () {};
         });

package/test/spec/modules/consentManagement_spec.js

@@ -1,18 +1,17 @@
 import {
-  setConsentConfig,
-  requestBidsHook,
-  resetConsentData,
-  userCMP,
-  consentTimeout,
   actionTimeout,
-  staticConsentData,
+  consentTimeout,
   gdprScope,
   loadConsentData,
-  setActionTimeout
+  requestBidsHook,
+  resetConsentData,
+  setConsentConfig,
+  staticConsentData,
+  userCMP
 } from 'modules/consentManagement.js';
-import { gdprDataHandler } from 'src/adapterManager.js';
+import {gdprDataHandler} from 'src/adapterManager.js';
 import * as utils from 'src/utils.js';
-import { config } from 'src/config.js';
+import {config} from 'src/config.js';
 import 'src/prebid.js';
 
 let expect = require('chai').expect;
@@ -487,15 +486,6 @@ describe('consentManagement', function () {
 
         testIFramedPage('with/JSON response', false, 'abc12345234', 2);
         testIFramedPage('with/String response', true, 'abc12345234', 2);
-
-        it('should contain correct v2 CMP definition', (done) => {
-          setConsentConfig(goodConfig);
-          requestBidsHook(() => {
-            const nbArguments = window.__tcfapi.toString().split('\n')[0].split(', ').length;
-            expect(nbArguments).to.equal(4);
-            done();
-          }, {});
-        });
       });
     });
 

package/test/spec/modules/datablocksBidAdapter_spec.js

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import { spec } from '../../../modules/datablocksBidAdapter.js';
 import { BotClientTests } from '../../../modules/datablocksBidAdapter.js';
 import { getStorageManager } from '../../../src/storageManager.js';
+import {deepClone} from '../../../src/utils.js';
 
 const bid = {
   bidId: '2dd581a2b6281d',
@@ -409,7 +410,7 @@ describe('DatablocksAdapter', function() {
       expect(spec.isBidRequestValid(bid)).to.be.true;
     });
     it('Should return false when host/source_id is not set', function() {
-      let moddedBid = Object.assign({}, bid);
+      let moddedBid = deepClone(bid);
       delete moddedBid.params.source_id;
       expect(spec.isBidRequestValid(moddedBid)).to.be.false;
     });
@@ -442,9 +443,12 @@ describe('DatablocksAdapter', function() {
   });
 
   describe('buildRequests', function() {
-    let request = spec.buildRequests([bid, bid2, nativeBid], bidderRequest);
+    let request;
+    before(() => {
+      request = spec.buildRequests([bid, bid2, nativeBid], bidderRequest);
+      expect(request).to.exist;
+    })
 
-    expect(request).to.exist;
     it('Returns POST method', function() {
       expect(request.method).to.exist;
       expect(request.method).to.equal('POST');

package/test/spec/modules/eids_spec.js

@@ -187,6 +187,24 @@ describe('eids array generation for known sub-modules', function() {
     });
   });
 
+  it('bidswitch with ext', function() {
+    const userId = {
+      bidswitch: {'id': 'sample_id', 'ext': {'provider': 'some.provider.com'}}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'bidswitch.net',
+      uids: [{
+        id: 'sample_id',
+        atype: 3,
+        ext: {
+          provider: 'some.provider.com'
+        }
+      }]
+    });
+  });
+
   it('medianet', function() {
     const userId = {
       medianet: {'id': 'sample_id'}
@@ -202,6 +220,57 @@ describe('eids array generation for known sub-modules', function() {
     });
   });
 
+  it('medianet with ext', function() {
+    const userId = {
+      medianet: {'id': 'sample_id', 'ext': {'provider': 'some.provider.com'}}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'media.net',
+      uids: [{
+        id: 'sample_id',
+        atype: 3,
+        ext: {
+          provider: 'some.provider.com'
+        }
+      }]
+    });
+  });
+
+  it('magnite', function() {
+    const userId = {
+      magnite: {'id': 'sample_id'}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'rubiconproject.com',
+      uids: [{
+        id: 'sample_id',
+        atype: 3
+      }]
+    });
+  });
+
+  it('magnite with ext', function() {
+    const userId = {
+      magnite: {'id': 'sample_id', 'ext': {'provider': 'some.provider.com'}}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'rubiconproject.com',
+      uids: [{
+        id: 'sample_id',
+        atype: 3,
+        ext: {
+          provider: 'some.provider.com'
+        }
+      }]
+    });
+  });
+
   it('liveIntentId; getValue call and NO ext', function() {
     const userId = {
       lipb: {
@@ -348,6 +417,24 @@ describe('eids array generation for known sub-modules', function() {
     });
   });
 
+  it('uid2 with ext', function() {
+    const userId = {
+      uid2: {'id': 'Sample_AD_Token', 'ext': {'provider': 'some.provider.com'}}
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: 'uidapi.com',
+      uids: [{
+        id: 'Sample_AD_Token',
+        atype: 3,
+        ext: {
+          provider: 'some.provider.com'
+        }
+      }]
+    });
+  });
+
   it('euid', function() {
     const userId = {
       euid: {'id': 'Sample_AD_Token'}

package/test/spec/modules/freepassBidAdapter_spec.js

@@ -0,0 +1,161 @@
+import {expect} from 'chai';
+import {spec} from 'modules/freepassBidAdapter.js';
+import {newBidder} from 'src/adapters/bidderFactory.js';
+
+describe('FreePass adapter', function () {
+  const adapter = newBidder(spec);
+  describe('inherited functions', function () {
+    it('exists and is a function', function () {
+      expect(adapter.callBids).to.exist.and.to.be.a('function');
+    });
+  });
+
+  describe('isBidRequestValid', function () {
+    const bid = {
+      bidder: 'freepass',
+      userId: {
+        freepassId: {
+          userId: 'fpid'
+        }
+      },
+      adUnitCode: 'adunit-code',
+    };
+
+    it('should return true when required params found', function () {
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
+    });
+
+    it('should return false when adUnitCode is missing', function () {
+      let localBid = Object.assign({}, bid);
+      delete localBid.adUnitCode;
+      expect(spec.isBidRequestValid(localBid)).to.equal(false);
+    });
+  });
+
+  describe('buildRequests', function () {
+    let bidRequests, bidderRequest;
+    beforeEach(function () {
+      bidRequests = [{
+        'bidder': 'freepass',
+        'userId': {
+          'freepassId': {
+            'userIp': '172.21.0.1',
+            'userId': '56c4c789-71ce-46f5-989e-9e543f3d5f96',
+            'commonId': 'commonIdValue'
+          }
+        }
+      }];
+      bidderRequest = {};
+    });
+
+    it('should return an empty array when no bid requests', function () {
+      const bidRequest = spec.buildRequests([], bidderRequest);
+      expect(bidRequest).to.be.an('array');
+      expect(bidRequest.length).to.equal(0);
+    });
+
+    it('should return a valid bid request object', function () {
+      const bidRequest = spec.buildRequests(bidRequests, bidderRequest);
+      expect(bidRequest).to.be.an('object');
+      expect(bidRequest.data).to.be.an('object');
+      expect(bidRequest.method).to.equal('POST');
+      expect(bidRequest.url).to.not.equal('');
+      expect(bidRequest.url).to.not.equal(undefined);
+      expect(bidRequest.url).to.not.equal(null);
+    });
+
+    it('should add user id to user information', function () {
+      const bidRequest = spec.buildRequests(bidRequests, bidderRequest);
+      const ortbData = bidRequest.data;
+      expect(ortbData.user).to.be.an('object');
+      expect(ortbData.user.id).to.equal('56c4c789-71ce-46f5-989e-9e543f3d5f96');
+    });
+
+    it('should add freepass commonId to extended user information', function () {
+      const bidRequest = spec.buildRequests(bidRequests, bidderRequest);
+      const ortbData = bidRequest.data;
+      expect(ortbData.user).to.be.an('object');
+      expect(ortbData.user.ext).to.be.an('object');
+      expect(ortbData.user.ext.fuid).to.equal('commonIdValue');
+    });
+
+    it('should skip freepass commonId when not available', function () {
+      let localBidRequests = [Object.assign({}, bidRequests[0])];
+      delete localBidRequests[0].userId.freepassId.commonId;
+      const bidRequest = spec.buildRequests(localBidRequests, bidderRequest);
+      const ortbData = bidRequest.data;
+      expect(ortbData.user).to.be.an('object');
+      expect(ortbData.user.ext).to.be.an('object');
+      expect(ortbData.user.ext.fuid).to.be.undefined;
+    });
+
+    it('should add IP information to extended device information', function () {
+      const bidRequest = spec.buildRequests(bidRequests, bidderRequest);
+      const ortbData = bidRequest.data;
+      expect(ortbData.device).to.be.an('object');
+      expect(ortbData.device.ip).to.equal('172.21.0.1');
+      expect(ortbData.device.ext).to.be.an('object');
+      expect(ortbData.device.ext.is_accurate_ip).to.equal(1);
+    });
+
+    it('should skip IP information when not available', function () {
+      let localBidRequests = [Object.assign({}, bidRequests[0])];
+      delete localBidRequests[0].userId.freepassId.userIp;
+      const bidRequest = spec.buildRequests(localBidRequests, bidderRequest);
+      const ortbData = bidRequest.data;
+      expect(ortbData.device).to.be.an('object');
+      expect(ortbData.device.ip).to.be.undefined;
+      expect(ortbData.device.ext).to.be.an('object');
+      expect(ortbData.device.ext.is_accurate_ip).to.equal(0);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    let bidRequests, bidderRequest;
+    beforeEach(function () {
+      bidRequests = [{
+        'bidId': '28ffdf2a952532',
+        'bidder': 'freepass',
+        'userId': {
+          'freepassId': {
+            'userIp': '172.21.0.1',
+            'userId': '56c4c789-71ce-46f5-989e-9e543f3d5f96',
+            'commonId': 'commonIdValue'
+          }
+        }
+      }];
+      bidderRequest = {};
+    });
+
+    const ad = '<iframe src=\'http://127.0.0.1:8081/banner.html?w=300&h=250&cr=0\' width=\'300\' height=\'250\' style=\'border:none;\'></iframe>';
+    const serverResponse = {
+      body: {
+        'cur': 'JPY',
+        'seatbid': [{
+          'bid': [{
+            'impid': '28ffdf2a952532',
+            'price': 97,
+            'adm': ad,
+            'w': 300,
+            'h': 250,
+            'crid': 'creative0'
+          }]
+        }]
+      }
+    };
+    it('should interpret server response', function () {
+      const bidRequest = spec.buildRequests(bidRequests, bidderRequest);
+      const bids = spec.interpretResponse(serverResponse, bidRequest);
+      expect(bids).to.be.an('array');
+
+      const bid = bids[0];
+      expect(bid).to.be.an('object');
+      expect(bid.currency).to.equal('JPY');
+      expect(bid.cpm).to.equal(97);
+      expect(bid.ad).to.equal(ad)
+      expect(bid.width).to.equal(300);
+      expect(bid.height).to.equal(250);
+      expect(bid.creativeId).to.equal('creative0');
+    });
+  });
+});

package/test/spec/modules/greenbidsAnalyticsAdapter_spec.js

@@ -389,7 +389,6 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
     it('should parse config correctly with optional values', function () {
       expect(greenbidsAnalyticsAdapter.getAnalyticsOptions().options).to.deep.equal(configOptions);
       expect(greenbidsAnalyticsAdapter.getAnalyticsOptions().pbuid).to.equal(configOptions.pbuid);
-      expect(greenbidsAnalyticsAdapter.getAnalyticsOptions().sampled).to.equal(false);
     });
 
     it('should not enable Analytics when pbuid is missing', function () {
@@ -400,19 +399,5 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
       const validConfig = greenbidsAnalyticsAdapter.initConfig(configOptions);
       expect(validConfig).to.equal(false);
     });
-    it('should fall back to default value when sampling factor is not number', function () {
-      const configOptions = {
-        options: {
-          pbuid: pbuid,
-          sampling: 'string',
-        }
-      };
-      greenbidsAnalyticsAdapter.enableAnalytics({
-        provider: 'greenbidsAnalytics',
-        options: configOptions
-      });
-
-      expect(greenbidsAnalyticsAdapter.getAnalyticsOptions().sampled).to.equal(false);
-    });
   });
 });