prebid.js 7.29.0 → 7.31.0

package/src/adloader.js

@@ -20,7 +20,8 @@ const _approvedLoadExternalJSList = [
   'hadron',
   'medianet',
   'improvedigital',
-  'aaxBlockmeter'
+  'aaxBlockmeter',
+  'confiant'
 ]
 
 /**

package/src/consentHandler.js

@@ -107,3 +107,14 @@ export class GdprConsentHandler extends ConsentHandler {
     }
   }
 }
+
+export class GppConsentHandler extends ConsentHandler {
+  getConsentMeta() {
+    const consentData = this.getConsentData();
+    if (consentData && this.generatedTime) {
+      return {
+        generatedAt: this.generatedTime,
+      }
+    }
+  }
+}

package/src/prebid.js

@@ -45,7 +45,7 @@ import {executeRenderer, isRendererRequired} from './Renderer.js';
 import {createBid} from './bidfactory.js';
 import {storageCallbacks} from './storageManager.js';
 import {emitAdRenderFail, emitAdRenderSucceeded} from './adRendering.js';
-import {default as adapterManager, gdprDataHandler, getS2SBidderSet, uspDataHandler} from './adapterManager.js';
+import {default as adapterManager, gdprDataHandler, getS2SBidderSet, gppDataHandler, uspDataHandler} from './adapterManager.js';
 import CONSTANTS from './constants.json';
 import * as events from './events.js';
 import {newMetrics, useMetrics} from './utils/perfMetrics.js';
@@ -336,6 +336,7 @@ function getConsentMetadata() {
   return {
     gdpr: gdprDataHandler.getConsentMeta(),
     usp: uspDataHandler.getConsentMeta(),
+    gpp: gppDataHandler.getConsentMeta(),
     coppa: !!(config.getConfig('coppa'))
   }
 }
@@ -628,6 +629,13 @@ $$PREBID_GLOBAL$$.requestBids = (function() {
     events.emit(REQUEST_BIDS);
     const cbTimeout = timeout || config.getConfig('bidderTimeout');
     logInfo('Invoking $$PREBID_GLOBAL$$.requestBids', arguments);
+    if (adUnitCodes && adUnitCodes.length) {
+      // if specific adUnitCodes supplied filter adUnits for those codes
+      adUnits = adUnits.filter(unit => includes(adUnitCodes, unit.code));
+    } else {
+      // otherwise derive adUnitCodes from adUnits
+      adUnitCodes = adUnits && adUnits.map(unit => unit.code);
+    }
     const ortb2Fragments = {
       global: mergeDeep({}, config.getAnyConfig('ortb2') || {}, ortb2 || {}),
       bidder: Object.fromEntries(Object.entries(config.getBidderConfig()).map(([bidder, cfg]) => [bidder, cfg.ortb2]).filter(([_, ortb2]) => ortb2 != null))
@@ -660,14 +668,6 @@ export const startAuction = hook('async', function ({ bidsBackHandler, timeout:
   const s2sBidders = getS2SBidderSet(config.getConfig('s2sConfig') || []);
   adUnits = useMetrics(metrics).measureTime('requestBids.validate', () => checkAdUnitSetup(adUnits));
 
-  if (adUnitCodes && adUnitCodes.length) {
-    // if specific adUnitCodes supplied filter adUnits for those codes
-    adUnits = adUnits.filter(unit => includes(adUnitCodes, unit.code));
-  } else {
-    // otherwise derive adUnitCodes from adUnits
-    adUnitCodes = adUnits && adUnits.map(unit => unit.code);
-  }
-
   function auctionDone(bids, timedOut, auctionId) {
     if (typeof bidsBackHandler === 'function') {
       try {

package/test/helpers/hookSetup.js

@@ -0,0 +1,5 @@
+import {hook} from '../../src/hook.js';
+
+before(() => {
+  hook.ready();
+});

package/test/spec/modules/ViouslyBidAdapter_spec.js

@@ -0,0 +1,378 @@
+import {expect} from 'chai';
+
+import { deepClone, mergeDeep } from 'src/utils';
+import { createEidsArray } from 'modules/userId/eids.js';
+
+import {spec as adapter} from 'modules/viouslyBidAdapter';
+
+import sinon from 'sinon';
+import { config } from 'src/config.js';
+
+const CURRENCY = 'EUR';
+const TTL = 60;
+const HTTP_METHOD = 'POST';
+const REQUEST_URL = 'https://bidder.viously.com/bid';
+
+const VALID_BID_VIDEO = {
+  bidder: 'viously',
+  bidId: '5e6f7g8h',
+  adUnitCode: 'id-5678',
+  params: {
+    pid: '123e4567-e89b-12d3-a456-426614174001'
+  },
+  mediaTypes: {
+    video: {
+      playerSize: [640, 360],
+      context: 'instream',
+      playbackmethod: [1, 2, 3, 4]
+    }
+  }
+};
+
+const VALID_REQUEST_VIDEO = {
+  method: HTTP_METHOD,
+  url: REQUEST_URL,
+  data: {
+    pid: '123e4567-e89b-12d3-a456-426614174001',
+    currency_code: CURRENCY,
+    placements: [
+      {
+        id: 'id-5678',
+        bid_id: '5e6f7g8h',
+        video_params: {
+          context: 'instream',
+          playbackmethod: [1, 2, 3, 4],
+          size: ['640x360']
+        }
+      }
+    ]
+  }
+};
+
+const VALID_GDPR = {
+  gdprApplies: true,
+  apiVersion: 2,
+  consentString: 'abcdefgh',
+  addtlConsent: '1~12345678',
+  vendorData: {
+    purpose: {
+      consents: {
+        1: true
+      }
+    }
+  }
+};
+const US_PRIVACY = '1YNN';
+
+describe('ViouslyAdapter', function () {
+  describe('isBidRequestValid', function () {
+    describe('Check method return', function () {
+      it('should return true', function () {
+        expect(adapter.isBidRequestValid(VALID_BID_VIDEO)).to.equal(true);
+      });
+
+      it('should return false because the pid is missing', function () {
+        let wrongBid = deepClone(VALID_BID_VIDEO);
+        delete wrongBid.params.pid;
+
+        expect(adapter.isBidRequestValid(wrongBid)).to.equal(false);
+      });
+
+      it('should return false because the video context parameter is missing', function () {
+        let wrongBid = deepClone(VALID_BID_VIDEO);
+
+        delete wrongBid.mediaTypes.video.context;
+        expect(adapter.isBidRequestValid(wrongBid)).to.equal(false);
+      });
+    });
+  });
+
+  describe('buildRequests', function () {
+    describe('Check method return', function () {
+      it('should return the right formatted video requests', function() {
+        expect(adapter.buildRequests([VALID_BID_VIDEO])).to.deep.equal(VALID_REQUEST_VIDEO);
+      });
+
+      it('should return the right formatted request with the referer info', function() {
+        let bidderRequest = {
+          refererInfo: {
+            page: 'https://www.example.com/test'
+          }
+        };
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            domain: 'www.example.com',
+            page_domain: 'https://www.example.com/test'
+          }
+        });
+
+        expect(adapter.buildRequests([VALID_BID_VIDEO], bidderRequest)).to.deep.equal(requests);
+      });
+
+      it('should return the right formatted request with the referer info from config', function() {
+        /** Mock the config.getConfig method */
+        sinon.stub(config, 'getConfig')
+          .withArgs('pageUrl')
+          .returns('https://www.example.com/page');
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            domain: 'www.example.com',
+            page_domain: 'https://www.example.com/page'
+          }
+        });
+
+        expect(adapter.buildRequests([VALID_BID_VIDEO])).to.deep.equal(requests);
+
+        config.getConfig.restore();
+      });
+
+      it('should return the right formatted request with GDPR Consent info', function() {
+        let bidderRequest = {
+          gdprConsent: VALID_GDPR
+        };
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            gdpr: true,
+            gdpr_consent: 'abcdefgh',
+            addtl_consent: '1~12345678'
+          }
+        });
+
+        expect(adapter.buildRequests([VALID_BID_VIDEO], bidderRequest)).to.deep.equal(requests);
+      });
+
+      it('should return the right formatted request with US Privacy info', function() {
+        let bidderRequest = {
+          uspConsent: US_PRIVACY
+        };
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            us_privacy: US_PRIVACY
+          }
+        });
+
+        expect(adapter.buildRequests([VALID_BID_VIDEO], bidderRequest)).to.deep.equal(requests);
+      });
+
+      // TODO: Supply chain
+      it('should return the right formatted request with Supply Chain info', function() {
+        let schain = {
+          'ver': '1.0',
+          'complete': 1,
+          'nodes': [
+            {
+              'asi': 'test1.com',
+              'sid': '00001',
+              'hp': 1
+            },
+            {
+              'asi': 'test2-2.com',
+              'sid': '00002',
+              'hp': 2
+            }
+          ]
+        };
+
+        let bid = mergeDeep(deepClone(VALID_BID_VIDEO), {
+          schain: schain
+        });
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            schain: schain
+          }
+        });
+
+        expect(adapter.buildRequests([bid])).to.deep.equal(requests);
+      });
+
+      it('should return the right formatted request with User Ids info', function() {
+        let userIds = {
+          idl_env: '1234-5678-9012-3456', // Liveramp
+          netId: 'testnetid123', // NetId
+          IDP: 'userIDP000', // IDP
+          fabrickId: 'fabrickId9000', // FabrickId
+          uid2: { id: 'testuid2' } // UID 2.0
+        };
+
+        let bid = mergeDeep(deepClone(VALID_BID_VIDEO), {
+          userIds: userIds
+        }, {
+          userIdAsEids: createEidsArray(userIds)
+        });
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO), {
+          data: {
+            users_uid: createEidsArray(userIds)
+          }
+        });
+
+        expect(adapter.buildRequests([bid])).to.deep.equal(requests);
+      });
+
+      it('should return the right formatted request with endpint test', function() {
+        let endpoint = 'https://bid-test.viously.com/prebid';
+
+        let bid = mergeDeep(deepClone(VALID_BID_VIDEO), {
+          params: {
+            endpoint: endpoint
+          }
+        });
+
+        let requests = mergeDeep(deepClone(VALID_REQUEST_VIDEO));
+
+        requests.url = endpoint;
+
+        expect(adapter.buildRequests([bid])).to.deep.equal(requests);
+      });
+
+      // TODO: Floor
+    });
+  });
+
+  describe('interpretResponse', function() {
+    describe('Check method return', function () {
+      it('should return the right formatted response', function() {
+        let response = {
+          body: {
+            ads: [
+              {
+                bid: false,
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-0',
+                bid_id: '1234'
+              },
+              {
+                bid: true,
+                creative_id: '2468',
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-1',
+                bid_id: '5678',
+                cpm: 8,
+                ad: 'vast xml',
+                ad_url: 'http://www.example.com/vast',
+                type: 'video',
+                size: '640x480',
+                nurl: [
+                  'win.domain.com'
+                ]
+              },
+              {
+                bid: true,
+                creative_id: '1469',
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-3',
+                bid_id: '2570',
+                cpm: 4,
+                ad: 'vast xml',
+                type: 'video',
+                size: '640x480',
+              }
+            ]
+          }
+        };
+        let requests = {
+          data: {
+            placements: [
+              {
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-0',
+                bid_id: '1234'
+              },
+              {
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-1',
+                bid_id: '5678'
+              },
+              {
+                id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-3',
+                bid_id: '2570'
+              }
+            ]
+          }
+        };
+
+        let formattedReponse = [
+          {
+            requestId: '5678',
+            id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-1',
+            cpm: 8,
+            width: '640',
+            height: '480',
+            creativeId: '2468',
+            currency: CURRENCY,
+            netRevenue: true,
+            ttl: TTL,
+            mediaType: 'video',
+            meta: {},
+            vastUrl: 'http://www.example.com/vast',
+            nurl: [
+              'win.domain.com'
+            ]
+          },
+          {
+            requestId: '2570',
+            id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-3',
+            cpm: 4,
+            width: '640',
+            height: '480',
+            creativeId: '1469',
+            currency: CURRENCY,
+            netRevenue: true,
+            ttl: TTL,
+            mediaType: 'video',
+            meta: {},
+            vastXml: 'vast xml',
+            nurl: []
+          }
+        ];
+
+        expect(adapter.interpretResponse(response, requests)).to.deep.equal(formattedReponse);
+      });
+    });
+  });
+
+  describe('onBidWon', function() {
+    describe('Check methods succeed', function () {
+      it('should not throw error', function() {
+        let bids = [
+          {
+            requestId: '5678',
+            id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-1',
+            cpm: 8,
+            width: '640',
+            height: '480',
+            creativeId: '2468',
+            currency: CURRENCY,
+            netRevenue: true,
+            ttl: TTL,
+            mediaType: 'video',
+            meta: {},
+            vastUrl: 'http://www.example.com/vast',
+            nurl: [
+              'win.domain.com'
+            ]
+          },
+          {
+            requestId: '2570',
+            id: 'id-0157324f-bee4-5390-a14c-47a7da3eb73c-3',
+            cpm: 4,
+            width: '640',
+            height: '480',
+            creativeId: '1469',
+            currency: CURRENCY,
+            netRevenue: true,
+            ttl: TTL,
+            mediaType: 'video',
+            meta: {},
+            vastXml: 'vast xml',
+            nurl: []
+          }
+        ];
+
+        bids.forEach(function(bid) {
+          expect(adapter.onBidWon.bind(adapter, bid)).to.not.throw();
+        });
+      });
+    });
+  });
+});

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -985,6 +985,52 @@ describe('AppNexusAdapter', function () {
       expect(payload.us_privacy).to.exist.and.to.equal(consentString);
     });
 
+    it('should add gpp information to the request via bidderRequest.gppConsent', function () {
+      let consentString = 'abc1234';
+      let bidderRequest = {
+        'bidderCode': 'appnexus',
+        'auctionId': '1d1a030790a475',
+        'bidderRequestId': '22edbae2733bf6',
+        'timeout': 3000,
+        'gppConsent': {
+          'gppString': consentString,
+          'applicableSections': [8]
+        }
+      };
+      bidderRequest.bids = bidRequests;
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.privacy).to.exist;
+      expect(payload.privacy.gpp).to.equal(consentString);
+      expect(payload.privacy.gpp_sid).to.deep.equal([8]);
+    });
+
+    it('should add gpp information to the request via bidderRequest.ortb2.regs', function () {
+      let consentString = 'abc1234';
+      let bidderRequest = {
+        'bidderCode': 'appnexus',
+        'auctionId': '1d1a030790a475',
+        'bidderRequestId': '22edbae2733bf6',
+        'timeout': 3000,
+        'ortb2': {
+          'regs': {
+            'gpp': consentString,
+            'gpp_sid': [7]
+          }
+        }
+      };
+      bidderRequest.bids = bidRequests;
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      expect(payload.privacy).to.exist;
+      expect(payload.privacy.gpp).to.equal(consentString);
+      expect(payload.privacy.gpp_sid).to.deep.equal([7]);
+    });
+
     it('supports sending hybrid mobile app parameters', function () {
       let appRequest = Object.assign({},
         bidRequests[0],

package/test/spec/modules/colossussspBidAdapter_spec.js

@@ -56,6 +56,93 @@ describe('ColossussspAdapter', function () {
       referer: 'http://www.example.com',
       reachedTop: true,
     },
+    ortb2: {
+      app: {
+        name: 'myappname',
+        keywords: 'power tools, drills',
+        content: {
+          data: [
+            {
+              name: 'www.dataprovider1.com',
+              ext: {
+                segtax: 6
+              },
+              segment: [
+                {
+                  id: '687'
+                },
+                {
+                  id: '123'
+                }
+              ]
+            },
+            {
+              name: 'www.dataprovider1.com',
+              ext: {
+                segtax: 7
+              },
+              segment: [
+                {
+                  id: '456'
+                },
+                {
+                  id: '789'
+                }
+              ]
+            }
+          ]
+        }
+      },
+      site: {
+        name: 'example',
+        domain: 'page.example.com',
+        cat: ['IAB2'],
+        sectioncat: ['IAB2-2'],
+        pagecat: ['IAB2-2'],
+        page: 'https://page.example.com/here.html',
+        ref: 'https://ref.example.com',
+        keywords: 'power tools, drills',
+        search: 'drill',
+        content: {
+          userrating: '4',
+          data: [{
+            name: 'www.dataprovider1.com',
+            ext: {
+              segtax: 7,
+              cids: ['iris_c73g5jq96mwso4d8']
+            },
+            segment: [
+              { id: '687' },
+              { id: '123' }
+            ]
+          }]
+        },
+        ext: {
+          data: {
+            pageType: 'article',
+            category: 'repair'
+          }
+        }
+      },
+      user: {
+        yob: 1985,
+        gender: 'm',
+        keywords: 'a,b',
+        data: [{
+          name: 'dataprovider.com',
+          ext: { segtax: 4 },
+          segment: [
+            { id: '1' }
+          ]
+        }],
+        ext: {
+          data: {
+            registered: true,
+            interests: ['cars']
+          }
+        }
+      }
+    },
     bids: [bid]
   }
 
@@ -91,7 +178,7 @@ describe('ColossussspAdapter', 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', 'ccpa', 'gdpr_consent', 'gdpr_require');
+      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'ccpa', 'gdpr_consent', 'gdpr_require', 'userObj', 'siteObj', 'appObj');
       expect(data.deviceWidth).to.be.a('number');
       expect(data.deviceHeight).to.be.a('number');
       expect(data.language).to.be.a('string');
@@ -132,7 +219,7 @@ describe('ColossussspAdapter', function () {
 
       let data = serverRequest.data;
       expect(data).to.be.an('object');
-      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'ccpa', 'gdpr_consent', 'gdpr_require');
+      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'ccpa', 'gdpr_consent', 'gdpr_require', 'userObj', 'siteObj', 'appObj');
       expect(data.deviceWidth).to.be.a('number');
       expect(data.deviceHeight).to.be.a('number');
       expect(data.language).to.be.a('string');