GDPR consentManagement module

modules/appnexusBidAdapter.js

@@ -73,6 +73,13 @@ export const spec = {
     if (member > 0) {
       payload.member_id = member;
     }
+    if (bidderRequest && bidderRequest.gdprConsent) {
+      payload.gdprConsent = {
+        gdprConsentString: bidderRequest.gdprConsent.consentString,
+        gdprConsentRequired: bidderRequest.gdprConsent.consentRequired
+      };
+    }
+
     const payloadString = JSON.stringify(payload);
     return {
       method: 'POST',

modules/consentManagement.js

@@ -0,0 +1,142 @@
+import * as utils from 'src/utils';
+import { config } from 'src/config';
+import { setTimeout } from 'core-js/library/web/timers';
+
+// add new CMPs here
+const availCMPs = ['iab'];
+
+export let userCMP;
+export let consentId = '';
+export let consentTimeout;
+export let lookUpFailureChoice;
+
+export function requestBidsHook(config, fn) {
+  let adUnits = config.adUnits || $$PREBID_GLOBAL$$.adUnits;
+  let context = this;
+  let args = arguments;
+  let nextFn = fn;
+  let cmpActive = true;
+  let _timer;
+
+  // in case we already have consent (eg during bid refresh)
+  if (consentId) {
+    adUnits = applyConsent(consentId);
+    return fn.apply(context, args);
+  }
+
+  // ensure user requested supported cmp, otherwise abort and return to hooked function
+  if (!availCMPs.includes(userCMP)) {
+    utils.logWarn(`CMP framework ${userCMP} is not a supported framework.  Aborting consentManagement module and resuming auction.`);
+    return fn.apply(context, args);
+  }
+
+  // start of CMP specific logic
+  if (userCMP === 'iab') {
+    if (!window.__cmp) {
+      utils.logWarn('IAB CMP framework is not detected.  Aborting consentManagement module and resuming auction.');
+      return fn.apply(context, args);
+    }
+
+    lookupIabId();
+  }
+
+  function lookupIabId () {
+    // lookup times and user interaction with CMP prompts can greatly vary, so enforcing a timeout on the CMP process
+    _timer = setTimeout(cmpTimedOut, consentTimeout);
+
+    // first lookup - to determine if new or existing user
+    // if new user, then wait for user to make a choice and then run postLookup method
+    // if existing user, then skip to postLookup method
+    window.__cmp('getConsentData', 'vendorConsents', function(consentString) {
+      if (cmpActive) {
+        if (consentString === null || !consentString) {
+          window.__cmp('addEventListener', 'onSubmit', function() {
+            if (cmpActive) {
+              // redo lookup to find new string based on user's choices
+              window.__cmp('getConsentData', 'vendorConsents', postLookup);
+            }
+          });
+        } else {
+          postLookup(consentString);
+        }
+      }
+    });
+  }
+
+  // after we have grabbed ideal ID from CMP, apply the data to adUnits object and finish up the module
+  function postLookup(consentString) {
+    if (cmpActive) {
+      if (typeof consentString != 'string' || consentString === '') {
+        exitFailedCMP(`CMP returned unexpected value during lookup process; returned value was (${consentString}).`);
+      } else {
+        clearTimeout(_timer);
+        consentId = consentString;
+        adUnits = applyConsent(consentString);
+        fn.apply(context, args);
+      }
+    }
+  }
+
+  // assuming we have valid consent ID, apply to adUnits object
+  function applyConsent(consentString) {
+    adUnits.forEach(adUnit => {
+      adUnit['gdprConsent'] = {
+        consentString: consentString,
+        consentRequired: true
+      };
+    });
+    return adUnits;
+  }
+
+  function cmpTimedOut () {
+    if (cmpActive) {
+      exitFailedCMP('CMP workflow exceeded timeout threshold.');
+    }
+  }
+
+  function exitFailedCMP(message) {
+    cmpActive = false;
+    if (lookUpFailureChoice === 'proceed') {
+      utils.logWarn(message + ' Resuming auction without consent data as per consentManagement config.');
+      adUnits = applyConsent(undefined);
+      nextFn.apply(context, args);
+    } else {
+      utils.logError(message + ' Canceling auction as per consentManagement config.');
+    }
+  }
+}
+
+export function resetConsentId() {
+  consentId = '';
+}
+
+export function setConfig(config) {
+  if (typeof config.cmp === 'string') {
+    userCMP = config.cmp;
+  } else {
+    userCMP = 'iab';
+    utils.logInfo(`consentManagement config did not specify cmp.  Using system default setting (${userCMP}).`);
+  }
+
+  if (typeof config.waitForConsentTimeout === 'number') {
+    consentTimeout = config.waitForConsentTimeout;
+  } else {
+    consentTimeout = 5000;
+    utils.logInfo(`consentManagement config did not specify waitForConsentTimeout.  Using system default setting (${consentTimeout}).`);
+  }
+
+  if (typeof config.lookUpFailureResolution === 'string') {
+    if (config.lookUpFailureResolution === 'proceed' || config.lookUpFailureResolution === 'cancel') {
+      lookUpFailureChoice = config.lookUpFailureResolution;
+    } else {
+      lookUpFailureChoice = 'proceed';
+      utils.logWarn(`Invalid choice was set for consentManagement lookUpFailureResolution property. Using system default (${lookUpFailureChoice}).`);
+    }
+  } else {
+    lookUpFailureChoice = 'proceed';
+    utils.logInfo(`consentManagement config did not specify lookUpFailureResolution.  Using system default setting (${lookUpFailureChoice}).`);
+  }
+
+  $$PREBID_GLOBAL$$.requestBids.addHook(requestBidsHook, 50);
+}
+config.getConfig('consentManagement', config => setConfig(config.consentManagement));

modules/pre1api.js

@@ -124,7 +124,7 @@ pbjs.requestBids.addHook((config, next = config) => {
   } else {
     logWarn(`${MODULE_NAME} module: concurrency has been disabled and "$$PREBID_GLOBAL$$.requestBids" call was queued`);
   }
-}, 100);
+}, 5);
 
 Object.keys(auctionPropMap).forEach(prop => {
   if (prop === 'allBidsAvailable') {

modules/prebidServerBidAdapter.js

@@ -251,7 +251,7 @@ function _getDigiTrustQueryParams() {
  */
 const LEGACY_PROTOCOL = {
 
-  buildRequest(s2sBidRequest, adUnits) {
+  buildRequest(s2sBidRequest, bidRequests, adUnits) {
     // pbs expects an ad_unit.video attribute if the imp is video
     adUnits.forEach(adUnit => {
       const videoMediaType = utils.deepAccess(adUnit, 'mediaTypes.video');
@@ -381,7 +381,7 @@ const OPEN_RTB_PROTOCOL = {
 
   bidMap: {},
 
-  buildRequest(s2sBidRequest, adUnits) {
+  buildRequest(s2sBidRequest, bidRequests, adUnits) {
     let imps = [];
 
     // transform ad unit into array of OpenRTB impression objects
@@ -456,6 +456,11 @@ const OPEN_RTB_PROTOCOL = {
       request.user = { ext: { digitrust: digiTrust } };
     }
 
+    if (bidRequests && bidRequests[0].gdprConsent) {
+      request.regs = { ext: { gdpr: bidRequests[0].gdprConsent.consentRequired ? 1 : 0 } };
+      request.user = { ext: { consent: bidRequests[0].gdprConsent.consentString } };
+    }
+
     return request;
   },
 
@@ -556,7 +561,7 @@ export function PrebidServer() {
       .reduce(utils.flatten)
       .filter(utils.uniques);
 
-    const request = protocolAdapter().buildRequest(s2sBidRequest, adUnitsWithSizes);
+    const request = protocolAdapter().buildRequest(s2sBidRequest, bidRequests, adUnitsWithSizes);
     const requestJson = JSON.stringify(request);
 
     ajax(

src/adaptermanager.js

@@ -211,6 +211,11 @@ exports.makeBidRequests = function(adUnits, auctionStart, auctionId, cbTimeout,
       bidRequests.push(bidderRequest);
     }
   });
+  if (adUnits[0].gdprConsent) {
+    bidRequests.forEach(bidRequest => {
+      bidRequest['gdprConsent'] = adUnits[0].gdprConsent;
+    });
+  }
   return bidRequests;
 };
 

test/spec/modules/appnexusBidAdapter_spec.js

@@ -173,7 +173,7 @@ describe('AppNexusAdapter', () => {
       });
     });
 
-    it('should attache native params to the request', () => {
+    it('should attach native params to the request', () => {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
@@ -290,7 +290,7 @@ describe('AppNexusAdapter', () => {
       }]);
     });
 
-    it('should should add payment rules to the request', () => {
+    it('should add payment rules to the request', () => {
       let bidRequest = Object.assign({},
         bidRequests[0],
         {
@@ -306,6 +306,22 @@ describe('AppNexusAdapter', () => {
 
       expect(payload.tags[0].use_pmt_rule).to.equal(true);
     });
+
+    it('should gdpr consent information to the request', () => {
+      let bidderRequest = {
+        'bidderCode': 'appnexus',
+        'auctionId': '1d1a030790a475',
+        'bidderRequestId': '22edbae2733bf6',
+        'timeout': 3000,
+        'consentId': 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A=='
+      };
+      bidderRequest.bids = bidRequests;
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const payload = JSON.parse(request.data);
+
+      // add expect checks - new spec will likely have the consent data in the request.data field
+    });
   })
 
   describe('interpretResponse', () => {