Price floors module : accept null floors (#12295)

* 10432 Accept null floors * lint fix * Adding tests for floor provider case * null-safe getFloor in adapters * Update kargoBidAdapter.js --------- Co-authored-by: Marcin Komorski <marcinkomorski@Marcins-MacBook-Pro.local> Co-authored-by: Patrick McCann <patmmccann@gmail.com>
prebid · Dec 3, 2024 · d014440 · d014440
1 parent 7facccb
commit d014440
Show file tree

Hide file tree

Showing 78 changed files with 204 additions and 109 deletions.
diff --git a/libraries/advangUtils/index.js b/libraries/advangUtils/index.js
@@ -14,7 +14,7 @@ export function isVideoBid(bid) {
 
 export function getBannerBidFloor(bid) {
   let floorInfo = isFn(bid.getFloor) ? bid.getFloor({ currency: 'USD', mediaType: 'banner', size: '*' }) : {};
-  return floorInfo.floor || getBannerBidParam(bid, 'bidfloor');
+  return floorInfo?.floor || getBannerBidParam(bid, 'bidfloor');
 }
 
 export function getVideoBidFloor(bid) {

diff --git a/libraries/currencyUtils/floor.js b/libraries/currencyUtils/floor.js
@@ -16,7 +16,7 @@ export function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (_) {
     return 0;
   }

diff --git a/libraries/dspxUtils/bidderUtils.js b/libraries/dspxUtils/bidderUtils.js
@@ -225,7 +225,7 @@ export function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (_) {
     return 0
   }

diff --git a/libraries/precisoUtils/bidUtilsCommon.js b/libraries/precisoUtils/bidUtilsCommon.js
@@ -37,7 +37,7 @@ export function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (_) {
     return 0
   }

diff --git a/libraries/riseUtils/index.js b/libraries/riseUtils/index.js
@@ -5,7 +5,8 @@ import {
   isEmpty,
   contains,
   isInteger,
-  getBidIdParameter
+  getBidIdParameter,
+  isPlainObject
 } from '../../src/utils.js';
 import { BANNER, VIDEO } from '../../src/mediaTypes.js';
 import {config} from '../../src/config.js';
@@ -19,7 +20,7 @@ export function getFloor(bid, mediaType) {
     mediaType: mediaType,
     size: '*'
   });
-  return floorResult.currency === 'USD' && floorResult.floor ? floorResult.floor : 0;
+  return isPlainObject(floorResult) && floorResult.currency === 'USD' && floorResult.floor ? floorResult.floor : 0;
 }
 
 export function getSizesArray(bid, mediaType) {

diff --git a/libraries/teqblazeUtils/bidderUtils.js b/libraries/teqblazeUtils/bidderUtils.js
@@ -29,7 +29,7 @@ const getBidFloor = (bid) => {
       size: '*',
     });
 
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (err) {
     return 0;
   }

diff --git a/libraries/vidazooUtils/bidderUtils.js b/libraries/vidazooUtils/bidderUtils.js
@@ -255,7 +255,7 @@ export function buildRequestData(bid, topWindowUrl, sizes, bidderRequest, bidder
       size: '*'
     });
 
-    if (floorInfo.currency === 'USD') {
+    if (floorInfo?.currency === 'USD') {
       bidFloor = floorInfo.floor;
     }
   }

diff --git a/libraries/xeUtils/bidderUtils.js b/libraries/xeUtils/bidderUtils.js
@@ -1,4 +1,4 @@
-import {deepAccess, getBidIdParameter, isFn, logError, isArray, parseSizesInput} from '../../src/utils.js';
+import {deepAccess, getBidIdParameter, isFn, logError, isArray, parseSizesInput, isPlainObject} from '../../src/utils.js';
 import {getAdUnitSizes} from '../sizeUtils/sizeUtils.js';
 import {findIndex} from '../../src/polyfill.js';
 
@@ -13,7 +13,7 @@ export function getBidFloor(bid, currency = 'USD') {
     size: '*'
   });
 
-  if (typeof floor === 'object' && !isNaN(floor.floor) && floor.currency === currency) {
+  if (isPlainObject(floor) && !isNaN(floor.floor) && floor.currency === currency) {
     return floor.floor;
   }
 

diff --git a/modules/33acrossBidAdapter.js b/modules/33acrossBidAdapter.js
@@ -535,7 +535,7 @@ function _getBidFloors(bidRequest, size, mediaType) {
     size: [ size.w, size.h ]
   });
 
-  if (!isNaN(bidFloors.floor) && (bidFloors.currency === CURRENCY)) {
+  if (!isNaN(bidFloors?.floor) && (bidFloors?.currency === CURRENCY)) {
     return bidFloors.floor;
   }
 }

diff --git a/modules/adagioBidAdapter.js b/modules/adagioBidAdapter.js
@@ -313,7 +313,7 @@ function _getFloors(bidRequest) {
     floors.push(cleanObj({
       mt: mediaType,
       s: isArray(size) ? `${size[0]}x${size[1]}` : undefined,
-      f: (!isNaN(info.floor) && info.currency === CURRENCY) ? info.floor : undefined
+      f: (!isNaN(info?.floor) && info?.currency === CURRENCY) ? info?.floor : undefined
     }));
   }
 

diff --git a/modules/adfBidAdapter.js b/modules/adfBidAdapter.js
@@ -75,8 +75,8 @@ export const spec = {
         mediaType: '*'
       }) : {};
 
-      const bidfloor = floorInfo.floor;
-      const bidfloorcur = floorInfo.currency;
+      const bidfloor = floorInfo?.floor;
+      const bidfloorcur = floorInfo?.currency;
       const { mid, inv, mname } = bid.params;
       const impExtData = bid.ortb2Imp?.ext?.data;
 

diff --git a/modules/admixerBidAdapter.js b/modules/admixerBidAdapter.js
@@ -133,7 +133,7 @@ function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (_) {
     return 0;
   }

diff --git a/modules/adotBidAdapter.js b/modules/adotBidAdapter.js
@@ -641,7 +641,7 @@ function getFloor(adUnit, size, mediaType, currency) {
 
   const floorResult = adUnit.getFloor({ currency, mediaType, size });
 
-  return floorResult.currency === currency ? floorResult.floor : 0;
+  return floorResult?.currency === currency ? floorResult?.floor : 0;
 }
 
 /**

diff --git a/modules/adriverBidAdapter.js b/modules/adriverBidAdapter.js
@@ -1,5 +1,5 @@
 // ADRIVER BID ADAPTER for Prebid 1.13
-import {logInfo, getWindowLocation, _each, getBidIdParameter} from '../src/utils.js';
+import {logInfo, getWindowLocation, _each, getBidIdParameter, isPlainObject} from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
 
@@ -188,12 +188,12 @@ function _getFloor(bid, currencyPar, sizes) {
       size: isSize ? sizes : '*'
     });
 
-    if (typeof floorInfo === 'object' &&
-      !isNaN(parseFloat(floorInfo.floor))) {
+    if (isPlainObject(floorInfo) &&
+      !isNaN(parseFloat(floorInfo?.floor))) {
       floor = floorInfo.floor;
     }
 
-    if (typeof floorInfo === 'object' && floorInfo.currency) {
+    if (isPlainObject(floorInfo) && floorInfo.currency) {
       currencyResult = floorInfo.currency;
     }
   }

diff --git a/modules/adtrgtmeBidAdapter.js b/modules/adtrgtmeBidAdapter.js
@@ -90,7 +90,7 @@ function getFloorModuleData(bid) {
     mediaType: BANNER,
     size: '*'
   };
-  return (isFn(bid.getFloor)) ? bid.getFloor(getFloorRequestObject) : false;
+  return (isFn(bid.getFloor)) ? (bid.getFloor(getFloorRequestObject) || {}) : false;
 };
 
 function generateOpenRtbObject(bidderRequest, bid) {

diff --git a/modules/adyoulikeBidAdapter.js b/modules/adyoulikeBidAdapter.js
@@ -255,7 +255,7 @@ function getFloor(bidRequest, size, mediaType) {
     size: [ size.width, size.height ]
   });
 
-  if (!isNaN(bidFloors.floor) && (bidFloors.currency === CURRENCY)) {
+  if (!isNaN(bidFloors?.floor) && (bidFloors?.currency === CURRENCY)) {
     return bidFloors.floor;
   }
 }

diff --git a/modules/amxBidAdapter.js b/modules/amxBidAdapter.js
@@ -142,7 +142,7 @@ function getFloor(bid) {
       size: '*',
       bidRequest: bid,
     });
-    return floor.floor;
+    return floor?.floor;
   } catch (e) {
     logError('call to getFloor failed: ', e);
     return DEFAULT_MIN_FLOOR;

diff --git a/modules/appushBidAdapter.js b/modules/appushBidAdapter.js
@@ -85,7 +85,7 @@ function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (err) {
     logError(err);
     return 0;

diff --git a/modules/audiencerunBidAdapter.js b/modules/audiencerunBidAdapter.js
@@ -47,7 +47,7 @@ function getBidFloor(bid) {
       mediaType: BANNER,
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (_) {
     return 0;
   }

diff --git a/modules/axonixBidAdapter.js b/modules/axonixBidAdapter.js
@@ -21,7 +21,7 @@ function getBidFloor(bidRequest) {
     });
   }
 
-  return floorInfo.floor || 0;
+  return floorInfo?.floor || 0;
 }
 
 function getPageUrl(bidRequest, bidderRequest) {

diff --git a/modules/beopBidAdapter.js b/modules/beopBidAdapter.js
@@ -3,6 +3,7 @@ import {
   deepAccess, getBidIdParameter,
   getValue,
   isArray,
+  isPlainObject,
   logInfo,
   logWarn,
   triggerPixel
@@ -147,7 +148,7 @@ function beOpRequestSlotsMaker(bid) {
   let floor;
   if (typeof bid.getFloor === 'function') {
     const floorInfo = bid.getFloor({currency: publisherCurrency, mediaType: 'banner', size: [1, 1]});
-    if (typeof floorInfo === 'object' && floorInfo.currency === publisherCurrency && !isNaN(parseFloat(floorInfo.floor))) {
+    if (isPlainObject(floorInfo) && floorInfo.currency === publisherCurrency && !isNaN(parseFloat(floorInfo.floor))) {
       floor = parseFloat(floorInfo.floor);
     }
   }

diff --git a/modules/brightMountainMediaBidAdapter.js b/modules/brightMountainMediaBidAdapter.js
@@ -1,4 +1,4 @@
-import { generateUUID, deepAccess, logWarn, deepSetValue } from '../src/utils.js';
+import { generateUUID, deepAccess, logWarn, deepSetValue, isPlainObject } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { BANNER, VIDEO } from '../src/mediaTypes.js';
 import { config } from '../src/config.js';
@@ -224,7 +224,7 @@ function getFloor(bid, size) {
       size: size,
     });
 
-    if (typeof floorInfo === 'object' && floorInfo.currency === 'USD') {
+    if (isPlainObject(floorInfo) && floorInfo.currency === 'USD') {
       return parseFloat(floorInfo.floor);
     }
   }

diff --git a/modules/c1xBidAdapter.js b/modules/c1xBidAdapter.js
@@ -185,7 +185,7 @@ function getBidFloor(bidRequest) {
   }
 
   let floor =
-    floorInfo.floor ||
+    floorInfo?.floor ||
     bidRequest.params.bidfloor ||
     bidRequest.params.floorPriceMap ||
     0;

diff --git a/modules/carodaBidAdapter.js b/modules/carodaBidAdapter.js
@@ -184,8 +184,8 @@ function getImps (validBidRequests, common) {
     const floorInfo = bid.getFloor
       ? bid.getFloor({ currency: common.currency || 'EUR' })
       : {};
-    const bidfloor = floorInfo.floor;
-    const bidfloorcur = floorInfo.currency;
+    const bidfloor = floorInfo?.floor;
+    const bidfloorcur = floorInfo?.currency;
     const { ctok, placementId } = bid.params;
     const imp = {
       bid_id: bid.bidId,

diff --git a/modules/connatixBidAdapter.js b/modules/connatixBidAdapter.js
@@ -57,7 +57,7 @@ export function getBidFloor(bid) {
       mediaType: '*',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (err) {
     logError(err);
     return 0;

diff --git a/modules/connectadBidAdapter.js b/modules/connectadBidAdapter.js
@@ -243,7 +243,7 @@ function getBidFloor(bidRequest) {
     });
   }
 
-  let floor = floorInfo.floor || bidRequest.params.bidfloor || bidRequest.params.floorprice || 0;
+  let floor = floorInfo?.floor || bidRequest.params.bidfloor || bidRequest.params.floorprice || 0;
 
   return floor;
 }

diff --git a/modules/dailyhuntBidAdapter.js b/modules/dailyhuntBidAdapter.js
@@ -129,7 +129,7 @@ const createOrtbPublisherObj = (validBidRequests) => ({ ...extractKeyInfo(validB
 // get bidFloor Function for different creatives
 function getBidFloor(bid, creative) {
   let floorInfo = typeof (bid.getFloor) == 'function' ? bid.getFloor({ currency: 'USD', mediaType: creative, size: '*' }) : {};
-  return Math.floor(floorInfo.floor || (bid.params.bidfloor ? bid.params.bidfloor : 0.0));
+  return Math.floor(floorInfo?.floor || (bid.params.bidfloor ? bid.params.bidfloor : 0.0));
 }
 
 const createOrtbImpObj = (bid) => {

diff --git a/modules/deltaprojectsBidAdapter.js b/modules/deltaprojectsBidAdapter.js
@@ -229,7 +229,7 @@ export function getBidFloor(bid, mediaType, size, currency) {
   if (isFn(bid.getFloor)) {
     const bidFloorCurrency = currency || 'USD';
     const bidFloor = bid.getFloor({currency: bidFloorCurrency, mediaType: mediaType, size: size});
-    if (isNumber(bidFloor.floor)) {
+    if (isNumber(bidFloor?.floor)) {
       return bidFloor;
     }
   }

diff --git a/modules/dianomiBidAdapter.js b/modules/dianomiBidAdapter.js
@@ -128,8 +128,8 @@ export const spec = {
           currency: currency || 'USD',
         })
         : {};
-      const bidfloor = floorInfo.floor;
-      const bidfloorcur = floorInfo.currency;
+      const bidfloor = floorInfo?.floor;
+      const bidfloorcur = floorInfo?.currency;
       const { smartadId } = bid.params;
 
       const imp = {

diff --git a/modules/eplanningBidAdapter.js b/modules/eplanningBidAdapter.js
@@ -274,7 +274,7 @@ function getFloorStr(bid) {
       currency: DOLLAR_CODE,
       mediaType: '*',
       size: '*'
-    });
+    }) || {};
 
     if (bidFloor.floor) {
       return '|' + encodeURIComponent(bidFloor.floor);

diff --git a/modules/freewheel-sspBidAdapter.js b/modules/freewheel-sspBidAdapter.js
@@ -231,7 +231,7 @@ function getBidFloor(bid, config) {
       mediaType: typeof bid.mediaTypes['banner'] == 'object' ? 'banner' : 'video',
       size: '*',
     });
-    return bidFloor.floor;
+    return bidFloor?.floor;
   } catch (e) {
     return -1;
   }

diff --git a/modules/getintentBidAdapter.js b/modules/getintentBidAdapter.js
@@ -152,7 +152,7 @@ function getBidFloor(bidRequest, currency) {
       currency: currency || DEFAULT_CURRENCY,
       mediaType: bidRequest.mediaType,
       size: bidRequest.sizes || '*'
-    });
+    }) || {};
   }
 
   return {

diff --git a/modules/gridBidAdapter.js b/modules/gridBidAdapter.js
@@ -7,7 +7,8 @@ import {
   mergeDeep,
   logWarn,
   isNumber,
-  isStr
+  isStr,
+  isPlainObject
 } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
@@ -508,7 +509,7 @@ function _getFloor (mediaTypes, bid) {
       size: bid.sizes.map(([w, h]) => ({w, h}))
     });
 
-    if (typeof floorInfo === 'object' &&
+    if (isPlainObject(floorInfo) &&
       floorInfo.currency === 'USD' &&
       !isNaN(parseFloat(floorInfo.floor))) {
       floor = Math.max(floor, parseFloat(floorInfo.floor));

diff --git a/modules/gumgumBidAdapter.js b/modules/gumgumBidAdapter.js
@@ -233,7 +233,7 @@ function _getFloor(mediaTypes, staticBidFloor, bid) {
     const { currency, floor } = bid.getFloor({
       mediaType: curMediaType,
       size: '*'
-    });
+    }) || {};
     floor && (bidFloor.floor = floor);
     currency && (bidFloor.currency = currency);
 

diff --git a/modules/impactifyBidAdapter.js b/modules/impactifyBidAdapter.js
@@ -1,6 +1,6 @@
 'use strict';
 
-import { deepAccess, deepSetValue, generateUUID } from '../src/utils.js';
+import { deepAccess, deepSetValue, generateUUID, isPlainObject } from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { ajax } from '../src/ajax.js';
@@ -98,7 +98,7 @@ const helpers = {
       mediaType: '*',
       size: '*'
     });
-    if (typeof floorInfo === 'object' && floorInfo.currency === DEFAULT_CURRENCY && !isNaN(parseFloat(floorInfo.floor))) {
+    if (isPlainObject(floorInfo) && floorInfo.currency === DEFAULT_CURRENCY && !isNaN(parseFloat(floorInfo.floor))) {
       return parseFloat(floorInfo.floor);
     }
     return null;

diff --git a/modules/kargoBidAdapter.js b/modules/kargoBidAdapter.js
@@ -1,4 +1,4 @@
-import { _each, isEmpty, buildUrl, deepAccess, pick, logError } from '../src/utils.js';
+import { _each, isEmpty, buildUrl, deepAccess, pick, logError, isPlainObject } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -526,7 +526,7 @@ function getImpression(bid) {
       } catch (e) {
         logError('Kargo: getFloor threw an error: ', e);
       }
-      imp.floor = typeof floorInfo === 'object' && floorInfo.currency === 'USD' && !isNaN(parseInt(floorInfo.floor)) ? floorInfo.floor : undefined;
+      imp.floor = isPlainObject(floorInfo) && floorInfo.currency === 'USD' && !isNaN(parseInt(floorInfo.floor)) ? floorInfo.floor : undefined;
     }
   }
-Original file line number
+Diff line change
@@ Expand Up / @@ -641,7 +641,7 @@ function getFloor(adUnit, size, mediaType, currency) { @@
       const floorResult = adUnit.getFloor({ currency, mediaType, size });
-      return floorResult.currency === currency ? floorResult.floor : 0;
+      return floorResult?.currency === currency ? floorResult?.floor : 0;
     }
     /**
@@ Expand Down @@