prebid.js 6.5.0 → 6.9.0

package/test/spec/modules/welectBidAdapter_spec.js

@@ -0,0 +1,211 @@
+import { expect } from 'chai';
+import { spec as adapter } from 'modules/welectBidAdapter.js';
+
+describe('WelectAdapter', function () {
+  describe('Check methods existance', function () {
+    it('exists and is a function', function () {
+      expect(adapter.isBidRequestValid).to.exist.and.to.be.a('function');
+    });
+    it('exists and is a function', function () {
+      expect(adapter.buildRequests).to.exist.and.to.be.a('function');
+    });
+    it('exists and is a function', function () {
+      expect(adapter.interpretResponse).to.exist.and.to.be.a('function');
+    });
+  });
+
+  describe('Check method isBidRequestValid return', function () {
+    let bid = {
+      bidder: 'welect',
+      params: {
+        placementId: 'exampleAlias',
+        domain: 'www.welect.de'
+      },
+      sizes: [[640, 360]],
+      mediaTypes: {
+        video: {
+          context: 'instream'
+        }
+      },
+    };
+    let bid2 = {
+      bidder: 'welect',
+      params: {
+        domain: 'www.welect.de'
+      },
+      mediaTypes: {
+        video: {
+          context: 'instream',
+          playerSize: [640, 360]
+        }
+      },
+    };
+
+    it('should be true', function () {
+      expect(adapter.isBidRequestValid(bid)).to.be.true;
+    });
+
+    it('should be false because the placementId is missing', function () {
+      expect(adapter.isBidRequestValid(bid2)).to.be.false;
+    });
+  });
+
+  describe('Check buildRequests method', function () {
+    // Bids to be formatted
+    let bid1 = {
+      bidder: 'welect',
+      params: {
+        placementId: 'exampleAlias'
+      },
+      sizes: [[640, 360]],
+      mediaTypes: {
+        video: {
+          context: 'instream'
+        }
+      },
+      bidId: 'abdc'
+    };
+    let bid2 = {
+      bidder: 'welect',
+      params: {
+        placementId: 'exampleAlias',
+        domain: 'www.welect2.de'
+      },
+      sizes: [[640, 360]],
+      mediaTypes: {
+        video: {
+          context: 'instream'
+        }
+      },
+      bidId: 'abdc',
+      gdprConsent: {
+        gdprApplies: 1,
+        gdprConsent: 'some_string'
+      }
+    };
+
+    let data1 = {
+      bid_id: 'abdc',
+      width: 640,
+      height: 360
+    }
+
+    let data2 = {
+      bid_id: 'abdc',
+      width: 640,
+      height: 360,
+      gdpr_consent: {
+        gdprApplies: 1,
+        tcString: 'some_string'
+      }
+    }
+
+    // Formatted requets
+    let request1 = {
+      method: 'POST',
+      url: 'https://www.welect.de/api/v2/preflight/exampleAlias',
+      data: data1,
+      options: {
+        contentType: 'application/json',
+        withCredentials: false,
+        crossOrigin: true,
+      }
+    };
+
+    let request2 = {
+      method: 'POST',
+      url: 'https://www.welect2.de/api/v2/preflight/exampleAlias',
+      data: data2,
+      options: {
+        contentType: 'application/json',
+        withCredentials: false,
+        crossOrigin: true,
+      }
+    }
+
+    it('defaults to www.welect.de, without gdpr object', function () {
+      expect(adapter.buildRequests([bid1])).to.deep.equal([request1]);
+    })
+
+    it('must return the right formatted requests, with gdpr object', function () {
+      expect(adapter.buildRequests([bid2])).to.deep.equal([request2]);
+    });
+  });
+
+  describe('Check interpretResponse method return', function () {
+    // invalid server response
+    let unavailableResponse = {
+      body: {
+        available: false
+      }
+    };
+
+    let availableResponse = {
+      body: {
+        available: true,
+        bidResponse: {
+          ad: {
+            video: 'some vast url'
+          },
+          meta: {
+            advertiserDomains: [],
+          },
+          cpm: 17,
+          creativeId: 'svmpreview',
+          currency: 'EUR',
+          netRevenue: true,
+          requestId: 'some bid id',
+          ttl: 120,
+          vastUrl: 'some vast url',
+          height: 640,
+          width: 320
+        }
+      }
+    }
+    // bid Request
+    let bid = {
+      data: {
+        bid_id: 'some bid id',
+        width: 640,
+        height: 320,
+        gdpr_consent: {
+          gdprApplies: 1,
+          tcString: 'some_string'
+        }
+      },
+      method: 'POST',
+      url: 'https://www.welect.de/api/v2/preflight/exampleAlias',
+      options: {
+        contentType: 'application/json',
+        withCredentials: false,
+        crossOrigin: true,
+      }
+    };
+    // Formatted reponse
+    let result = {
+      ad: {
+        video: 'some vast url'
+      },
+      meta: {
+        advertiserDomains: []
+      },
+      cpm: 17,
+      creativeId: 'svmpreview',
+      currency: 'EUR',
+      height: 640,
+      netRevenue: true,
+      requestId: 'some bid id',
+      ttl: 120,
+      vastUrl: 'some vast url',
+      width: 320
+    }
+
+    it('if response reflects unavailability, should be empty', function () {
+      expect(adapter.interpretResponse(unavailableResponse, bid)).to.deep.equal([]);
+    });
+
+    it('if response reflects availability, should equal result', function () {
+      expect(adapter.interpretResponse(availableResponse, bid)).to.deep.equal([result])
+    })
+  });
+});

package/test/spec/modules/yahoosspBidAdapter_spec.js

@@ -177,6 +177,16 @@ describe('YahooSSP Bid Adapter:', () => {
     expect(obj).to.be.an('object');
   });
 
+  describe('Validate basic properties', () => {
+    it('should define the correct bidder code', () => {
+      expect(spec.code).to.equal('yahoossp')
+    });
+
+    it('should define the correct vendor ID', () => {
+      expect(spec.gvlid).to.equal(25)
+    });
+  });
+
   describe('getUserSyncs()', () => {
     const IMAGE_PIXEL_URL = 'http://image-pixel.com/foo/bar?1234&baz=true';
     const IFRAME_ONE_URL = 'http://image-iframe.com/foo/bar?1234&baz=true';

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

@@ -16,6 +16,7 @@ import * as auctionModule from 'src/auction.js';
 import { registerBidder } from 'src/adapters/bidderFactory.js';
 import { _sendAdToCreative } from 'src/secureCreatives.js';
 import find from 'core-js-pure/features/array/find.js';
+import {synchronizePromise} from '../../helpers/syncPromise.js';
 
 var assert = require('chai').assert;
 var expect = require('chai').expect;
@@ -190,13 +191,16 @@ window.apntag = {
 }
 
 describe('Unit: Prebid Module', function () {
-  let bidExpiryStub;
+  let bidExpiryStub, promiseSandbox;
   beforeEach(function () {
+    promiseSandbox = sinon.createSandbox();
+    synchronizePromise(promiseSandbox);
     bidExpiryStub = sinon.stub(filters, 'isBidNotExpired').callsFake(() => true);
     configObj.setConfig({ useBidCache: true });
   });
 
   afterEach(function() {
+    promiseSandbox.restore();
     $$PREBID_GLOBAL$$.adUnits = [];
     bidExpiryStub.restore();
     configObj.setConfig({ useBidCache: false });
@@ -1002,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);
@@ -1135,13 +1134,15 @@ describe('Unit: Prebid Module', function () {
             height: 0
           }
         },
-        getElementsByTagName: sinon.stub()
+        getElementsByTagName: sinon.stub(),
+        querySelector: sinon.stub()
       };
 
       elStub = {
         insertBefore: sinon.stub()
       };
       doc.getElementsByTagName.returns([elStub]);
+      doc.querySelector.returns(elStub);
 
       spyLogError = sinon.spy(utils, 'logError');
       spyLogMessage = sinon.spy(utils, 'logMessage');
@@ -1852,11 +1853,23 @@ describe('Unit: Prebid Module', function () {
                   pos: 2
                 }
               }
+            },
+            {
+              code: 'test6',
+              bids: [],
+              sizes: [300, 250],
+              mediaTypes: {
+                banner: {
+                  sizes: [300, 250],
+                  pos: 0
+                }
+              }
             }];
             $$PREBID_GLOBAL$$.requestBids({
               adUnits: adUnit
             });
             expect(auctionArgs.adUnits[0].mediaTypes.banner.pos).to.equal(2);
+            expect(auctionArgs.adUnits[1].mediaTypes.banner.pos).to.equal(0);
           });
         });
 

package/test/spec/unit/secureCreatives_spec.js

@@ -1,6 +1,7 @@
 import {
-  _sendAdToCreative, receiveMessage
+  _sendAdToCreative, getReplier, receiveMessage
 } from 'src/secureCreatives.js';
+import * as secureCreatives from 'src/secureCreatives.js';
 import * as utils from 'src/utils.js';
 import {getAdUnits, getBidRequests, getBidResponses} from 'test/fixtures/fixtures.js';
 import {auctionManager} from 'src/auctionManager.js';
@@ -9,12 +10,51 @@ import * as native from 'src/native.js';
 import {fireNativeTrackers, getAllAssetsMessage} from 'src/native.js';
 import events from 'src/events.js';
 import { config as configObj } from 'src/config.js';
+import 'src/prebid.js';
 
 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');
@@ -40,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;
     });
@@ -141,9 +177,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
-          data: JSON.stringify(data)
-        };
+        const ev = makeEvent({
+          data: JSON.stringify(data),
+        });
 
         receiveMessage(ev);
 
@@ -168,9 +204,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -209,9 +245,9 @@ describe('secureCreatives', () => {
           message: 'Prebid Request'
         };
 
-        const ev = {
+        const ev = makeEvent({
           data: JSON.stringify(data)
-        };
+        });
 
         receiveMessage(ev);
 
@@ -237,6 +273,38 @@ describe('secureCreatives', () => {
 
         configObj.setConfig({'auctionOptions': {}});
       });
+
+      it('should emit AD_RENDER_FAILED if requested missing adId', () => {
+        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,
+          adId: 'missing'
+        }));
+      });
+
+      it('should emit AD_RENDER_FAILED if creative can\'t be sent to rendering frame', () => {
+        pushBidResponseToAuction({});
+        const ev = makeEvent({
+          source: {
+            postMessage: sinon.stub().callsFake(() => { throw new Error(); })
+          },
+          data: JSON.stringify({
+            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,
+          adId: bidId
+        }));
+      });
     });
 
     describe('Prebid Native', function() {
@@ -249,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);
 
@@ -278,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);
 
@@ -322,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);
 
@@ -366,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);
 
@@ -395,5 +463,56 @@ describe('secureCreatives', () => {
         expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
       });
     });
+
+    describe('Prebid Event', () => {
+      Object.entries({
+        'unrendered': [false, (bid) => { delete bid.status; }],
+        'rendered': [true, (bid) => { bid.status = CONSTANTS.BID_STATUS.RENDERED }]
+      }).forEach(([test, [shouldEmit, prepBid]]) => {
+        describe(`for ${test} bids`, () => {
+          beforeEach(() => {
+            prepBid(adResponse);
+            pushBidResponseToAuction(adResponse);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_FAILED`, () => {
+            const event = makeEvent({
+              data: JSON.stringify({
+                message: 'Prebid Event',
+                event: CONSTANTS.EVENTS.AD_RENDER_FAILED,
+                adId: bidId,
+                info: {
+                  reason: 'Fail reason',
+                  message: 'Fail message',
+                },
+              })
+            });
+            receiveMessage(event);
+            expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_FAILED, {
+              adId: bidId,
+              bid: adResponse,
+              reason: 'Fail reason',
+              message: 'Fail message'
+            })).to.equal(shouldEmit);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_SUCCEEDED`, () => {
+            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,
+              bid: adResponse,
+              doc: null
+            })).to.equal(shouldEmit);
+          });
+        });
+      });
+    });
   });
 });