prebid.js 6.7.0 → 6.8.0

package/modules/sovrnBidAdapter.md

@@ -10,9 +10,9 @@ Maintainer: jrosendahl@sovrn.com
 
 Sovrn's adapter integration to the Prebid library. Posts plain-text JSON to the /rtb/bid endpoint.
 
-# Test Parameters
+# Banner Test Parameters
 
-```
+```js
 var adUnits = [
   {
     code: 'test-leaderboard',
@@ -45,3 +45,81 @@ var adUnits = [
   }
 ]
 ```
+
+# Video Test Parameters
+### Instream
+```js
+var videoAdUnit = {
+  code: 'video1',
+  sizes: [640, 480],
+  mediaTypes: {
+    video: {
+      context: 'instream',
+      playerSize: [640, 480],
+      mimes: ['video/mp4'],
+      protocols: [1, 2, 3, 4, 5, 6, 7, 8],
+      playbackmethod: [2],
+      skip: 1,
+    },
+  },
+  bids: [
+    {
+      bidder: 'sovrn',
+      // Prebid Server Bidder Params https://docs.prebid.org/dev-docs/pbs-bidders.html#sovrn
+      params: {
+        tagid: '315045',
+        bidfloor: '0.04',
+      },
+    },
+  ],
+}
+```
+### Outstream
+```js
+var adUnits = [
+  {
+    code: videoId,
+    mediaTypes: {
+      video: {
+        context: 'outstream',
+        playerSize: [640, 360],
+        mimes: ['video/mp4'],
+        protocols: [1, 2, 3, 4, 5, 6, 7, 8],
+        playbackmethod: [2],
+        skip: 1,
+      },
+    },
+    bids: [
+      {
+        bidder: 'sovrn',
+        // Prebid Server Bidder Params https://docs.prebid.org/dev-docs/pbs-bidders.html#sovrn
+        params: {
+          tagid: '315045',
+          bidfloor: '0.04',
+        },
+      },
+    ],
+    renderer: {
+      url: 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js',
+      render: function (bid) {
+        adResponse = {
+          ad: {
+            video: {
+              content: bid.vastXml,
+              player_height: bid.height,
+              player_width: bid.width,
+            },
+          },
+        }
+        // push to render queue because ANOutstreamVideo may not be loaded yet.
+        bid.renderer.push(() => {
+          ANOutstreamVideo.renderAd({
+            targetId: bid.adUnitCode,
+            adResponse: adResponse,
+          })
+        })
+      },
+    },
+  },
+]
+```

package/modules/undertoneBidAdapter.js

@@ -12,6 +12,20 @@ const FRAME_USER_SYNC = 'https://cdn.undertone.com/js/usersync.html';
 const PIXEL_USER_SYNC_1 = 'https://usr.undertone.com/userPixel/syncOne?id=1&of=2';
 const PIXEL_USER_SYNC_2 = 'https://usr.undertone.com/userPixel/syncOne?id=2&of=2';
 
+function getBidFloor(bidRequest, mediaType) {
+  if (typeof bidRequest.getFloor !== 'function') {
+    return 0;
+  }
+
+  const floor = bidRequest.getFloor({
+    currency: 'USD',
+    mediaType: mediaType,
+    size: '*'
+  });
+
+  return (floor && floor.currency === 'USD' && floor.floor) || 0;
+}
+
 function getCanonicalUrl() {
   try {
     let doc = window.top.document;
@@ -134,6 +148,9 @@ export const spec = {
         params: bidReq.params
       };
       const videoMediaType = deepAccess(bidReq, 'mediaTypes.video');
+      const mediaType = videoMediaType ? VIDEO : BANNER;
+      bid.mediaType = mediaType;
+      bid.bidfloor = getBidFloor(bidReq, mediaType);
       if (videoMediaType) {
         bid.video = {
           playerSize: deepAccess(bidReq, 'mediaTypes.video.playerSize') || null,
@@ -142,7 +159,6 @@ export const spec = {
           maxDuration: deepAccess(bidReq, 'params.video.maxDuration') || null,
           skippable: deepAccess(bidReq, 'params.video.skippable') || null
         };
-        bid.mediaType = 'video';
       }
       payload['x-ut-hb-params'].push(bid);
     });

package/modules/yahoosspBidAdapter.js

@@ -6,6 +6,7 @@ import { Renderer } from '../src/Renderer.js';
 
 const INTEGRATION_METHOD = 'prebid.js';
 const BIDDER_CODE = 'yahoossp';
+const GVLID = 25;
 const ADAPTER_VERSION = '1.0.2';
 const PREBID_VERSION = '$prebid.version$';
 const DEFAULT_BID_TTL = 300;
@@ -515,6 +516,7 @@ function createRenderer(bidderRequest, bidResponse) {
 
 export const spec = {
   code: BIDDER_CODE,
+  gvlid: GVLID,
   aliases: [],
   supportedMediaTypes: [BANNER, VIDEO],
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/src/adRendering.js

@@ -0,0 +1,38 @@
+import {logError} from './utils.js';
+import events from './events.js';
+import CONSTANTS from './constants.json';
+
+const {AD_RENDER_FAILED, AD_RENDER_SUCCEEDED} = CONSTANTS.EVENTS;
+
+/**
+ * Emit the AD_RENDER_FAILED event.
+ *
+ * @param reason one of the values in CONSTANTS.AD_RENDER_FAILED_REASON
+ * @param message failure description
+ * @param bid? bid response object that failed to render
+ * @param id? adId that failed to render
+ */
+export function emitAdRenderFail({ reason, message, bid, id }) {
+  const data = { reason, message };
+  if (bid) data.bid = bid;
+  if (id) data.adId = id;
+
+  logError(message);
+  events.emit(AD_RENDER_FAILED, data);
+}
+
+/**
+ * Emit the AD_RENDER_SUCCEEDED event.
+ *
+ * @param doc document object that was used to `.write` the ad. Should be `null` if unavailable (e.g. for documents in
+ * a cross-origin frame).
+ * @param bid bid response object for the ad that was rendered
+ * @param id adId that was rendered.
+ */
+export function emitAdRenderSucceeded({ doc, bid, id }) {
+  const data = { doc };
+  if (bid) data.bid = bid;
+  if (id) data.adId = id;
+
+  events.emit(AD_RENDER_SUCCEEDED, data);
+}

package/src/auction.js

@@ -250,10 +250,7 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, a
 
         let callbacks = auctionCallbacks(auctionDone, this);
         adapterManager.callBids(_adUnits, bidRequests, function(...args) {
-          addBidResponse.apply({
-            dispatch: callbacks.addBidResponse,
-            bidderRequest: this
-          }, args)
+          callbacks.addBidResponse.apply(this, args);
         }, callbacks.adapterDone, {
           request(source, origin) {
             increment(outstandingRequests, origin);
@@ -344,6 +341,7 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, a
     addWinningBid,
     setBidTargeting,
     getWinningBids: () => _winningBids,
+    getAuctionStart: () => _auctionStart,
     getTimeout: () => _timeout,
     getAuctionId: () => _auctionId,
     getAuctionStatus: () => _auctionStatus,
@@ -355,8 +353,12 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, a
   }
 }
 
-export const addBidResponse = hook('async', function(adUnitCode, bid) {
-  this.dispatch.call(this.bidderRequest, adUnitCode, bid);
+/**
+ * addBidResponse may return a Promise; if it does, the auction will attempt to
+ * wait for it to complete (successfully or not) before closing.
+ */
+export const addBidResponse = hook('sync', function(adUnitCode, bid) {
+  return this.dispatch.call(this.bidderRequest, adUnitCode, bid);
 }, 'addBidResponse');
 
 export const addBidderRequests = hook('sync', function(bidderRequests) {
@@ -374,6 +376,32 @@ export function auctionCallbacks(auctionDone, auctionInstance) {
   let allAdapterCalledDone = false;
   let bidderRequestsDone = new Set();
   let bidResponseMap = {};
+  const ready = {};
+
+  function waitFor(bidderRequest, result) {
+    const id = bidderRequest.bidderRequestId;
+    if (ready[id] == null) {
+      ready[id] = Promise.resolve();
+    }
+    ready[id] = ready[id].then(() => Promise.resolve(result).catch(() => {}))
+  }
+
+  function guard(bidderRequest, fn) {
+    let timeout = bidderRequest.timeout;
+    if (timeout == null || timeout > auctionInstance.getTimeout()) {
+      timeout = auctionInstance.getTimeout();
+    }
+    const timeRemaining = auctionInstance.getAuctionStart() + timeout - Date.now();
+    const wait = ready[bidderRequest.bidderRequestId];
+    if (wait != null && timeRemaining > 0) {
+      Promise.race([
+        new Promise((resolve) => setTimeout(resolve, timeRemaining)),
+        wait
+      ]).then(fn);
+    } else {
+      fn();
+    }
+  }
 
   function afterBidAdded() {
     outstandingBidsAdded--;
@@ -382,7 +410,7 @@ export function auctionCallbacks(auctionDone, auctionInstance) {
     }
   }
 
-  function addBidResponse(adUnitCode, bid) {
+  function handleBidResponse(adUnitCode, bid) {
     let bidderRequest = this;
 
     bidResponseMap[bid.requestId] = true;
@@ -429,8 +457,15 @@ export function auctionCallbacks(auctionDone, auctionInstance) {
   }
 
   return {
-    addBidResponse,
-    adapterDone
+    addBidResponse: function (...args) {
+      waitFor(this, addBidResponse.apply({
+        dispatch: handleBidResponse,
+        bidderRequest: this
+      }, args));
+    },
+    adapterDone: function () {
+      guard(this, adapterDone.bind(this))
+    }
   }
 }
 

package/src/prebid.js

@@ -19,6 +19,7 @@ import { adunitCounter } from './adUnits.js';
 import { executeRenderer, isRendererRequired } from './Renderer.js';
 import { createBid } from './bidfactory.js';
 import { storageCallbacks } from './storageManager.js';
+import { emitAdRenderSucceeded, emitAdRenderFail } from './adRendering.js';
 
 const $$PREBID_GLOBAL$$ = getGlobal();
 const CONSTANTS = require('./constants.json');
@@ -27,7 +28,7 @@ const events = require('./events.js');
 const { triggerUserSyncs } = userSync;
 
 /* private variables */
-const { ADD_AD_UNITS, BID_WON, REQUEST_BIDS, SET_TARGETING, AD_RENDER_FAILED, AD_RENDER_SUCCEEDED, STALE_RENDER } = CONSTANTS.EVENTS;
+const { ADD_AD_UNITS, BID_WON, REQUEST_BIDS, SET_TARGETING, STALE_RENDER } = CONSTANTS.EVENTS;
 const { PREVENT_WRITING_ON_MAIN_DOCUMENT, NO_AD, EXCEPTION, CANNOT_FIND_AD, MISSING_DOC_OR_ADID } = CONSTANTS.AD_RENDER_FAILED_REASON;
 
 const eventValidators = {
@@ -146,7 +147,7 @@ function validateNativeMediaType(adUnit) {
 function validateAdUnitPos(adUnit, mediaType) {
   let pos = deepAccess(adUnit, `mediaTypes.${mediaType}.pos`);
 
-  if (!pos || !isNumber(pos) || !isFinite(pos)) {
+  if (!isNumber(pos) || isNaN(pos) || !isFinite(pos)) {
     let warning = `Value of property 'pos' on ad unit ${adUnit.code} should be of type: Number`;
 
     logWarn(warning);
@@ -385,23 +386,6 @@ $$PREBID_GLOBAL$$.setTargetingForAst = function (adUnitCodes) {
   events.emit(SET_TARGETING, targeting.getAllTargeting());
 };
 
-function emitAdRenderFail({ reason, message, bid, id }) {
-  const data = { reason, message };
-  if (bid) data.bid = bid;
-  if (id) data.adId = id;
-
-  logError(message);
-  events.emit(AD_RENDER_FAILED, data);
-}
-
-function emitAdRenderSucceeded({ doc, bid, id }) {
-  const data = { doc };
-  if (bid) data.bid = bid;
-  if (id) data.adId = id;
-
-  events.emit(AD_RENDER_SUCCEEDED, data);
-}
-
 /**
  * This function will check for presence of given node in given parent. If not present - will inject it.
  * @param {Node} node node, whose existance is in question

package/src/secureCreatives.js

@@ -4,18 +4,25 @@
  */
 
 import events from './events.js';
-import { fireNativeTrackers, getAssetMessage, getAllAssetsMessage } from './native.js';
+import {fireNativeTrackers, getAllAssetsMessage, getAssetMessage} from './native.js';
 import constants from './constants.json';
-import { logWarn, replaceAuctionPrice, deepAccess, isGptPubadsDefined, isApnGetTagDefined } from './utils.js';
-import { auctionManager } from './auctionManager.js';
+import {deepAccess, isApnGetTagDefined, isGptPubadsDefined, logError, logWarn, replaceAuctionPrice} from './utils.js';
+import {auctionManager} from './auctionManager.js';
 import find from 'core-js-pure/features/array/find.js';
-import { isRendererRequired, executeRenderer } from './Renderer.js';
+import {executeRenderer, isRendererRequired} from './Renderer.js';
 import includes from 'core-js-pure/features/array/includes.js';
-import { config } from './config.js';
+import {config} from './config.js';
+import {emitAdRenderFail, emitAdRenderSucceeded} from './adRendering.js';
 
 const BID_WON = constants.EVENTS.BID_WON;
 const STALE_RENDER = constants.EVENTS.STALE_RENDER;
 
+const HANDLER_MAP = {
+  'Prebid Request': handleRenderRequest,
+  'Prebid Native': handleNativeRequest,
+  'Prebid Event': handleEventRequest,
+}
+
 export function listenMessagesFromCreative() {
   window.addEventListener('message', receiveMessage, false);
 }
@@ -29,52 +36,114 @@ export function receiveMessage(ev) {
     return;
   }
 
-  if (data && data.adId) {
+  if (data && data.adId && data.message) {
     const adObject = find(auctionManager.getBidsReceived(), function (bid) {
       return bid.adId === data.adId;
     });
+    if (HANDLER_MAP.hasOwnProperty(data.message)) {
+      HANDLER_MAP[data.message](ev, data, adObject);
+    }
+  }
+}
 
-    if (adObject && data.message === 'Prebid Request') {
-      if (adObject.status === constants.BID_STATUS.RENDERED) {
-        logWarn(`Ad id ${adObject.adId} has been rendered before`);
-        events.emit(STALE_RENDER, adObject);
-        if (deepAccess(config.getConfig('auctionOptions'), 'suppressStaleRender')) {
-          return;
-        }
-      }
+function handleRenderRequest(ev, data, adObject) {
+  if (adObject == null) {
+    emitAdRenderFail({
+      reason: constants.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+      message: `Cannot find ad '${data.adId}' for cross-origin render request`,
+      id: data.adId
+    });
+    return;
+  }
+  if (adObject.status === constants.BID_STATUS.RENDERED) {
+    logWarn(`Ad id ${adObject.adId} has been rendered before`);
+    events.emit(STALE_RENDER, adObject);
+    if (deepAccess(config.getConfig('auctionOptions'), 'suppressStaleRender')) {
+      return;
+    }
+  }
 
-      _sendAdToCreative(adObject, ev);
+  try {
+    _sendAdToCreative(adObject, ev);
+  } catch (e) {
+    emitAdRenderFail({
+      reason: constants.AD_RENDER_FAILED_REASON.EXCEPTION,
+      message: e.message,
+      id: data.adId,
+      bid: adObject
+    });
+    return;
+  }
 
-      // save winning bids
-      auctionManager.addWinningBid(adObject);
+  // save winning bids
+  auctionManager.addWinningBid(adObject);
 
-      events.emit(BID_WON, adObject);
-    }
+  events.emit(BID_WON, adObject);
+}
 
-    // handle this script from native template in an ad server
-    // window.parent.postMessage(JSON.stringify({
-    //   message: 'Prebid Native',
-    //   adId: '%%PATTERN:hb_adid%%'
-    // }), '*');
-    if (adObject && data.message === 'Prebid Native') {
-      if (data.action === 'assetRequest') {
-        const message = getAssetMessage(data, adObject);
-        ev.source.postMessage(JSON.stringify(message), ev.origin);
-      } else if (data.action === 'allAssetRequest') {
-        const message = getAllAssetsMessage(data, adObject);
-        ev.source.postMessage(JSON.stringify(message), ev.origin);
-      } else if (data.action === 'resizeNativeHeight') {
-        adObject.height = data.height;
-        adObject.width = data.width;
-        resizeRemoteCreative(adObject);
-      } else {
-        const trackerType = fireNativeTrackers(data, adObject);
-        if (trackerType === 'click') { return; }
-
-        auctionManager.addWinningBid(adObject);
-        events.emit(BID_WON, adObject);
+function handleNativeRequest(ev, data, adObject) {
+  // handle this script from native template in an ad server
+  // window.parent.postMessage(JSON.stringify({
+  //   message: 'Prebid Native',
+  //   adId: '%%PATTERN:hb_adid%%'
+  // }), '*');
+  if (adObject == null) {
+    logError(`Cannot find ad '${data.adId}' for x-origin event request`);
+    return;
+  }
+  switch (data.action) {
+    case 'assetRequest':
+      reply(getAssetMessage(data, adObject));
+      break;
+    case 'allAssetRequest':
+      reply(getAllAssetsMessage(data, adObject));
+      break;
+    case 'resizeNativeHeight':
+      adObject.height = data.height;
+      adObject.width = data.width;
+      resizeRemoteCreative(adObject);
+      break;
+    default:
+      const trackerType = fireNativeTrackers(data, adObject);
+      if (trackerType === 'click') {
+        return;
       }
-    }
+      auctionManager.addWinningBid(adObject);
+      events.emit(BID_WON, adObject);
+  }
+
+  function reply(message) {
+    ev.source.postMessage(JSON.stringify(message), ev.origin);
+  }
+}
+
+function handleEventRequest(ev, data, adObject) {
+  if (adObject == null) {
+    logError(`Cannot find ad '${data.adId}' for x-origin event request`);
+    return;
+  }
+  if (adObject.status !== constants.BID_STATUS.RENDERED) {
+    logWarn(`Received x-origin event request without corresponding render request for ad '${data.adId}'`);
+    return;
+  }
+  switch (data.event) {
+    case constants.EVENTS.AD_RENDER_FAILED:
+      emitAdRenderFail({
+        bid: adObject,
+        id: data.adId,
+        reason: data.info.reason,
+        message: data.info.message
+      });
+      break;
+    case constants.EVENTS.AD_RENDER_SUCCEEDED:
+      emitAdRenderSucceeded({
+        doc: null,
+        bid: adObject,
+        id: data.adId
+      });
+      break;
+    default:
+      logError(`Received x-origin event request for unsupported event: '${data.event}' (adId: '${data.adId}')`)
   }
 }
 

package/src/utils.js

@@ -22,7 +22,17 @@ let consoleLogExists = Boolean(consoleExists && window.console.log);
 let consoleInfoExists = Boolean(consoleExists && window.console.info);
 let consoleWarnExists = Boolean(consoleExists && window.console.warn);
 let consoleErrorExists = Boolean(consoleExists && window.console.error);
-var events = require('./events.js');
+
+const emitEvent = (function () {
+  // lazy load events to avoid circular import
+  let ev;
+  return function() {
+    if (ev == null) {
+      ev = require('./events.js');
+    }
+    return ev.emit.apply(ev, arguments);
+  }
+})();
 
 // this allows stubbing of utility functions that are used internally by other utility functions
 export const internal = {
@@ -265,14 +275,14 @@ export function logWarn() {
   if (debugTurnedOn() && consoleWarnExists) {
     console.warn.apply(console, decorateLog(arguments, 'WARNING:'));
   }
-  events.emit(CONSTANTS.EVENTS.AUCTION_DEBUG, {type: 'WARNING', arguments: arguments});
+  emitEvent(CONSTANTS.EVENTS.AUCTION_DEBUG, {type: 'WARNING', arguments: arguments});
 }
 
 export function logError() {
   if (debugTurnedOn() && consoleErrorExists) {
     console.error.apply(console, decorateLog(arguments, 'ERROR:'));
   }
-  events.emit(CONSTANTS.EVENTS.AUCTION_DEBUG, {type: 'ERROR', arguments: arguments});
+  emitEvent(CONSTANTS.EVENTS.AUCTION_DEBUG, {type: 'ERROR', arguments: arguments});
 }
 
 function decorateLog(args, prefix) {

package/test/helpers/syncPromise.js

@@ -0,0 +1,71 @@
+const orig = {};
+['resolve', 'reject', 'all', 'race', 'allSettled'].forEach((k) => orig[k] = Promise[k].bind(Promise))
+
+// Callbacks attached through Promise.resolve(value).then(...) will usually
+// not execute immediately even if `value` is immediately available. This
+// breaks tests that were written before promises even though they are semantically still valid.
+// They can be made to work by making promises quasi-synchronous.
+
+export function SyncPromise(value, fail = false) {
+  if (value instanceof SyncPromise) {
+    return value;
+  } else if (typeof value === 'object' && typeof value.then === 'function') {
+    return orig.resolve(value);
+  } else {
+    Object.assign(this, {
+      then: function (cb, err) {
+        const handler = fail ? err : cb;
+        if (handler != null) {
+          return new SyncPromise(handler(value));
+        } else {
+          return this;
+        }
+      },
+      catch: function (cb) {
+        if (fail) {
+          return new SyncPromise(cb(value))
+        } else {
+          return this;
+        }
+      },
+      finally: function (cb) {
+        cb();
+        return this;
+      },
+      __value: fail ? {status: 'rejected', reason: value} : {status: 'fulfilled', value}
+    })
+  }
+}
+
+Object.assign(SyncPromise, {
+  resolve: (val) => new SyncPromise(val),
+  reject: (val) => new SyncPromise(val, true),
+  race: (promises) => promises.find((p) => p instanceof SyncPromise) || orig.race(promises),
+  allSettled: (promises) => {
+    if (promises.every((p) => p instanceof SyncPromise)) {
+      return new SyncPromise(promises.map((p) => p.__value))
+    } else {
+      return orig.allSettled(promises);
+    }
+  },
+  all: (promises) => {
+    if (promises.every((p) => p instanceof SyncPromise)) {
+      return SyncPromise.allSettled(promises).then((result) => {
+        const err = result.find((r) => r.status === 'rejected');
+        if (err != null) {
+          return new SyncPromise(err.reason, true);
+        } else {
+          return new SyncPromise(result.map((r) => r.value))
+        }
+      })
+    } else {
+      return orig.all(promises);
+    }
+  }
+})
+
+export function synchronizePromise(sandbox) {
+  Object.keys(orig).forEach((k) => {
+    sandbox.stub(window.Promise, k).callsFake(SyncPromise[k]);
+  })
+}