prebid.js 7.26.0 → 7.28.0

package/modules/yandexBidAdapter.md

@@ -12,10 +12,11 @@ Yandex Bidder Adapter for Prebid.js.
 
 # Parameters
 
-| Name          | Scope    | Description             | Example   | Type      |
-|---------------|----------|-------------------------|-----------|-----------|
-| `pageId`      | required | Page ID                 | `123`     | `Integer` |
-| `impId`       | required | Block ID                | `1`       | `Integer` |
+| Name          | Required?                                  | Description | Example | Type      |
+|---------------|--------------------------------------------|-------------|---------|-----------|
+| `placementId` | Yes                                        | Block ID    | `123-1` | `String`  |
+| `pageId`      | No<br>Deprecated. Please use `placementId` | Page ID     | `123`   | `Integer` |
+| `impId`       | No<br>Deprecated. Please use `placementId` | Imp ID      | `1`     | `Integer` |
 
 # Test Parameters
 
@@ -24,15 +25,14 @@ var adUnits = [{
   code: 'banner-1',
   mediaTypes: {
     banner: {
-      sizes: [[240, 400]],
+      sizes: [[240, 400], [300, 600]],
     }
   },
   bids: [{
     {
       bidder: 'yandex',
       params: {
-        pageId: 346580,
-        impId: 143,
+        placementId: '346580-1'
       },
     }
   }]

package/modules/yieldlabBidAdapter.js

@@ -41,6 +41,7 @@ export const spec = {
 
     const adslotIds = []
     const adslotSizes = [];
+    const adslotFloors = [];
     const timestamp = Date.now()
     const query = {
       ts: timestamp,
@@ -77,7 +78,7 @@ export const spec = {
       }
       const floor = getBidFloor(bid, sizes)
       if (floor) {
-        query.floor = floor;
+        adslotFloors.push(bid.params.adslotId + ':' + floor);
       }
     })
 
@@ -99,6 +100,11 @@ export const spec = {
     if (adslotSizes.length > 0) {
       query.sizes = adslotSizes.join(',')
     }
+
+    if (adslotFloors.length > 0) {
+      query.floor = adslotFloors.join(',')
+    }
+
     const queryString = createQueryString(query)
 
     return {
@@ -463,7 +469,7 @@ function extractSizes(bid) {
  *
  * @param {Object} bid
  * @param {string[]} sizes
- * @returns The floor CPM of a matched rule based on the rule selection process (mediaType, size and currency),
+ * @returns The floor CPM in cents of a matched rule based on the rule selection process (mediaType, size and currency),
  *          using the getFloor() inputs. Multi sizes and unsupported media types will default to '*'
  */
 function getBidFloor(bid, sizes) {
@@ -475,10 +481,10 @@ function getBidFloor(bid, sizes) {
   const floor = bid.getFloor({
     currency: CURRENCY_CODE,
     mediaType: mediaType !== undefined && spec.supportedMediaTypes.includes(mediaType) ? mediaType : '*',
-    size: sizes.length !== 1 ? '*' : extractSizes(sizes)
+    size: sizes.length !== 1 ? '*' : sizes[0].split(DIMENSION_SIGN)
   });
   if (floor.currency === CURRENCY_CODE) {
-    return floor.floor;
+    return (floor.floor * 100).toFixed(0);
   }
   return undefined;
 }

package/modules/yieldliftBidAdapter.js

@@ -2,9 +2,9 @@ import {deepSetValue, logInfo, deepAccess} from '../src/utils.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {BANNER} from '../src/mediaTypes.js';
 
-const ENDPOINT_URL = 'https://x.yieldlift.com/auction';
+const ENDPOINT_URL = 'https://x.yieldlift.com/pbjs';
 
-const DEFAULT_BID_TTL = 30;
+const DEFAULT_BID_TTL = 300;
 const DEFAULT_CURRENCY = 'USD';
 const DEFAULT_NET_REVENUE = true;
 
@@ -98,7 +98,7 @@ export const spec = {
           width: bid.w,
           height: bid.h,
           ad: bid.adm,
-          ttl: DEFAULT_BID_TTL,
+          ttl: typeof bid.exp === 'number' ? bid.exp : DEFAULT_BID_TTL,
           creativeId: bid.crid,
           netRevenue: DEFAULT_NET_REVENUE,
           currency: DEFAULT_CURRENCY,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.26.0",
+  "version": "7.28.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {
@@ -130,7 +130,7 @@
     "express": "^4.15.4",
     "fun-hooks": "^0.9.9",
     "just-clone": "^1.0.2",
-    "live-connect-js": "2.4.0"
+    "live-connect-js": "3.0.1"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.2"

package/src/auction.js

@@ -76,7 +76,7 @@ import {
   timestamp
 } from './utils.js';
 import {getPriceBucketString} from './cpmBucketManager.js';
-import {getNativeTargeting} from './native.js';
+import {getNativeTargeting, toLegacyResponse} from './native.js';
 import {getCacheUrl, store} from './videoCache.js';
 import {Renderer} from './Renderer.js';
 import {config} from './config.js';
@@ -462,9 +462,14 @@ export function auctionCallbacks(auctionDone, auctionInstance, {index = auctionM
     handleBidResponse(adUnitCode, bid, (done) => {
       let bidResponse = getPreparedBidForAuction(bid);
 
-      if (bidResponse.mediaType === 'video') {
+      if (bidResponse.mediaType === VIDEO) {
         tryAddVideoBid(auctionInstance, bidResponse, done);
       } else {
+        if (FEATURES.NATIVE && bidResponse.native != null && typeof bidResponse.native === 'object') {
+          // NOTE: augment bidResponse.native even if bidResponse.mediaType !== NATIVE; it's possible
+          // to treat banner responses as native
+          addLegacyFieldsIfNeeded(bidResponse);
+        }
         addBidToAuction(auctionInstance, bidResponse);
         done();
       }
@@ -593,6 +598,17 @@ function tryAddVideoBid(auctionInstance, bidResponse, afterBidAdded, {index = au
   }
 }
 
+// Native bid response might be in ortb2 format - adds legacy field for backward compatibility
+const addLegacyFieldsIfNeeded = (bidResponse) => {
+  const nativeOrtbRequest = auctionManager.index.getAdUnit(bidResponse)?.nativeOrtbRequest;
+  const nativeOrtbResponse = bidResponse.native?.ortb
+
+  if (nativeOrtbRequest && nativeOrtbResponse) {
+    const legacyResponse = toLegacyResponse(nativeOrtbResponse, nativeOrtbRequest);
+    Object.assign(bidResponse.native, legacyResponse);
+  }
+}
+
 const storeInCache = (batch) => {
   store(batch.map(entry => entry.bidResponse), function (error, cacheIds) {
     cacheIds.forEach((cacheId, i) => {
@@ -672,7 +688,7 @@ function addCommonResponseProperties(bidResponse, adUnitCode, {index = auctionMa
   Object.assign(bidResponse, {
     responseTimestamp: bidResponse.responseTimestamp || timestamp(),
     requestTimestamp: bidResponse.requestTimestamp || start,
-    cpm: bidResponse.cpm || parseFloat(bidResponse.cpm) || 0,
+    cpm: parseFloat(bidResponse.cpm) || 0,
     bidder: bidResponse.bidder || bidResponse.bidderCode,
     adUnitCode
   });
@@ -812,6 +828,16 @@ export const getAdvertiserDomain = () => {
   }
 }
 
+/**
+ * This function returns a function to get the primary category id from bid response meta
+ * @returns {function}
+ */
+export const getPrimaryCatId = () => {
+  return (bid) => {
+    return (bid.meta && bid.meta.primaryCatId) ? bid.meta.primaryCatId : '';
+  }
+}
+
 // factory for key value objs
 function createKeyVal(key, value) {
   return {
@@ -837,6 +863,7 @@ function defaultAdserverTargeting() {
     createKeyVal(TARGETING_KEYS.SOURCE, 'source'),
     createKeyVal(TARGETING_KEYS.FORMAT, 'mediaType'),
     createKeyVal(TARGETING_KEYS.ADOMAIN, getAdvertiserDomain()),
+    createKeyVal(TARGETING_KEYS.ACAT, getPrimaryCatId()),
   ]
 }
 
@@ -849,7 +876,6 @@ function defaultAdserverTargeting() {
 export function getStandardBidderSettings(mediaType, bidderCode) {
   const TARGETING_KEYS = CONSTANTS.TARGETING_KEYS;
   const standardSettings = Object.assign({}, bidderSettings.settingsFor(null));
-
   if (!standardSettings[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING]) {
     standardSettings[CONSTANTS.JSON_MAPPING.ADSERVER_TARGETING] = defaultAdserverTargeting();
   }

package/src/consentHandler.js

@@ -1,6 +1,14 @@
 import {isStr, timestamp} from './utils.js';
 import {defer, GreedyPromise} from './utils/promise.js';
 
+/**
+ * Placeholder gvlid for when vendor consent is not required. When this value is used as gvlid, the gdpr
+ * enforcement module will take it to mean "vendor consent was given".
+ *
+ * see https://github.com/prebid/Prebid.js/issues/8161
+ */
+export const VENDORLESS_GVLID = Object.freeze({});
+
 export class ConsentHandler {
   #enabled;
   #data;

package/src/constants.json

@@ -76,7 +76,8 @@
     "UUID": "hb_uuid",
     "CACHE_ID": "hb_cache_id",
     "CACHE_HOST": "hb_cache_host",
-    "ADOMAIN": "hb_adomain"
+    "ADOMAIN": "hb_adomain",
+    "ACAT": "hb_acat"
   },
   "DEFAULT_TARGETING_KEYS": {
     "BIDDER": "hb_bidder",

package/src/events.js

@@ -157,3 +157,7 @@ const _public = (function () {
 utils._setEventEmitter(_public.emit.bind(_public));
 
 export const {on, off, get, getEvents, emit, addEvents} = _public;
+
+export function clearEvents() {
+  eventsFired.length = 0;
+}

package/src/native.js

@@ -23,7 +23,7 @@ export const NATIVE_TARGETING_KEYS = Object.keys(CONSTANTS.NATIVE_KEYS).map(
   key => CONSTANTS.NATIVE_KEYS[key]
 );
 
-const IMAGE = {
+export const IMAGE = {
   ortb: {
     ver: '1.2',
     assets: [
@@ -385,26 +385,14 @@ export function getNativeTargeting(bid, {index = auctionManager.index} = {}) {
   return keyValues;
 }
 
-const getNativeRequest = (bidResponse) => auctionManager.index.getAdUnit(bidResponse)?.nativeOrtbRequest;
-
-function assetsMessage(data, adObject, keys, {getNativeReq = getNativeRequest} = {}) {
+function assetsMessage(data, adObject, keys) {
   const message = {
     message: 'assetResponse',
     adId: data.adId,
   };
 
-  // Pass to Prebid Universal Creative all assets, the legacy ones + the ortb ones (under ortb property)
-  const ortbRequest = getNativeReq(adObject);
   let nativeResp = adObject.native;
-  const ortbResponse = adObject.native?.ortb;
-  let legacyResponse = {};
-  if (ortbRequest && ortbResponse) {
-    legacyResponse = toLegacyResponse(ortbResponse, ortbRequest);
-    nativeResp = {
-      ...adObject.native,
-      ...legacyResponse
-    };
-  }
+
   if (adObject.native.ortb) {
     message.ortb = adObject.native.ortb;
   }
@@ -435,13 +423,13 @@ function assetsMessage(data, adObject, keys, {getNativeReq = getNativeRequest} =
  * Constructs a message object containing asset values for each of the
  * requested data keys.
  */
-export function getAssetMessage(data, adObject, {getNativeReq = getNativeRequest} = {}) {
+export function getAssetMessage(data, adObject) {
   const keys = data.assets.map((k) => getKeyByValue(CONSTANTS.NATIVE_KEYS, k));
-  return assetsMessage(data, adObject, keys, {getNativeReq});
+  return assetsMessage(data, adObject, keys);
 }
 
-export function getAllAssetsMessage(data, adObject, {getNativeReq = getNativeRequest} = {}) {
-  return assetsMessage(data, adObject, null, {getNativeReq});
+export function getAllAssetsMessage(data, adObject) {
+  return assetsMessage(data, adObject, null);
 }
 
 /**
@@ -749,7 +737,7 @@ export function toOrtbNativeResponse(legacyResponse, ortbRequest) {
  * @param {*} ortbRequest the ortb request, useful to match ids.
  * @returns an object containing the response in legacy native format: { title: "this is a title", image: ... }
  */
-function toLegacyResponse(ortbResponse, ortbRequest) {
+export function toLegacyResponse(ortbResponse, ortbRequest) {
   const legacyResponse = {};
   const requestAssets = ortbRequest?.assets || [];
   legacyResponse.clickUrl = ortbResponse.link.url;
@@ -764,6 +752,29 @@ function toLegacyResponse(ortbResponse, ortbRequest) {
       legacyResponse[PREBID_NATIVE_DATA_KEYS_TO_ORTB_INVERSE[NATIVE_ASSET_TYPES_INVERSE[requestAsset.data.type]]] = asset.data.value;
     }
   }
+
+  // Handle trackers
+  legacyResponse.impressionTrackers = [];
+  let jsTrackers = [];
+
+  if (ortbRequest?.imptrackers) {
+    legacyResponse.impressionTrackers.push(...ortbRequest.imptrackers);
+  }
+  for (const eventTracker of ortbResponse?.eventtrackers || []) {
+    if (eventTracker.event === TRACKER_EVENTS.impression && eventTracker.method === TRACKER_METHODS.img) {
+      legacyResponse.impressionTrackers.push(eventTracker.url);
+    }
+    if (eventTracker.event === TRACKER_EVENTS.impression && eventTracker.method === TRACKER_METHODS.js) {
+      jsTrackers.push(eventTracker.url);
+    }
+  }
+
+  jsTrackers = jsTrackers.map(url => `<script async src="${url}"></script>`);
+  if (ortbResponse?.jstracker) { jsTrackers.push(ortbResponse.jstracker); }
+  if (jsTrackers.length) {
+    legacyResponse.javascriptTrackers = jsTrackers.join('\n');
+  }
+
   return legacyResponse;
 }
 

package/src/refererDetection.js

@@ -120,6 +120,7 @@ export function detectReferer(win) {
     const stack = [];
     const ancestors = getAncestorOrigins(win);
     const maxNestedIframes = config.getConfig('maxNestedIframes');
+
     let currentWindow;
     let bestLocation;
     let bestCanonicalUrl;
@@ -226,7 +227,11 @@ export function detectReferer(win) {
 
     const location = reachedTop || hasTopLocation ? bestLocation : null;
     const canonicalUrl = config.getConfig('pageUrl') || bestCanonicalUrl || null;
-    const page = ensureProtocol(canonicalUrl, win) || location;
+    let page = config.getConfig('pageUrl') || location || ensureProtocol(canonicalUrl, win);
+
+    if (location && location.indexOf('?') > -1 && page.indexOf('?') === -1) {
+      page = `${page}${location.substring(location.indexOf('?'))}`;
+    }
 
     return {
       reachedTop,

package/src/storageManager.js

@@ -1,6 +1,7 @@
 import {hook} from './hook.js';
 import {hasDeviceAccess, checkCookieSupport, logError, logInfo, isPlainObject} from './utils.js';
 import {bidderSettings as defaultBidderSettings} from './bidderSettings.js';
+import {VENDORLESS_GVLID} from './consentHandler.js';
 
 const moduleTypeWhiteList = ['core', 'prebid-module'];
 
@@ -33,7 +34,9 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
     return storageAllowed == null ? false : storageAllowed;
   }
 
-  const isVendorless = moduleTypeWhiteList.includes(moduleType);
+  if (moduleTypeWhiteList.includes(moduleType)) {
+    gvlid = gvlid || VENDORLESS_GVLID;
+  }
 
   function isValid(cb) {
     if (!isBidderAllowed()) {
@@ -45,7 +48,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
       let hookDetails = {
         hasEnforcementHook: false
       }
-      validateStorageEnforcement(isVendorless, gvlid, bidderCode || moduleName, hookDetails, function(result) {
+      validateStorageEnforcement(gvlid, bidderCode || moduleName, hookDetails, function(result) {
         if (result && result.hasEnforcementHook) {
           value = cb(result);
         } else {
@@ -296,7 +299,7 @@ export function newStorageManager({gvlid, moduleName, bidderCode, moduleType} =
 /**
  * This hook validates the storage enforcement if gdprEnforcement module is included
  */
-export const validateStorageEnforcement = hook('async', function(isVendorless, gvlid, moduleName, hookDetails, callback) {
+export const validateStorageEnforcement = hook('async', function(gvlid, moduleName, hookDetails, callback) {
   callback(hookDetails);
 }, 'validateStorageEnforcement');
 

package/test/helpers/analytics.js

@@ -0,0 +1,34 @@
+import * as pbEvents from 'src/events.js';
+import constants from '../../src/constants.json';
+
+export function fireEvents(events = [
+  constants.EVENTS.AUCTION_INIT,
+  constants.EVENTS.AUCTION_END,
+  constants.EVENTS.BID_REQUESTED,
+  constants.EVENTS.BID_RESPONSE,
+  constants.EVENTS.BID_WON
+]) {
+  return events.map((ev, i) => {
+    ev = Array.isArray(ev) ? ev : [ev, {i: i}];
+    pbEvents.emit.apply(null, ev)
+    return ev;
+  });
+}
+
+export function expectEvents(events) {
+  events = fireEvents(events);
+  return {
+    to: {
+      beTrackedBy(trackFn) {
+        events.forEach(([eventType, args]) => {
+          sinon.assert.calledWithMatch(trackFn, sinon.match({eventType, args}));
+        });
+      },
+      beBundledTo(bundleFn) {
+        events.forEach(([eventType, args]) => {
+          sinon.assert.calledWithMatch(bundleFn, sinon.match.any, eventType, sinon.match(args))
+        });
+      },
+    },
+  };
+}

package/test/helpers/refererDetectionHelper.js

@@ -0,0 +1,88 @@
+/**
+ * Build a walkable linked list of window-like objects for testing.
+ *
+ * @param {Array} urls Array of URL strings starting from the top window.
+ * @param {string} [topReferrer]
+ * @param {string} [canonicalUrl]
+ * @param {boolean} [ancestorOrigins]
+ * @returns {Object}
+ */
+export function buildWindowTree(urls, topReferrer = null, canonicalUrl = null, ancestorOrigins = false) {
+  /**
+   * Find the origin from a given fully-qualified URL.
+   *
+   * @param {string} url The fully qualified URL
+   * @returns {string|null}
+   */
+  function getOrigin(url) {
+    const originRegex = new RegExp('^(https?://[^/]+/?)');
+
+    const result = originRegex.exec(url);
+
+    if (result && result[0]) {
+      return result[0];
+    }
+
+    return null;
+  }
+
+  const inaccessibles = [];
+
+  let previousWindow, topWindow;
+  const topOrigin = getOrigin(urls[0]);
+
+  const windowList = urls.map((url, index) => {
+    const thisOrigin = getOrigin(url),
+      sameOriginAsPrevious = index === 0 ? true : (getOrigin(urls[index - 1]) === thisOrigin),
+      sameOriginAsTop = thisOrigin === topOrigin;
+
+    const win = {
+      location: {
+        href: url,
+      },
+      document: {
+        referrer: index === 0 ? topReferrer : urls[index - 1]
+      }
+    };
+
+    if (topWindow == null) {
+      topWindow = win;
+      win.document.querySelector = function (selector) {
+        if (selector === 'link[rel=\'canonical\']') {
+          return {
+            href: canonicalUrl
+          };
+        }
+        return null;
+      };
+    }
+
+    if (sameOriginAsPrevious) {
+      win.parent = previousWindow;
+    } else {
+      win.parent = inaccessibles[inaccessibles.length - 1];
+    }
+    if (ancestorOrigins) {
+      win.location.ancestorOrigins = urls.slice(0, index).reverse().map(getOrigin);
+    }
+    win.top = sameOriginAsTop ? topWindow : inaccessibles[0];
+
+    const inWin = {parent: inaccessibles[inaccessibles.length - 1], top: inaccessibles[0]};
+    if (index === 0) {
+      inWin.top = inWin;
+    }
+    ['document', 'location'].forEach((prop) => {
+      Object.defineProperty(inWin, prop, {
+        get: function () {
+          throw new Error('cross-origin access');
+        }
+      });
+    });
+    inaccessibles.push(inWin);
+    previousWindow = win;
+
+    return win;
+  });
+
+  return windowList[windowList.length - 1];
+}

package/test/mocks/analyticsStub.js

@@ -1,8 +1,10 @@
-import {_internal} from '../../libraries/analyticsAdapter/AnalyticsAdapter.js';
+import {_internal, setDebounceDelay} from '../../libraries/analyticsAdapter/AnalyticsAdapter.js';
 
 before(() => {
   // stub out analytics networking to avoid random events polluting the global xhr mock
   disableAjaxForAnalytics();
+  // make analytics event handling synchronous
+  setDebounceDelay(0);
 })
 
 export function disableAjaxForAnalytics() {