Rubicon project improvement/user sync

modules/prebidServerBidAdapter.js

@@ -4,7 +4,8 @@ import bidmanager from 'src/bidmanager';
 import * as utils from 'src/utils';
 import { ajax } from 'src/ajax';
 import { STATUS, S2S } from 'src/constants';
-import { queueSync, cookieSet } from 'src/cookie';
+import { userSync } from 'src/userSync.js';
+import { cookieSet } from 'src/cookie.js';
 import adaptermanager from 'src/adaptermanager';
 import { config } from 'src/config';
 import { StorageManager, pbjsSyncsKey } from 'src/storagemanager';
@@ -144,7 +145,7 @@ function PrebidServer() {
         if (result.bidder_status) {
           result.bidder_status.forEach(bidder => {
             if (bidder.no_cookie && !_cookiesQueued) {
-              queueSync({bidder: bidder.bidder, url: bidder.usersync.url, type: bidder.usersync.type});
+              userSync.registerSync(bidder.usersync.type, bidder.bidder, bidder.usersync.url);
             }
           });
         }

modules/rubiconBidAdapter.js

@@ -5,7 +5,7 @@ import adaptermanager from 'src/adaptermanager';
 import * as utils from 'src/utils';
 import { ajax } from 'src/ajax';
 import { STATUS } from 'src/constants';
-
+import { userSync } from 'src/userSync';
 const RUBICON_BIDDER_CODE = 'rubicon';
 
 // use deferred function call since version isn't defined yet at this point
@@ -422,15 +422,16 @@ RubiconAdapter.masSizeOrdering = function(sizes) {
 /**
  * syncEmily
  * @summary A user sync dependency for the Rubicon Project adapter
- * When enabled, creates an user sync iframe after a delay once the first auction is complete.
- * Only fires once except that with each winning creative there will be additional, similar calls to the same service.
- * @example
- *  // Config example for Rubicon user sync
- *  $$PREBID_GLOBAL$$.setConfig({ rubicon: {
- *    userSync: {
- *      enabled: true,
- *      delay: 1000
- *    }
+ * Registers an Emily iframe user sync to be called/created later by Prebid
+ * Only registers once except that with each winning creative there will be additional, similar calls to the same service.  Must enable iframe syncs which are off by default
+@example
+ *  // Config example for iframe user sync
+ *  $$PREBID_GLOBAL$$.setConfig({ userSync: {
+ *    syncEnabled: true,
+ *    pixelEnabled: true,
+ *    syncsPerBidder: 5,
+ *    syncDelay: 3000,
+ *    iframeEnabled: true
  *  }});
  * @return {boolean} Whether or not Emily synced
  */
@@ -440,25 +441,11 @@ function syncEmily(hasSynced) {
     return true;
   }
 
-  const defaultUserSyncConfig = {
-    enabled: false,
-    delay: 5000
-  };
   const iframeUrl = 'https://tap-secure.rubiconproject.com/partner/scripts/rubicon/emily.html?rtb_ext=1';
 
-  let rubiConfig = $$PREBID_GLOBAL$$.getConfig('rubicon');
-  let publisherUserSyncConfig = rubiConfig && rubiConfig.userSync;
-
-  // Merge publisher user sync config with the defaults
-  let userSyncConfig = Object.assign(defaultUserSyncConfig, publisherUserSyncConfig);
-
-  // Check that user sync is enabled
-  if (!userSyncConfig.enabled) {
-    return false;
-  }
+  // register the sync with the Prebid (to be called later)
+  userSync.registerSync('iframe', 'rubicon', iframeUrl);
 
-  // Delay inserting the Emily iframe
-  setTimeout(() => utils.insertCookieSyncIframe(iframeUrl), Number(userSyncConfig.delay));
   return true;
 }
 

src/adapters/bidderFactory.js

@@ -1,9 +1,11 @@
 import Adapter from 'src/adapter';
 import adaptermanager from 'src/adaptermanager';
+import { config } from 'src/config';
 import { ajax } from 'src/ajax';
 import bidmanager from 'src/bidmanager';
 import bidfactory from 'src/bidfactory';
 import { STATUS } from 'src/constants';
+import { userSync } from 'src/userSync';
 
 import { logWarn, logError, parseQueryStringParameters, delayExecution } from 'src/utils';
 
@@ -162,9 +164,30 @@ export function newBidder(spec) {
           });
       }
 
+      // After all the responses have come back, fill up the "no bid" bids and
+      // register any required usersync pixels.
+      const responses = [];
+      function afterAllResponses() {
+        fillNoBids();
+        if (spec.getUserSyncs) {
+          let syncs = spec.getUserSyncs({
+            iframeEnabled: config.getConfig('userSync.iframeEnabled'),
+            pixelEnabled: config.getConfig('userSync.pixelEnabled'),
+          }, responses);
+          if (syncs) {
+            if (!Array.isArray(syncs)) {
+              syncs = [syncs];
+            }
+            syncs.forEach((sync) => {
+              userSync.registerSync(sync.type, spec.code, sync.url)
+            });
+          }
+        }
+      }
+
       const bidRequests = bidderRequest.bids.filter(filterAndWarn);
       if (bidRequests.length === 0) {
-        fillNoBids();
+        afterAllResponses();
         return;
       }
       const bidRequestMap = {};
@@ -174,27 +197,13 @@ export function newBidder(spec) {
 
       let requests = spec.buildRequests(bidRequests);
       if (!requests || requests.length === 0) {
-        fillNoBids();
+        afterAllResponses();
         return;
       }
       if (!Array.isArray(requests)) {
         requests = [requests];
       }
 
-      // After all the responses have come back, fill up the "no bid" bids and
-      // register any required usersync pixels.
-      const responses = [];
-      function afterAllResponses() {
-        fillNoBids();
-
-        if (spec.getUserSyncs) {
-          // TODO: Before merge, replace this empty object with the real config values.
-          // Then register them with the UserSync pool. This is waiting on the UserSync PR
-          // to be merged first, though.
-          spec.getUserSyncs({ }, responses);
-        }
-      }
-
       // Callbacks don't compose as nicely as Promises. We should call fillNoBids() once _all_ the
       // Server requests have returned and been processed. Since `ajax` accepts a single callback,
       // we need to rig up a function which only executes after all the requests have been responded.

src/config.js

@@ -15,6 +15,12 @@ const DEFAULT_BIDDER_TIMEOUT = 3000;
 const DEFAULT_PUBLISHER_DOMAIN = window.location.origin;
 const DEFAULT_COOKIESYNC_DELAY = 100;
 const DEFAULT_ENABLE_SEND_ALL_BIDS = false;
+const DEFAULT_USERSYNC = {
+  syncEnabled: true,
+  pixelEnabled: true,
+  syncsPerBidder: 5,
+  syncDelay: 3000
+};
 
 const GRANULARITY_OPTIONS = {
   'LOW': 'low',
@@ -118,6 +124,8 @@ export function newConfig() {
       $$PREBID_GLOBAL$$.setS2SConfig(val);
     },
 
+    // userSync defaults
+    userSync: DEFAULT_USERSYNC
   };
 
   function hasGranularity(val) {

src/cookie.js

@@ -1,48 +1,7 @@
 import * as utils from './utils';
 import adLoader from './adloader';
-import { StorageManager, pbjsSyncsKey } from './storagemanager';
 
 const cookie = exports;
-const queue = [];
-
-function fireSyncs() {
-  queue.forEach(obj => {
-    utils.logMessage(`Invoking cookie sync for bidder: ${obj.bidder}`);
-    if (obj.type === 'iframe') {
-      utils.insertCookieSyncIframe(obj.url, false);
-    } else {
-      utils.insertPixel(obj.url);
-    }
-    setBidderSynced(obj.bidder);
-  });
-  // empty queue.
-  queue.length = 0;
-}
-
-function setBidderSynced(bidder) {
-  StorageManager.add(pbjsSyncsKey, bidder, true);
-}
-
-/**
- * Add this bidder to the queue for sync
- * @param  {String} bidder bidder code
- * @param  {String} url    optional URL for invoking cookie sync if provided.
- */
-cookie.queueSync = function ({bidder, url, type}) {
-  queue.push({bidder, url, type});
-};
-
-/**
- * Fire cookie sync URLs previously queued
- * @param  {number} timeout time in ms to delay in sending
- */
-cookie.syncCookies = function(timeout) {
-  if (timeout) {
-    setTimeout(fireSyncs, timeout);
-  } else {
-    fireSyncs();
-  }
-};
 
 cookie.cookieSet = function(cookieSetUrl) {
   if (!utils.isSafariBrowser()) {

src/native.js

@@ -1,4 +1,4 @@
-import { getBidRequest, logError, insertPixel } from './utils';
+import { getBidRequest, logError, triggerPixel } from './utils';
 
 export const nativeAdapters = [];
 
@@ -92,6 +92,6 @@ export function fireNativeImpressions(adObject) {
     adObject.native.impressionTrackers;
 
   (impressionTrackers || []).forEach(tracker => {
-    insertPixel(tracker);
+    triggerPixel(tracker);
   });
 }

src/prebid.js

@@ -7,7 +7,7 @@ import { nativeAdUnit, nativeBidder, hasNonNativeBidder } from './native';
 import './polyfill';
 import { parse as parseURL, format as formatURL } from './url';
 import { listenMessagesFromCreative } from './secureCreatives';
-import { syncCookies } from './cookie';
+import { userSync } from 'src/userSync.js';
 import { loadScript } from './adloader';
 import { setAjaxTimeout } from './ajax';
 import { config } from './config';
@@ -22,6 +22,7 @@ var bidfactory = require('./bidfactory');
 var events = require('./events');
 var adserver = require('./adserver.js');
 var targeting = require('./targeting.js');
+const { syncUsers, triggerUserSyncs } = userSync;
 
 /* private variables */
 
@@ -71,8 +72,8 @@ utils.logInfo('Prebid.js v$prebid.version$ loaded');
 // create adUnit array
 $$PREBID_GLOBAL$$.adUnits = $$PREBID_GLOBAL$$.adUnits || [];
 
-/** @deprecated - use pbjs.setConfig({ cookieSyncDelay: <domain> ) */
-$$PREBID_GLOBAL$$.cookieSyncDelay = $$PREBID_GLOBAL$$.cookieSyncDelay;
+// Allow publishers who enable user sync override to trigger their sync
+$$PREBID_GLOBAL$$.triggerUserSyncs = triggerUserSyncs;
 
 function checkDefinedPlacement(id) {
   var placementCodes = $$PREBID_GLOBAL$$._bidsRequested.map(bidSet => bidSet.bids.map(bid => bid.placementCode))
@@ -334,7 +335,13 @@ $$PREBID_GLOBAL$$.removeAdUnit = function (adUnitCode) {
 
 $$PREBID_GLOBAL$$.clearAuction = function() {
   auctionRunning = false;
-  syncCookies(config.getConfig('cookieSyncDelay'));
+  // Only automatically sync if the publisher has not chosen to "enableOverride"
+  let userSyncConfig = config.getConfig('userSync') || {};
+  if (!userSyncConfig.enableOverride) {
+    // Delay the auto sync by the config delay
+    syncUsers(userSyncConfig.syncDelay);
+  }
+
   utils.logMessage('Prebid auction cleared');
   if (bidRequestQueue.length) {
     bidRequestQueue.shift()();
@@ -695,7 +702,7 @@ $$PREBID_GLOBAL$$.buildMasterVideoTagFromAdserverTag = function (adserverTag, op
  * @param {string} order One of the valid orders, described above.
  * @deprecated - use pbjs.setConfig({ bidderSequence: <order> })
  */
-$$PREBID_GLOBAL$$.setBidderSequence = adaptermanager.setBidderSequence
+$$PREBID_GLOBAL$$.setBidderSequence = adaptermanager.setBidderSequence;
 
 /**
  * Get array of highest cpm bids for all adUnits, or highest cpm bid