prebid.js 6.8.0 → 6.9.0

package/test/spec/unit/core/bidderSettings_spec.js

@@ -0,0 +1,123 @@
+import {bidderSettings, ScopedSettings} from '../../../../src/bidderSettings.js';
+import {expect} from 'chai';
+import * as prebidGlobal from '../../../../src/prebidGlobal';
+import sinon from 'sinon';
+
+describe('ScopedSettings', () => {
+  let data;
+  let settings;
+
+  beforeEach(() => {
+    settings = new ScopedSettings(() => data, 'fallback');
+  });
+
+  describe('get', () => {
+    it('should retrieve setting from scope', () => {
+      data = {
+        scope: {key: 'value'}
+      };
+      expect(settings.get('scope', 'key')).to.equal('value');
+    });
+
+    it('should fallback to fallback scope', () => {
+      data = {
+        fallback: {
+          key: 'value'
+        }
+      };
+      expect(settings.get('scope', 'key')).to.equal('value');
+    });
+
+    it('should retrieve from default scope if scope is null', () => {
+      data = {
+        fallback: {
+          key: 'value'
+        }
+      };
+
+      expect(settings.get(null, 'key')).to.equal('value');
+    });
+
+    it('should not fall back if own setting has a falsy value', () => {
+      data = {
+        scope: {
+          key: false,
+        },
+        fallback: {
+          key: true
+        }
+      }
+      expect(settings.get('scope', 'key')).to.equal(false);
+    })
+  });
+
+  describe('getOwn', () => {
+    it('should not fall back to default scope', () => {
+      data = {
+        fallback: {
+          key: 'value'
+        }
+      };
+      expect(settings.getOwn('missing', 'key')).to.be.undefined;
+    });
+
+    it('should use default if scope is null', () => {
+      data = {
+        fallback: {
+          key: 'value'
+        }
+      };
+      expect(settings.getOwn(null, 'key')).to.equal('value');
+    });
+  });
+
+  describe('getScopes', () => {
+    it('should return all top-level keys except the default scope', () => {
+      data = {
+        fallback: {},
+        scope1: {},
+        scope2: {},
+      };
+      expect(settings.getScopes()).to.have.members(['scope1', 'scope2']);
+    });
+  });
+
+  describe('settingsFor', () => {
+    it('should merge with default scope', () => {
+      data = {
+        fallback: {
+          dkey: 'value'
+        },
+        scope: {
+          skey: 'value'
+        }
+      }
+      expect(settings.settingsFor('scope')).to.eql({
+        dkey: 'value',
+        skey: 'value'
+      })
+    })
+  });
+});
+
+describe('bidderSettings', () => {
+  let sandbox;
+  beforeEach(() => {
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(prebidGlobal, 'getGlobal').returns({
+      bidderSettings: {
+        scope: {
+          key: 'value'
+        }
+      }
+    });
+  })
+
+  afterEach(() => {
+    sandbox.restore();
+  })
+
+  it('should fetch data from getGlobal().bidderSettings', () => {
+    expect(bidderSettings.get('scope', 'key')).to.equal('value');
+  })
+});

package/test/spec/unit/pbjs_api_spec.js

@@ -1006,12 +1006,7 @@ describe('Unit: Prebid Module', function () {
         adUnitCode: config.adUnitCodes[0],
       };
 
-      const event = {
-        source: { postMessage: sinon.stub() },
-        origin: 'origin.sf.com'
-      };
-
-      _sendAdToCreative(mockAdObject, event);
+      _sendAdToCreative(mockAdObject, sinon.stub());
 
       expect(slots[0].spyGetSlotElementId.called).to.equal(false);
       expect(slots[1].spyGetSlotElementId.called).to.equal(true);

package/test/spec/unit/secureCreatives_spec.js

@@ -1,5 +1,5 @@
 import {
-  _sendAdToCreative, receiveMessage
+  _sendAdToCreative, getReplier, receiveMessage
 } from 'src/secureCreatives.js';
 import * as secureCreatives from 'src/secureCreatives.js';
 import * as utils from 'src/utils.js';
@@ -17,6 +17,44 @@ import { expect } from 'chai';
 var CONSTANTS = require('src/constants.json');
 
 describe('secureCreatives', () => {
+  function makeEvent(ev) {
+    return Object.assign({origin: 'mock-origin', ports: []}, ev)
+  }
+
+  describe('getReplier', () => {
+    it('should use source.postMessage if no MessagePort is available', () => {
+      const ev = {
+        ports: [],
+        source: {
+          postMessage: sinon.spy()
+        },
+        origin: 'mock-origin'
+      };
+      getReplier(ev)('test');
+      sinon.assert.calledWith(ev.source.postMessage, JSON.stringify('test'));
+    });
+
+    it('should use MesagePort.postMessage if available', () => {
+      const ev = {
+        ports: [{
+          postMessage: sinon.spy()
+        }]
+      }
+      getReplier(ev)('test');
+      sinon.assert.calledWith(ev.ports[0].postMessage, JSON.stringify('test'));
+    });
+
+    it('should throw if origin is null and no MessagePort is available', () => {
+      const ev = {
+        origin: null,
+        ports: [],
+        postMessage: sinon.spy()
+      }
+      const reply = getReplier(ev);
+      expect(() => reply('test')).to.throw();
+    });
+  });
+
   describe('_sendAdToCreative', () => {
     beforeEach(function () {
       sinon.stub(utils, 'logError');
@@ -42,14 +80,10 @@ describe('secureCreatives', () => {
         cpm: '1.00',
         adUnitCode: 'some_dom_id'
       };
-      const event = {
-        source: { postMessage: sinon.stub() },
-        origin: 'origin.sf.com'
-      };
-
-      _sendAdToCreative(mockAdObject, event);
-      expect(JSON.parse(event.source.postMessage.args[0][0]).ad).to.equal('<script src="http://prebid.org/creative/1.00"></script>');
-      expect(JSON.parse(event.source.postMessage.args[0][0]).adUrl).to.equal('http://creative.prebid.org/1.00');
+      const reply = sinon.spy();
+      _sendAdToCreative(mockAdObject, reply);
+      expect(reply.args[0][0].ad).to.equal('<script src="http://prebid.org/creative/1.00"></script>');
+      expect(reply.args[0][0].adUrl).to.equal('http://creative.prebid.org/1.00');
       window.googletag = oldVal;
       window.apntag = oldapntag;
     });
@@ -143,9 +177,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
-          data: JSON.stringify(data)
-        };
+        const ev = makeEvent({
+          data: JSON.stringify(data),
+        });
 
         receiveMessage(ev);
 
@@ -170,9 +204,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -211,9 +245,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -241,12 +275,12 @@ describe('secureCreatives', () => {
       });
 
       it('should emit AD_RENDER_FAILED if requested missing adId', () => {
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify({
             message: 'Prebid Request',
             adId: 'missing'
           })
-        };
+        });
         receiveMessage(ev);
         sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
           reason: CONSTANTS.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
@@ -256,7 +290,7 @@ describe('secureCreatives', () => {
 
       it('should emit AD_RENDER_FAILED if creative can\'t be sent to rendering frame', () => {
         pushBidResponseToAuction({});
-        const ev = {
+        const ev = makeEvent({
           source: {
             postMessage: sinon.stub().callsFake(() => { throw new Error(); })
           },
@@ -264,7 +298,7 @@ describe('secureCreatives', () => {
             message: 'Prebid Request',
             adId: bidId
           })
-        }
+        });
         receiveMessage(ev)
         sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
           reason: CONSTANTS.AD_RENDER_FAILED_REASON.EXCEPTION,
@@ -283,13 +317,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -312,13 +346,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -356,13 +390,13 @@ describe('secureCreatives', () => {
           action: 'allAssetRequest'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -400,13 +434,13 @@ describe('secureCreatives', () => {
           action: 'click',
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data),
           source: {
             postMessage: sinon.stub()
           },
           origin: 'any origin'
-        };
+        });
 
         receiveMessage(ev);
 
@@ -442,7 +476,7 @@ describe('secureCreatives', () => {
           });
 
           it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_FAILED`, () => {
-            const event = {
+            const event = makeEvent({
               data: JSON.stringify({
                 message: 'Prebid Event',
                 event: CONSTANTS.EVENTS.AD_RENDER_FAILED,
@@ -452,7 +486,7 @@ describe('secureCreatives', () => {
                   message: 'Fail message',
                 },
               })
-            };
+            });
             receiveMessage(event);
             expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_FAILED, {
               adId: bidId,
@@ -463,13 +497,13 @@ describe('secureCreatives', () => {
           });
 
           it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_SUCCEEDED`, () => {
-            const event = {
+            const event = makeEvent({
               data: JSON.stringify({
                 message: 'Prebid Event',
                 event: CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED,
                 adId: bidId,
               })
-            };
+            });
             receiveMessage(event);
             expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, {
               adId: bidId,