prebid-universal-creative 1.14.2 → 1.16.0

package/src/renderingManager.js

@@ -1,385 +1,133 @@
-import * as utils from './utils';
-import * as domHelper from './domHelper';
-import {triggerPixel} from './utils';
+import { parseUrl, transformAuctionTargetingData } from './utils';
+import { canLocatePrebid } from './environment';
+import { insertElement, getEmptyIframe } from './domHelper';
 import {prebidMessenger} from './messaging.js';
 
-const DEFAULT_CACHE_HOST = 'prebid.adnxs.com';
-const DEFAULT_CACHE_PATH = '/pbc/v1/cache';
+export function renderBannerOrDisplayAd(doc, dataObject) {
+  const targetingData = transformAuctionTargetingData(dataObject);
 
-/**
- *
- * @param {Object} win Window object
- * @param {Object} environment Environment object
- * @returns {Object}
- */
-export function newRenderingManager(win, environment) {
-  /**
-   * DataObject passed to render the ad
-   * @typedef {Object} dataObject
-   * @property {string} host - Prebid cache host
-   * @property {string} uuid - ID to fetch the value from prebid cache
-   * @property {string} mediaType - Creative media type, It can be banner, native or video
-   * @property {string} pubUrl - Publisher url
-   * @property {string} winurl
-   * @property {string} winbidid
-   */
-
-  /**
-   * Public render ad function to be used in dfp creative setup
-   * @param  {object} doc
-   * @param  {dataObject} dataObject
-   */
-  let renderAd = function(doc, dataObject) {
-    const targetingData = utils.transformAuctionTargetingData(dataObject);
-
-    if (environment.isMobileApp(targetingData.env)) {
-      renderAmpOrMobileAd(targetingData.cacheHost, targetingData.cachePath, targetingData.uuid, targetingData.size, targetingData.hbPb, true);
-    } else if (environment.isAmp(targetingData.uuid)) {
-      renderAmpOrMobileAd(targetingData.cacheHost, targetingData.cachePath, targetingData.uuid, targetingData.size, targetingData.hbPb);
-    } else if (!environment.canLocatePrebid()) {
-      renderCrossDomain(targetingData.adId, targetingData.adServerDomain, targetingData.pubUrl);
-    } else {
-      renderLegacy(doc, targetingData.adId);
-    }
-  };
-
-  /**
-   * Calls prebid.js renderAd function to render ad
-   * @param {Object} doc Document
-   * @param {string} adId Id of creative to render
-   */
-  function renderLegacy(doc, adId) {
-    let w = win;
-    for (let i = 0; i < 10; i++) {
-      w = w.parent;
-      if (w.$$PREBID_GLOBAL$$) {
-        try {
-          w.$$PREBID_GLOBAL$$.renderAd(doc, adId);
-          break;
-        } catch (e) {
-          continue;
-        }
-      }
-    }
+  if (!canLocatePrebid(window)) {
+    renderCrossDomain(window, targetingData.adId, targetingData.adServerDomain, targetingData.pubUrl);
+  } else {
+    renderLegacy(doc, targetingData.adId);
   }
+}
 
-  /**
-   * Render ad in safeframe using postmessage
-   * @param {string} adId Id of creative to render
-   * @param {string} pubAdServerDomain publisher adserver domain name
-   * @param {string} pubUrl Url of publisher page
-   */
-  function renderCrossDomain(adId, pubAdServerDomain = '', pubUrl) {
-    let windowLocation = win.location;
-    let adServerDomain = pubAdServerDomain || win.location.hostname;
-    let fullAdServerDomain = windowLocation.protocol + '//' + adServerDomain;
-    const sendMessage = prebidMessenger(pubUrl, win);
-
-    function renderAd(ev) {
-      let key = ev.message ? 'message' : 'data';
-      let adObject = {};
+/**
+ * Calls prebid.js renderAd function to render ad
+ * @param {Object} doc Document
+ * @param {string} adId Id of creative to render
+ */
+export function renderLegacy(doc, adId) {
+  let found = false;
+  let w = window;
+  for (let i = 0; i < 10; i++) {
+    w = w.parent;
+    if (w.$$PREBID_GLOBAL$$) {
       try {
-        adObject = JSON.parse(ev[key]);
+        found = true;
+        w.$$PREBID_GLOBAL$$.renderAd(doc, adId);
+        break;
       } catch (e) {
-        return;
-      }
-
-      if (adObject.message && adObject.message === 'Prebid Response' &&
-          adObject.adId === adId) {
-        try {
-          let body = win.document.body;
-          let ad = adObject.ad;
-          let url = adObject.adUrl;
-          let width = adObject.width;
-          let height = adObject.height;
-
-          if (adObject.mediaType === 'video') {
-            signalRenderResult(false, {
-              reason: 'preventWritingOnMainDocument',
-              message: `Cannot render video ad ${adId}`
-            });
-            console.log('Error trying to write ad.');
-          } else if (ad) {
-            const iframe =  domHelper.getEmptyIframe(adObject.height, adObject.width);
-            body.appendChild(iframe);
-            iframe.contentDocument.open();
-            iframe.contentDocument.write(ad);
-            iframe.contentDocument.close();
-            signalRenderResult(true);
-          } else if (url) {
-            const iframe = domHelper.getEmptyIframe(height, width);
-            iframe.style.display = 'inline';
-            iframe.style.overflow = 'hidden';
-            iframe.src = url;
-
-            domHelper.insertElement(iframe, document, 'body');
-            signalRenderResult(true);
-          } else {
-            signalRenderResult(false, {
-              reason: 'noAd',
-              message: `No ad for ${adId}`
-            });
-            console.log(`Error trying to write ad. No ad markup or adUrl for ${adId}`);
-          }
-        } catch (e) {
-          signalRenderResult(false, {reason: "exception", message: e.message});
-          console.log(`Error in rendering ad`, e);
-        }
-      }
-
-      function signalRenderResult(success, {reason, message} = {}) {
-        const payload = {
-          message: 'Prebid Event',
-          adId,
-          event: success ? 'adRenderSucceeded' : 'adRenderFailed',
-        }
-        if (!success) {
-          payload.info = {reason, message};
-        }
-        sendMessage(payload);
+        continue;
       }
     }
-
-
-    function requestAdFromPrebid() {
-      let message = {
-        message: 'Prebid Request',
-        adId: adId,
-        adServerDomain: fullAdServerDomain
-      }
-      sendMessage(message, renderAd);
-    }
-
-    requestAdFromPrebid();
-  }
-
-  /**
-   * Returns cache endpoint concatenated with cache path
-   * @param {string} cacheHost Cache Endpoint host
-   * @param {string} cachePath Cache Endpoint path
-   */
-  function getCacheEndpoint(cacheHost, cachePath) {
-    let host = (typeof cacheHost === 'undefined' || cacheHost === "") ? DEFAULT_CACHE_HOST : cacheHost;
-    let path = (typeof cachePath === 'undefined' || cachePath === "") ? DEFAULT_CACHE_PATH : cachePath;
-
-    return `https://${host}${path}`;
   }
-
-  /**
-   * update iframe by using size string to resize
-   * @param {string} size
-   */
-  function updateIframe(size) {
-    if (size) {
-      const sizeArr = size.split('x').map(Number);
-      resizeIframe(sizeArr[0], sizeArr[1]);
-    } else {
-      console.log('Targeting key hb_size not found to resize creative');
-    }
+  if (!found) {
+    console.error("Unable to locate $$PREBID_GLOBAL$$.renderAd function!");
   }
+}
 
-  /**
-   * Render mobile or amp ad
-   * @param {string} cacheHost Cache host
-   * @param {string} cachePath Cache path
-   * @param {string} uuid id to render response from cache endpoint
-   * @param {string} size size of the creative
-   * @param {string} hbPb final price of the winning bid
-   * @param {Bool} isMobileApp flag to detect mobile app
-   */
-  function renderAmpOrMobileAd(cacheHost, cachePath, uuid = '', size, hbPb, isMobileApp) {
-    // For MoPub, creative is stored in localStorage via SDK.
-    let search = 'Prebid_';
-    if(uuid.substr(0, search.length) === search) {
-      loadFromLocalCache(uuid);
-      //register creative right away to not miss initial geom-update
-      updateIframe(size);
-    } else {
-      let adUrl = `${getCacheEndpoint(cacheHost, cachePath)}?uuid=${uuid}`;
-      //register creative right away to not miss initial geom-update
-      updateIframe(size);
-      utils.sendRequest(adUrl, responseCallback(isMobileApp, hbPb));
+/**
+ * Render ad in safeframe using postmessage
+ * @param {string} adId Id of creative to render
+ * @param {string} pubAdServerDomain publisher adserver domain name
+ * @param {string} pubUrl Url of publisher page
+ */
+export function renderCrossDomain(win, adId, pubAdServerDomain = '', pubUrl) {
+  let windowLocation = win.location;
+  let adServerDomain = pubAdServerDomain || win.location.hostname;
+  let fullAdServerDomain = windowLocation.protocol + '//' + adServerDomain;
+  const sendMessage = prebidMessenger(pubUrl, win);
+
+  function renderAd(ev) {
+    let key = ev.message ? "message" : "data";
+    let adObject = {};
+    try {
+      adObject = JSON.parse(ev[key]);
+    } catch (e) {
+      return;
     }
-  }
 
-  /**
-   * Cache request Callback to display creative
-   * @param {Bool} isMobileApp
-   * @param {string} hbPb final price of the winning bid
-   * @returns {function} a callback function that parses response
-   */
-  function responseCallback(isMobileApp, hbPb) {
-    return function(response) {
-      let bidObject = parseResponse(response);
-      let auctionPrice = bidObject.price || hbPb;
-      let ad = utils.getCreativeCommentMarkup(bidObject);
-      let width = (bidObject.width) ? bidObject.width : bidObject.w;
-      let height = (bidObject.height) ? bidObject.height : bidObject.h;
-
-      // When Prebid Universal Creative reads from Prebid Cache, we need to have it check for the existence of the wurl parameter. If it exists, hit it.
-      if (bidObject.wurl) {
-        triggerPixel(decodeURIComponent(bidObject.wurl));
-      }
-
-      if (bidObject.adm) {
-        if(auctionPrice) { // replace ${AUCTION_PRICE} macro with the bidObject.price or hb_pb.
-          bidObject.adm = bidObject.adm.replace('${AUCTION_PRICE}', auctionPrice);
-        } else {
-          /*
-            From OpenRTB spec 2.5: If the source value is an optional parameter that was not specified, the macro will simply be removed (i.e., replaced with a zero-length string).
-           */
-          bidObject.adm = bidObject.adm.replace('${AUCTION_PRICE}', '');
-        }
-        ad += (isMobileApp) ? constructMarkup(bidObject.adm, width, height) : bidObject.adm;
-        if (bidObject.nurl) {
-          ad += utils.createTrackPixelHtml(decodeURIComponent(bidObject.nurl));
-        }
-        if (bidObject.burl) {
-          let triggerBurl = function(){ utils.triggerPixel(bidObject.burl); };
-          if(isMobileApp) {
-            let mraidScript = utils.loadScript(win, 'mraid.js',
-              function() { // Success loading MRAID
-                let result = registerMRAIDViewableEvent(triggerBurl);
-                if (!result) {
-                  triggerBurl(); // Error registering event
-                }
-              },
-              triggerBurl // Error loading MRAID
-              );
-          } else {
-            triggerBurl(); // Not a mobile app
-          }
-        }
-        utils.writeAdHtml(ad);
-      } else if (bidObject.nurl) {
-        if(isMobileApp) {
-          let adhtml = utils.loadScript(win, bidObject.nurl);
-          ad += constructMarkup(adhtml.outerHTML, width, height);
-          utils.writeAdHtml(ad);
+    if (
+      adObject.message &&
+      adObject.message === "Prebid Response" &&
+      adObject.adId === adId
+    ) {
+      try {
+        let body = win.document.body;
+        let ad = adObject.ad;
+        let url = adObject.adUrl;
+        let width = adObject.width;
+        let height = adObject.height;
+
+        if (adObject.mediaType === "video") {
+          signalRenderResult(false, {
+            reason: "preventWritingOnMainDocument",
+            message: `Cannot render video ad ${adId}`,
+          });
+          console.log("Error trying to write ad.");
+        } else if (ad) {
+          const iframe = getEmptyIframe(adObject.height, adObject.width);
+          body.appendChild(iframe);
+          iframe.contentDocument.open();
+          iframe.contentDocument.write(ad);
+          iframe.contentDocument.close();
+          signalRenderResult(true);
+        } else if (url) {
+          const iframe = getEmptyIframe(height, width);
+          iframe.style.display = "inline";
+          iframe.style.overflow = "hidden";
+          iframe.src = url;
+
+          insertElement(iframe, document, "body");
+          signalRenderResult(true);
         } else {
-          let nurl = bidObject.nurl;
-          let commentElm = utils.getCreativeComment(bidObject);
-          domHelper.insertElement(commentElm, document, 'body');
-          utils.writeAdUrl(nurl, width, height);
+          signalRenderResult(false, {
+            reason: "noAd",
+            message: `No ad for ${adId}`,
+          });
+          console.log(
+            `Error trying to write ad. No ad markup or adUrl for ${adId}`
+          );
         }
+      } catch (e) {
+        signalRenderResult(false, { reason: "exception", message: e.message });
+        console.log(`Error in rendering ad`, e);
       }
     }
-  };
-
-  /**
-   * Load response from localStorage. In case of MoPub, sdk caches response
-   * @param {string} cacheId
-   */
-  function loadFromLocalCache(cacheId) {
-    let bid = win.localStorage.getItem(cacheId);
-    let displayFn = responseCallback(true);
-    displayFn(bid);
-  }
-
-  /**
-   * Parse response
-   * @param {string} response
-   * @returns {Object} bidObject parsed response
-   */
-  function parseResponse(response) {
-    let bidObject;
-    try {
-      bidObject = JSON.parse(response);
-    } catch (error) {
-      console.log(`Error parsing response from cache host: ${error}`);
-    }
-    return bidObject;
-  }
-
-  /**
-   * Wrap mobile app creative in div
-   * @param {string} ad html for creative
-   * @param {Number} width width of creative
-   * @param {Number} height height of creative
-   * @returns {string} creative markup
-   */
-  function constructMarkup(ad, width, height) {
-    let id = utils.getUUID();
-    return `<div id="${id}" style="border-style: none; position: absolute; width:100%; height:100%;">
-      <div id="${id}_inner" style="margin: 0 auto; width:${width}px; height:${height}px; position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%);">${ad}</div>
-      </div>`;
-  }
-
-  /**
-   * Resize container iframe
-   * @param {Number} width width of creative
-   * @param {Number} height height of creative
-   */
-  function resizeIframe(width, height) {
-    if (environment.isSafeFrame()) {
-      const iframeWidth = win.innerWidth;
-      const iframeHeight = win.innerHeight;
 
-      function resize(status) {
-        let newWidth = width - iframeWidth;
-        let newHeight = height - iframeHeight;
-        win.$sf.ext.expand({r:newWidth, b:newHeight, push: true});
-      }
-
-      if (iframeWidth !== width || iframeHeight !== height) {
-        win.$sf.ext.register(width, height, resize);
-        // we need to resize the DFP container as well
-        win.parent.postMessage({
-          sentinel: 'amp',
-          type: 'embed-size',
-          width: width,
-          height: height
-        }, '*');
+    function signalRenderResult(success, { reason, message } = {}) {
+      const payload = {
+        message: "Prebid Event",
+        adId,
+        event: success ? "adRenderSucceeded" : "adRenderFailed",
+      };
+      if (!success) {
+        payload.info = { reason, message };
       }
+      sendMessage(payload);
     }
   }
 
-  function registerMRAIDViewableEvent(callback) {
-
-    function exposureChangeListener(exposure) {
-      if (exposure > 0) {
-        mraid.removeEventListener('exposureChange', exposureChangeListener);
-        callback();
-      }
-    }
-
-    function viewableChangeListener(viewable) {
-      if (viewable) {
-        mraid.removeEventListener('viewableChange', viewableChangeListener);
-        callback();
-      }
-    }
-
-    function registerViewableChecks() {
-      if (win.MRAID_ENV && parseFloat(win.MRAID_ENV.version) >= 3) {
-        mraid.addEventListener('exposureChange', exposureChangeListener);
-      } else if(win.MRAID_ENV && parseFloat(win.MRAID_ENV.version) < 3) {
-        if (mraid.isViewable()) {
-          callback();
-        } else {
-          mraid.addEventListener('viewableChange', viewableChangeListener);
-        }
-      }
-    }
-
-    function readyListener() {
-      mraid.removeEventListener('ready', readyListener);
-      registerViewableChecks();
-    }
-
-    if (win.mraid && win.MRAID_ENV) {
-      if (mraid.getState() == 'loading') {
-        mraid.addEventListener('ready', readyListener);
-      } else {
-        registerViewableChecks();
-      }
-      return true;
-    } else {
-      return false;
+  function requestAdFromPrebid() {
+    let message = {
+      message: 'Prebid Request',
+      adId: adId,
+      adServerDomain: fullAdServerDomain
     }
+    sendMessage(message, renderAd);
   }
 
-  return {
-    renderAd
-  }
+  requestAdFromPrebid();
 }

package/src/utils.js

@@ -1,4 +1,3 @@
-const postscribe = require('postscribe');
 import * as domHelper from './domHelper';
 
 /**
@@ -31,15 +30,6 @@ export function writeAdUrl(adUrl, width, height) {
   document.body.appendChild(iframe);
 }
 
-export function writeAdHtml(markup) {
-  // remove <?xml> and <!doctype> tags
-  // https://github.com/prebid/prebid-universal-creative/issues/134
-  markup = markup.replace(/\<(\?xml|(\!DOCTYPE[^\>\[]+(\[[^\]]+)?))+[^>]+\>/g, '');
-  postscribe(document.body, markup, {
-    error: console.error
-  });
-}
-
 export function sendRequest(url, callback) {
   function reqListener() {
     callback(oReq.responseText);
@@ -115,7 +105,7 @@ export function getCreativeComment(bid) {
  * @param {*} bid
  */
 export function getCreativeCommentMarkup(bid) {
-  let creativeComment = exports.getCreativeComment(bid);
+  let creativeComment = getCreativeComment(bid);
   let wrapper = document.createElement('div');
   wrapper.appendChild(creativeComment);
   return wrapper.innerHTML;

package/template/amp/dfp-creative.html

@@ -1,4 +1,4 @@
-<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/creative.js"></script>
+<script src = "https://cdn.jsdelivr.net/npm/prebid-universal-creative@latest/dist/%%PATTERN::hb_format%%.js"></script>
 <script>
   var ucTagData = {};
   ucTagData.adServerDomain = "";

package/test/spec/environment_spec.js

@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { newEnvironment } from 'src/environment';
+import * as env from 'src/environment';
 import { mocks } from 'test/helpers/mocks';
 import { merge } from 'lodash';
 
@@ -16,8 +16,6 @@ const envMocks = {
 describe('environment module', function() {
   
   it('should return env object with proper public api', function() {
-    const mockWin = merge(mocks.createFakeWindow('http://appnexus.com'), envMocks.getWindowObject());
-    const env = newEnvironment(mockWin);
     expect(env.isMobileApp).to.exist;
     expect(env.isCrossDomain).to.exist;
     expect(env.isSafeFrame).to.exist;
@@ -26,8 +24,7 @@ describe('environment module', function() {
 
   it('should detect safeframe', function() {
     const mockWin = merge(mocks.createFakeWindow('http://appnexus.com'), envMocks.getWindowObject());
-    const env = newEnvironment(mockWin);
-    expect(env.isSafeFrame()).to.equal(true);
+    expect(env.isSafeFrame(mockWin)).to.equal(true);
   });
 
   it('should detect amp', function() {
@@ -39,8 +36,7 @@ describe('environment module', function() {
 			}
 		}
     const mockWin = merge(mocks.createFakeWindow('http://appnexus.com'), envMocks.getWindowObject(), localWindow);
-    const env = newEnvironment(mockWin);
-    expect(env.isAmp('some-uuid')).to.equal(true);
+    expect(env.isAmp('some-uuid', mockWin)).to.equal(true);
 	});
 	
 	it('should detect Prebid in higher window', function() {
@@ -54,13 +50,10 @@ describe('environment module', function() {
       }
     };
     const mockWin = merge(mocks.createFakeWindow('http://appnexus.com'), envMocks.getWindowObject(), localWindow);
-    const env = newEnvironment(mockWin);
-    expect(env.canLocatePrebid()).to.equal(true);
+    expect(env.canLocatePrebid(mockWin)).to.equal(true);
 	});
   
   it('should detect mobile app', function() {
-    const mockWin = merge(mocks.createFakeWindow('http://appnexus.com'), envMocks.getWindowObject());
-    const env = newEnvironment(mockWin);
     expect(env.isMobileApp('mobile-app')).to.equal(true);
   });
 });

package/test/spec/legacyNativeRender_spec.js

@@ -0,0 +1,25 @@
+import '../../src/legacyNativeRender';
+
+describe('legacyNativeRender', () => {
+
+    after(() => {
+        delete window.pbNativeTag;
+        window.nativeRenderManager.renderNativeAd.reset();
+    })
+    it('should accept only one argument', () => {
+        
+        expect(window.pbNativeTag.renderNativeAd).to.exist;
+        //expect exactly one argument by this function
+        expect(window.pbNativeTag.renderNativeAd.length).to.equal(1);
+        
+        const args = {
+            pubUrl: 'http://prebidjs.com',
+            adId: 'abc123'
+        };
+        window.nativeRenderManager.renderNativeAd = sinon.stub();
+
+        window.pbNativeTag.renderNativeAd(args);
+        expect(nativeRenderManager.renderNativeAd.calledOnceWith(document, args)).to.be.true;
+        
+    })
+})