prebid.js 7.23.0 → 7.24.0

package/modules/permutiveRtdProvider.md

@@ -45,17 +45,52 @@ as well as enabling settings for specific use cases mentioned above (e.g. acbidd
 | params.acBidders       | String[] | An array of bidders which should receive AC cohorts.                                          | `[]`    |
 | params.maxSegs         | Integer  | Maximum number of cohorts to be included in either the `permutive` or `p_standard` key-value. | `500`   |
 | params.transformations | Object[] | An array of configurations for ORTB2 user data transformations                                |         |
+| params.overwrites      | Object   | An object specifying functions for custom targeting logic for bidders.                        | -       |
 
 ##### The `transformations` parameter
 
 This array contains configurations for transformations we'll apply to the Permutive object in the ORTB2 `user.data` array. The results of these transformations will be appended to the `user.data` array that's attached to ORTB2 bid requests.
 
-##### Supported transformations
+###### Supported transformations
 
 | Name           | ID  | Config structure                                  | Description                                                                          |
 |----------------|-----|---------------------------------------------------|--------------------------------------------------------------------------------------|
 | IAB taxonomies | iab | { segtax: number, iabIds: Object<number, number>} | Transform segment IDs from Permutive to IAB (note: alpha version, subject to change) |
 
+##### The `overwrites` parameter
+
+The keys for this object should match a bidder (e.g. `rubicon`), which then can define a function to overwrite the customer targeting logic.
+
+```javascript
+{
+  params: {
+    overwrites: {
+      rubicon: function customTargeting(bid, data, acEnabled, utils, defaultFn) {
+        if (defaultFn) {
+          bid = defaultFn(bid, data, acEnabled)
+        }
+        if (data.gam && data.gam.length) {
+          utils.deepSetValue(bid, 'params.visitor.permutive', data.gam)
+        }
+      } 
+    }
+  }
+}
+```
+
+###### `customTargeting` function parameters
+
+| Name         | Description                                                                    |
+|--------------|--------------------------------------------------------------------------------|
+| `bid`        | The bid request object.                                                        |
+| `data`       | Permutive's targeting data read from localStorage.                             |
+| `acEnabled`  | Boolean stating whether Audience Connect is enabled via `acBidders`.           |
+| `utils`      | An object of helpful utilities. `(deepSetValue, deepAccess, isFn, mergeDeep)`. |
+| `defaultFn`  | The default targeting function.                                                |
+
+
+
+
 #### Context
 
 Permutive is not listed as a TCF vendor as all data collection is on behalf of the publisher and based on consent the publisher has received from the user.

package/modules/pubmaticBidAdapter.js

@@ -392,37 +392,29 @@ function _createNativeRequest(params) {
             }
             break;
           case NATIVE_ASSETS.IMAGE.KEY:
-            if (params[key].sizes && params[key].sizes.length > 0) {
-              assetObj = {
-                id: NATIVE_ASSETS.IMAGE.ID,
-                required: params[key].required ? 1 : 0,
-                img: {
-                  type: NATIVE_ASSET_IMAGE_TYPE.IMAGE,
-                  w: params[key].w || params[key].width || (params[key].sizes ? params[key].sizes[0] : UNDEFINED),
-                  h: params[key].h || params[key].height || (params[key].sizes ? params[key].sizes[1] : UNDEFINED),
-                  wmin: params[key].wmin || params[key].minimumWidth || (params[key].minsizes ? params[key].minsizes[0] : UNDEFINED),
-                  hmin: params[key].hmin || params[key].minimumHeight || (params[key].minsizes ? params[key].minsizes[1] : UNDEFINED),
-                  mimes: params[key].mimes,
-                  ext: params[key].ext,
-                }
-              };
-            } else {
-              logWarn(LOG_WARN_PREFIX + 'Error: Image sizes is required for native ad: ' + JSON.stringify(params));
-            }
+            assetObj = {
+              id: NATIVE_ASSETS.IMAGE.ID,
+              required: params[key].required ? 1 : 0,
+              img: {
+                type: NATIVE_ASSET_IMAGE_TYPE.IMAGE,
+                w: params[key].w || params[key].width || (params[key].sizes ? params[key].sizes[0] : UNDEFINED),
+                h: params[key].h || params[key].height || (params[key].sizes ? params[key].sizes[1] : UNDEFINED),
+                wmin: params[key].wmin || params[key].minimumWidth || (params[key].minsizes ? params[key].minsizes[0] : UNDEFINED),
+                hmin: params[key].hmin || params[key].minimumHeight || (params[key].minsizes ? params[key].minsizes[1] : UNDEFINED),
+                mimes: params[key].mimes,
+                ext: params[key].ext,
+              }
+            };
             break;
           case NATIVE_ASSETS.ICON.KEY:
-            if (params[key].sizes && params[key].sizes.length > 0) {
-              assetObj = {
-                id: NATIVE_ASSETS.ICON.ID,
-                required: params[key].required ? 1 : 0,
-                img: {
-                  type: NATIVE_ASSET_IMAGE_TYPE.ICON,
-                  w: params[key].w || params[key].width || (params[key].sizes ? params[key].sizes[0] : UNDEFINED),
-                  h: params[key].h || params[key].height || (params[key].sizes ? params[key].sizes[1] : UNDEFINED),
-                }
-              };
-            } else {
-              logWarn(LOG_WARN_PREFIX + 'Error: Icon sizes is required for native ad: ' + JSON.stringify(params));
+            assetObj = {
+              id: NATIVE_ASSETS.ICON.ID,
+              required: params[key].required ? 1 : 0,
+              img: {
+                type: NATIVE_ASSET_IMAGE_TYPE.ICON,
+                w: params[key].w || params[key].width || (params[key].sizes ? params[key].sizes[0] : UNDEFINED),
+                h: params[key].h || params[key].height || (params[key].sizes ? params[key].sizes[1] : UNDEFINED),
+              }
             };
             break;
           case NATIVE_ASSETS.VIDEO.KEY:

package/modules/tripleliftBidAdapter.js

@@ -29,7 +29,7 @@ export const tripleliftAdapterSpec = {
     tlCall = tryAppendQueryString(tlCall, 'v', '$prebid.version$');
 
     if (bidderRequest && bidderRequest.refererInfo) {
-      let referrer = bidderRequest.refererInfo.page;
+      let referrer = bidderRequest?.refererInfo?.topmostLocation || bidderRequest?.refererInfo?.page;
       tlCall = tryAppendQueryString(tlCall, 'referrer', referrer);
     }
 

package/modules/userId/eids.js

@@ -88,13 +88,13 @@ export const USER_IDS_CONFIG = {
     atype: 1,
     getValue: function(data) {
       let value = '';
-      if (data.DeviceID) {
-        value = data.DeviceID.join(',');
+      if (data && data.ext && data.ext.DeviceID) {
+        value = data.ext.DeviceID;
       }
       return value;
     },
     getUidExt: function(data) {
-      return 'DeviceID';
+      return data && data.ext;
     }
   },
 
@@ -418,13 +418,6 @@ export function createEidsArray(bidRequestUserId) {
     if (bidRequestUserId.hasOwnProperty(subModuleKey)) {
       if (subModuleKey === 'pubProvidedId') {
         eids = eids.concat(bidRequestUserId['pubProvidedId']);
-      } else if (subModuleKey === 'ftrackId') {
-        // Schema based on the return value of ftrack decode() method
-        eids.push({
-          atype: 1,
-          ext: bidRequestUserId.ftrackId.ext,
-          id: bidRequestUserId.ftrackId.uid
-        });
       } else if (Array.isArray(bidRequestUserId[subModuleKey])) {
         bidRequestUserId[subModuleKey].forEach((config, index, arr) => {
           const eid = createEidObject(config, subModuleKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.23.0",
+  "version": "7.24.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {
@@ -35,13 +35,13 @@
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.16.5",
-    "@wdio/browserstack-service": "^7.16.0",
-    "@wdio/cli": "^7.5.2",
-    "@wdio/concise-reporter": "^7.5.2",
-    "@wdio/local-runner": "^7.5.2",
-    "@wdio/mocha-framework": "^7.5.2",
-    "@wdio/spec-reporter": "^7.19.0",
-    "@wdio/sync": "^7.5.2",
+    "@wdio/browserstack-service": "~7.16.0",
+    "@wdio/cli": "~7.5.2",
+    "@wdio/concise-reporter": "~7.5.2",
+    "@wdio/local-runner": "~7.5.2",
+    "@wdio/mocha-framework": "~7.5.2",
+    "@wdio/spec-reporter": "~7.19.0",
+    "@wdio/sync": "~7.5.2",
     "ajv": "6.12.3",
     "assert": "^2.0.0",
     "babel-loader": "^8.0.5",

package/src/adRendering.js

@@ -23,7 +23,7 @@ export function emitAdRenderFail({ reason, message, bid, id }) {
 
 /**
  * Emit the AD_RENDER_SUCCEEDED event.
- *
+ * (Note: Invocation of this function indicates that the render function did not generate an error, it does not guarantee that tracking for this event has occurred yet.)
  * @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

package/src/adloader.js

@@ -6,6 +6,7 @@ const _requestCache = new WeakMap();
 const _approvedLoadExternalJSList = [
   'debugging',
   'adloox',
+  'admatic',
   'criteo',
   'outstream',
   'adagio',

package/src/auction.js

@@ -475,7 +475,7 @@ export function auctionCallbacks(auctionDone, auctionInstance, {index = auctionM
     return handleBidResponse(adUnitCode, bid, (done) => {
       // return a "NO_BID" replacement that the caller can decide to continue with
       // TODO: remove this in v8; see https://github.com/prebid/Prebid.js/issues/8956
-      const noBid = createBid(CONSTANTS.STATUS.NO_BID, bid.getIdentifiers());
+      const noBid = createBid(CONSTANTS.STATUS.NO_BID, bid.getIdentifiers?.());
       Object.assign(noBid, Object.fromEntries(Object.entries(bid).filter(([k]) => !noBid.hasOwnProperty(k) && ![
         'ad',
         'adUrl',

package/src/prebid.js

@@ -49,6 +49,7 @@ import {default as adapterManager, gdprDataHandler, getS2SBidderSet, uspDataHand
 import CONSTANTS from './constants.json';
 import * as events from './events.js';
 import {newMetrics, useMetrics} from './utils/perfMetrics.js';
+import {defer} from './utils/promise.js';
 
 const $$PREBID_GLOBAL$$ = getGlobal();
 const { triggerUserSyncs } = userSync;
@@ -622,7 +623,7 @@ $$PREBID_GLOBAL$$.removeAdUnit = function (adUnitCode) {
  * @alias module:pbjs.requestBids
  */
 $$PREBID_GLOBAL$$.requestBids = (function() {
-  const delegate = hook('sync', function ({ bidsBackHandler, timeout, adUnits, adUnitCodes, labels, auctionId, ttlBuffer, ortb2, metrics } = {}) {
+  const delegate = hook('async', function ({ bidsBackHandler, timeout, adUnits, adUnitCodes, labels, auctionId, ttlBuffer, ortb2, metrics, defer } = {}) {
     events.emit(REQUEST_BIDS);
     const cbTimeout = timeout || config.getConfig('bidderTimeout');
     logInfo('Invoking $$PREBID_GLOBAL$$.requestBids', arguments);
@@ -630,23 +631,28 @@ $$PREBID_GLOBAL$$.requestBids = (function() {
       global: mergeDeep({}, config.getAnyConfig('ortb2') || {}, ortb2 || {}),
       bidder: Object.fromEntries(Object.entries(config.getBidderConfig()).map(([bidder, cfg]) => [bidder, cfg.ortb2]).filter(([_, ortb2]) => ortb2 != null))
     }
-    return startAuction({bidsBackHandler, timeout: cbTimeout, adUnits, adUnitCodes, labels, auctionId, ttlBuffer, ortb2Fragments, metrics});
+    return startAuction({bidsBackHandler, timeout: cbTimeout, adUnits, adUnitCodes, labels, auctionId, ttlBuffer, ortb2Fragments, metrics, defer});
   }, 'requestBids');
 
   return wrapHook(delegate, function requestBids(req = {}) {
-    // if the request does not specify adUnits, clone the global adUnit array - before
-    // any hook has a chance to run.
+    // unlike the main body of `delegate`, this runs before any other hook has a chance to;
+    // it's also not restricted in its return value in the way `async` hooks are.
+
+    // if the request does not specify adUnits, clone the global adUnit array;
     // otherwise, if the caller goes on to use addAdUnits/removeAdUnits, any asynchronous logic
     // in any hook might see their effects.
-    req.metrics = newMetrics();
-    req.metrics.checkpoint('requestBids');
     let adUnits = req.adUnits || $$PREBID_GLOBAL$$.adUnits;
     req.adUnits = (isArray(adUnits) ? adUnits.slice() : [adUnits]);
-    return delegate.call(this, req);
+
+    req.metrics = newMetrics();
+    req.metrics.checkpoint('requestBids');
+    req.defer = defer({promiseFactory: (r) => new Promise(r)})
+    delegate.call(this, req);
+    return req.defer.promise;
   });
 })();
 
-export const startAuction = hook('sync', function ({ bidsBackHandler, timeout: cbTimeout, adUnits, ttlBuffer, adUnitCodes, labels, auctionId, ortb2Fragments, metrics } = {}) {
+export const startAuction = hook('async', function ({ bidsBackHandler, timeout: cbTimeout, adUnits, ttlBuffer, adUnitCodes, labels, auctionId, ortb2Fragments, metrics, defer } = {}) {
   const s2sBidders = getS2SBidderSet(config.getConfig('s2sConfig') || []);
   adUnits = useMetrics(metrics).measureTime('requestBids.validate', () => checkAdUnitSetup(adUnits));
 
@@ -658,85 +664,83 @@ export const startAuction = hook('sync', function ({ bidsBackHandler, timeout: c
     adUnitCodes = adUnits && adUnits.map(unit => unit.code);
   }
 
-  return new Promise((resolve) => {
-    function auctionDone(bids, timedOut, auctionId) {
-      if (typeof bidsBackHandler === 'function') {
-        try {
-          bidsBackHandler(bids, timedOut, auctionId);
-        } catch (e) {
-          logError('Error executing bidsBackHandler', null, e);
-        }
+  function auctionDone(bids, timedOut, auctionId) {
+    if (typeof bidsBackHandler === 'function') {
+      try {
+        bidsBackHandler(bids, timedOut, auctionId);
+      } catch (e) {
+        logError('Error executing bidsBackHandler', null, e);
       }
-      resolve({bids, timedOut, auctionId});
     }
+    defer.resolve({bids, timedOut, auctionId})
+  }
+
+  /*
+   * for a given adunit which supports a set of mediaTypes
+   * and a given bidder which supports a set of mediaTypes
+   * a bidder is eligible to participate on the adunit
+   * if it supports at least one of the mediaTypes on the adunit
+   */
+  adUnits.forEach(adUnit => {
+    // get the adunit's mediaTypes, defaulting to banner if mediaTypes isn't present
+    const adUnitMediaTypes = Object.keys(adUnit.mediaTypes || { 'banner': 'banner' });
 
-    /*
-     * for a given adunit which supports a set of mediaTypes
-     * and a given bidder which supports a set of mediaTypes
-     * a bidder is eligible to participate on the adunit
-     * if it supports at least one of the mediaTypes on the adunit
-     */
-    adUnits.forEach(adUnit => {
-      // get the adunit's mediaTypes, defaulting to banner if mediaTypes isn't present
-      const adUnitMediaTypes = Object.keys(adUnit.mediaTypes || { 'banner': 'banner' });
-
-      // get the bidder's mediaTypes
-      const allBidders = adUnit.bids.map(bid => bid.bidder);
-      const bidderRegistry = adapterManager.bidderRegistry;
-
-      const bidders = allBidders.filter(bidder => !s2sBidders.has(bidder));
-
-      const tid = adUnit.ortb2Imp?.ext?.tid || generateUUID();
-      adUnit.transactionId = tid;
-      if (ttlBuffer != null && !adUnit.hasOwnProperty('ttlBuffer')) {
-        adUnit.ttlBuffer = ttlBuffer;
+    // get the bidder's mediaTypes
+    const allBidders = adUnit.bids.map(bid => bid.bidder);
+    const bidderRegistry = adapterManager.bidderRegistry;
+
+    const bidders = allBidders.filter(bidder => !s2sBidders.has(bidder));
+
+    const tid = adUnit.ortb2Imp?.ext?.tid || generateUUID();
+    adUnit.transactionId = tid;
+    if (ttlBuffer != null && !adUnit.hasOwnProperty('ttlBuffer')) {
+      adUnit.ttlBuffer = ttlBuffer;
+    }
+    // Populate ortb2Imp.ext.tid with transactionId. Specifying a transaction ID per item in the ortb impression array, lets multiple transaction IDs be transmitted in a single bid request.
+    deepSetValue(adUnit, 'ortb2Imp.ext.tid', tid);
+
+    bidders.forEach(bidder => {
+      const adapter = bidderRegistry[bidder];
+      const spec = adapter && adapter.getSpec && adapter.getSpec();
+      // banner is default if not specified in spec
+      const bidderMediaTypes = (spec && spec.supportedMediaTypes) || ['banner'];
+
+      // check if the bidder's mediaTypes are not in the adUnit's mediaTypes
+      const bidderEligible = adUnitMediaTypes.some(type => includes(bidderMediaTypes, type));
+      if (!bidderEligible) {
+        // drop the bidder from the ad unit if it's not compatible
+        logWarn(unsupportedBidderMessage(adUnit, bidder));
+        adUnit.bids = adUnit.bids.filter(bid => bid.bidder !== bidder);
+      } else {
+        adunitCounter.incrementBidderRequestsCounter(adUnit.code, bidder);
       }
-      // Populate ortb2Imp.ext.tid with transactionId. Specifying a transaction ID per item in the ortb impression array, lets multiple transaction IDs be transmitted in a single bid request.
-      deepSetValue(adUnit, 'ortb2Imp.ext.tid', tid);
-
-      bidders.forEach(bidder => {
-        const adapter = bidderRegistry[bidder];
-        const spec = adapter && adapter.getSpec && adapter.getSpec();
-        // banner is default if not specified in spec
-        const bidderMediaTypes = (spec && spec.supportedMediaTypes) || ['banner'];
-
-        // check if the bidder's mediaTypes are not in the adUnit's mediaTypes
-        const bidderEligible = adUnitMediaTypes.some(type => includes(bidderMediaTypes, type));
-        if (!bidderEligible) {
-          // drop the bidder from the ad unit if it's not compatible
-          logWarn(unsupportedBidderMessage(adUnit, bidder));
-          adUnit.bids = adUnit.bids.filter(bid => bid.bidder !== bidder);
-        } else {
-          adunitCounter.incrementBidderRequestsCounter(adUnit.code, bidder);
-        }
-      });
-      adunitCounter.incrementRequestsCounter(adUnit.code);
     });
+    adunitCounter.incrementRequestsCounter(adUnit.code);
+  });
 
-    if (!adUnits || adUnits.length === 0) {
-      logMessage('No adUnits configured. No bids requested.');
-      auctionDone();
-    } else {
-      const auction = auctionManager.createAuction({
-        adUnits,
-        adUnitCodes,
-        callback: auctionDone,
-        cbTimeout,
-        labels,
-        auctionId,
-        ortb2Fragments,
-        metrics,
-      });
-
-      let adUnitsLen = adUnits.length;
-      if (adUnitsLen > 15) {
-        logInfo(`Current auction ${auction.getAuctionId()} contains ${adUnitsLen} adUnits.`, adUnits);
-      }
+  if (!adUnits || adUnits.length === 0) {
+    logMessage('No adUnits configured. No bids requested.');
+    auctionDone();
+  } else {
+    const auction = auctionManager.createAuction({
+      adUnits,
+      adUnitCodes,
+      callback: auctionDone,
+      cbTimeout,
+      labels,
+      auctionId,
+      ortb2Fragments,
+      metrics,
+    });
 
-      adUnitCodes.forEach(code => targeting.setLatestAuctionForAdUnit(code, auction.getAuctionId()));
-      auction.callBids();
+    let adUnitsLen = adUnits.length;
+    if (adUnitsLen > 15) {
+      logInfo(`Current auction ${auction.getAuctionId()} contains ${adUnitsLen} adUnits.`, adUnits);
     }
-  });
+
+    adUnitCodes.forEach(code => targeting.setLatestAuctionForAdUnit(code, auction.getAuctionId()));
+    auction.callBids();
+  }
 }, 'startAuction');
 
 export function executeCallbacks(fn, reqBidsConfigObj) {

package/test/spec/auctionmanager_spec.js

@@ -1641,6 +1641,15 @@ describe('auctionmanager.js', function () {
         });
       });
 
+      it('should return NO_BID replacement when rejected bid is not a "proper" bid', () => {
+        const noBid = cbs.addBidResponse.reject(AU_CODE, {});
+        sinon.assert.match(noBid, {
+          status: CONSTANTS.BID_STATUS.BID_REJECTED,
+          statusMessage: 'Bid returned empty or error response',
+          cpm: 0,
+        });
+      })
+
       it('addBidResponse hooks should not be able to reject the same bid twice', () => {
         cbs.addBidResponse(AU_CODE, bid);
         expect(auction.addBidRejected.calledOnce).to.be.true;

package/test/spec/modules/admaticBidAdapter_spec.js

@@ -0,0 +1,46 @@
+import {expect} from 'chai';
+import {spec, storage} from 'modules/admaticBidAdapter.js';
+import {newBidder} from 'src/adapters/bidderFactory.js';
+import {getStorageManager} from 'src/storageManager';
+
+const ENDPOINT = 'https://layer.serve.admatic.com.tr/v1';
+
+describe('admaticBidAdapter', () => {
+  const adapter = newBidder(spec);
+
+  describe('inherited functions', () => {
+    it('exists and is a function', () => {
+      expect(adapter.callBids).to.exist.and.to.be.a('function');
+    });
+  });
+
+  describe('isBidRequestValid', function() {
+    let bid = {
+      'bidder': 'admatic',
+      'params': {
+        'networkId': 10433394
+      },
+      'adUnitCode': 'adunit-code',
+      'sizes': [[300, 250], [300, 600]],
+      'bidId': '30b31c1838de1e',
+      'bidderRequestId': '22edbae2733bf6',
+      'auctionId': '1d1a030790a475',
+      'creativeId': 'er2ee'
+    };
+
+    it('should return true when required params found', function() {
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
+    });
+
+    it('should return false when required params are not passed', function() {
+      let bid = Object.assign({}, bid);
+      delete bid.params;
+
+      bid.params = {
+        'networkId': 0
+      };
+
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
+  });
+});