prebid.js 7.44.0 → 7.46.0

package/modules/yieldmoBidAdapter.js

@@ -68,6 +68,7 @@ export const spec = {
     const videoBidRequests = bidRequests.filter(request => hasVideoMediaType(request));
     let serverRequests = [];
     const eids = getEids(bidRequests[0]) || [];
+
     if (bannerBidRequests.length > 0) {
       let serverRequest = {
         pbav: '$prebid.version$',
@@ -80,7 +81,9 @@ export const spec = {
         userConsent: JSON.stringify({
           // case of undefined, stringify will remove param
           gdprApplies: deepAccess(bidderRequest, 'gdprConsent.gdprApplies') || '',
-          cmp: deepAccess(bidderRequest, 'gdprConsent.consentString') || ''
+          cmp: deepAccess(bidderRequest, 'gdprConsent.consentString') || '',
+          gpp: deepAccess(bidderRequest, 'gppConsent.gppString') || '',
+          gpp_sid: deepAccess(bidderRequest, 'gppConsent.applicableSections') || ''
         }),
         us_privacy: deepAccess(bidderRequest, 'uspConsent') || ''
       };
@@ -514,12 +517,19 @@ function openRtbSite(bidRequest, bidderRequest) {
  */
 function populateOpenRtbGdpr(openRtbRequest, bidderRequest) {
   const gdpr = bidderRequest.gdprConsent;
-  if (gdpr && 'gdprApplies' in gdpr) {
-    deepSetValue(openRtbRequest, 'regs.ext.gdpr', gdpr.gdprApplies ? 1 : 0);
-    deepSetValue(openRtbRequest, 'user.ext.consent', gdpr.consentString);
+  const gpp = deepAccess(bidderRequest, 'gppConsent.gppString');
+  const gppsid = deepAccess(bidderRequest, 'gppConsent.applicableSections');
+  if (gpp) {
+    deepSetValue(openRtbRequest, 'regs.ext.gpp', gpp);
+  } else {
+    deepSetValue(openRtbRequest, 'regs.ext.gdpr', gdpr && gdpr.gdprApplies ? 1 : 0);
+    deepSetValue(openRtbRequest, 'user.ext.consent', gdpr && gdpr.consentString ? gdpr.consentString : '');
+  }
+  if (gppsid) {
+    deepSetValue(openRtbRequest, 'regs.ext.gpp_sid', gppsid);
   }
   const uspConsent = deepAccess(bidderRequest, 'uspConsent');
-  if (uspConsent) {
+  if (!gpp && uspConsent) {
     deepSetValue(openRtbRequest, 'regs.ext.us_privacy', uspConsent);
   }
 }

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/package.json

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

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/config.js

@@ -66,158 +66,109 @@ export function newConfig() {
 
   function resetConfig() {
     defaults = {};
-    let newConfig = {
-      // `debug` is equivalent to legacy `pbjs.logging` property
-      _debug: DEFAULT_DEBUG,
-      get debug() {
-        return this._debug;
-      },
-      set debug(val) {
-        this._debug = val;
-      },
 
-      // default timeout for all bids
-      _bidderTimeout: DEFAULT_BIDDER_TIMEOUT,
-      get bidderTimeout() {
-        return this._bidderTimeout;
-      },
-      set bidderTimeout(val) {
-        this._bidderTimeout = val;
-      },
+    function getProp(name) {
+      return props[name].val;
+    }
 
-      _publisherDomain: null,
-      get publisherDomain() {
-        return this._publisherDomain;
-      },
-      set publisherDomain(val) {
-        logWarn('publisherDomain is deprecated and has no effect since v7 - use pageUrl instead')
-        this._publisherDomain = val;
-      },
+    function setProp(name, val) {
+      props[name].val = val;
+    }
 
-      // calls existing function which may be moved after deprecation
-      _priceGranularity: GRANULARITY_OPTIONS.MEDIUM,
-      set priceGranularity(val) {
-        if (validatePriceGranularity(val)) {
-          if (typeof val === 'string') {
-            this._priceGranularity = (hasGranularity(val)) ? val : GRANULARITY_OPTIONS.MEDIUM;
-          } else if (isPlainObject(val)) {
-            this._customPriceBucket = val;
-            this._priceGranularity = GRANULARITY_OPTIONS.CUSTOM;
-            logMessage('Using custom price granularity');
+    const props = {
+      publisherDomain: {
+        set(val) {
+          if (val != null) {
+            logWarn('publisherDomain is deprecated and has no effect since v7 - use pageUrl instead')
           }
+          setProp('publisherDomain', val);
         }
       },
-      get priceGranularity() {
-        return this._priceGranularity;
-      },
-
-      _customPriceBucket: {},
-      get customPriceBucket() {
-        return this._customPriceBucket;
-      },
-
-      /**
-       * mediaTypePriceGranularity
-       * @type {MediaTypePriceGranularity}
-       */
-      _mediaTypePriceGranularity: {},
-
-      get mediaTypePriceGranularity() {
-        return this._mediaTypePriceGranularity;
-      },
-      set mediaTypePriceGranularity(val) {
-        this._mediaTypePriceGranularity = Object.keys(val).reduce((aggregate, item) => {
-          if (validatePriceGranularity(val[item])) {
+      priceGranularity: {
+        val: GRANULARITY_OPTIONS.MEDIUM,
+        set(val) {
+          if (validatePriceGranularity(val)) {
             if (typeof val === 'string') {
-              aggregate[item] = (hasGranularity(val[item])) ? val[item] : this._priceGranularity;
+              setProp('priceGranularity', (hasGranularity(val)) ? val : GRANULARITY_OPTIONS.MEDIUM);
             } else if (isPlainObject(val)) {
-              aggregate[item] = val[item];
-              logMessage(`Using custom price granularity for ${item}`);
+              setProp('customPriceBucket', val);
+              setProp('priceGranularity', GRANULARITY_OPTIONS.CUSTOM)
+              logMessage('Using custom price granularity');
             }
-          } else {
-            logWarn(`Invalid price granularity for media type: ${item}`);
           }
-          return aggregate;
-        }, {});
-      },
-
-      _sendAllBids: DEFAULT_ENABLE_SEND_ALL_BIDS,
-      get enableSendAllBids() {
-        return this._sendAllBids;
+        }
       },
-      set enableSendAllBids(val) {
-        this._sendAllBids = val;
+      customPriceBucket: {
+        val: {},
+        set() {}
       },
-
-      _useBidCache: DEFAULT_BID_CACHE,
-      get useBidCache() {
-        return this._useBidCache;
+      mediaTypePriceGranularity: {
+        val: {},
+        set(val) {
+          val != null && setProp('mediaTypePriceGranularity', Object.keys(val).reduce((aggregate, item) => {
+            if (validatePriceGranularity(val[item])) {
+              if (typeof val === 'string') {
+                aggregate[item] = (hasGranularity(val[item])) ? val[item] : getProp('priceGranularity');
+              } else if (isPlainObject(val)) {
+                aggregate[item] = val[item];
+                logMessage(`Using custom price granularity for ${item}`);
+              }
+            } else {
+              logWarn(`Invalid price granularity for media type: ${item}`);
+            }
+            return aggregate;
+          }, {}));
+        }
       },
-      set useBidCache(val) {
-        this._useBidCache = val;
+      bidderSequence: {
+        val: DEFAULT_BIDDER_SEQUENCE,
+        set(val) {
+          if (VALID_ORDERS[val]) {
+            setProp('bidderSequence', val);
+          } else {
+            logWarn(`Invalid order: ${val}. Bidder Sequence was not set.`);
+          }
+        }
       },
+      auctionOptions: {
+        val: {},
+        set(val) {
+          if (validateauctionOptions(val)) {
+            setProp('auctionOptions', val);
+          }
+        }
+      }
+    }
+    let newConfig = {
+      // `debug` is equivalent to legacy `pbjs.logging` property
+      debug: DEFAULT_DEBUG,
+      bidderTimeout: DEFAULT_BIDDER_TIMEOUT,
+      enableSendAllBids: DEFAULT_ENABLE_SEND_ALL_BIDS,
+      useBidCache: DEFAULT_BID_CACHE,
 
       /**
        * deviceAccess set to false will disable setCookie, getCookie, hasLocalStorage
        * @type {boolean}
        */
-      _deviceAccess: DEFAULT_DEVICE_ACCESS,
-      get deviceAccess() {
-        return this._deviceAccess;
-      },
-      set deviceAccess(val) {
-        this._deviceAccess = val;
-      },
-
-      _bidderSequence: DEFAULT_BIDDER_SEQUENCE,
-      get bidderSequence() {
-        return this._bidderSequence;
-      },
-      set bidderSequence(val) {
-        if (VALID_ORDERS[val]) {
-          this._bidderSequence = val;
-        } else {
-          logWarn(`Invalid order: ${val}. Bidder Sequence was not set.`);
-        }
-      },
+      deviceAccess: DEFAULT_DEVICE_ACCESS,
 
       // timeout buffer to adjust for bidder CDN latency
-      _timeoutBuffer: DEFAULT_TIMEOUTBUFFER,
-      get timeoutBuffer() {
-        return this._timeoutBuffer;
-      },
-      set timeoutBuffer(val) {
-        this._timeoutBuffer = val;
-      },
-
-      _disableAjaxTimeout: DEFAULT_DISABLE_AJAX_TIMEOUT,
-      get disableAjaxTimeout() {
-        return this._disableAjaxTimeout;
-      },
-      set disableAjaxTimeout(val) {
-        this._disableAjaxTimeout = val;
-      },
+      timeoutBuffer: DEFAULT_TIMEOUTBUFFER,
+      disableAjaxTimeout: DEFAULT_DISABLE_AJAX_TIMEOUT,
 
       // default max nested iframes for referer detection
-      _maxNestedIframes: DEFAULT_MAX_NESTED_IFRAMES,
-      get maxNestedIframes() {
-        return this._maxNestedIframes;
-      },
-      set maxNestedIframes(val) {
-        this._maxNestedIframes = val;
-      },
-
-      _auctionOptions: {},
-      get auctionOptions() {
-        return this._auctionOptions;
-      },
-      set auctionOptions(val) {
-        if (validateauctionOptions(val)) {
-          this._auctionOptions = val;
-        }
-      },
+      maxNestedIframes: DEFAULT_MAX_NESTED_IFRAMES,
     };
 
+    Object.defineProperties(newConfig,
+      Object.fromEntries(Object.entries(props)
+        .map(([k, def]) => [k, Object.assign({
+          get: getProp.bind(null, k),
+          set: setProp.bind(null, k),
+          enumerable: true,
+        }, def)]))
+    );
+
     if (config) {
       callSubscribers(
         Object.keys(config).reduce((memo, topic) => {

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/test/spec/auctionmanager_spec.js

@@ -1403,8 +1403,8 @@ describe('auctionmanager.js', function () {
         assert.equal(addedBid.native.title, 'Sample title')
         assert.equal(addedBid.native.sponsoredBy, 'Sample sponsoredBy')
         assert.equal(addedBid.native.clickUrl, 'http://www.click.com')
-        assert.equal(addedBid.native.image, 'https://www.example.com/image.png')
-        assert.equal(addedBid.native.icon, 'https://www.example.com/icon.png')
+        assert.equal(addedBid.native.image.url, 'https://www.example.com/image.png')
+        assert.equal(addedBid.native.icon.url, 'https://www.example.com/icon.png')
         assert.equal(addedBid.native.impressionTrackers[0], 'http://www.imptracker.com')
         assert.equal(addedBid.native.javascriptTrackers, '<script async src="http://www.jstracker.com/file.js"></script>')
       });

package/test/spec/libraries/domainOverrideToRootDomain/index_spec.js

@@ -0,0 +1,77 @@
+import {domainOverrideToRootDomain} from 'libraries/domainOverrideToRootDomain/index.js';
+import {getStorageManager} from 'src/storageManager.js';
+import {MODULE_TYPE_UID} from '../../../../src/activities/modules';
+
+const storage = getStorageManager({ moduleName: 'test', moduleType: MODULE_TYPE_UID });
+const domainOverride = domainOverrideToRootDomain(storage, 'test');
+
+describe('domainOverride', () => {
+  let sandbox, domain, cookies, rejectCookiesFor;
+  let setCookieStub;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox();
+    sandbox.stub(document, 'domain').get(() => domain);
+    cookies = {};
+    sandbox.stub(storage, 'getCookie').callsFake((key) => cookies[key]);
+    rejectCookiesFor = null;
+    setCookieStub = sandbox.stub(storage, 'setCookie').callsFake((key, value, expires, sameSite, domain) => {
+      if (domain !== rejectCookiesFor) {
+        if (expires != null) {
+          expires = new Date(expires);
+        }
+        if (expires == null || expires > Date.now()) {
+          cookies[key] = value;
+        } else {
+          delete cookies[key];
+        }
+      }
+    });
+  });
+
+  afterEach(() => sandbox.restore())
+
+  it('test cookies include the module name', () => {
+    domain = 'greatpublisher.com'
+    rejectCookiesFor = 'greatpublisher.com'
+
+    // stub Date.now() to return a constant value
+    sandbox.stub(Date, 'now').returns(1234567890)
+
+    const randomName = `adapterV${(Math.random() * 1e8).toString(16)}`
+    const localDomainOverride = domainOverrideToRootDomain(storage, randomName)
+
+    const time = Date.now();
+    localDomainOverride();
+
+    sandbox.assert.callCount(setCookieStub, 2)
+    sandbox.assert.calledWith(setCookieStub, `_gd${time}_${randomName}`, '1', undefined, undefined, 'greatpublisher.com')
+  });
+
+  it('will return the root domain when given a subdomain', () => {
+    const test_domains = [
+      'deeply.nested.subdomain.for.greatpublisher.com',
+      'greatpublisher.com',
+      'subdomain.greatpublisher.com',
+      'a-subdomain.greatpublisher.com',
+    ];
+
+    test_domains.forEach((testDomain) => {
+      domain = testDomain
+      rejectCookiesFor = 'com'
+      expect(domainOverride()).to.equal('greatpublisher.com');
+    });
+  });
+
+  it(`If we can't set cookies on the root domain, we'll return the subdomain`, () => {
+    domain = 'subdomain.greatpublisher.com'
+    rejectCookiesFor = 'greatpublisher.com'
+    expect(domainOverride()).to.equal('subdomain.greatpublisher.com');
+  });
+
+  it('Will return undefined if we can\'t set cookies on the root domain or the subdomain', () => {
+    domain = 'subdomain.greatpublisher.com'
+    rejectCookiesFor = 'subdomain.greatpublisher.com'
+    expect(domainOverride()).to.equal(undefined);
+  });
+});

package/test/spec/modules/1plusXRtdProvider_spec.js

@@ -332,15 +332,16 @@ describe('1plusXRtdProvider', () => {
     }
 
     it('correctly builds URLs if gdpr parameters are present', () => {
-      const url1 = getPapiUrl(customer)
-      const url2 = getPapiUrl(customer, extractConsent(consent))
-      expect(['&consent_string=myConsent&gdpr_applies=1', '&gdpr_applies=1&consent_string=myConsent']).to.contain(url2.replace(url1, ''))
+      const url1 = getPapiUrl(customer);
+      const url2 = getPapiUrl(customer, extractConsent(consent));
+      expect(['&consent_string=myConsent&gdpr_applies=1', '&gdpr_applies=1&consent_string=myConsent']).to.contain(url2.replace(url1, ''));
     })
 
-    it('correctly builds URLs if fpid parameters are present')
-    const url1 = getPapiUrl(customer)
-    const url2 = getPapiUrl(customer, {}, 'my_first_party_id')
-    expect(url2.replace(url1, '')).to.equal('&fpid=my_first_party_id')
+    it('correctly builds URLs if fpid parameters are present', () => {
+      const url1 = getPapiUrl(customer);
+      const url2 = getPapiUrl(customer, {}, 'my_first_party_id');
+      expect(url2.replace(url1, '')).to.equal('&fpid=my_first_party_id');
+    })
   })
 
   describe('updateBidderConfig', () => {

package/test/spec/modules/acuityAdsBidAdapter_spec.js

@@ -76,7 +76,8 @@ describe('AcuityAdsBidAdapter', function () {
     gdprConsent: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
     refererInfo: {
       referer: 'https://test.com'
-    }
+    },
+    timeout: 500
   };
 
   describe('isBidRequestValid', function () {

package/test/spec/modules/adagioBidAdapter_spec.js

@@ -1481,31 +1481,6 @@ describe('Adagio bid adapter', () => {
     });
   });
 
-  describe.skip('optional params auto detection', function() {
-    it('should auto detect adUnitElementId when GPT is used', function() {
-      sandbox.stub(utils, 'getGptSlotInfoForAdUnitCode').withArgs('banner').returns({divId: 'gpt-banner'});
-      expect(adagio.autoDetectAdUnitElementId('banner')).to.eq('gpt-banner');
-    });
-  });
-
-  describe.skip('print number handling', function() {
-    it('should return 1 if no adunit-code found. This means it is the first auction', function() {
-      sandbox.stub(adagio, 'getPageviewId').returns('abc-def');
-      expect(adagio.computePrintNumber('adunit-code')).to.eql(1);
-    });
-
-    it('should increment the adunit print number when the adunit-code has already been used for an other auction', function() {
-      sandbox.stub(adagio, 'getPageviewId').returns('abc-def');
-
-      window.top.ADAGIO.adUnits['adunit-code'] = {
-        pageviewId: 'abc-def',
-        printNumber: 1,
-      };
-
-      expect(adagio.computePrintNumber('adunit-code')).to.eql(2);
-    });
-  });
-
   describe('site information using refererDetection or window.top', function() {
     it('should returns domain, page and window.referrer in a window.top context', function() {
       const bidderRequest = new BidderRequestBuilder({

package/test/spec/modules/admaticBidAdapter_spec.js

@@ -3,7 +3,7 @@ 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/pb?bidder=admatic';
+const ENDPOINT = 'https://layer.serve.admatic.com.tr/pb';
 
 describe('admaticBidAdapter', () => {
   const adapter = newBidder(spec);

package/test/spec/modules/adnuntiusBidAdapter_spec.js

@@ -8,6 +8,7 @@ import { getStorageManager } from 'src/storageManager.js';
 
 describe('adnuntiusBidAdapter', function () {
   const URL = 'https://ads.adnuntius.delivery/i?tzo=';
+  const EURO_URL = 'https://europe.delivery.adnuntius.com/i?tzo=';
   const GVLID = 855;
   const usi = utils.generateUUID()
   const meta = [{ key: 'usi', value: usi }]
@@ -35,7 +36,7 @@ describe('adnuntiusBidAdapter', function () {
   const ENDPOINT_URL_VIDEO = `${URL}${tzo}&format=json&userId=${usi}&tt=vast4`;
   const ENDPOINT_URL_NOCOOKIE = `${URL}${tzo}&format=json&userId=${usi}&noCookies=true`;
   const ENDPOINT_URL_SEGMENTS = `${URL}${tzo}&format=json&segments=segment1,segment2,segment3&userId=${usi}`;
-  const ENDPOINT_URL_CONSENT = `${URL}${tzo}&format=json&consentString=consentString&userId=${usi}`;
+  const ENDPOINT_URL_CONSENT = `${EURO_URL}${tzo}&format=json&consentString=consentString&userId=${usi}`;
   const adapter = newBidder(spec);
 
   const bidderRequests = [

package/test/spec/modules/amxIdSystem_spec.js

@@ -1,4 +1,4 @@
-import { amxIdSubmodule } from 'modules/amxIdSystem.js';
+import { amxIdSubmodule, storage } from 'modules/amxIdSystem.js';
 import { server } from 'test/mocks/xhr.js';
 import * as utils from 'src/utils.js';
 
@@ -48,38 +48,17 @@ describe('validateConfig', () => {
     logErrorSpy.restore();
   });
 
-  it('should return undefined if config.storage is not present', () => {
+  it('should allow configuration with no storage', () => {
     expect(
       amxIdSubmodule.getId(
         {
           ...config,
-          storage: null,
+          storage: undefined
         },
         null,
         null
       )
-    ).to.equal(undefined);
-
-    expect(logErrorSpy.calledOnce).to.be.true;
-    expect(logErrorSpy.lastCall.lastArg).to.contain('storage is required');
-  });
-
-  it('should return undefined if config.storage.type !== "html5"', () => {
-    expect(
-      amxIdSubmodule.getId(
-        {
-          ...config,
-          storage: {
-            type: 'cookie',
-          },
-        },
-        null,
-        null
-      )
-    ).to.equal(undefined);
-
-    expect(logErrorSpy.calledOnce).to.be.true;
-    expect(logErrorSpy.lastCall.lastArg).to.contain('cookie');
+    ).to.not.equal(undefined);
   });
 
   it('should return undefined if expires > 30', () => {
@@ -111,10 +90,18 @@ describe('getId', () => {
   });
 
   it('should call the sync endpoint and accept a valid response', () => {
+    storage.setDataInLocalStorage('__amuidpb', TEST_ID);
+
     const { callback } = amxIdSubmodule.getId(config, null, null);
     callback(spy);
 
     const [request] = server.requests;
+    expect(request.withCredentials).to.be.true
+    expect(request.requestHeaders['Content-Type']).to.match(/text\/plain/)
+
+    const { search } = utils.parseUrl(request.url);
+    expect(search.av).to.equal(amxIdSubmodule.version);
+    expect(search.am).to.equal(TEST_ID);
     expect(request.method).to.equal('GET');
 
     request.respond(
@@ -187,7 +174,7 @@ describe('getId', () => {
     );
 
     const [, secondRequest] = server.requests;
-    expect(secondRequest.url).to.be.equal(intermediateValue);
+    expect(secondRequest.url).to.match(new RegExp(`^${intermediateValue}\?`));
     secondRequest.respond(
       200,
       {},