prebid-universal-creative 1.14.2 → 1.16.0

package/test/spec/nativeORTBTrackerManager_spec.js

@@ -37,40 +37,24 @@ describe('test firing native trackers', function () {
 
 
   it('should fire impression trackers', function () {
-    let imgUrl = 'foo.bar/event?type=img';
-    let jsUrl = 'foo.bar/event?type=js';
-    
-
     fireNativeImpressionTrackers("abc123", sendMessage);
 
     expect(sendMessage.getCall(0).args[0]).to.deep.equal({
-      message: 'Prebid Native', 
+      message: 'Prebid Native',
       action: 'fireNativeImpressionTrackers',
       adId: 'abc123'
     })
   });
 
   it('should fire asset clicktrackers', function () {
-    let assetTrackers = ['foo.bar/click?id=1', 'foo.bar/click?id=2'];
-    let mainTrackers = ['foo.bar/click?id=3'];
     let adId = "abc123";
-    let nativeOrtb = {
-      assets: [{
-        id: 1,
-        link: { clicktrackers: assetTrackers }
-      }],
-      link: {
-        clicktrackers: mainTrackers
-      }
-    }
-
-    addNativeClickTrackers(adId, nativeOrtb, sendMessage);
+    addNativeClickTrackers(adId, sendMessage);
     expect(sendMessage.getCall(0).args[0]).to.deep.equal({
       message: "Prebid Native",
       action: 'click',
       adId: 'abc123',
       assetId: 1
     });
-    
+
   });
 });

package/test/spec/nativeRenderManager_spec.js

@@ -1,8 +1,7 @@
-import { newNativeRenderManager } from 'src/nativeRenderManager';
-import * as nam  from 'src/nativeAssetManager';
-import { expect } from 'chai';
-import { mocks } from 'test/helpers/mocks';
-import { merge } from 'lodash';
+import {newNativeRenderManager} from 'src/nativeRenderManager';
+import * as nam from 'src/nativeAssetManager';
+import {mocks} from 'test/helpers/mocks';
+import {merge} from 'lodash';
 
 const renderingMocks = {
   getWindowObject: function() {
@@ -15,10 +14,6 @@ const renderingMocks = {
   }
 };
 
-function trimPort(url) {
-  return ((/:\d+/).test(url)) ? url.substring(0, url.lastIndexOf(':')) : url;
-}
-
 describe('nativeRenderManager', function () {
   describe('load renderNativeAd', function () {
     let mockWin;
@@ -55,56 +50,83 @@ describe('nativeRenderManager', function () {
       assetManagerStub.restore();
     });
 
-    it('should verify the postMessage for impression trackers was executed', function() {
-      mockWin.document.getElementsByClassName = () => [{
-        attributes: {
-          pbAdId: {
-            value: 'ad123'
-          }
-        },
-        addEventListener: (type, listener, capture) => {
-        },
-      }];
-      let nativeTracker = new newNativeRenderManager(mockWin);
-      nativeTracker.renderNativeAd(tagData);
-
-      expect(mockWin.parent.postMessage.callCount).to.equal(1);
-      let postMessageTargetDomain = mockWin.parent.postMessage.args[0][1];
-      let postMessageContents = mockWin.parent.postMessage.args[0][0];
-      let rawPostMessage = JSON.parse(postMessageContents);
-
-      expect(rawPostMessage.message).to.exist.and.to.equal("Prebid Native");
-      expect(rawPostMessage.adId).to.exist.and.to.equal("ad123");
-      expect(rawPostMessage.action).to.not.exist;
-      expect(trimPort(postMessageTargetDomain)).to.equal(tagData.pubUrl);
-    });
+    describe('should fire event', () => {
+      let recvMessages;
+      function mockMessenger() {
+        return recvMessages.push.bind(recvMessages);
+      }
 
-    it('should verify the postMessages for the impression and click trackers were executed', function() {
-      mockWin.document.getElementsByClassName = () => [{
-        attributes: {
-          pbAdId: {
-            value: 'ad123'
+      beforeEach(() => {
+        recvMessages = [];
+      });
+      it('AD_RENDER_SUCCEEDED', () => {
+        const mockAssetMgr = function () {
+          return {
+            loadAssets(_, fn) {
+              fn();
+            }
           }
-        },
-        addEventListener: ((type, listener, capture) => {
-          listener({
+        }
+        const rdr = newNativeRenderManager(mockWin, mockMessenger, mockAssetMgr);
+        rdr.renderNativeAd(mockWin.document, tagData);
+        sinon.assert.match(recvMessages[0], {
+          message: 'Prebid Event',
+          adId: 'ad123',
+          event: 'adRenderSucceeded',
+        })
+      })
+      describe('AD_RENDER_FAILED', () => {
+        it('on exceptions', () => {
+          const rdr = newNativeRenderManager(mockWin, mockMessenger);
+          rdr.renderNativeAd(mockWin.document, Object.defineProperties({...tagData}, {
+            rendererUrl: {
+              get() {
+                throw new Error('err');
+              }
+            }
+          }));
+          sinon.assert.match(recvMessages[0], {
+            message: 'Prebid Event',
+            adId: 'ad123',
+            event: 'adRenderFailed',
+            info: {
+              reason: 'exception',
+              message: 'err'
+            }
+          })
+        });
+        it('on missing adId',() => {
+          const rdr = newNativeRenderManager(mockWin, mockMessenger);
+          rdr.renderNativeAd(mockWin.document, {...tagData, adId: undefined});
+          sinon.assert.match(recvMessages[0], {
+            message: 'Prebid Event',
+            event: 'adRenderFailed',
+            info: {
+              reason: 'missingDocOrAdid',
+            }
+          })
+        });
+        it('on rendering errors', () => {
+          const mockAssetMgr = function () {
+            return {
+              loadAssets(_1, _2, err) {
+                err(new Error('err'))
+              }
+            }
+          }
+          const rdr = newNativeRenderManager(mockWin, mockMessenger, mockAssetMgr);
+          rdr.renderNativeAd(mockWin.document, tagData);
+          sinon.assert.match(recvMessages[0], {
+            message: 'Prebid Event',
+            event: 'adRenderFailed',
+            info: {
+              reason: 'exception',
+              message: 'err'
+            }
           })
         })
-      }];
-
-      let nativeTracker = new newNativeRenderManager(mockWin);
-      nativeTracker.renderNativeAd(tagData);
-
-      expect(mockWin.parent.postMessage.callCount).to.equal(2);
-
-      let postMessageTargetDomain = mockWin.parent.postMessage.args[0][1];
-      let postMessageContents = mockWin.parent.postMessage.args[1][0];
-      let rawPostMessage = JSON.parse(postMessageContents);
-
-      expect(rawPostMessage.message).to.exist.and.to.equal("Prebid Native");
-      expect(rawPostMessage.adId).to.exist.and.to.equal("ad123");
-      expect(rawPostMessage.action).to.exist.and.to.equal('click');
-      expect(trimPort(postMessageTargetDomain)).to.equal(tagData.pubUrl);
+      })
     });
   });
+
 });

package/test/spec/nativeRender_spec.js

@@ -0,0 +1,23 @@
+import '../../src/nativeRender';
+
+describe('nativeRender', () => {
+
+    after(() => {
+        delete window.ucTag;
+    })
+
+    it('should accept 2 arguments', () => {
+        expect(window.ucTag.renderAd).to.exist;
+        //expect exactly two arguments by this function
+        expect(window.ucTag.renderAd.length).to.equal(2);
+        
+        // this function with two arguments and see it NOT throwing
+        const renderAd = window.ucTag.renderAd.bind(this, document, {
+            pubUrl: 'http://prebidjs.com',
+            adId: 'abc123',
+            replaceAllAssets: true
+        })
+        expect(renderAd).to.not.throw();
+        
+    })
+})

package/test/spec/renderingManager_spec.js

@@ -1,4 +1,4 @@
-import { newRenderingManager } from 'src/renderingManager';
+import { renderCrossDomain, renderLegacy } from 'src/renderingManager';
 import * as utils from 'src/utils';
 import * as domHelper from 'src/domHelper';
 import { expect } from 'chai';
@@ -70,251 +70,12 @@ describe('renderingManager', function() {
     xhr.restore();
   });
 
-  describe('mobile creative', function() {
-    let writeHtmlSpy;
-    let sendRequestSpy;
-    let triggerPixelSpy;
-    let mockWin;
-
-    before(function() {
-      writeHtmlSpy = sinon.spy(utils, 'writeAdHtml');
-      sendRequestSpy = sinon.spy(utils, 'sendRequest');
-      triggerPixelSpy = sinon.spy(utils, 'triggerPixel');
-      mockWin = merge(mocks.createFakeWindow('http://example.com'), renderingMocks().getWindowObject());
-    });
-
-    afterEach(function() {
-      writeHtmlSpy.resetHistory();
-      sendRequestSpy.resetHistory();
-      triggerPixelSpy.resetHistory();
-    });
-
-    after(function() {
-      writeHtmlSpy.restore();
-      sendRequestSpy.restore();
-      triggerPixelSpy.restore();
-    });
-
-    const env = {
-      isMobileApp: () => true,
-      isSafeFrame: () => false
-    };
-
-    it('should render mobile app creative', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-      let ucTagData = {
-        cacheHost: 'example.com',
-        cachePath: '/path',
-        uuid: '123',
-        size: '300x250'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        adm: 'ad-markup',
-        wurl: 'https://test.prebidcache.wurl'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.callCount).to.equal(1);
-      expect(sendRequestSpy.args[0][0]).to.equal('https://example.com/path?uuid=123');
-    });
-
-    it('should render mobile app creative with missing cache wurl', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-      let ucTagData = {
-        cacheHost: 'example.com',
-        cachePath: '/path',
-        uuid: '123',
-        size: '300x250'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        adm: 'ad-markup'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.callCount).to.equal(1);
-      expect(sendRequestSpy.args[0][0]).to.equal('https://example.com/path?uuid=123');
-    });
-
-    it('should render mobile app creative using default cacheHost and cachePath', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-      let ucTagData = {
-        uuid: '123',
-        size: '300x250'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        adm: 'ad-markup'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.callCount).to.equal(1);
-      expect(sendRequestSpy.args[0][0]).to.equal('https://prebid.adnxs.com/pbc/v1/cache?uuid=123');
-    });
-
-    // it('should catch errors from creative', function (done) {
-    //   window.addEventListener('error', e => {
-    //     done(e.error);
-    //   });
-
-    //   const consoleErrorSpy = sinon.spy(console, 'error');
-
-    //   const renderObject = newRenderingManager(mockWin, env);
-    //   let ucTagData = {
-    //     cacheHost: 'example.com',
-    //     cachePath: '/path',
-    //     uuid: '123',
-    //     size: '300x250'
-    //   };
-
-    //   renderObject.renderAd(mockWin.document, ucTagData);
-
-    //   let response = {
-    //     width: 300,
-    //     height: 250,
-    //     crid: 123,
-    //     adm: '<script src="notExistingScript.js"></script>'
-    //   };
-    //   requests[0].respond(200, {}, JSON.stringify(response));
-
-    //   setTimeout(()=>{
-    //     expect(consoleErrorSpy.callCount).to.equal(1);
-    //     done();
-    //   }, 10);
-    // });
-  });
-
-  describe('amp creative', function() {
-    let writeHtmlSpy;
-    let sendRequestSpy;
-    let triggerPixelSpy;
-    let mockWin;
-
-    before(function() {
-      writeHtmlSpy = sinon.spy(utils, 'writeAdHtml');
-      sendRequestSpy = sinon.spy(utils, 'sendRequest');
-      triggerPixelSpy = sinon.spy(utils, 'triggerPixel');
-      mockWin = merge(mocks.createFakeWindow('http://example.com'), renderingMocks().getWindowObject());
-    });
-
-    afterEach(function() {
-      writeHtmlSpy.resetHistory();
-      sendRequestSpy.resetHistory();
-      triggerPixelSpy.resetHistory();
-    });
-
-    after(function() {
-      writeHtmlSpy.restore();
-      sendRequestSpy.restore();
-      triggerPixelSpy.restore();
-    });
-
-    const env = {
-      isMobileApp: () => false,
-      isAmp: () => true,
-      isSafeFrame: () => true
-    };
-
-    it('should render amp creative', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-
-      let ucTagData = {
-        cacheHost: 'example.com',
-        cachePath: '/path',
-        uuid: '123',
-        size: '300x250',
-        hbPb: '10.00'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        adm: 'ad-markup${AUCTION_PRICE}',
-        wurl: 'https://test.prebidcache.wurl'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.args[0][0]).to.equal('<!--Creative 123 served by Prebid.js Header Bidding-->ad-markup10.00');
-      expect(sendRequestSpy.args[0][0]).to.equal('https://example.com/path?uuid=123');
-      expect(triggerPixelSpy.args[0][0]).to.equal('https://test.prebidcache.wurl');
-    });
-
-    it('should replace AUCTION_PRICE with response.price over hbPb', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-
-      let ucTagData = {
-        cacheHost: 'example.com',
-        cachePath: '/path',
-        uuid: '123',
-        size: '300x250',
-        hbPb: '10.00'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        price: 12.50,
-        adm: 'ad-markup${AUCTION_PRICE}',
-        wurl: 'https://test.prebidcache.wurl'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.args[0][0]).to.equal('<!--Creative 123 served by Prebid.js Header Bidding-->ad-markup12.5');
-      expect(sendRequestSpy.args[0][0]).to.equal('https://example.com/path?uuid=123');
-      expect(triggerPixelSpy.args[0][0]).to.equal('https://test.prebidcache.wurl');
-    });
-
-    it('should replace AUCTION_PRICE with with empty value when neither price nor hbPb exist', function() {
-      const renderObject = newRenderingManager(mockWin, env);
-
-      let ucTagData = {
-        cacheHost: 'example.com',
-        cachePath: '/path',
-        uuid: '123',
-        size: '300x250'
-      };
-
-      renderObject.renderAd(mockWin.document, ucTagData);
-
-      let response = {
-        width: 300,
-        height: 250,
-        crid: 123,
-        adm: 'ad-markup${AUCTION_PRICE}',
-        wurl: 'https://test.prebidcache.wurl'
-      };
-      requests[0].respond(200, {}, JSON.stringify(response));
-      expect(writeHtmlSpy.args[0][0]).to.equal('<!--Creative 123 served by Prebid.js Header Bidding-->ad-markup');
-      expect(sendRequestSpy.args[0][0]).to.equal('https://example.com/path?uuid=123');
-      expect(triggerPixelSpy.args[0][0]).to.equal('https://test.prebidcache.wurl');
-    });
-  });
-
   describe('cross domain creative', function() {
     const ORIGIN = 'http://example.com';
     let parseStub;
     let iframeStub;
     let triggerPixelSpy;
     let mockWin;
-    let env;
-    let renderObject;
     let ucTagData;
     let mockIframe;
     let eventSource;
@@ -329,22 +90,18 @@ describe('renderingManager', function() {
         host: 'example.com'
       });
       mockWin = merge(mocks.createFakeWindow(ORIGIN), renderingMocks().getWindowObject());
-      env = {
-        isMobileApp: () => false,
-        isAmp: () => false,
-        canLocatePrebid: () => false
-      };
-      renderObject = newRenderingManager(mockWin, env);
       ucTagData = {
         adId: '123',
         adServerDomain: 'mypub.com',
         pubUrl: ORIGIN,
       };
-      renderObject.renderAd(mockWin.document, ucTagData);
+      eventSource = null;
+
+      renderCrossDomain(mockWin, ucTagData.adId, ucTagData.adServerDomain, ucTagData.pubUrl);
 
     });
 
-    afterEach(function() {
+    afterEach(function () {
       parseStub.restore();
       iframeStub.restore();
       triggerPixelSpy.restore();
@@ -353,17 +110,17 @@ describe('renderingManager', function() {
     function mockPrebidResponse(msg)  {
       mockWin.postMessage({
         origin: ORIGIN,
-        message: JSON.stringify(Object.assign({message: 'Prebid Response'}, msg))
+        message: JSON.stringify(Object.assign({ message: 'Prebid Response' }, msg))
       });
     }
 
-    it('should render cross domain creative', function() {
+    it("should render cross domain creative", function () {
       mockPrebidResponse({
-        ad: 'ad',
+        ad: "ad",
         adUrl: ORIGIN,
-        adId: '123',
+        adId: "123",
         width: 300,
-        height: 250
+        height: 250,
       });
       expect(mockIframe.contentDocument.write.args[0][0]).to.equal("ad");
     });
@@ -390,13 +147,13 @@ describe('renderingManager', function() {
             info: {
               reason: 'preventWritingOnMainDocument'
             }
-          })
+          });
         });
 
         it('on ads that have no markup or adUrl', () => {
           mockPrebidResponse({
             adId: '123',
-          })
+          });
           expectEventMessage({
             adId: '123',
             event: RENDER_FAILED,
@@ -408,7 +165,7 @@ describe('renderingManager', function() {
 
         it('on exceptions', () => {
           iframeStub.callsFake(() => {
-            throw new Error()
+            throw new Error();
           });
           mockPrebidResponse({
             adId: '123',
@@ -422,7 +179,7 @@ describe('renderingManager', function() {
               reason: 'exception'
             }
           });
-        })
+        });
       });
       describe('should post AD_RENDER_SUCCEEDED', () => {
         it('on ad with markup', () => {
@@ -452,18 +209,12 @@ describe('renderingManager', function() {
   describe('legacy creative', function() {
     it('should render legacy creative', function() {
       const mockWin = merge(mocks.createFakeWindow('http://example.com'), renderingMocks().getWindowObject());
-      const env = {
-        isMobileApp: () => false,
-        isAmp: () => false,
-        canLocatePrebid: () => true
-      };
-      const renderObject = newRenderingManager(mockWin, env);
-
       let ucTagData = {
         adId: '123'
       };
+      window.parent = mockWin;
 
-      renderObject.renderAd(mockWin.document, ucTagData);
+      renderLegacy(mockWin.document, ucTagData.adId);
       expect(mockWin.parent.$$PREBID_GLOBAL$$.renderAd.callCount).to.equal(1);
     });
   });

package/webpack.conf.js

@@ -1,6 +1,7 @@
 var creative = require('./package.json');
 var StringReplacePlugin = require('string-replace-webpack-plugin');
 var path = require('path');
+const ShakePlugin = require('webpack-common-shake').Plugin;
 
 module.exports = {
   devtool: 'source-map',
@@ -42,5 +43,6 @@ module.exports = {
         })
       }
     ]
-  }
+  },
+  plugins: [new ShakePlugin()],
 };