prebid-universal-creative 1.12.0 → 1.14.0

package/src/renderingManager.js

@@ -1,6 +1,7 @@
 import * as utils from './utils';
 import * as domHelper from './domHelper';
 import {triggerPixel} from './utils';
+import {prebidMessenger} from './messaging.js';
 
 const DEFAULT_CACHE_HOST = 'prebid.adnxs.com';
 const DEFAULT_CACHE_PATH = '/pbc/v1/cache';
@@ -70,10 +71,9 @@ export function newRenderingManager(win, environment) {
    */
   function renderCrossDomain(adId, pubAdServerDomain = '', pubUrl) {
     let windowLocation = win.location;
-    let parsedUrl = utils.parseUrl(pubUrl);
-    let publisherDomain = parsedUrl.protocol + '://' + parsedUrl.host;
     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';
@@ -84,52 +84,72 @@ export function newRenderingManager(win, environment) {
         return;
       }
 
-      let origin = ev.origin || ev.originalEvent.origin;
       if (adObject.message && adObject.message === 'Prebid Response' &&
-          publisherDomain === origin &&
-          adObject.adId === adId &&
-          (adObject.ad || adObject.adUrl)) {
-        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') {
-          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();
-        } 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');
-        } else {
-          console.log(`Error trying to write ad. No ad for bid response id: ${id}`);
+          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);
       }
     }
 
+
     function requestAdFromPrebid() {
-      let message = JSON.stringify({
+      let message = {
         message: 'Prebid Request',
         adId: adId,
         adServerDomain: fullAdServerDomain
-      });
-      win.parent.postMessage(message, publisherDomain);
-    }
-
-    function listenAdFromPrebid() {
-      win.addEventListener('message', renderAd, false);
+      }
+      sendMessage(message, renderAd);
     }
 
-    listenAdFromPrebid();
     requestAdFromPrebid();
   }
 
@@ -144,7 +164,7 @@ export function newRenderingManager(win, environment) {
 
     return `https://${host}${path}`;
   }
-  
+
   /**
    * update iframe by using size string to resize
    * @param {string} size

package/src/utils.js

@@ -32,6 +32,9 @@ export function writeAdUrl(adUrl, width, height) {
 }
 
 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
   });

package/static/prebid-mobile-rewarded-vast.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<VAST version="2.0">
+   <Ad id="PrebidMobileAppEvent">
+      <InLine>
+         <AdSystem version="1.0">Prebid org</AdSystem>
+         <AdTitle>PrebidAppEvent</AdTitle>
+         <Impression><![CDATA[https://test.url.com]]></Impression>
+         <Creatives>
+            <Creative>
+               <Linear>
+                  <Duration>00:00:02</Duration>
+                  <MediaFiles>
+                     <MediaFile delivery="progressive" height="540" id="539733616" type="video/mp4" width="960">
+                         <![CDATA[https://test.url.com/gam_rewarded.mp4]]>
+                     </MediaFile>
+                  </MediaFiles>
+               </Linear>
+            </Creative>
+         </Creatives>
+      </InLine>
+   </Ad>
+</VAST>

package/test/helpers/mocks.js

@@ -1,15 +1,19 @@
 export const mocks = {
   createFakeWindow: function (href) {
     return {
+      addEventListener: function () {},
+      removeEventListener: function () {},
       document: {
         head: {},
-        body: {}
+        body: {
+          style: {}
+        }
       },
       location: {
         href: href,
       },
       parent: {},
-      top: {}
+      top: {},
     };
   }
-}
+}

package/test/spec/messaging_spec.js

@@ -0,0 +1,64 @@
+import {mocks} from '../helpers/mocks.js';
+import {prebidMessenger} from '../../src/messaging.js';
+
+describe('prebidMessenger',() => {
+    let win;
+    beforeEach(() => {
+        win = Object.assign(mocks.createFakeWindow(), {
+            parent: {
+                postMessage: sinon.spy()
+            }
+        });
+    })
+    describe('when publisher URL is unavailable', () => {
+        let sendMessage;
+
+        beforeEach(() => {
+            sendMessage = prebidMessenger(null, win);
+        });
+
+        it('should throw', () => {
+            expect(() => sendMessage('test')).to.throw();
+        })
+    });
+
+    describe('when publisher URL is available', () => {
+        const URL = 'https://www.publisher.com/page.html';
+        const ORIGIN = 'https://www.publisher.com'
+        let sendMessage;
+        let callback, handler;
+
+        beforeEach(() => {
+            win.addEventListener = function (_, h) {
+                handler = h;
+            }
+            win.removeEventListener = sinon.spy();
+            sendMessage = prebidMessenger(URL, win);
+            callback = sinon.spy();
+        })
+
+        it('should use origin for postMessage', () => {
+           sendMessage('test');
+           sinon.assert.calledWith(win.parent.postMessage, JSON.stringify('test'), ORIGIN);
+        });
+
+        it('should not run callback on response if origin does not mach', ()=> {
+           sendMessage('test', callback);
+           handler({origin: 'different'});
+           expect(callback.called).to.be.false;
+        });
+
+        it('should run callback on response if origin does match', () => {
+            sendMessage('test', callback);
+            const ev = {origin: ORIGIN, data: 'stuff'};
+            handler(ev);
+            sinon.assert.calledWith(callback, ev);
+        });
+
+        it('should remove window listener when canceled', () => {
+            sendMessage('test', callback)();
+            expect(win.removeEventListener.called).to.be.true;
+        })
+
+    });
+})