prebid.js 7.43.0 → 7.45.0

package/modules/videoheroesBidAdapter.js

@@ -80,7 +80,7 @@ export const spec = {
         domain: parseUrl(page).hostname,
         page: page,
       },
-      tmax: bidderRequest.timeout || config.getConfig('bidderTimeout') || 500,
+      tmax: bidderRequest.timeout,
       imp
     };
 

package/modules/vidoomyBidAdapter.js

@@ -46,6 +46,54 @@ const isBidRequestValid = bid => {
   return true;
 };
 
+/**
+ * Schain Object needed encodes URI Component with exlamation mark
+ * @param {String} str
+ * @returns {String}
+ */
+function encodeURIComponentWithExlamation(str) {
+  return encodeURIComponent(str).replace(/!/g, '%21');
+}
+
+/**
+ * Serializes the supply chain object based on IAB standards
+ * @see https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md
+ * @param {Object} schainObj supply chain object
+ * @returns {string} serialized supply chain value
+ */
+function serializeSupplyChainObj(schainObj) {
+  if (!schainObj || !schainObj.nodes) {
+    return '';
+  }
+  const nodeProps = ['asi', 'sid', 'hp', 'rid', 'name', 'domain'];
+  const serializedNodes = schainObj.nodes.map(node =>
+    nodeProps.map(prop => encodeURIComponentWithExlamation(node[prop] || '')).join(',')
+  ).join('!');
+
+  const serializedSchain = `${schainObj.ver},${schainObj.complete}!${serializedNodes}`;
+  return serializedSchain;
+}
+
+/**
+ * Gets highest floor between getFloor.floor and params.bidfloor
+ * @param {Object} bid
+ * @param {Object} mediaType
+ * @param {Array} sizes
+ * @param {Number} bidfloor
+ * @returns {Number} floor
+ */
+function getBidFloor(bid, mediaType, sizes, bidfloor) {
+  let floor = bidfloor;
+  var size = sizes && sizes.length > 0 ? sizes[0] : '*';
+  if (typeof bid.getFloor === 'function') {
+    const floorInfo = bid.getFloor({currency: 'USD', mediaType, size});
+    if (typeof floorInfo === 'object' && floorInfo.currency === 'USD' && !isNaN(parseFloat(floorInfo.floor))) {
+      floor = Math.max(bidfloor, parseFloat(floorInfo.floor));
+    }
+  }
+  return floor;
+}
+
 const isBidResponseValid = bid => {
   if (!bid || !bid.requestId || !bid.cpm || !bid.ttl || !bid.currency) {
     return false;
@@ -78,6 +126,7 @@ const buildRequests = (validBidRequests, bidderRequest) => {
 
     const videoContext = deepAccess(bid, 'mediaTypes.video.context');
     const bidfloor = deepAccess(bid, `params.bidfloor`, 0);
+    const floor = getBidFloor(bid, adType, sizes, bidfloor);
 
     const queryParams = {
       id: bid.params.id,
@@ -91,8 +140,8 @@ const buildRequests = (validBidRequests, bidderRequest) => {
       dt: /Mobi/.test(navigator.userAgent) ? 2 : 1,
       pid: bid.params.pid,
       requestId: bid.bidId,
-      schain: bid.schain || '',
-      bidfloor,
+      schain: serializeSupplyChainObj(bid.schain) || '',
+      bidfloor: floor,
       d: getDomainWithoutSubdomain(hostname), // 'vidoomy.com',
       // TODO: does the fallback make sense here?
       sp: encodeURIComponent(bidderRequest.refererInfo.page || bidderRequest.refererInfo.topmostLocation),

package/modules/visiblemeasuresBidAdapter.js

@@ -155,7 +155,7 @@ export const spec = {
       coppa: config.getConfig('coppa') === true ? 1 : 0,
       ccpa: bidderRequest.uspConsent || undefined,
       gdpr: bidderRequest.gdprConsent || undefined,
-      tmax: config.getConfig('bidderTimeout')
+      tmax: bidderRequest.timeout
     };
 
     const len = validBidRequests.length;

package/modules/vrtcalBidAdapter.js

@@ -46,7 +46,7 @@ export const spec = {
         coppa = 1;
       }
 
-      tmax = config.getConfig('bidderTimeout');
+      tmax = bid.timeout;
 
       const params = {
         prebidJS: 1,

package/modules/weboramaRtdProvider.js

@@ -122,6 +122,7 @@ import {
   getStorageManager
 } from '../src/storageManager.js';
 import adapterManager from '../src/adapterManager.js';
+import {MODULE_TYPE_RTD} from '../src/activities/modules.js';
 
 /** @type {string} */
 const MODULE_NAME = 'realTimeData';
@@ -153,7 +154,7 @@ const SFBX_LITE_DATA_SOURCE_LABEL = 'lite';
 const GVLID = 284;
 
 export const storage = getStorageManager({
-  gvlid: GVLID,
+  moduleType: MODULE_TYPE_RTD,
   moduleName: SUBMODULE_NAME
 });
 
@@ -180,6 +181,7 @@ export const storage = getStorageManager({
 class WeboramaRtdProvider {
   #components;
   name = SUBMODULE_NAME;
+  gvlid = GVLID;
   /**
    * @param  {Components} components
    */

package/modules/yieldmoBidAdapter.js

@@ -17,7 +17,6 @@ import {BANNER, VIDEO} from '../src/mediaTypes.js';
 import {registerBidder} from '../src/adapters/bidderFactory.js';
 import {Renderer} from '../src/Renderer.js';
 import {find, includes} from '../src/polyfill.js';
-import {createEidsArray} from './userId/eids.js';
 
 const BIDDER_CODE = 'yieldmo';
 const GVLID = 173;
@@ -652,8 +651,8 @@ function shortcutProperty(extraCharacters, target, propertyName) {
  * @return array of eids objects
  */
 function getEids(bidRequest) {
-  if (deepAccess(bidRequest, 'userId')) {
-    return createEidsArray(bidRequest.userId) || [];
+  if (deepAccess(bidRequest, 'userIdAsEids')) {
+    return bidRequest.userIdAsEids || [];
   }
 };
 

package/modules/yieldoneBidAdapter.js

@@ -53,7 +53,7 @@ export const spec = {
       const bidId = bidRequest.bidId;
       const transactionId = bidRequest.transactionId;
       const unitCode = bidRequest.adUnitCode;
-      const timeout = config.getConfig('bidderTimeout');
+      const timeout = bidderRequest.timeout;
       const language = window.navigator.language;
       const screenSize = window.screen.width + 'x' + window.screen.height;
       const payload = {

package/modules/yuktamediaAnalyticsAdapter.js

@@ -7,8 +7,10 @@ import {getStorageManager} from '../src/storageManager.js';
 import {getRefererInfo} from '../src/refererDetection.js';
 import {includes as strIncludes} from '../src/polyfill.js';
 import {getGlobal} from '../src/prebidGlobal.js';
+import {MODULE_TYPE_ANALYTICS} from '../src/activities/modules.js';
 
-const storage = getStorageManager();
+const MODULE_CODE = 'yuktamedia';
+const storage = getStorageManager({moduleType: MODULE_TYPE_ANALYTICS, moduleName: MODULE_CODE});
 const yuktamediaAnalyticsVersion = 'v3.1.0';
 
 let initOptions;
@@ -261,7 +263,7 @@ yuktamediaAnalyticsAdapter.enableAnalytics = function (config) {
 
 adapterManager.registerAnalyticsAdapter({
   adapter: yuktamediaAnalyticsAdapter,
-  code: 'yuktamedia'
+  code: MODULE_CODE,
 });
 
 export default yuktamediaAnalyticsAdapter;

package/modules/zeotapIdPlusIdSystem.js

@@ -6,7 +6,8 @@
  */
 import { isStr, isPlainObject } from '../src/utils.js';
 import {submodule} from '../src/hook.js';
-import { getStorageManager } from '../src/storageManager.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {MODULE_TYPE_UID} from '../src/activities/modules.js';
 
 const ZEOTAP_COOKIE_NAME = 'IDP';
 const ZEOTAP_VENDOR_ID = 301;
@@ -21,7 +22,7 @@ function readFromLocalStorage() {
 }
 
 export function getStorage() {
-  return getStorageManager({gvlid: ZEOTAP_VENDOR_ID, moduleName: ZEOTAP_MODULE_NAME});
+  return getStorageManager({moduleType: MODULE_TYPE_UID, moduleName: ZEOTAP_MODULE_NAME});
 }
 
 export const storage = getStorage();

package/modules/zeta_global_sspBidAdapter.js

@@ -77,6 +77,9 @@ export const spec = {
         id: request.bidId,
         secure: secure
       };
+      if (params.tagid) {
+        impData.tagid = params.tagid;
+      }
       if (request.mediaTypes) {
         for (const mediaType in request.mediaTypes) {
           switch (mediaType) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "7.43.0",
+  "version": "7.45.0",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.js",
   "scripts": {

package/plugins/eslint/validateImports.js

@@ -1,11 +1,17 @@
 
-let path = require('path');
-let _ = require('lodash');
-let resolveFrom = require('resolve-from');
+const path = require('path');
+const _ = require('lodash');
+const resolveFrom = require('resolve-from');
+const MODULES_PATH = path.resolve(__dirname, '../../modules');
+
+function isInDirectory(filename, dir) {
+  const rel = path.relative(dir, filename);
+  return rel && !rel.startsWith('..') && !path.isAbsolute(rel);
+}
 
 function flagErrors(context, node, importPath) {
   let absFileDir = path.dirname(context.getFilename());
-  let absImportPath = path.resolve(absFileDir, importPath);
+  let absImportPath = importPath.startsWith('.') ? path.resolve(absFileDir, importPath) : require.resolve(importPath);
 
   try {
     resolveFrom(absFileDir, importPath);
@@ -20,16 +26,9 @@ function flagErrors(context, node, importPath) {
   ) {
     context.report(node, `import "${importPath}" not in import whitelist`);
   } else {
-    let absModulePath = path.resolve(__dirname, '../../modules');
-
-    // don't allow import of any files directly within modules folder or index.js files within modules' sub-folders
-    if (
-      path.dirname(absImportPath) === absModulePath || (
-        absImportPath.startsWith(absModulePath) &&
-        path.basename(absImportPath) === 'index.js'
-      )
-    ) {
-      context.report(node, `import "${importPath}" cannot require module entry point`);
+    // do not allow cross-module imports
+    if (isInDirectory(absImportPath, MODULES_PATH) && (!isInDirectory(absImportPath, absFileDir) || absFileDir === MODULES_PATH)) {
+      context.report(node, `import "${importPath}": importing from modules is not allowed`);
     }
 
     // don't allow extension-less local imports

package/plugins/pbjsGlobals.js

@@ -42,9 +42,11 @@ module.exports = function(api, options) {
   ];
 
   const PREBID_ROOT = path.resolve(__dirname, '..');
+  // on Windows, require paths are not filesystem paths
+  const SEP_PAT = new RegExp(path.sep.replace(/\\/g, '\\\\'), 'g')
 
   function relPath(from, toRelToProjectRoot) {
-    return path.relative(path.dirname(from), path.join(PREBID_ROOT, toRelToProjectRoot));
+    return path.relative(path.dirname(from), path.join(PREBID_ROOT, toRelToProjectRoot)).replace(SEP_PAT, '/');
   }
 
   function getModuleName(filename) {

package/src/Renderer.js

@@ -22,6 +22,7 @@ export function Renderer(options) {
   this.config = config;
   this.handlers = {};
   this.id = id;
+  this.renderNow = renderNow;
 
   // a renderer may push to the command queue to delay rendering until the
   // render function is loaded by loadExternalScript, at which point the the command
@@ -110,7 +111,7 @@ Renderer.prototype.process = function() {
  * @returns {Boolean}
  */
 export function isRendererRequired(renderer) {
-  return !!(renderer && renderer.url);
+  return !!(renderer && (renderer.url || renderer.renderNow));
 }
 
 /**

package/src/activities/modules.js

@@ -0,0 +1,5 @@
+export const MODULE_TYPE_CORE = 'core';
+export const MODULE_TYPE_BIDDER = 'bidder';
+export const MODULE_TYPE_UID = 'userId';
+export const MODULE_TYPE_RTD = 'rtd';
+export const MODULE_TYPE_ANALYTICS = 'analytics';

package/src/adapterManager.js

@@ -31,11 +31,12 @@ import {hook} from './hook.js';
 import {find, includes} from './polyfill.js';
 import {adunitCounter} from './adUnits.js';
 import {getRefererInfo} from './refererDetection.js';
-import {GdprConsentHandler, UspConsentHandler, GppConsentHandler} from './consentHandler.js';
+import {GdprConsentHandler, UspConsentHandler, GppConsentHandler, GDPR_GVLIDS} from './consentHandler.js';
 import * as events from './events.js';
 import CONSTANTS from './constants.json';
 import {useMetrics} from './utils/perfMetrics.js';
 import {auctionManager} from './auctionManager.js';
+import {MODULE_TYPE_ANALYTICS, MODULE_TYPE_BIDDER} from './activities/modules.js';
 
 export const PARTITIONS = {
   CLIENT: 'client',
@@ -338,13 +339,6 @@ adapterManager.makeBidRequests = hook('sync', function (adUnits, auctionStart, a
     }
   });
 
-  bidRequests.forEach(bidRequest => {
-    config.runWithBidder(bidRequest.bidderCode, () => {
-      const fledgeEnabledFromConfig = config.getConfig('fledgeEnabled');
-      bidRequest['fledgeEnabled'] = navigator.runAdAuction && fledgeEnabledFromConfig
-    });
-  });
-
   return bidRequests;
 }, 'makeBidRequests');
 
@@ -470,6 +464,7 @@ adapterManager.registerBidAdapter = function (bidAdapter, bidderCode, {supported
   if (bidAdapter && bidderCode) {
     if (typeof bidAdapter.callBids === 'function') {
       _bidderRegistry[bidderCode] = bidAdapter;
+      GDPR_GVLIDS.register(MODULE_TYPE_BIDDER, bidderCode, bidAdapter.getSpec?.().gvlid);
 
       if (FEATURES.VIDEO && includes(supportedMediaTypes, 'video')) {
         adapterManager.videoAdapters.push(bidderCode);
@@ -539,6 +534,7 @@ adapterManager.registerAnalyticsAdapter = function ({adapter, code, gvlid}) {
     if (typeof adapter.enableAnalytics === 'function') {
       adapter.code = code;
       _analyticsRegistry[code] = { adapter, gvlid };
+      GDPR_GVLIDS.register(MODULE_TYPE_ANALYTICS, code, gvlid);
     } else {
       logError(`Prebid Error: Analytics adaptor error for analytics "${code}"
         analytics adapter must implement an enableAnalytics() function`);

package/src/adapters/bidderFactory.js

@@ -1,20 +1,32 @@
 import Adapter from '../adapter.js';
 import adapterManager from '../adapterManager.js';
-import { config } from '../config.js';
-import { createBid } from '../bidfactory.js';
-import { userSync } from '../userSync.js';
-import { nativeBidIsValid } from '../native.js';
-import { isValidVideoBid } from '../video.js';
+import {config} from '../config.js';
+import {createBid} from '../bidfactory.js';
+import {userSync} from '../userSync.js';
+import {nativeBidIsValid} from '../native.js';
+import {isValidVideoBid} from '../video.js';
 import CONSTANTS from '../constants.json';
 import * as events from '../events.js';
 import {includes} from '../polyfill.js';
-import { ajax } from '../ajax.js';
-import { logWarn, logInfo, logError, parseQueryStringParameters, delayExecution, parseSizesInput, flatten, uniques, timestamp, deepAccess, isArray, isPlainObject } from '../utils.js';
-import { ADPOD } from '../mediaTypes.js';
-import { getHook, hook } from '../hook.js';
-import { getCoreStorageManager } from '../storageManager.js';
+import {ajax} from '../ajax.js';
+import {
+  deepAccess,
+  delayExecution,
+  flatten,
+  isArray,
+  isPlainObject,
+  logError,
+  logWarn,
+  parseQueryStringParameters,
+  parseSizesInput,
+  timestamp,
+  uniques
+} from '../utils.js';
+import {ADPOD} from '../mediaTypes.js';
+import {getHook, hook} from '../hook.js';
+import {getCoreStorageManager} from '../storageManager.js';
 import {auctionManager} from '../auctionManager.js';
-import { bidderSettings } from '../bidderSettings.js';
+import {bidderSettings} from '../bidderSettings.js';
 import {useMetrics} from '../utils/perfMetrics.js';
 
 export const storage = getCoreStorageManager('bidderFactory');
@@ -187,7 +199,7 @@ export function registerBidder(spec) {
 export function newBidder(spec) {
   return Object.assign(new Adapter(spec.code), {
     getSpec: function() {
-      return Object.freeze(spec);
+      return Object.freeze(Object.assign({}, spec));
     },
     registerSyncs,
     callBids: function(bidderRequest, addBidResponse, done, ajax, onTimelyResponse, configEnabledCallback) {
@@ -247,7 +259,9 @@ export function newBidder(spec) {
           fledgeAuctionConfigs.forEach((fledgeAuctionConfig) => {
             const bidRequest = bidRequestMap[fledgeAuctionConfig.bidId];
             if (bidRequest) {
-              addComponentAuction(bidRequest, fledgeAuctionConfig);
+              addComponentAuction(bidRequest.adUnitCode, fledgeAuctionConfig.config);
+            } else {
+              logWarn('Received fledge auction configuration for an unknown bidId', fledgeAuctionConfig);
             }
           });
         },
@@ -463,13 +477,13 @@ export const registerSyncInner = hook('async', function(spec, responses, gdprCon
       syncs.forEach((sync) => {
         userSync.registerSync(sync.type, spec.code, sync.url)
       });
+      userSync.bidderDone(spec.code);
     }
   }
 }, 'registerSyncs')
 
-export const addComponentAuction = hook('sync', (_bidRequest, fledgeAuctionConfig) => {
-  logInfo(`bidderFactory.addComponentAuction`, fledgeAuctionConfig);
-}, 'addComponentAuction')
+export const addComponentAuction = hook('sync', (adUnitCode, fledgeAuctionConfig) => {
+}, 'addComponentAuction');
 
 export function preloadBidderMappingFile(fn, adUnits) {
   if (FEATURES.VIDEO) {

package/src/consentHandler.js

@@ -118,3 +118,45 @@ export class GppConsentHandler extends ConsentHandler {
     }
   }
 }
+
+export function gvlidRegistry() {
+  const registry = {};
+  const flat = {};
+  const none = {};
+  return {
+    /**
+     * Register a module's GVL ID.
+     * @param {string} moduleType defined in `activities/modules.js`
+     * @param {string} moduleName
+     * @param {number} gvlid
+     */
+    register(moduleType, moduleName, gvlid) {
+      if (gvlid) {
+        (registry[moduleName] = registry[moduleName] || {})[moduleType] = gvlid;
+        if (flat.hasOwnProperty(moduleName)) {
+          if (flat[moduleName] !== gvlid) flat[moduleName] = none;
+        } else {
+          flat[moduleName] = gvlid;
+        }
+      }
+    },
+    /**
+     * Get a module's GVL ID(s).
+     *
+     * @param {string} moduleName
+     * @return {{modules: {[moduleType]: number}, gvlid?: number}} an object where:
+     *   `modules` is a map from module type to that module's GVL ID;
+     *   `gvlid` is the single GVL ID for this family of modules (only defined
+     *   if all modules with this name declared the same ID).
+     */
+    get(moduleName) {
+      const result = {modules: registry[moduleName] || {}};
+      if (flat.hasOwnProperty(moduleName) && flat[moduleName] !== none) {
+        result.gvlid = flat[moduleName];
+      }
+      return result;
+    }
+  }
+}
+
+export const GDPR_GVLIDS = gvlidRegistry();

package/src/native.js

@@ -750,7 +750,11 @@ export function toLegacyResponse(ortbResponse, ortbRequest) {
     if (asset.title) {
       legacyResponse.title = asset.title.text;
     } else if (asset.img) {
-      legacyResponse[requestAsset.img.type === NATIVE_IMAGE_TYPES.MAIN ? 'image' : 'icon'] = asset.img.url;
+      legacyResponse[requestAsset.img.type === NATIVE_IMAGE_TYPES.MAIN ? 'image' : 'icon'] = {
+        url: asset.img.url,
+        width: asset.img.w,
+        height: asset.img.h
+      };
     } else if (asset.data) {
       legacyResponse[PREBID_NATIVE_DATA_KEYS_TO_ORTB_INVERSE[NATIVE_ASSET_TYPES_INVERSE[requestAsset.data.type]]] = asset.data.value;
     }

package/src/refererDetection.js

@@ -51,6 +51,26 @@ export function parseDomain(url, {noLeadingWww = false, noPort = false} = {}) {
   return url;
 }
 
+/**
+ * This function returns canonical URL which refers to an HTML link element, with the attribute of rel="canonical", found in the <head> element of your webpage
+ *
+ * @param {Object} doc document
+ * @returns {string|null}
+ */
+function getCanonicalUrl(doc) {
+  try {
+    const element = doc.querySelector("link[rel='canonical']");
+
+    if (element !== null) {
+      return element.href;
+    }
+  } catch (e) {
+    // Ignore error
+  }
+
+  return null;
+}
+
 /**
  * @param {Window} win Window
  * @returns {Function}
@@ -75,26 +95,6 @@ export function detectReferer(win) {
     }
   }
 
-  /**
-   * This function returns canonical URL which refers to an HTML link element, with the attribute of rel="canonical", found in the <head> element of your webpage
-   *
-   * @param {Object} doc document
-   * @returns {string|null}
-   */
-  function getCanonicalUrl(doc) {
-    try {
-      const element = doc.querySelector("link[rel='canonical']");
-
-      if (element !== null) {
-        return element.href;
-      }
-    } catch (e) {
-      // Ignore error
-    }
-
-    return null;
-  }
-
   // TODO: the meaning of "reachedTop" seems to be intentionally ambiguous - best to leave them out of
   // the typedef for now. (for example, unit tests enforce that "reachedTop" should be false in some situations where we
   // happily provide a location for the top).
@@ -260,7 +260,25 @@ export function detectReferer(win) {
   return refererInfo;
 }
 
+// cache result of fn (= referer info) as long as:
+// - we are the top window
+// - canonical URL tag and window location have not changed
+export function cacheWithLocation(fn, win = window) {
+  if (win.top !== win) return fn;
+  let canonical, href, value;
+  return function () {
+    const newCanonical = getCanonicalUrl(win.document);
+    const newHref = win.location.href;
+    if (canonical !== newCanonical || newHref !== href) {
+      canonical = newCanonical;
+      href = newHref;
+      value = fn();
+    }
+    return value;
+  }
+}
+
 /**
  * @type {function(): refererInfo}
  */
-export const getRefererInfo = detectReferer(window);
+export const getRefererInfo = cacheWithLocation(detectReferer(window));

package/src/secureCreatives.js

@@ -73,7 +73,7 @@ function handleRenderRequest(reply, data, adObject) {
   if (adObject == null) {
     emitAdRenderFail({
       reason: constants.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
-      message: `Cannot find ad '${data.adId}' for cross-origin render request`,
+      message: `Cannot find ad for cross-origin render request: '${data.adId}'`,
       id: data.adId
     });
     return;
@@ -111,7 +111,7 @@ function handleNativeRequest(reply, data, adObject) {
   //   adId: '%%PATTERN:hb_adid%%'
   // }), '*');
   if (adObject == null) {
-    logError(`Cannot find ad '${data.adId}' for x-origin event request`);
+    logError(`Cannot find ad for x-origin event request: '${data.adId}'`);
     return;
   }