Rubicon project improvement/user sync

src/prebid.js

@@ -22,7 +22,7 @@ var bidfactory = require('./bidfactory');
 var events = require('./events');
 var adserver = require('./adserver.js');
 var targeting = require('./targeting.js');
-const { syncUsers, syncUsersOverride } = userSync;
+const { syncUsers, triggerUserSyncs } = userSync;
 
 /* private variables */
 
@@ -73,7 +73,7 @@ utils.logInfo('Prebid.js v$prebid.version$ loaded');
 $$PREBID_GLOBAL$$.adUnits = $$PREBID_GLOBAL$$.adUnits || [];
 
 // Allow publishers who enable user sync override to trigger their sync
-$$PREBID_GLOBAL$$.triggerUserSyncs = syncUsersOverride;
+$$PREBID_GLOBAL$$.triggerUserSyncs = triggerUserSyncs;
 
 function checkDefinedPlacement(id) {
   var placementCodes = $$PREBID_GLOBAL$$._bidsRequested.map(bidSet => bidSet.bids.map(bid => bid.placementCode))

src/userSync.js

@@ -1,5 +1,6 @@
 import * as utils from 'src/utils';
 import { config } from 'src/config';
+import { StorageManager, pbjsSyncsKey } from './storagemanager';
 
 /**
  * Factory function which creates a new UserSyncPool.
@@ -74,6 +75,8 @@ export function newUserSync(userSyncDependencies) {
       utils.logMessage(`Invoking image pixel user sync for bidder: ${bidderName}`);
       // Create image object and add the src url
       utils.triggerPixel(trackingPixelUrl);
+      // track that bidder has been synced
+      setBidderSynced(bidderName);
     });
   }
 
@@ -92,9 +95,20 @@ export function newUserSync(userSyncDependencies) {
       utils.logMessage(`Invoking iframe user sync for bidder: ${bidderName}`);
       // Create image object and add the src url
       utils.insertUserSyncIframe(iframeUrl);
+      // track that bidder has been synced
+      setBidderSynced(bidderName);
     });
   }
 
+  /**
+   * @function setBidderSynced
+   * @summary track that bidder has been synced in storagemanager
+   * @private
+   */
+  function setBidderSynced(bidder) {
+    StorageManager.add(pbjsSyncsKey, bidder, true);
+  }
+
   /**
    * @function incrementAdapterBids
    * @summary Increment the count of user syncs queue for the adapter
@@ -157,11 +171,11 @@ export function newUserSync(userSyncDependencies) {
   };
 
   /**
-   * @function overrideSyncUsers
+   * @function triggerUserSyncs
    * @summary A `syncUsers` wrapper for determining if enableOverride has been turned on
    * @public
    */
-  publicApi.syncUsersOverride = () => {
+  publicApi.triggerUserSyncs = () => {
     if (config.enableOverride) {
       publicApi.syncUsers();
     }

src/utils.js

@@ -463,8 +463,7 @@ exports.triggerPixel = function (url) {
  * @param  {string} encodeUri boolean if URL should be encoded before inserted. Defaults to true
  */
 exports.insertUserSyncIframe = function(url) {
-  let iframeHtml = this.createTrackPixelIframeHtml(url, false);
-  iframeHtml = iframeHtml.replace('<iframe', '<iframe sandbox="allow-scripts"');
+  let iframeHtml = this.createTrackPixelIframeHtml(url, false, 'allow-scripts');
   let div = document.createElement('div');
   div.innerHTML = iframeHtml;
   let iframe = div.firstChild;
@@ -491,17 +490,21 @@ exports.createTrackPixelHtml = function (url) {
  * Creates a snippet of Iframe HTML that retrieves the specified `url`
  * @param  {string} url plain URL to be requested
  * @param  {string} encodeUri boolean if URL should be encoded before inserted. Defaults to true
+ * @param  {string} sandbox string if provided the sandbox attribute will be included with the given value
  * @return {string}     HTML snippet that contains the iframe src = set to `url`
  */
-exports.createTrackPixelIframeHtml = function (url, encodeUri = true) {
+exports.createTrackPixelIframeHtml = function (url, encodeUri = true, sandbox = '') {
   if (!url) {
     return '';
   }
   if (encodeUri) {
     url = encodeURI(url);
   }
+  if (sandbox) {
+    sandbox = `sandbox="${sandbox}"`;
+  }
 
-  return `<iframe id="${exports.getUniqueIdentifierStr()}"
+  return `<iframe ${sandbox} id="${exports.getUniqueIdentifierStr()}"
       frameborder="0"
       allowtransparency="true"
       marginheight="0" marginwidth="0"

test/spec/userSync_spec.js

@@ -1,5 +1,6 @@
 import { expect } from 'chai';
 import { config } from 'src/config';
+import { StorageManager, pbjsSyncsKey } from 'src/storagemanager';
 // Use require since we need to be able to write to these vars
 const utils = require('../../src/utils');
 let { newUserSync } = require('../../src/userSync');
@@ -10,6 +11,7 @@ describe('user sync', () => {
   let timeoutStub;
   let shuffleStub;
   let getUniqueIdentifierStrStub;
+  let storageManagerAddStub;
   let idPrefix = 'test-generated-id-';
   let lastId = 0;
   let defaultUserSyncConfig = config.getConfig('userSync');
@@ -30,6 +32,7 @@ describe('user sync', () => {
     shuffleStub = sinon.stub(utils, 'shuffle', (array) => array.reverse());
     getUniqueIdentifierStrStub = sinon.stub(utils, 'getUniqueIdentifierStr', () => idPrefix + (lastId += 1));
     timeoutStub = sinon.stub(window, 'setTimeout', (callbackFunc) => { callbackFunc(); });
+    storageManagerAddStub = sinon.stub(StorageManager, 'add');
   });
 
   afterEach(() => {
@@ -38,6 +41,7 @@ describe('user sync', () => {
     shuffleStub.restore();
     getUniqueIdentifierStrStub.restore();
     timeoutStub.restore();
+    storageManagerAddStub.restore();
   });
 
   it('should register and fire a pixel URL', () => {
@@ -46,12 +50,15 @@ describe('user sync', () => {
     userSync.syncUsers();
     expect(triggerPixelStub.getCall(0)).to.not.be.null;
     expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
   });
 
   it('should clear queue after sync', () => {
     const userSync = newTestUserSync();
     userSync.syncUsers();
     expect(triggerPixelStub.callCount).to.equal(0);
+    expect(storageManagerAddStub.callCount).to.be.equal(0);
   });
 
   it('should delay firing a pixel by the expected amount', () => {
@@ -72,13 +79,19 @@ describe('user sync', () => {
     expect(triggerPixelStub.getCall(1)).to.not.be.null;
     expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.include('http://example.com/');
     expect(triggerPixelStub.getCall(2)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
+    expect(storageManagerAddStub.getCall(1)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(1).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
+    expect(storageManagerAddStub.getCall(2)).to.be.null;
   });
 
   it('should not register pixel URL since it is not supported', () => {
     const userSync = newTestUserSync({pixelEnabled: false});
     userSync.registerSync('image', 'testBidder', 'http://example.com');
     userSync.syncUsers();
     expect(triggerPixelStub.getCall(0)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.be.null;
   });
 
   it('should register and load an iframe', () => {
@@ -88,6 +101,8 @@ describe('user sync', () => {
     let iframe = window.document.getElementById(idPrefix + lastId);
     expect(iframe).to.exist;
     expect(iframe.src).to.equal('http://example.com/iframe');
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
   });
 
   it('should only trigger syncs once per page', () => {
@@ -99,13 +114,17 @@ describe('user sync', () => {
     expect(triggerPixelStub.getCall(0)).to.not.be.null;
     expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/1');
     expect(triggerPixelStub.getCall(1)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
+    expect(storageManagerAddStub.getCall(1)).to.be.null;
   });
 
   it('should not fire syncs if cookies are not supported', () => {
     const userSync = newTestUserSync({pixelEnabled: true}, true);
     userSync.registerSync('image', 'testBidder', 'http://example.com');
     userSync.syncUsers();
     expect(triggerPixelStub.getCall(0)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.be.null;
   });
 
   it('should prevent registering invalid type', () => {
@@ -115,15 +134,15 @@ describe('user sync', () => {
   });
 
   it('should expose the syncUsers method for the publisher to manually trigger syncs', () => {
-    // syncUsersOverride should do nothing by default
+    // triggerUserSyncs should do nothing by default
     let userSync = newTestUserSync();
     let syncUsersSpy = sinon.spy(userSync, 'syncUsers');
-    userSync.syncUsersOverride();
+    userSync.triggerUserSyncs();
     expect(syncUsersSpy.notCalled).to.be.true;
-    // syncUsersOverride should trigger syncUsers if enableOverride is on
+    // triggerUserSyncs should trigger syncUsers if enableOverride is on
     userSync = newTestUserSync({enableOverride: true});
     syncUsersSpy = sinon.spy(userSync, 'syncUsers');
-    userSync.syncUsersOverride();
+    userSync.triggerUserSyncs();
     expect(syncUsersSpy.called).to.be.true;
   });
 
@@ -138,6 +157,11 @@ describe('user sync', () => {
     expect(triggerPixelStub.getCall(1)).to.not.be.null;
     expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2]/);
     expect(triggerPixelStub.getCall(2)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
+    expect(storageManagerAddStub.getCall(1)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(1).args).to.eql([pbjsSyncsKey, 'testBidder', true]);
+    expect(storageManagerAddStub.getCall(2)).to.be.null;
   });
 
   it('should balance out bidder requests', () => {
@@ -172,5 +196,8 @@ describe('user sync', () => {
     expect(triggerPixelStub.getCall(0)).to.not.be.null;
     expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.include('http://example.com/');
     expect(triggerPixelStub.getCall(1)).to.be.null;
+    expect(storageManagerAddStub.getCall(0)).to.not.be.null;
+    expect(storageManagerAddStub.getCall(0).args).to.eql([pbjsSyncsKey, 'testBidderA', true]);
+    expect(storageManagerAddStub.getCall(1)).to.be.null;
   });
 });