prebid.js 6.2.0 → 6.3.0

package/src/prebid.js

@@ -47,8 +47,7 @@ $$PREBID_GLOBAL$$.libLoaded = true;
 $$PREBID_GLOBAL$$.version = 'v$prebid.version$';
 logInfo('Prebid.js v$prebid.version$ loaded');
 
-// modules list generated from build
-$$PREBID_GLOBAL$$.installedModules = ['v$prebid.modulesList$'];
+$$PREBID_GLOBAL$$.installedModules = $$PREBID_GLOBAL$$.installedModules || [];
 
 // create adUnit array
 $$PREBID_GLOBAL$$.adUnits = $$PREBID_GLOBAL$$.adUnits || [];

package/src/targeting.js

@@ -18,6 +18,10 @@ var pbTargetingKeys = [];
 const MAX_DFP_KEYLENGTH = 20;
 const TTL_BUFFER = 1000;
 
+const CFG_ALLOW_TARGETING_KEYS = `targetingControls.allowTargetingKeys`;
+const CFG_ADD_TARGETING_KEYS = `targetingControls.addTargetingKeys`;
+const TARGETING_KEY_CONFIGURATION_ERROR_MSG = `Only one of "${CFG_ALLOW_TARGETING_KEYS}" or "${CFG_ADD_TARGETING_KEYS}" can be set`;
+
 export const TARGETING_KEYS = Object.keys(CONSTANTS.TARGETING_KEYS).map(
   key => CONSTANTS.TARGETING_KEYS[key]
 );
@@ -261,7 +265,17 @@ export function newTargeting(auctionManager) {
     });
 
     const defaultKeys = Object.keys(Object.assign({}, CONSTANTS.DEFAULT_TARGETING_KEYS, CONSTANTS.NATIVE_KEYS));
-    const allowedKeys = config.getConfig('targetingControls.allowTargetingKeys') || defaultKeys;
+    let allowedKeys = config.getConfig(CFG_ALLOW_TARGETING_KEYS);
+    const addedKeys = config.getConfig(CFG_ADD_TARGETING_KEYS);
+
+    if (addedKeys != null && allowedKeys != null) {
+      throw new Error(TARGETING_KEY_CONFIGURATION_ERROR_MSG);
+    } else if (addedKeys != null) {
+      allowedKeys = defaultKeys.concat(addedKeys);
+    } else {
+      allowedKeys = allowedKeys || defaultKeys;
+    }
+
     if (Array.isArray(allowedKeys) && allowedKeys.length > 0) {
       targeting = getAllowedTargetingKeyValues(targeting, allowedKeys);
     }
@@ -284,6 +298,13 @@ export function newTargeting(auctionManager) {
     return targeting;
   };
 
+  // warn about conflicting configuration
+  config.getConfig('targetingControls', function (config) {
+    if (deepAccess(config, CFG_ALLOW_TARGETING_KEYS) != null && deepAccess(config, CFG_ADD_TARGETING_KEYS) != null) {
+      logError(TARGETING_KEY_CONFIGURATION_ERROR_MSG);
+    }
+  });
+
   // create an encoded string variant based on the keypairs of the provided object
   //  - note this will encode the characters between the keys (ie = and &)
   function convertKeysToQueryForm(keyMap) {

package/src/utils.js

@@ -482,16 +482,43 @@ export function insertElement(elm, doc, target, asLastChildChild) {
   } catch (e) {}
 }
 
+/**
+ * Returns a promise that completes when the given element triggers a 'load' or 'error' DOM event, or when
+ * `timeout` milliseconds have elapsed.
+ *
+ * @param {HTMLElement} element
+ * @param {Number} [timeout]
+ * @returns {Promise}
+ */
+export function waitForElementToLoad(element, timeout) {
+  let timer = null;
+  return new Promise((resolve) => {
+    const onLoad = function() {
+      element.removeEventListener('load', onLoad);
+      element.removeEventListener('error', onLoad);
+      if (timer != null) {
+        window.clearTimeout(timer);
+      }
+      resolve();
+    };
+    element.addEventListener('load', onLoad);
+    element.addEventListener('error', onLoad);
+    if (timeout != null) {
+      timer = window.setTimeout(onLoad, timeout);
+    }
+  });
+}
+
 /**
  * Inserts an image pixel with the specified `url` for cookie sync
  * @param {string} url URL string of the image pixel to load
  * @param  {function} [done] an optional exit callback, used when this usersync pixel is added during an async process
+ * @param  {Number} [timeout] an optional timeout in milliseconds for the image to load before calling `done`
  */
-export function triggerPixel(url, done) {
+export function triggerPixel(url, done, timeout) {
   const img = new Image();
   if (done && internal.isFn(done)) {
-    img.addEventListener('load', done);
-    img.addEventListener('error', done);
+    waitForElementToLoad(img, timeout).then(done);
   }
   img.src = url;
 }
@@ -539,18 +566,18 @@ export function insertHtmlIntoIframe(htmlCode) {
  * @param  {string} url URL to be requested
  * @param  {string} encodeUri boolean if URL should be encoded before inserted. Defaults to true
  * @param  {function} [done] an optional exit callback, used when this usersync pixel is added during an async process
+ * @param  {Number} [timeout] an optional timeout in milliseconds for the iframe to load before calling `done`
  */
-export function insertUserSyncIframe(url, done) {
+export function insertUserSyncIframe(url, done, timeout) {
   let iframeHtml = internal.createTrackPixelIframeHtml(url, false, 'allow-scripts allow-same-origin');
   let div = document.createElement('div');
   div.innerHTML = iframeHtml;
   let iframe = div.firstChild;
   if (done && internal.isFn(done)) {
-    iframe.addEventListener('load', done);
-    iframe.addEventListener('error', done);
+    waitForElementToLoad(iframe, timeout).then(done);
   }
   internal.insertElement(iframe, document, 'html', true);
-};
+}
 
 /**
  * Creates a snippet of HTML that retrieves the specified `url`

package/test/spec/modules/33acrossBidAdapter_spec.js

@@ -16,20 +16,21 @@ function validateBuiltServerRequest(builtReq, expectedReq) {
 describe('33acrossBidAdapter:', function () {
   const BIDDER_CODE = '33across';
   const SITE_ID = 'sample33xGUID123456789';
-  const PRODUCT_ID = 'siab';
   const END_POINT = 'https://ssc.33across.com/api/v1/hb';
 
   let element, win;
   let bidRequests;
   let sandbox;
 
-  function TtxRequestBuilder() {
+  function TtxRequestBuilder(siteId = SITE_ID) {
     const ttxRequest = {
-      imp: [{}],
+      imp: [{
+        id: 'b1'
+      }],
       site: {
-        id: SITE_ID
+        id: siteId
       },
-      id: 'b1',
+      id: 'r1',
       regs: {
         ext: {
           gdpr: 0
@@ -46,66 +47,83 @@ describe('33acrossBidAdapter:', function () {
       }
     };
 
+    this.addImp = (id = 'b2') => {
+      ttxRequest.imp.push({ id });
+
+      return this;
+    }
+
     this.withBanner = () => {
-      Object.assign(ttxRequest.imp[0], {
-        banner: {
-          format: [
-            {
-              w: 300,
-              h: 250
-            },
-            {
-              w: 728,
-              h: 90
-            }
-          ],
-          ext: {
-            ttx: {
-              viewability: {
-                amount: 100
+      ttxRequest.imp.forEach((imp) => {
+        Object.assign(imp, {
+          banner: {
+            format: [
+              {
+                w: 300,
+                h: 250
+              },
+              {
+                w: 728,
+                h: 90
+              }
+            ],
+            ext: {
+              ttx: {
+                viewability: {
+                  amount: 100
+                }
               }
             }
           }
-        }
+        });
       });
-
       return this;
     };
 
     this.withBannerSizes = this.withSizes = sizes => {
-      Object.assign(ttxRequest.imp[0].banner, { format: sizes });
+      ttxRequest.imp.forEach((imp) => {
+        Object.assign(imp.banner, { format: sizes });
+      });
+
       return this;
     };
 
     this.withVideo = (params = {}) => {
-      Object.assign(ttxRequest.imp[0], {
-        video: {
-          w: 300,
-          h: 250,
-          placement: 2,
-          ...params
-        }
+      ttxRequest.imp.forEach((imp) => {
+        Object.assign(imp, {
+          video: {
+            w: 300,
+            h: 250,
+            placement: 2,
+            ...params
+          }
+        });
       });
 
       return this;
     };
 
     this.withViewability = (viewability, format = 'banner') => {
-      Object.assign(ttxRequest.imp[0][format], {
-        ext: {
-          ttx: { viewability }
-        }
+      ttxRequest.imp.forEach((imp) => {
+        Object.assign(imp[format], {
+          ext: {
+            ttx: { viewability }
+          }
+        });
       });
+
       return this;
     };
 
-    this.withProduct = (prod = PRODUCT_ID) => {
-      Object.assign(ttxRequest.imp[0], {
-        ext: {
-          ttx: {
-            prod
+    this.withProduct = (prod = 'siab') => {
+      ttxRequest.imp.forEach((imp) => {
+        Object.assign(imp, {
+          ext: {
+            ttx: {
+              prod
+            }
           }
-        }
+        });
       });
 
       return this;
@@ -249,7 +267,7 @@ describe('33acrossBidAdapter:', function () {
         bidderRequestId: 'b1a',
         params: {
           siteId: SITE_ID,
-          productId: PRODUCT_ID
+          productId: 'siab'
         },
         adUnitCode: 'div-id',
         auctionId: 'r1',
@@ -258,35 +276,61 @@ describe('33acrossBidAdapter:', function () {
       }
     ];
 
+    this.addBid = (bidParams = {}) => {
+      bidRequests.push({
+        bidId: 'b2',
+        bidder: '33across',
+        bidderRequestId: 'b1b',
+        params: {
+          siteId: SITE_ID,
+          productId: 'siab'
+        },
+        adUnitCode: 'div-id',
+        auctionId: 'r1',
+        mediaTypes: {},
+        transactionId: 't2',
+        ...bidParams
+      });
+
+      return this;
+    };
+
     this.withBanner = () => {
-      bidRequests[0].mediaTypes.banner = {
-        sizes: [
-          [300, 250],
-          [728, 90]
-        ]
-      };
+      bidRequests.forEach((bid) => {
+        bid.mediaTypes.banner = {
+          sizes: [
+            [300, 250],
+            [728, 90]
+          ]
+        };
+      });
 
       return this;
     };
 
     this.withProduct = (prod) => {
-      bidRequests[0].params.productId = prod;
-
+      bidRequests.forEach((bid) => {
+        bid.params.productId = prod;
+      });
       return this;
     };
 
     this.withVideo = (params) => {
-      bidRequests[0].mediaTypes.video = {
-        playerSize: [[300, 250]],
-        context: 'outstream',
-        ...params
-      };
+      bidRequests.forEach((bid) => {
+        bid.mediaTypes.video = {
+          playerSize: [[300, 250]],
+          context: 'outstream',
+          ...params
+        };
+      });
 
       return this;
     }
 
     this.withUserIds = (eids) => {
-      bidRequests[0].userIdAsEids = eids;
+      bidRequests.forEach((bid) => {
+        bid.userIdAsEids = eids;
+      });
 
       return this;
     };
@@ -315,6 +359,7 @@ describe('33acrossBidAdapter:', function () {
       }
     };
     win = {
+      parent: null,
       document: {
         visibilityState: 'visible'
       },
@@ -331,7 +376,7 @@ describe('33acrossBidAdapter:', function () {
 
     sandbox = sinon.sandbox.create();
     sandbox.stub(Date, 'now').returns(1);
-    sandbox.stub(document, 'getElementById').withArgs('div-id').returns(element);
+    sandbox.stub(document, 'getElementById').returns(element);
     sandbox.stub(utils, 'getWindowTop').returns(win);
     sandbox.stub(utils, 'getWindowSelf').returns(win);
   });
@@ -1376,10 +1421,146 @@ describe('33acrossBidAdapter:', function () {
         });
       });
     });
+
+    context('when SRA mode is enabled', function() {
+      it('builds a single request with multiple imps corresponding to each group {siteId, productId}', function() {
+        sandbox.stub(config, 'getConfig').callsFake(() => {
+          return {
+            enableSRAMode: true
+          }
+        });
+
+        const bidRequests = new BidRequestsBuilder()
+          .addBid()
+          .addBid({
+            bidId: 'b3',
+            adUnitCode: 'div-id',
+            params: {
+              siteId: 'sample33xGUID123456780',
+              productId: 'siab'
+            }
+          })
+          .addBid({
+            bidId: 'b4',
+            adUnitCode: 'div-id',
+            params: {
+              siteId: 'sample33xGUID123456780',
+              productId: 'inview'
+            }
+          })
+          .withBanner()
+          .withVideo({context: 'outstream'})
+          .build();
+
+        const req1 = new TtxRequestBuilder()
+          .addImp()
+          .withProduct('siab')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        const req2 = new TtxRequestBuilder('sample33xGUID123456780')
+          .withProduct('siab')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        req2.imp[0].id = 'b3';
+
+        const req3 = new TtxRequestBuilder('sample33xGUID123456780')
+          .withProduct('inview')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        req3.imp[0].id = 'b4';
+
+        const serverReq1 = new ServerRequestBuilder()
+          .withData(req1)
+          .build();
+
+        const serverReq2 = new ServerRequestBuilder()
+          .withData(req2)
+          .withUrl('https://ssc.33across.com/api/v1/hb?guid=sample33xGUID123456780')
+          .build();
+
+        const serverReq3 = new ServerRequestBuilder()
+          .withData(req3)
+          .withUrl('https://ssc.33across.com/api/v1/hb?guid=sample33xGUID123456780')
+          .build();
+
+        const builtServerRequests = spec.buildRequests(bidRequests, {});
+
+        expect(builtServerRequests).to.deep.equal([serverReq1, serverReq2, serverReq3]);
+      });
+    });
+
+    context('when SRA mode is not enabled', function() {
+      it('builds multiple requests, one corresponding to each Ad Unit', function() {
+        const bidRequests = new BidRequestsBuilder()
+          .addBid()
+          .addBid({
+            bidId: 'b3',
+            adUnitCode: 'div-id',
+            params: {
+              siteId: 'sample33xGUID123456780',
+              productId: 'siab'
+            }
+          })
+          .withBanner()
+          .withVideo({context: 'outstream'})
+          .build();
+
+        const req1 = new TtxRequestBuilder()
+          .withProduct('siab')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        const req2 = new TtxRequestBuilder()
+          .withProduct('siab')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        req2.imp[0].id = 'b2';
+
+        const req3 = new TtxRequestBuilder('sample33xGUID123456780')
+          .withProduct('siab')
+          .withBanner()
+          .withVideo()
+          .build();
+
+        req3.imp[0].id = 'b3';
+
+        const serverReq1 = new ServerRequestBuilder()
+          .withData(req1)
+          .build();
+
+        const serverReq2 = new ServerRequestBuilder()
+          .withData(req2)
+          .build();
+
+        const serverReq3 = new ServerRequestBuilder()
+          .withData(req3)
+          .withUrl('https://ssc.33across.com/api/v1/hb?guid=sample33xGUID123456780')
+          .build();
+
+        const builtServerRequests = spec.buildRequests(bidRequests, {});
+
+        expect(builtServerRequests)
+          .to.deep.equal([
+            serverReq1,
+            serverReq2,
+            serverReq3
+          ]);
+      });
+    });
   });
 
   describe('interpretResponse', function() {
     let ttxRequest, serverRequest;
+    const videoBid = '<VAST version="3.0"><Ad></Ad></VAST>';
 
     beforeEach(function() {
       ttxRequest = new TtxRequestBuilder()
@@ -1390,6 +1571,7 @@ describe('33acrossBidAdapter:', function () {
           page: 'https://test-url.com'
         })
         .build();
+
       serverRequest = new ServerRequestBuilder()
         .withUrl('https://staging-ssc.33across.com/api/v1/hb')
         .withData(ttxRequest)
@@ -1405,11 +1587,12 @@ describe('33acrossBidAdapter:', function () {
         const serverResponse = {
           cur: 'USD',
           ext: {},
-          id: 'b1',
+          id: 'r1',
           seatbid: [
             {
               bid: [{
                 id: '1',
+                impid: 'b1',
                 adm: '<html><h3>I am an ad</h3></html>',
                 crid: 1,
                 h: 250,
@@ -1441,15 +1624,15 @@ describe('33acrossBidAdapter:', function () {
       });
 
       it('interprets and returns the single video bid response', function() {
-        const videoBid = '<VAST version="3.0"><Ad></Ad></VAST>';
         const serverResponse = {
           cur: 'USD',
           ext: {},
-          id: 'b1',
+          id: 'r1',
           seatbid: [
             {
               bid: [{
                 id: '1',
+                impid: 'b1',
                 adm: videoBid,
                 ext: {
                   ttx: {
@@ -1497,6 +1680,7 @@ describe('33acrossBidAdapter:', function () {
               {
                 bid: [{
                   id: '1',
+                  impid: 'b1',
                   adm: '<html><h3>I am an ad</h3></html>',
                   crid: 1,
                   h: 250,
@@ -1533,7 +1717,7 @@ describe('33acrossBidAdapter:', function () {
         const serverResponse = {
           cur: 'USD',
           ext: {},
-          id: 'b1',
+          id: 'r1',
           seatbid: []
         };
 
@@ -1542,15 +1726,16 @@ describe('33acrossBidAdapter:', function () {
     });
 
     context('when more than one bids are returned', function() {
-      it('interprets and returns the the first bid of the first seatbid', function() {
+      it('interprets and returns all bids', function() {
         const serverResponse = {
           cur: 'USD',
           ext: {},
-          id: 'b1',
+          id: 'r1',
           seatbid: [
             {
               bid: [{
                 id: '1',
+                impid: 'b1',
                 adm: '<html><h3>I am an ad</h3></html>',
                 crid: 1,
                 h: 250,
@@ -1559,6 +1744,7 @@ describe('33acrossBidAdapter:', function () {
               },
               {
                 id: '2',
+                impid: 'b2',
                 adm: '<html><h3>I am an ad</h3></html>',
                 crid: 2,
                 h: 250,
@@ -1570,7 +1756,14 @@ describe('33acrossBidAdapter:', function () {
             {
               bid: [{
                 id: '3',
-                adm: '<html><h3>I am an ad</h3></html>',
+                impid: 'b3',
+                adm: videoBid,
+                ext: {
+                  ttx: {
+                    mediaType: 'video',
+                    vastType: 'xml'
+                  }
+                },
                 crid: 3,
                 h: 250,
                 w: 300,
@@ -1579,21 +1772,50 @@ describe('33acrossBidAdapter:', function () {
             }
           ]
         };
-        const bidResponse = {
-          requestId: 'b1',
-          bidderCode: BIDDER_CODE,
-          cpm: 0.0940,
-          width: 300,
-          height: 250,
-          ad: '<html><h3>I am an ad</h3></html>',
-          ttl: 60,
-          creativeId: 1,
-          mediaType: 'banner',
-          currency: 'USD',
-          netRevenue: true
-        };
+        const bidResponse = [
+          {
+            requestId: 'b1',
+            bidderCode: BIDDER_CODE,
+            cpm: 0.0940,
+            width: 300,
+            height: 250,
+            ad: '<html><h3>I am an ad</h3></html>',
+            ttl: 60,
+            creativeId: 1,
+            mediaType: 'banner',
+            currency: 'USD',
+            netRevenue: true
+          },
+          {
+            requestId: 'b2',
+            bidderCode: BIDDER_CODE,
+            cpm: 0.0938,
+            width: 300,
+            height: 250,
+            ad: '<html><h3>I am an ad</h3></html>',
+            ttl: 60,
+            creativeId: 2,
+            mediaType: 'banner',
+            currency: 'USD',
+            netRevenue: true
+          },
+          {
+            requestId: 'b3',
+            bidderCode: BIDDER_CODE,
+            cpm: 0.0938,
+            width: 300,
+            height: 250,
+            ad: videoBid,
+            vastXml: '<VAST version=\"3.0\"><Ad></Ad></VAST>',
+            ttl: 60,
+            creativeId: 3,
+            mediaType: 'video',
+            currency: 'USD',
+            netRevenue: true
+          }
+        ];
 
-        expect(spec.interpretResponse({ body: serverResponse }, serverRequest)).to.deep.equal([bidResponse]);
+        expect(spec.interpretResponse({ body: serverResponse }, serverRequest)).to.deep.equal(bidResponse);
       });
     });
   });