Browsi real time data module (prebid#4114)

* real time data module,
browsi sub module for real time data,
new hook bidsBackCallback,
fix for config unsubscribe

* change timeout&primary ad server only to auctionDelay
update docs

* support multiple providers

* change promise to callbacks
configure submodule on submodules.json

* bug fixes

* use Prebid ajax

* tests fix

modules/.submodules.json

@@ -10,5 +10,8 @@
   "adpod": [
     "freeWheelAdserverVideo",
     "dfpAdServerVideo"
+  ],
+  "rtdModule": [
+    "browsiRtdProvider"
   ]
 }

modules/browsiRtdProvider.js

@@ -0,0 +1,253 @@
+/**
+ * This module adds browsi provider to the eal time data module
+ * The {@link module:modules/realTimeData} module is required
+ * The module will fetch predictions from browsi server
+ * The module will place browsi bootstrap script on page
+ * @module modules/browsiProvider
+ * @requires module:modules/realTimeData
+ */
+
+/**
+ * @typedef {Object} ModuleParams
+ * @property {string} siteKey
+ * @property {string} pubKey
+ * @property {string} url
+ * @property {?string} keyName
+ * @property {number} auctionDelay
+ */
+
+import {config} from '../src/config.js';
+import * as utils from '../src/utils';
+import {submodule} from '../src/hook';
+import {ajax} from '../src/ajax';
+
+/** @type {string} */
+const MODULE_NAME = 'realTimeData';
+/** @type {ModuleParams} */
+let _moduleParams = {};
+/** @type {null|Object} */
+let _data = null;
+/** @type {null | function} */
+let _dataReadyCallback = null;
+
+/**
+ * add browsi script to page
+ * @param {string} bptUrl
+ */
+export function addBrowsiTag(bptUrl) {
+  let script = document.createElement('script');
+  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', bptUrl);
+  document.head.appendChild(script);
+  return script;
+}
+
+/**
+ * collect required data from page
+ * send data to browsi server to get predictions
+ */
+function collectData() {
+  const win = window.top;
+  const doc = win.document;
+  let browsiData = null;
+  try {
+    browsiData = utils.getDataFromLocalStorage('__brtd');
+  } catch (e) {
+    utils.logError('unable to parse __brtd');
+  }
+
+  let predictorData = {
+    ...{
+      sk: _moduleParams.siteKey,
+      sw: (win.screen && win.screen.width) || -1,
+      sh: (win.screen && win.screen.height) || -1,
+      url: encodeURIComponent(`${doc.location.protocol}//${doc.location.host}${doc.location.pathname}`),
+    },
+    ...(browsiData ? {us: browsiData} : {us: '{}'}),
+    ...(document.referrer ? {r: document.referrer} : {}),
+    ...(document.title ? {at: document.title} : {})
+  };
+  getPredictionsFromServer(`//${_moduleParams.url}/prebid?${toUrlParams(predictorData)}`);
+}
+
+export function setData(data) {
+  _data = data;
+
+  if (typeof _dataReadyCallback === 'function') {
+    _dataReadyCallback(_data);
+    _dataReadyCallback = null;
+  }
+}
+
+/**
+ * wait for data from server
+ * call callback when data is ready
+ * @param {function} callback
+ */
+function waitForData(callback) {
+  if (_data) {
+    _dataReadyCallback = null;
+    callback(_data);
+  } else {
+    _dataReadyCallback = callback;
+  }
+}
+
+/**
+ * filter server data according to adUnits received
+ * call callback (onDone) when data is ready
+ * @param {adUnit[]} adUnits
+ * @param {function} onDone callback function
+ */
+function sendDataToModule(adUnits, onDone) {
+  try {
+    waitForData(_predictionsData => {
+      const _predictions = _predictionsData.p;
+      if (!_predictions || !Object.keys(_predictions).length) {
+        return onDone({});
+      }
+      const slots = getAllSlots();
+      if (!slots) {
+        return onDone({});
+      }
+      let dataToReturn = adUnits.reduce((rp, cau) => {
+        const adUnitCode = cau && cau.code;
+        if (!adUnitCode) { return rp }
+        const predictionData = _predictions[adUnitCode];
+        if (!predictionData) { return rp }
+
+        if (predictionData.p) {
+          if (!isIdMatchingAdUnit(adUnitCode, slots, predictionData.w)) {
+            return rp;
+          }
+          rp[adUnitCode] = getKVObject(predictionData.p, _predictionsData.kn);
+        }
+        return rp;
+      }, {});
+      return onDone(dataToReturn);
+    });
+  } catch (e) {
+    onDone({});
+  }
+}
+
+/**
+ * get all slots on page
+ * @return {Object[]} slot GoogleTag slots
+ */
+function getAllSlots() {
+  return utils.isGptPubadsDefined && window.googletag.pubads().getSlots();
+}
+/**
+ * get prediction and return valid object for key value set
+ * @param {number} p
+ * @param {string?} keyName
+ * @return {Object} key:value
+ */
+function getKVObject(p, keyName) {
+  const prValue = p < 0 ? 'NA' : (Math.floor(p * 10) / 10).toFixed(2);
+  let prObject = {};
+  prObject[((_moduleParams['keyName'] || keyName).toString())] = prValue.toString();
+  return prObject;
+}
+/**
+ * check if placement id matches one of given ad units
+ * @param {number} id placement id
+ * @param {Object[]} allSlots google slots on page
+ * @param {string[]} whitelist ad units
+ * @return {boolean}
+ */
+export function isIdMatchingAdUnit(id, allSlots, 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);
+}
+
+/**
+ * XMLHttpRequest to get data form browsi server
+ * @param {string} url server url with query params
+ */
+function getPredictionsFromServer(url) {
+  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});
+            } else {
+              setData({});
+            }
+            addBrowsiTag(data.u);
+          } catch (err) {
+            utils.logError('unable to parse data');
+            setData({})
+          }
+        } else if (req.status === 204) {
+          // unrecognized site key
+          setData({});
+        }
+      },
+      error: function () {
+        setData({});
+        utils.logError('unable to get prediction data');
+      }
+    }
+  );
+}
+
+/**
+ * serialize object and return query params string
+ * @param {Object} data
+ * @return {string}
+ */
+function toUrlParams(data) {
+  return Object.keys(data)
+    .map(key => key + '=' + encodeURIComponent(data[key]))
+    .join('&');
+}
+
+/** @type {RtdSubmodule} */
+export const browsiSubmodule = {
+  /**
+   * used to link submodule with realTimeData
+   * @type {string}
+   */
+  name: 'browsi',
+  /**
+   * get data and send back to realTimeData module
+   * @function
+   * @param {adUnit[]} adUnits
+   * @param {function} onDone
+   */
+  getData: sendDataToModule
+};
+
+export function init(config) {
+  const confListener = config.getConfig(MODULE_NAME, ({realTimeData}) => {
+    try {
+      _moduleParams = realTimeData.dataProviders && realTimeData.dataProviders.filter(
+        pr => pr.name && pr.name.toLowerCase() === 'browsi')[0].params;
+      _moduleParams.auctionDelay = realTimeData.auctionDelay;
+    } catch (e) {
+      _moduleParams = {};
+    }
+    if (_moduleParams.siteKey && _moduleParams.pubKey && _moduleParams.url) {
+      confListener();
+      collectData();
+    } else {
+      utils.logError('missing params for Browsi provider');
+    }
+  });
+}
+
+submodule('realTimeData', browsiSubmodule);
+init(config);