prebid.js 10.2.0 → 10.4.0

package/src/video.ts

@@ -12,39 +12,39 @@ export const OUTSTREAM = 'outstream';
 export const INSTREAM = 'instream';
 
 const ORTB_PARAMS = [
-    [ 'mimes', value => Array.isArray(value) && value.length > 0 && value.every(v => typeof v === 'string') ],
-    [ 'minduration', isInteger ],
-    [ 'maxduration', isInteger ],
-    [ 'startdelay', isInteger ],
-    [ 'maxseq', isInteger ],
-    [ 'poddur', isInteger ],
-    [ 'protocols', isArrayOfNums ],
-    [ 'w', isInteger ],
-    [ 'h', isInteger ],
-    [ 'podid', isStr ],
-    [ 'podseq', isInteger ],
-    [ 'rqddurs', isArrayOfNums ],
-    [ 'placement', isInteger ], // deprecated, see plcmt
-    [ 'plcmt', isInteger ],
-    [ 'linearity', isInteger ],
-    [ 'skip', value => [1, 0].includes(value) ],
-    [ 'skipmin', isInteger ],
-    [ 'skipafter', isInteger ],
-    [ 'sequence', isInteger ], // deprecated
-    [ 'slotinpod', isInteger ],
-    [ 'mincpmpersec', isNumber ],
-    [ 'battr', isArrayOfNums ],
-    [ 'maxextended', isInteger ],
-    [ 'minbitrate', isInteger ],
-    [ 'maxbitrate', isInteger ],
-    [ 'boxingallowed', isInteger ],
-    [ 'playbackmethod', isArrayOfNums ],
-    [ 'playbackend', isInteger ],
-    [ 'delivery', isArrayOfNums ],
-    [ 'pos', isInteger ],
-    [ 'api', isArrayOfNums ],
-    [ 'companiontype', isArrayOfNums ],
-    [ 'poddedupe', isArrayOfNums ]
+  [ 'mimes', value => Array.isArray(value) && value.length > 0 && value.every(v => typeof v === 'string') ],
+  [ 'minduration', isInteger ],
+  [ 'maxduration', isInteger ],
+  [ 'startdelay', isInteger ],
+  [ 'maxseq', isInteger ],
+  [ 'poddur', isInteger ],
+  [ 'protocols', isArrayOfNums ],
+  [ 'w', isInteger ],
+  [ 'h', isInteger ],
+  [ 'podid', isStr ],
+  [ 'podseq', isInteger ],
+  [ 'rqddurs', isArrayOfNums ],
+  [ 'placement', isInteger ], // deprecated, see plcmt
+  [ 'plcmt', isInteger ],
+  [ 'linearity', isInteger ],
+  [ 'skip', value => [1, 0].includes(value) ],
+  [ 'skipmin', isInteger ],
+  [ 'skipafter', isInteger ],
+  [ 'sequence', isInteger ], // deprecated
+  [ 'slotinpod', isInteger ],
+  [ 'mincpmpersec', isNumber ],
+  [ 'battr', isArrayOfNums ],
+  [ 'maxextended', isInteger ],
+  [ 'minbitrate', isInteger ],
+  [ 'maxbitrate', isInteger ],
+  [ 'boxingallowed', isInteger ],
+  [ 'playbackmethod', isArrayOfNums ],
+  [ 'playbackend', isInteger ],
+  [ 'delivery', isArrayOfNums ],
+  [ 'pos', isInteger ],
+  [ 'api', isArrayOfNums ],
+  [ 'companiontype', isArrayOfNums ],
+  [ 'poddedupe', isArrayOfNums ]
 ] as const;
 
 /**
@@ -57,46 +57,46 @@ export const ORTB_VIDEO_PARAMS = new Map(ORTB_PARAMS);
 export type VideoContext = typeof INSTREAM | typeof OUTSTREAM | typeof ADPOD;
 
 export interface VideoMediaType extends BaseMediaType, Pick<ORTBImp['video'], (typeof ORTB_PARAMS)[number][0]> {
-    context: VideoContext;
-    playerSize?: Size | Size[];
+  context: VideoContext;
+  playerSize?: Size | Size[];
 }
 
 export function fillVideoDefaults(adUnit: AdUnitDefinition) {
-    const video = adUnit?.mediaTypes?.video;
-    if (video != null) {
-        if (video.plcmt == null) {
-            if (video.context === OUTSTREAM || [2, 3, 4].includes(video.placement)) {
-                video.plcmt = 4;
-            } else if (video.playbackmethod?.some?.(method => [2, 6].includes(method))) {
-                video.plcmt = 2;
-            }
-        }
-        const playerSize = isArrayOfNums(video.playerSize, 2)
-            ? video.playerSize
-            : Array.isArray(video.playerSize) && isArrayOfNums(video.playerSize[0]) ? video.playerSize[0] : null;
-        const size: [number, number] = isNumber(video.w) && isNumber(video.h) ? [video.w, video.h] : null;
-        let conflict = false;
-        if (playerSize == null) {
-            if (size != null) {
-                if (video.playerSize != null) {
-                    conflict = true;
-                } else {
-                    video.playerSize = [size];
-                }
-            }
+  const video = adUnit?.mediaTypes?.video;
+  if (video != null) {
+    if (video.plcmt == null) {
+      if (video.context === OUTSTREAM || [2, 3, 4].includes(video.placement)) {
+        video.plcmt = 4;
+      } else if (video.playbackmethod?.some?.(method => [2, 6].includes(method))) {
+        video.plcmt = 2;
+      }
+    }
+    const playerSize = isArrayOfNums(video.playerSize, 2)
+      ? video.playerSize
+      : Array.isArray(video.playerSize) && isArrayOfNums(video.playerSize[0]) ? video.playerSize[0] : null;
+    const size: [number, number] = isNumber(video.w) && isNumber(video.h) ? [video.w, video.h] : null;
+    let conflict = false;
+    if (playerSize == null) {
+      if (size != null) {
+        if (video.playerSize != null) {
+          conflict = true;
         } else {
-            ['w', 'h'].forEach((prop, i) => {
-                if (video[prop] != null && video[prop] !== playerSize[i]) {
-                    conflict = true;
-                } else {
-                    video[prop] = playerSize[i];
-                }
-            })
+          video.playerSize = [size];
         }
-        if (conflict) {
-            logWarn(`Ad unit "${adUnit.code} has conflicting playerSize and w/h`, adUnit)
+      }
+    } else {
+      ['w', 'h'].forEach((prop, i) => {
+        if (video[prop] != null && video[prop] !== playerSize[i]) {
+          conflict = true;
+        } else {
+          video[prop] = playerSize[i];
         }
+      })
     }
+    if (conflict) {
+      logWarn(`Ad unit "${adUnit.code} has conflicting playerSize and w/h`, adUnit)
+    }
+  }
 }
 
 /**
@@ -150,16 +150,16 @@ export function isValidVideoBid(bid: VideoBid, {index = auctionManager.index} =
 }
 
 declare module './bidfactory' {
-    interface VideoBidResponseProperties {
-        vastXml?: string;
-        vastUrl?: string;
-    }
+  interface VideoBidResponseProperties {
+    vastXml?: string;
+    vastUrl?: string;
+  }
 }
 
 declare module './hook' {
-    interface NamedHooks {
-        checkVideoBidSetup: typeof checkVideoBidSetup
-    }
+  interface NamedHooks {
+    checkVideoBidSetup: typeof checkVideoBidSetup
+  }
 }
 
 export const checkVideoBidSetup = hook('sync', function(bid: VideoBid, adUnit, videoMediaType, context, useCacheKey) {

package/src/videoCache.ts

@@ -51,64 +51,64 @@ function wrapURI(uri: string, impTrackerURLs: string | string[]) {
 }
 
 declare module './bidfactory' {
-    interface VideoBidResponseProperties {
-        /**
-         *  VAST impression trackers to attach to this bid.
-         */
-        vastImpUrl?: string | string []
-        /**
-         * Cache key to use for caching this bid's VAST.
-         */
-        customCacheKey?: string
-    }
-    interface VideoBidProperties {
-        /**
-         * The cache key that was used for this bid.
-         */
-        videoCacheKey?: string;
-    }
-}
-
-export interface CacheConfig {
-    /**
-     * The URL of the Prebid Cache server endpoint where VAST creatives will be sent.
-     */
-    url: string;
-    /**
-     * Flag determining whether to locally save VAST XML as a blob
-     */
-    useLocal?: boolean;
-    /**
-     * Timeout (in milliseconds) for network requests to the cache
-     */
-    timeout?: number;
+  interface VideoBidResponseProperties {
     /**
-     * Passes additional data to the url, used for additional event tracking data. Defaults to false.
+     *  VAST impression trackers to attach to this bid.
      */
-    vasttrack?: boolean;
+    vastImpUrl?: string | string []
     /**
-     * If the bidder supplied their own cache key, setting this value to true adds a VAST wrapper around that URL,
-     * stores it in the cache defined by the url parameter, and replaces the original video cache key with the new one.
-     * This can dramatically simplify ad server setup because it means all VAST creatives reside behind a single URL.
-     * The tradeoff: this approach requires the video player to unwrap one extra level of VAST. Defaults to false.
+     * Cache key to use for caching this bid's VAST.
      */
-    ignoreBidderCacheKey?: boolean;
-    /**
-     * Enables video cache requests to be batched by a specified amount (defaults to 1) instead of making a single request per each video.
-     */
-    batchSize?: number;
+    customCacheKey?: string
+  }
+  interface VideoBidProperties {
     /**
-     * Used in conjunction with batchSize, batchTimeout specifies how long to wait in milliseconds before sending
-     * a batch video cache request based on the value for batchSize (if present). A batch request will be made whether
-     * the batchSize amount was reached or the batchTimeout timer runs out. batchTimeout defaults to 0.
+     * The cache key that was used for this bid.
      */
-    batchTimeout?: number;
+    videoCacheKey?: string;
+  }
+}
+
+export interface CacheConfig {
+  /**
+   * The URL of the Prebid Cache server endpoint where VAST creatives will be sent.
+   */
+  url: string;
+  /**
+   * Flag determining whether to locally save VAST XML as a blob
+   */
+  useLocal?: boolean;
+  /**
+   * Timeout (in milliseconds) for network requests to the cache
+   */
+  timeout?: number;
+  /**
+   * Passes additional data to the url, used for additional event tracking data. Defaults to false.
+   */
+  vasttrack?: boolean;
+  /**
+   * If the bidder supplied their own cache key, setting this value to true adds a VAST wrapper around that URL,
+   * stores it in the cache defined by the url parameter, and replaces the original video cache key with the new one.
+   * This can dramatically simplify ad server setup because it means all VAST creatives reside behind a single URL.
+   * The tradeoff: this approach requires the video player to unwrap one extra level of VAST. Defaults to false.
+   */
+  ignoreBidderCacheKey?: boolean;
+  /**
+   * Enables video cache requests to be batched by a specified amount (defaults to 1) instead of making a single request per each video.
+   */
+  batchSize?: number;
+  /**
+   * Used in conjunction with batchSize, batchTimeout specifies how long to wait in milliseconds before sending
+   * a batch video cache request based on the value for batchSize (if present). A batch request will be made whether
+   * the batchSize amount was reached or the batchTimeout timer runs out. batchTimeout defaults to 0.
+   */
+  batchTimeout?: number;
 }
 
 declare module './config' {
-    interface Config {
-        cache?: CacheConfig;
-    }
+  interface Config {
+    cache?: CacheConfig;
+  }
 }
 /**
  * Wraps a bid in the format expected by the prebid-server endpoints, or returns null if
@@ -117,7 +117,7 @@ declare module './config' {
  * @return {Object|null} - The payload to be sent to the prebid-server endpoints, or null if the bid can't be converted cleanly.
  */
 function toStorageRequest(bid, {index = auctionManager.index} = {}) {
-const vastValue = getVastXml(bid);
+  const vastValue = getVastXml(bid);
   const auction = index.getAuction(bid);
   const ttlWithBuffer = Number(bid.ttl) + ttlBufferInSeconds;
   const payload: any = {
@@ -144,16 +144,16 @@ const vastValue = getVastXml(bid);
 }
 
 interface VideoCacheStoreCallback {
-    /**
-     * A function which should be called with the results of the storage operation.
-     *
-     * @param error The error, if one occurred.
-     * @param uuids An array of unique IDs. The array will have one element for each bid we were asked
-     *   to store. It may include null elements if some of the bids were malformed, or an error occurred.
-     *   Each non-null element in this array is a valid input into the retrieve function, which will fetch
-     *   some VAST XML which can be used to render this bid's ad.
-     */
-    (error: Error | null, uuids: { uuid: string }[])
+  /**
+   * A function which should be called with the results of the storage operation.
+   *
+   * @param error The error, if one occurred.
+   * @param uuids An array of unique IDs. The array will have one element for each bid we were asked
+   *   to store. It may include null elements if some of the bids were malformed, or an error occurred.
+   *   Each non-null element in this array is a valid input into the retrieve function, which will fetch
+   *   some VAST XML which can be used to render this bid's ad.
+   */
+  (error: Error | null, uuids: { uuid: string }[])
 }
 
 /**

package/test/helpers/index_adapter_utils.js

@@ -137,8 +137,7 @@ function compareOnKeys(lhs, rhs) {
   }
 
   for (let key in rhs) {
-    if (key in lhs) {
-    } else {
+    if (!(key in lhs)) {
       ronly.push(rhs[key]);
     }
   }

package/test/helpers/refererDetectionHelper.js

@@ -33,8 +33,8 @@ export function buildWindowTree(urls, topReferrer = null, canonicalUrl = null, a
 
   const windowList = urls.map((url, index) => {
     const thisOrigin = getOrigin(url);
-      const sameOriginAsPrevious = index === 0 ? true : (getOrigin(urls[index - 1]) === thisOrigin);
-      const sameOriginAsTop = thisOrigin === topOrigin;
+    const sameOriginAsPrevious = index === 0 ? true : (getOrigin(urls[index - 1]) === thisOrigin);
+    const sameOriginAsTop = thisOrigin === topOrigin;
 
     const win = {
       location: {

package/test/mocks/timers.js

@@ -10,7 +10,10 @@ export function configureTimerInterceptors(debugLog = function() {}, generateSta
   wrappersActive = true;
   let theseWrappersActive = true;
 
-  const originalSetTimeout = setTimeout; const originalSetInterval = setInterval; const originalClearTimeout = clearTimeout; const originalClearInterval = clearInterval;
+  const originalSetTimeout = globalThis.setTimeout;
+  const originalSetInterval = globalThis.setInterval;
+  const originalClearTimeout = globalThis.clearTimeout;
+  const originalClearInterval = globalThis.clearInterval;
 
   let timerId = -1;
   const timers = [];
@@ -62,10 +65,10 @@ export function configureTimerInterceptors(debugLog = function() {}, generateSta
   const clearTimeoutInterceptor = generateClearInterceptor('timeout', originalClearTimeout);
   const clearIntervalInterceptor = generateClearInterceptor('interval', originalClearInterval);
 
-  setTimeout = setTimeoutInterceptor;
-  setInterval = setIntervalInterceptor;
-  clearTimeout = clearTimeoutInterceptor;
-  clearInterval = clearIntervalInterceptor;
+  globalThis.setTimeout = setTimeoutInterceptor;
+  globalThis.setInterval = setIntervalInterceptor;
+  globalThis.clearTimeout = clearTimeoutInterceptor;
+  globalThis.clearInterval = clearIntervalInterceptor;
 
   return {
     waitAllActiveTimers,
@@ -74,10 +77,10 @@ export function configureTimerInterceptors(debugLog = function() {}, generateSta
     restore: () => {
       if (theseWrappersActive) {
         theseWrappersActive = false;
-        setTimeout = originalSetTimeout;
-        setInterval = originalSetInterval;
-        clearTimeout = originalClearTimeout;
-        clearInterval = originalClearInterval;
+        globalThis.setTimeout = originalSetTimeout;
+        globalThis.setInterval = originalSetInterval;
+        globalThis.clearTimeout = originalClearTimeout;
+        globalThis.clearInterval = originalClearInterval;
       }
     }
   }

package/test/spec/adloader_spec.js

@@ -75,22 +75,22 @@ describe('adLoader', function () {
 
   it('attaches passed attributes to a script', function () {
     const doc = {
-        createElement: function () {
-          return {
-            setAttribute: function (key, value) {
-              this[key] = value;
-            }
+      createElement: function () {
+        return {
+          setAttribute: function (key, value) {
+            this[key] = value;
           }
-        },
-        getElementsByTagName: function() {
-          return {
-            firstChild: {
-              insertBefore: function() {}
-            }
+        }
+      },
+      getElementsByTagName: function() {
+        return {
+          firstChild: {
+            insertBefore: function() {}
           }
         }
-      };
-      const attrs = {'z': 'A', 'y': 2};
+      }
+    };
+    const attrs = {'z': 'A', 'y': 2};
     const script = adLoader.loadExternalScript('someUrl', MODULE_TYPE_PREBID, 'debugging', undefined, doc, attrs);
     expect(script.z).to.equal('A');
     expect(script.y).to.equal(2);

package/test/spec/config_spec.js

@@ -572,7 +572,9 @@ describe('config API', function () {
     mergeBidderConfig('invalid object');
     expect(logErrorSpy.calledOnce).to.equal(true);
     const error = 'setBidderConfig bidder options must be an object';
-    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+    const errObj = logErrorSpy.firstCall.args[0];
+    expect(errObj).to.be.instanceOf(Error);
+    expect(errObj.message).to.equal(error, 'expected error was logged');
   });
 
   it('should log error for empty bidders array', function () {
@@ -592,7 +594,9 @@ describe('config API', function () {
     });
     expect(logErrorSpy.calledOnce).to.equal(true);
     const error = 'setBidderConfig bidder options must contain a bidders list with at least 1 bidder';
-    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+    const errObj = logErrorSpy.firstCall.args[0];
+    expect(errObj).to.be.instanceOf(Error);
+    expect(errObj.message).to.equal(error, 'expected error was logged');
   });
 
   it('should log error for nonexistent config object', function () {
@@ -601,7 +605,9 @@ describe('config API', function () {
     });
     expect(logErrorSpy.calledOnce).to.equal(true);
     const error = 'setBidderConfig bidder options must contain a config object';
-    assert.ok(logErrorSpy.calledWith(error), 'expected error was logged');
+    const errObj = logErrorSpy.firstCall.args[0];
+    expect(errObj).to.be.instanceOf(Error);
+    expect(errObj.message).to.equal(error, 'expected error was logged');
   });
 
   it('should merge without array duplication', function() {

package/test/spec/libraries/greedy/greedyPromise_spec.js

@@ -25,7 +25,7 @@ describe('GreedyPromise', () => {
 
     Object.entries({
 
-      'resolver that throws': (P) => new P(() => { throw 'error' }),
+      'resolver that throws': (P) => new P(() => { throw new Error('error') }),
       'resolver that resolves multiple times': (P) => new P((resolve) => { resolve('first'); resolve('second'); }),
       'resolver that rejects multiple times': (P) => new P((resolve, reject) => { reject('first'); reject('second') }),
       'resolver that resolves and rejects': (P) => new P((resolve, reject) => { reject('first'); resolve('second') }),
@@ -75,7 +75,7 @@ describe('GreedyPromise', () => {
           .catch((err) => `${err} ${fval}`)
       },
 
-      '.finally that throws': (P) => makePromise(P, 'value').finally(() => { throw 'error' }),
+      '.finally that throws': (P) => makePromise(P, 'value').finally(() => { throw new Error('error') }),
       'chained .finally that rejects': (P) => makePromise(P, 'value').finally(() => P.reject('error')),
       'scalar Promise.resolve': (P) => P.resolve('scalar'),
       'null Promise.resolve': (P) => P.resolve(null),

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

@@ -266,7 +266,7 @@ describe('1plusXRtdProvider', () => {
       expect(extractConsent(consent1)).to.equal(null)
     })
 
-    it('throws an error if the consent is malformed', () => {
+    it('returns null if the consent is malformed', () => {
       const consent1 = {
         gdpr: {
           consentString: 'myConsent'
@@ -289,14 +289,7 @@ describe('1plusXRtdProvider', () => {
       }
 
       for (const consent of [consent1, consent2, consent3, consent4]) {
-        var failed = false;
-        try {
-          extractConsent(consent)
-        } catch (e) {
-          failed = true;
-        } finally {
-          assert(failed, 'Should be throwing an exception')
-        }
+        expect(extractConsent(consent)).to.be.null
       }
     })
   })

package/test/spec/modules/adgridBidAdapter_spec.js

@@ -563,11 +563,11 @@ describe('adgrid bid adapter tests', () => {
       var syncs = spec.getUserSyncs({}, null, DEFAULT_OPTIONS.gdprConsent, DEFAULT_OPTIONS.uspConsent);
       expect(syncs).to.eql([]);
     });
-      it('Verifies user sync with no bid body response', () => {
-        let syncs = spec.getUserSyncs({}, [], DEFAULT_OPTIONS.gdprConsent, DEFAULT_OPTIONS.uspConsent);
-        expect(syncs).to.eql([]);
-        syncs = spec.getUserSyncs({}, [{}], DEFAULT_OPTIONS.gdprConsent, DEFAULT_OPTIONS.uspConsent);
-        expect(syncs).to.eql([]);
-      });
+    it('Verifies user sync with no bid body response', () => {
+      let syncs = spec.getUserSyncs({}, [], DEFAULT_OPTIONS.gdprConsent, DEFAULT_OPTIONS.uspConsent);
+      expect(syncs).to.eql([]);
+      syncs = spec.getUserSyncs({}, [{}], DEFAULT_OPTIONS.gdprConsent, DEFAULT_OPTIONS.uspConsent);
+      expect(syncs).to.eql([]);
+    });
   });
 });