Update floors module for #5511

modules/priceFloors.js

@@ -286,9 +286,9 @@ export function updateAdUnitsForAuction(adUnits, floorData, auctionId) {
  bid.auctionId = auctionId;
  bid.floorData = {
  skipped: floorData.skipped,
- modelVersion: utils.deepAccess(floorData, 'data.modelVersion'),
- location: utils.deepAccess(floorData, 'data.location'),
  skipRate: floorData.skipRate,
+ modelVersion: utils.deepAccess(floorData, 'data.modelVersion'),
+ location: utils.deepAccess(floorData, 'data.location', 'noData'),
  fetchStatus: _floorsConfig.fetchStatus
  }
  });
@@ -568,8 +568,9 @@ export function handleSetFloorsConfig(config) {
  _floorsConfig = utils.pick(config, [
  'enabled', enabled => enabled !== false, // defaults to true
  'auctionDelay', auctionDelay => auctionDelay || 0,
+ 'floorProvider', floorProvider => String(floorProvider) || '',
  'endpoint', endpoint => endpoint || {},
- 'skipRate', () => !isNaN(utils.deepAccess(config, 'data.skipRate')) ? config.data.skipRate : config.skipRate || 0,
+ 'skipRate', () => !isNaN(utils.deepAccess(config, 'data.skipRate')) ? config.data.skipRate : config.skipRate || undefined,
  'enforcement', enforcement => utils.pick(enforcement || {}, [
  'enforceJS', enforceJS => enforceJS !== false, // defaults to true
  'enforcePBS', enforcePBS => enforcePBS === true, // defaults to false

modules/priceFloors.md

@@ -11,6 +11,7 @@ pbjs.setConfig({
  enforceJS: true //defaults to true
  },
  auctionDelay: 150, // in milliseconds defaults to 0
+ floorProvider: '', //defaults to en empty string
  endpoint: {
  url: 'http://localhost:1500/floor-domains',
  method: 'GET' // Only get supported for now
@@ -40,6 +41,7 @@ pbjs.setConfig({
 | enabled | Wether to turn off or on the floors module |
 | enforcement | object of booleans which control certain features of the module |
 | auctionDelay | The time to suspend and auction while waiting for a real time price floors fetch to come back |
+| floorProvider | A string identifying the floor provider.|
 | endpoint | An object describing the endpoint to retrieve floor data from. GET only |
 | data | The data to be used to select appropriate floors. See schema for more detail |
 | additionalSchemaFields | An object of additional fields to be used in a floor data object. The schema is KEY: function to retrieve the match |
@@ -59,4 +61,4 @@ This function can takes in an object with the following optional parameters:
 
 If a bid adapter passes in `*` as an attribute, then the `priceFloors` module will attempt to select the best rule based on context.
 
-For example, if an adapter passes in a `*`, but the bidRequest only has a single size and a single mediaType, then the `getFloor` function will attempt to get a rule for that size before matching with the `*` catch-all. Similarily, if mediaType can be inferred on the bidRequest, it will use it.
+For example, if an adapter passes in a `*`, but the bidRequest only has a single size and a single mediaType, then the `getFloor` function will attempt to get a rule for that size before matching with the `*` catch-all. Similarily, if mediaType can be inferred on the bidRequest, it will use it.

test/spec/modules/priceFloors_spec.js

@@ -37,6 +37,7 @@ describe('the price floors module', function () {
  const basicFloorConfig = {
  enabled: true,
  auctionDelay: 0,
+ floorProvider: '',
  endpoint: {},
  enforcement: {
  enforceJS: true,
@@ -314,8 +315,8 @@ describe('the price floors module', function () {
  validateBidRequests(false, {
  skipped: true,
  modelVersion: undefined,
- location: undefined,
- skipRate: 0,
+ location: 'noData',
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -347,7 +348,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'adUnit Model Version',
  location: 'adUnit',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -358,7 +359,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -403,7 +404,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -464,7 +465,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'model-1',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
 
@@ -475,7 +476,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'model-2',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
 
@@ -486,7 +487,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'model-3',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -513,7 +514,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: undefined
  });
  });
@@ -590,7 +591,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: 'timeout'
  });
  fakeFloorProvider.respond();
@@ -626,7 +627,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'fetch model name',
  location: 'fetch',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: 'success'
  });
  });
@@ -684,7 +685,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: 'error'
  });
  });
@@ -706,7 +707,7 @@ describe('the price floors module', function () {
  skipped: false,
  modelVersion: 'basic model',
  location: 'setConfig',
- skipRate: 0,
+ skipRate: undefined,
  fetchStatus: 'success'
  });
  });