Core: deferred rendering (#11914)

* mark bids with deferRendering / deferBilling

* refactor internals of triggerBilling

* deferred rendering

* trigger deferred render from triggerBilling

* Fix dfp gdpr parameter dupes

libraries/dfpUtils/dfpUtils.js

@@ -1,3 +1,5 @@
+import {gdprDataHandler} from '../../src/consentHandler.js';
+
 /** Safe defaults which work on pretty much all video calls. */
 export const DEFAULT_DFP_PARAMS = {
   env: 'vp',
@@ -12,9 +14,13 @@ export const DFP_ENDPOINT = {
   pathname: '/gampad/ads'
 }
 
-export const setGdprConsent = (gdprConsent, queryParams) => {
-  if (!gdprConsent) { return; }
-  if (typeof gdprConsent.gdprApplies === 'boolean') { queryParams.gdpr = Number(gdprConsent.gdprApplies); }
-  if (gdprConsent.consentString) { queryParams.gdpr_consent = gdprConsent.consentString; }
-  if (gdprConsent.addtlConsent) { queryParams.addtl_consent = gdprConsent.addtlConsent; }
+export function gdprParams() {
+  const gdprConsent = gdprDataHandler.getConsentData();
+  const params = {};
+  if (gdprConsent) {
+    if (typeof gdprConsent.gdprApplies === 'boolean') { params.gdpr = Number(gdprConsent.gdprApplies); }
+    if (gdprConsent.consentString) { params.gdpr_consent = gdprConsent.consentString; }
+    if (gdprConsent.addtlConsent) { params.addtl_consent = gdprConsent.addtlConsent; }
+  }
+  return params;
 }

modules/bidViewability.js

@@ -4,11 +4,12 @@
 
 import {config} from '../src/config.js';
 import * as events from '../src/events.js';
-import { EVENTS } from '../src/constants.js';
+import {EVENTS} from '../src/constants.js';
 import {isFn, logWarn, triggerPixel} from '../src/utils.js';
 import {getGlobal} from '../src/prebidGlobal.js';
-import adapterManager, {gdprDataHandler, uspDataHandler, gppDataHandler} from '../src/adapterManager.js';
+import adapterManager, {gppDataHandler, uspDataHandler} from '../src/adapterManager.js';
 import {find} from '../src/polyfill.js';
+import {gdprParams} from '../libraries/dfpUtils/dfpUtils.js';
 
 const MODULE_NAME = 'bidViewability';
 const CONFIG_ENABLED = 'enabled';
@@ -32,14 +33,7 @@ export let getMatchingWinningBidForGPTSlot = (globalModuleConfig, slot) => {
 
 export let fireViewabilityPixels = (globalModuleConfig, bid) => {
   if (globalModuleConfig[CONFIG_FIRE_PIXELS] === true && bid.hasOwnProperty(BID_VURL_ARRAY)) {
-    let queryParams = {};
-
-    const gdprConsent = gdprDataHandler.getConsentData();
-    if (gdprConsent) {
-      if (typeof gdprConsent.gdprApplies === 'boolean') { queryParams.gdpr = Number(gdprConsent.gdprApplies); }
-      if (gdprConsent.consentString) { queryParams.gdpr_consent = gdprConsent.consentString; }
-      if (gdprConsent.addtlConsent) { queryParams.addtl_consent = gdprConsent.addtlConsent; }
-    }
+    let queryParams = gdprParams();
 
     const uspConsent = uspDataHandler.getConsentData();
     if (uspConsent) { queryParams.us_privacy = uspConsent; }
@@ -67,7 +61,6 @@ export let logWinningBidNotFound = (slot) => {
 
 export let impressionViewableHandler = (globalModuleConfig, slot, event) => {
   let respectiveBid = getMatchingWinningBidForGPTSlot(globalModuleConfig, slot);
-  let respectiveDeferredAdUnit = getGlobal().adUnits.find(adUnit => adUnit.deferBilling && respectiveBid.adUnitCode === adUnit.code);
 
   if (respectiveBid === null) {
     logWinningBidNotFound(slot);
@@ -77,8 +70,8 @@ export let impressionViewableHandler = (globalModuleConfig, slot, event) => {
     // trigger respective bidder's onBidViewable handler
     adapterManager.callBidViewableBidder(respectiveBid.adapterCode || respectiveBid.bidder, respectiveBid);
 
-    if (respectiveDeferredAdUnit) {
-      adapterManager.callBidBillableBidder(respectiveBid);
+    if (respectiveBid.deferBilling) {
+      adapterManager.triggerBilling(respectiveBid);
     }
 
     // emit the BID_VIEWABLE event with bid details, this event can be consumed by bidders and analytics pixels

modules/dfpAdServerVideo.js

@@ -2,10 +2,8 @@
  * This module adds [DFP support]{@link https://www.doubleclickbygoogle.com/} for Video to Prebid.
  */
 
-import { DEFAULT_DFP_PARAMS, DFP_ENDPOINT, setGdprConsent } from '../libraries/dfpUtils/dfpUtils.js';
 import { getSignals } from '../libraries/gptUtils/gptUtils.js';
 import { registerVideoSupport } from '../src/adServerManager.js';
-import { gdprDataHandler } from '../src/adapterManager.js';
 import { getPPID } from '../src/adserver.js';
 import { auctionManager } from '../src/auctionManager.js';
 import { config } from '../src/config.js';
@@ -24,6 +22,7 @@ import {
   parseSizesInput,
   parseUrl
 } from '../src/utils.js';
+import {DEFAULT_DFP_PARAMS, DFP_ENDPOINT, gdprParams} from '../libraries/dfpUtils/dfpUtils.js';
 /**
  * @typedef {Object} DfpVideoParams
  *
@@ -108,13 +107,12 @@ export function buildDfpVideoUrl(options) {
     urlComponents.search,
     derivedParams,
     options.params,
-    { cust_params: encodedCustomParams }
+    { cust_params: encodedCustomParams },
+    gdprParams()
   );
 
   const descriptionUrl = getDescriptionUrl(bid, options, 'params');
   if (descriptionUrl) { queryParams.description_url = descriptionUrl; }
-  const gdprConsent = gdprDataHandler.getConsentData();
-  setGdprConsent(gdprConsent, queryParams);
 
   if (!queryParams.ppid) {
     const ppid = getPPID();

modules/dfpAdpod.js

@@ -1,8 +1,7 @@
 import {submodule} from '../src/hook.js';
 import {buildUrl, deepAccess, formatQS, logError, parseSizesInput} from '../src/utils.js';
 import {auctionManager} from '../src/auctionManager.js';
-import {DEFAULT_DFP_PARAMS, DFP_ENDPOINT, setGdprConsent} from '../libraries/dfpUtils/dfpUtils.js';
-import {gdprDataHandler} from '../src/consentHandler.js';
+import {DEFAULT_DFP_PARAMS, DFP_ENDPOINT, gdprParams} from '../libraries/dfpUtils/dfpUtils.js';
 import {registerVideoSupport} from '../src/adServerManager.js';
 
 export const adpodUtils = {};
@@ -75,12 +74,10 @@ export function buildAdpodVideoUrl({code, params, callback} = {}) {
       DEFAULT_DFP_PARAMS,
       derivedParams,
       params,
-      { cust_params: encodedCustomParams }
+      { cust_params: encodedCustomParams },
+      gdprParams(),
     );
 
-    const gdprConsent = gdprDataHandler.getConsentData();
-    setGdprConsent(gdprConsent, queryParams);
-
     const masterTag = buildUrl({
       ...DFP_ENDPOINT,
       search: queryParams

modules/prebidServerBidAdapter/ortbConverter.js

@@ -102,7 +102,10 @@ const PBS_CONVERTER = ortbConverter({
         transactionId: context.adUnit.transactionId,
         adUnitId: context.adUnit.adUnitId,
         auctionId: context.bidderRequest.auctionId,
-      }), bidResponse),
+      }), bidResponse, {
+        deferRendering: !!context.adUnit.deferBilling,
+        deferBilling: !!context.adUnit.deferBilling
+      }),
       adUnit: context.adUnit.code
     };
   },

modules/topLevelPaapi.js

@@ -96,7 +96,6 @@ export function getRenderingDataHook(next, bid, options) {
 
 export function markWinningBidHook(next, bid) {
   if (isPaapiBid(bid)) {
-    bid.status = BID_STATUS.RENDERED;
     emit(EVENTS.BID_WON, bid);
     next.bail();
   } else {

src/adRendering.js

@@ -19,6 +19,7 @@ import {hook} from './hook.js';
 import {fireNativeTrackers} from './native.js';
 import {GreedyPromise} from './utils/promise.js';
 import adapterManager from './adapterManager.js';
+import {useMetrics} from './utils/perfMetrics.js';
 
 const { AD_RENDER_FAILED, AD_RENDER_SUCCEEDED, STALE_RENDER, BID_WON } = EVENTS;
 const { EXCEPTION } = AD_RENDER_FAILED_REASON;
@@ -167,32 +168,70 @@ doRender.before(function (next, args) {
 }, 100)
 
 export function handleRender({renderFn, resizeFn, adId, options, bidResponse, doc}) {
+  deferRendering(bidResponse, () => {
+    if (bidResponse == null) {
+      emitAdRenderFail({
+        reason: AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+        message: `Cannot find ad '${adId}'`,
+        id: adId
+      });
+      return;
+    }
+    if (bidResponse.status === BID_STATUS.RENDERED) {
+      logWarn(`Ad id ${adId} has been rendered before`);
+      events.emit(STALE_RENDER, bidResponse);
+      if (deepAccess(config.getConfig('auctionOptions'), 'suppressStaleRender')) {
+        return;
+      }
+    }
+    try {
+      doRender({renderFn, resizeFn, bidResponse, options, doc});
+    } catch (e) {
+      emitAdRenderFail({
+        reason: AD_RENDER_FAILED_REASON.EXCEPTION,
+        message: e.message,
+        id: adId,
+        bid: bidResponse
+      });
+    }
+  })
+}
+
+export function markBidAsRendered(bidResponse) {
+  const metrics = useMetrics(bidResponse.metrics);
+  metrics.checkpoint('bidRender');
+  metrics.timeBetween('bidWon', 'bidRender', 'render.deferred');
+  metrics.timeBetween('auctionEnd', 'bidRender', 'render.pending');
+  metrics.timeBetween('requestBids', 'bidRender', 'render.e2e');
+  bidResponse.status = BID_STATUS.RENDERED;
+}
+
+const DEFERRED_RENDER = new WeakMap();
+const WINNERS = new WeakSet();
+
+export function deferRendering(bidResponse, renderFn) {
   if (bidResponse == null) {
-    emitAdRenderFail({
-      reason: AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
-      message: `Cannot find ad '${adId}'`,
-      id: adId
-    });
+    // if the bid is missing, let renderFn deal with it now
+    renderFn();
     return;
   }
-  if (bidResponse.status === BID_STATUS.RENDERED) {
-    logWarn(`Ad id ${adId} has been rendered before`);
-    events.emit(STALE_RENDER, bidResponse);
-    if (deepAccess(config.getConfig('auctionOptions'), 'suppressStaleRender')) {
-      return;
-    }
+  DEFERRED_RENDER.set(bidResponse, renderFn);
+  if (!bidResponse.deferRendering) {
+    renderIfDeferred(bidResponse);
   }
-  try {
-    doRender({renderFn, resizeFn, bidResponse, options, doc});
-  } catch (e) {
-    emitAdRenderFail({
-      reason: AD_RENDER_FAILED_REASON.EXCEPTION,
-      message: e.message,
-      id: adId,
-      bid: bidResponse
-    });
+  if (!WINNERS.has(bidResponse)) {
+    WINNERS.add(bidResponse);
+    markWinningBid(bidResponse);
+  }
+}
+
+export function renderIfDeferred(bidResponse) {
+  const renderFn = DEFERRED_RENDER.get(bidResponse);
+  if (renderFn) {
+    renderFn();
+    markBidAsRendered(bidResponse);
+    DEFERRED_RENDER.delete(bidResponse);
   }
-  markWinningBid(bidResponse);
 }
 
 export function renderAdDirect(doc, adId, options) {

src/adapterManager.js

@@ -10,6 +10,7 @@ import {
   getUniqueIdentifierStr,
   getUserConfiguredParams,
   groupBy,
+  internal,
   isArray,
   isPlainObject,
   isValidMediaTypes,
@@ -30,13 +31,15 @@ import {find, includes} from './polyfill.js';
 import {
   getBidderRequestsCounter,
   getBidderWinsCounter,
-  getRequestsCounter, incrementBidderRequestsCounter,
-  incrementBidderWinsCounter, incrementRequestsCounter
+  getRequestsCounter,
+  incrementBidderRequestsCounter,
+  incrementBidderWinsCounter,
+  incrementRequestsCounter
 } from './adUnits.js';
 import {getRefererInfo} from './refererDetection.js';
 import {GDPR_GVLIDS, gdprDataHandler, gppDataHandler, uspDataHandler, } from './consentHandler.js';
 import * as events from './events.js';
-import { EVENTS, S2S } from './constants.js';
+import {EVENTS, S2S} from './constants.js';
 import {useMetrics} from './utils/perfMetrics.js';
 import {auctionManager} from './auctionManager.js';
 import {MODULE_TYPE_ANALYTICS, MODULE_TYPE_BIDDER, MODULE_TYPE_PREBID} from './activities/modules.js';
@@ -134,6 +137,7 @@ function getBids({bidderCode, auctionId, bidderRequestId, adUnits, src, metrics}
           bidRequestsCount: getRequestsCounter(adUnit.code),
           bidderRequestsCount: getBidderRequestsCounter(adUnit.code, bid.bidder),
           bidderWinsCount: getBidderWinsCounter(adUnit.code, bid.bidder),
+          deferBilling: !!adUnit.deferBilling
         }));
         return bids;
       }, [])
@@ -644,7 +648,7 @@ function invokeBidderMethod(bidder, method, spec, fn, ...params) {
 }
 
 function tryCallBidderMethod(bidder, method, param) {
-  if (param?.src !== S2S.SRC) {
+  if (param?.source !== S2S.SRC) {
     const target = getBidderMethod(bidder, method);
     if (target != null) {
       invokeBidderMethod(bidder, method, ...target, param);
@@ -673,9 +677,18 @@ adapterManager.callBidWonBidder = function(bidder, bid, adUnits) {
   tryCallBidderMethod(bidder, 'onBidWon', bid);
 };
 
-adapterManager.callBidBillableBidder = function(bid) {
-  tryCallBidderMethod(bid.bidder, 'onBidBillable', bid);
-};
+adapterManager.triggerBilling = (() => {
+  const BILLED = new WeakSet();
+  return (bid) => {
+    if (!BILLED.has(bid)) {
+      BILLED.add(bid);
+      if (bid.source === S2S.SRC && bid.burl) {
+        internal.triggerPixel(bid.burl);
+      }
+      tryCallBidderMethod(bid.bidder, 'onBidBillable', bid);
+    }
+  }
+})();
 
 adapterManager.callSetTargetingBidder = function(bidder, bid) {
   tryCallBidderMethod(bidder, 'onSetTargeting', bid);

src/adapters/bidderFactory.js

@@ -323,6 +323,8 @@ export function newBidder(spec) {
             bid.originalCpm = bid.cpm;
             bid.originalCurrency = bid.currency;
             bid.meta = bid.meta || Object.assign({}, bid[bidRequest.bidder]);
+            bid.deferBilling = bidRequest.deferBilling;
+            bid.deferRendering = bid.deferBilling && (bid.deferRendering ?? typeof spec.onBidBillable !== 'function');
             const prebidBid = Object.assign(createBid(STATUS.GOOD, bidRequest), bid, pick(bidRequest, TIDS));
             addBidWithCode(bidRequest.adUnitCode, prebidBid);
           } else {

src/auction.js

@@ -66,7 +66,6 @@
  */
 
 import {
-  callBurl,
   deepAccess,
   generateUUID,
   getValue,
@@ -370,11 +369,11 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels, a
   }
 
   function addWinningBid(winningBid) {
-    const winningAd = adUnits.find(adUnit => adUnit.adUnitId === winningBid.adUnitId);
     _winningBids = _winningBids.concat(winningBid);
-    callBurl(winningBid);
     adapterManager.callBidWonBidder(winningBid.adapterCode || winningBid.bidder, winningBid, adUnits);
-    if (winningAd && !winningAd.deferBilling) adapterManager.callBidBillableBidder(winningBid);
+    if (!winningBid.deferBilling) {
+      adapterManager.triggerBilling(winningBid)
+    }
   }
 
   function setBidTargeting(bid) {

src/auctionManager.js

@@ -73,11 +73,10 @@ export function newAuctionManager() {
   auctionManager.addWinningBid = function(bid) {
     const metrics = useMetrics(bid.metrics);
     metrics.checkpoint('bidWon');
-    metrics.timeBetween('auctionEnd', 'bidWon', 'render.pending');
-    metrics.timeBetween('requestBids', 'bidWon', 'render.e2e');
+    metrics.timeBetween('auctionEnd', 'bidWon', 'adserver.pending');
+    metrics.timeBetween('requestBids', 'bidWon', 'adserver.e2e');
     const auction = getAuction(bid.auctionId);
     if (auction) {
-      bid.status = BID_STATUS.RENDERED;
       auction.addWinningBid(bid);
     } else {
       logWarn(`Auction not found when adding winning bid`);