Improvements for browsi RTD provider

modules/browsiRtdProvider.js

@@ -13,17 +13,20 @@
  * @property {string} pubKey
  * @property {string} url
  * @property {?string} keyName
- * @property {number} auctionDelay
+ * @property {?number} auctionDelay
+ * @property {?number} timeout
  */
 
 import {config} from '../src/config.js';
 import * as utils from '../src/utils';
 import {submodule} from '../src/hook';
-import {ajax} from '../src/ajax';
+import {ajaxBuilder} from '../src/ajax';
 import {loadExternalScript} from '../src/adloader';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
+/** @type {number} */
+const DEF_TIMEOUT = 1000;
 /** @type {ModuleParams} */
 let _moduleParams = {};
 /** @type {null|Object} */
@@ -33,14 +36,20 @@ let _dataReadyCallback = null;
 
 /**
  * add browsi script to page
- * @param {string} bptUrl
+ * @param {Object} data
  */
-export function addBrowsiTag(bptUrl) {
-  let script = loadExternalScript(bptUrl, 'browsi');
+export function addBrowsiTag(data) {
+  let script = loadExternalScript(data.u, 'browsi');
+  script.async = true;
   script.setAttribute('data-sitekey', _moduleParams.siteKey);
   script.setAttribute('data-pubkey', _moduleParams.pubKey);
   script.setAttribute('prebidbpt', 'true');
   script.setAttribute('id', 'browsi-tag');
+  script.setAttribute('src', data.u);
+  script.prebidData = utils.deepClone(data);
+  if (_moduleParams.keyName) {
+    script.prebidData.kn = _moduleParams.keyName;
+  }
   return script;
 }
 
@@ -109,17 +118,20 @@ function sendDataToModule(adUnits, onDone) {
         return onDone({});
       }
       const slots = getAllSlots();
-      if (!slots) {
+      if (!slots || !slots.length) {
         return onDone({});
       }
       let dataToReturn = adUnits.reduce((rp, cau) => {
         const adUnitCode = cau && cau.code;
         if (!adUnitCode) { return rp }
-        const predictionData = _predictions[adUnitCode];
+        const adSlot = getSlotById(adUnitCode);
+        if (!adSlot) { return rp }
+        const macroId = getMacroId(_predictionsData.pmd, adUnitCode, adSlot);
+        const predictionData = _predictions[macroId];
         if (!predictionData) { return rp }
 
         if (predictionData.p) {
-          if (!isIdMatchingAdUnit(adUnitCode, slots, predictionData.w)) {
+          if (!isIdMatchingAdUnit(adUnitCode, adSlot, predictionData.w)) {
             return rp;
           }
           rp[adUnitCode] = getKVObject(predictionData.p, _predictionsData.kn);
@@ -155,36 +167,87 @@ function getKVObject(p, keyName) {
 /**
  * check if placement id matches one of given ad units
  * @param {number} id placement id
- * @param {Object[]} allSlots google slots on page
+ * @param {Object} slot google slot
  * @param {string[]} whitelist ad units
  * @return {boolean}
  */
-export function isIdMatchingAdUnit(id, allSlots, whitelist) {
+export function isIdMatchingAdUnit(id, slot, whitelist) {
   if (!whitelist || !whitelist.length) {
     return true;
   }
-  const slot = allSlots.filter(s => s.getSlotElementId() === id);
-  const slotAdUnits = slot.map(s => s.getAdUnitPath());
-  return slotAdUnits.some(a => whitelist.indexOf(a) !== -1);
+  const slotAdUnits = slot.getAdUnitPath();
+  return whitelist.indexOf(slotAdUnits) !== -1;
 }
 
+/**
+ * get GPT slot by placement id
+ * @param {string} id placement id
+ * @return {?Object}
+ */
+function getSlotById(id) {
+  const slots = getAllSlots();
+  if (!slots || !slots.length) {
+    return null;
+  }
+  return slots.filter(s => s.getSlotElementId() === id)[0] || null;
+}
+
+/**
+ * generate id according to macro script
+ * @param {string} macro replacement macro
+ * @param {string} id placement id
+ * @param {Object} slot google slot
+ * @return {?Object}
+ */
+function getMacroId(macro, id, slot) {
+  if (macro) {
+    try {
+      const macroResult = evaluate(macro, slot.getSlotElementId(), slot.getAdUnitPath(), (match, p1) => {
+        return (p1 && slot.getTargeting(p1).join('_')) || 'NA';
+      });
+      return macroResult;
+    } catch (e) {
+      utils.logError(`failed to evaluate: ${macro}`);
+    }
+  }
+  return id;
+}
+
+function evaluate(macro, divId, adUnit, replacer) {
+  let macroResult = macro.p
+    .replace(/['"]+/g, '')
+    .replace(/<DIV_ID>/g, divId);
+
+  if (adUnit) {
+    macroResult = macroResult.replace(/<AD_UNIT>/g, adUnit);
+  }
+  if (replacer) {
+    macroResult = macroResult.replace(/<KEY_(\w+)>/g, replacer);
+  }
+  if (macro.s) {
+    macroResult = macroResult.substring(macro.s.s, macro.s.e);
+  }
+  return macroResult;
+}
 /**
  * XMLHttpRequest to get data form browsi server
  * @param {string} url server url with query params
  */
 function getPredictionsFromServer(url) {
+  let ajax = ajaxBuilder(_moduleParams.auctionDelay || _moduleParams.timeout || DEF_TIMEOUT);
+
   ajax(url,
     {
       success: function (response, req) {
         if (req.status === 200) {
           try {
             const data = JSON.parse(response);
             if (data && data.p && data.kn) {
-              setData({p: data.p, kn: data.kn});
+              setData({p: data.p, kn: data.kn, pmd: data.pmd});
             } else {
               setData({});
             }
-            addBrowsiTag(data.u);
+            addBrowsiTag(data);
           } catch (err) {
             utils.logError('unable to parse data');
             setData({})
@@ -235,6 +298,7 @@ export function init(config) {
       _moduleParams = realTimeData.dataProviders && realTimeData.dataProviders.filter(
         pr => pr.name && pr.name.toLowerCase() === 'browsi')[0].params;
       _moduleParams.auctionDelay = realTimeData.auctionDelay;
+      _moduleParams.timeout = realTimeData.timeout;
     } catch (e) {
       _moduleParams = {};
     }

modules/rtdModule/index.js

@@ -47,6 +47,13 @@
  * @type {Object}
  */
 
+/**
+ * @property
+ * @summary timeout (if no auction dealy)
+ * @name ModuleConfig#timeout
+ * @type {number}
+ */
+
 import {getGlobal} from '../../src/prebidGlobal';
 import {config} from '../../src/config.js';
 import {targeting} from '../../src/targeting';
@@ -55,6 +62,8 @@ import * as utils from '../../src/utils';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
+/** @type {number} */
+const DEF_TIMEOUT = 1000;
 /** @type {RtdSubmodule[]} */
 let subModules = [];
 /** @type {ModuleConfig} */
@@ -100,7 +109,7 @@ function getProviderData(adUnits, callback) {
   const dataWaitTimeout = setTimeout(() => {
     processDone = true;
     callback(dataReceived);
-  }, _moduleConfig.auctionDelay);
+  }, _moduleConfig.auctionDelay || _moduleConfig.timeout || DEF_TIMEOUT);
 
   subModules.forEach(sm => {
     sm.getData(adUnits, onDataReceived);

src/auction.js

@@ -168,7 +168,7 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, a
       _auctionEnd = Date.now();
 
       events.emit(CONSTANTS.EVENTS.AUCTION_END, getProperties());
-      bidsBackCallback(_adUnitCodes, function () {
+      bidsBackCallback(_adUnits, function () {
         try {
           if (_callback != null) {
             const adUnitCodes = _adUnitCodes;

test/spec/modules/realTimeModule_spec.js

@@ -178,10 +178,10 @@ describe('Real time module', function() {
       expect(script.async).to.equal(true);
 
       const slots = createSlots();
-      const test1 = isIdMatchingAdUnit('browsiAd_1', slots, ['/57778053/Browsi_Demo_300x250']); // true
-      const test2 = isIdMatchingAdUnit('browsiAd_1', slots, ['/57778053/Browsi_Demo_300x250', '/57778053/Browsi']); // true
-      const test3 = isIdMatchingAdUnit('browsiAd_1', slots, ['/57778053/Browsi_Demo_Low']); // false
-      const test4 = isIdMatchingAdUnit('browsiAd_1', slots, []); // true
+      const test1 = isIdMatchingAdUnit('browsiAd_1', slots[0], ['/57778053/Browsi_Demo_300x250']); // true
+      const test2 = isIdMatchingAdUnit('browsiAd_1', slots[0], ['/57778053/Browsi_Demo_300x250', '/57778053/Browsi']); // true
+      const test3 = isIdMatchingAdUnit('browsiAd_1', slots[0], ['/57778053/Browsi_Demo_Low']); // false
+      const test4 = isIdMatchingAdUnit('browsiAd_1', slots[0], []); // true
 
       expect(test1).to.equal(true);
       expect(test2).to.equal(true);