prebid.js 9.4.1 → 9.6.0

package/src/ajax.js

@@ -104,6 +104,7 @@ function toXHR({status, statusText = '', headers, url}, responseText) {
     return xml;
   }
   return {
+    // eslint-disable-next-line prebid/no-global
     readyState: XMLHttpRequest.DONE,
     status,
     statusText,
@@ -147,5 +148,19 @@ export function ajaxBuilder(timeout = 3000, {request, done} = {}) {
   };
 }
 
+/**
+ * simple wrapper around sendBeacon such that invocations of navigator.sendBeacon can be centrally maintained.
+ * verifies that the navigator and sendBeacon are defined for maximum compatibility
+ * @param {string} url The URL that will receive the data. Can be relative or absolute.
+ * @param {*} data An ArrayBuffer, a TypedArray, a DataView, a Blob, a string literal or object, a FormData or a URLSearchParams object containing the data to send.
+ * @returns {boolean} true if the user agent successfully queued the data for transfer. Otherwise, it returns false.
+ */
+export function sendBeacon(url, data) {
+  if (!window.navigator || !window.navigator.sendBeacon) {
+    return false;
+  }
+  return window.navigator.sendBeacon(url, data);
+}
+
 export const ajax = ajaxBuilder();
 export const fetch = fetcherFactory();

package/src/config.js

@@ -38,8 +38,6 @@ const DEFAULT_DEVICE_ACCESS = true;
 const DEFAULT_MAX_NESTED_IFRAMES = 10;
 const DEFAULT_MAXBID_VALUE = 5000
 
-const DEFAULT_TIMEOUTBUFFER = 400;
-
 const DEFAULT_IFRAMES_CONFIG = {};
 
 export const RANDOM = 'random';
@@ -157,8 +155,6 @@ export function newConfig() {
        */
       deviceAccess: DEFAULT_DEVICE_ACCESS,
 
-      // timeout buffer to adjust for bidder CDN latency
-      timeoutBuffer: DEFAULT_TIMEOUTBUFFER,
       disableAjaxTimeout: DEFAULT_DISABLE_AJAX_TIMEOUT,
 
       // default max nested iframes for referer detection

package/src/debugging.js

@@ -73,6 +73,7 @@ export const reset = ctl.reset;
 export function loadSession() {
   let storage = null;
   try {
+    // eslint-disable-next-line prebid/no-global
     storage = window.sessionStorage;
   } catch (e) {}
 

package/src/prebid.js

@@ -869,6 +869,10 @@ pbjsInstance.getHighestCpmBids = function (adUnitCode) {
   return targeting.getWinningBids(adUnitCode);
 };
 
+pbjsInstance.clearAllAuctions = function () {
+  auctionManager.clearAllAuctions();
+};
+
 if (FEATURES.VIDEO) {
   /**
    * Mark the winning bid as used, should only be used in conjunction with video

package/src/secureCreatives.js

@@ -144,7 +144,7 @@ export function resizeRemoteCreative({adId, adUnitCode, width, height}) {
       elementStyle.width = getDimension(width)
       elementStyle.height = getDimension(height);
     } else {
-      logWarn(`Unable to locate matching page element for adUnitCode ${adUnitCode}.  Can't resize it to ad's dimensions.  Please review setup.`);
+      logError(`Unable to locate matching page element for adUnitCode ${adUnitCode}.  Can't resize it to ad's dimensions.  Please review setup.`);
     }
   });
 

package/src/storageManager.js

@@ -18,6 +18,8 @@ export const STORAGE_TYPE_COOKIES = 'cookie';
 
 export let storageCallbacks = [];
 
+/* eslint-disable prebid/no-global */
+
 /*
  *  Storage manager constructor. Consumers should prefer one of `getStorageManager` or `getCoreStorageManager`.
  */
@@ -64,6 +66,7 @@ export function newStorageManager({moduleName, moduleType} = {}, {isAllowed = is
         const expiresPortion = (expires && expires !== '') ? ` ;expires=${expires}` : '';
         const isNone = (sameSite != null && sameSite.toLowerCase() == 'none')
         const secure = (isNone) ? '; Secure' : '';
+        // eslint-disable-next-line prebid/no-member
         document.cookie = `${key}=${encodeURIComponent(value)}${expiresPortion}; path=/${domainPortion}${sameSite ? `; SameSite=${sameSite}` : ''}${secure}`;
       }
     }
@@ -85,27 +88,6 @@ export function newStorageManager({moduleName, moduleType} = {}, {isAllowed = is
     return schedule(cb, STORAGE_TYPE_COOKIES, done);
   };
 
-  /**
-   * @returns {boolean}
-   */
-  const localStorageIsEnabled = function (done) {
-    let cb = function (result) {
-      if (result && result.valid) {
-        try {
-          localStorage.setItem('prebid.cookieTest', '1');
-          return localStorage.getItem('prebid.cookieTest') === '1';
-        } catch (error) {
-        } finally {
-          try {
-            localStorage.removeItem('prebid.cookieTest');
-          } catch (error) {}
-        }
-      }
-      return false;
-    }
-    return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
-  }
-
   /**
    * @returns {boolean}
    */
@@ -119,60 +101,69 @@ export function newStorageManager({moduleName, moduleType} = {}, {isAllowed = is
     return schedule(cb, STORAGE_TYPE_COOKIES, done);
   }
 
-  /**
-   * @param {string} key
-   * @param {string} value
-   */
-  const setDataInLocalStorage = function (key, value, done) {
-    let cb = function (result) {
-      if (result && result.valid && hasLocalStorage()) {
-        window.localStorage.setItem(key, value);
-      }
-    }
-    return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
-  }
+  function storageMethods(name) {
+    const capName = name.charAt(0).toUpperCase() + name.substring(1);
+    const backend = () => window[name];
 
-  /**
-   * @param {string} key
-   * @returns {(string|null)}
-   */
-  const getDataFromLocalStorage = function (key, done) {
-    let cb = function (result) {
-      if (result && result.valid && hasLocalStorage()) {
-        return window.localStorage.getItem(key);
-      }
-      return null;
-    }
-    return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
-  }
-
-  /**
-   * @param {string} key
-   */
-  const removeDataFromLocalStorage = function (key, done) {
-    let cb = function (result) {
-      if (result && result.valid && hasLocalStorage()) {
-        window.localStorage.removeItem(key);
+    const hasStorage = function (done) {
+      let cb = function (result) {
+        if (result && result.valid) {
+          try {
+            return !!backend();
+          } catch (e) {
+            logError(`${name} api disabled`);
+          }
+        }
+        return false;
       }
+      return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
     }
-    return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
-  }
 
-  /**
-   * @returns {boolean}
-   */
-  const hasLocalStorage = function (done) {
-    let cb = function (result) {
-      if (result && result.valid) {
-        try {
-          return !!window.localStorage;
-        } catch (e) {
-          logError('Local storage api disabled');
+    return {
+      [`has${capName}`]: hasStorage,
+      [`${name}IsEnabled`](done) {
+        let cb = function (result) {
+          if (result && result.valid) {
+            try {
+              backend().setItem('prebid.cookieTest', '1');
+              return backend().getItem('prebid.cookieTest') === '1';
+            } catch (error) {
+            } finally {
+              try {
+                backend().removeItem('prebid.cookieTest');
+              } catch (error) {}
+            }
+          }
+          return false;
         }
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
+      },
+      [`setDataIn${capName}`](key, value, done) {
+        let cb = function (result) {
+          if (result && result.valid && hasStorage()) {
+            backend().setItem(key, value);
+          }
+        }
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
+      },
+      [`getDataFrom${capName}`](key, done) {
+        let cb = function (result) {
+          if (result && result.valid && hasStorage()) {
+            return backend().getItem(key);
+          }
+          return null;
+        }
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
+      },
+      [`removeDataFrom${capName}`](key, done) {
+        let cb = function (result) {
+          if (result && result.valid && hasStorage()) {
+            backend().removeItem(key);
+          }
+        }
+        return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
       }
-      return false;
     }
-    return schedule(cb, STORAGE_TYPE_LOCALSTORAGE, done);
   }
 
   /**
@@ -186,6 +177,7 @@ export function newStorageManager({moduleName, moduleType} = {}, {isAllowed = is
       if (result && result.valid) {
         const all = [];
         if (hasDeviceAccess()) {
+          // eslint-disable-next-line prebid/no-member
           const cookies = document.cookie.split(';');
           while (cookies.length) {
             const cookie = cookies.pop();
@@ -207,12 +199,9 @@ export function newStorageManager({moduleName, moduleType} = {}, {isAllowed = is
   return {
     setCookie,
     getCookie,
-    localStorageIsEnabled,
     cookiesAreEnabled,
-    setDataInLocalStorage,
-    getDataFromLocalStorage,
-    removeDataFromLocalStorage,
-    hasLocalStorage,
+    ...storageMethods('localStorage'),
+    ...storageMethods('sessionStorage'),
     findSimilarCookies
   }
 }

package/src/targeting.js

@@ -1,3 +1,21 @@
+import { auctionManager } from './auctionManager.js';
+import { getTTL } from './bidTTL.js';
+import { bidderSettings } from './bidderSettings.js';
+import { config } from './config.js';
+import {
+  BID_STATUS,
+  DEFAULT_TARGETING_KEYS,
+  EVENTS,
+  JSON_MAPPING,
+  NATIVE_KEYS,
+  STATUS,
+  TARGETING_KEYS
+} from './constants.js';
+import * as events from './events.js';
+import { hook } from './hook.js';
+import { ADPOD } from './mediaTypes.js';
+import { NATIVE_TARGETING_KEYS } from './native.js';
+import { find, includes } from './polyfill.js';
 import {
   deepAccess,
   deepClone,
@@ -14,25 +32,7 @@ import {
   timestamp,
   uniques,
 } from './utils.js';
-import {config} from './config.js';
-import {NATIVE_TARGETING_KEYS} from './native.js';
-import {auctionManager} from './auctionManager.js';
-import {ADPOD} from './mediaTypes.js';
-import {hook} from './hook.js';
-import {bidderSettings} from './bidderSettings.js';
-import {find, includes} from './polyfill.js';
-import {
-  BID_STATUS,
-  DEFAULT_TARGETING_KEYS,
-  EVENTS,
-  JSON_MAPPING,
-  NATIVE_KEYS,
-  STATUS,
-  TARGETING_KEYS
-} from './constants.js';
-import {getHighestCpm, getOldestHighestCpmBid} from './utils/reducers.js';
-import {getTTL} from './bidTTL.js';
-import * as events from './events.js';
+import { getHighestCpm, getOldestHighestCpmBid } from './utils/reducers.js';
 
 var pbTargetingKeys = [];
 
@@ -139,7 +139,7 @@ export function sortByDealAndPriceBucketOrCpm(useCpm = false) {
  * @param {Array<String>} adUnitCodes
  * @param customSlotMatching
  * @param getSlots
- * @return {{[p: string]: any}}
+ * @return {Object.<string,any>}
  */
 export function getGPTSlotsForAdUnits(adUnitCodes, customSlotMatching, getSlots = () => window.googletag.pubads().getSlots()) {
   return getSlots().reduce((auToSlots, slot) => {
@@ -461,10 +461,16 @@ export function newTargeting(auctionManager) {
       });
     });
 
+    targeting.targetingDone(targetingSet);
+
     // emit event
     events.emit(EVENTS.SET_TARGETING, targetingSet);
   }, 'setTargetingForGPT');
 
+  targeting.targetingDone = hook('sync', function (targetingSet) {
+    return targetingSet;
+  }, 'targetingDone');
+
   /**
    * normlizes input to a `adUnit.code` array
    * @param  {(string|string[])} adUnitCode [description]

package/src/utils.js

@@ -748,6 +748,7 @@ export function hasDeviceAccess() {
  * @returns {(boolean|undefined)}
  */
 export function checkCookieSupport() {
+  // eslint-disable-next-line prebid/no-member
   if (window.navigator.cookieEnabled || !!document.cookie.length) {
     return true;
   }
@@ -1109,6 +1110,14 @@ export function safeJSONParse(data) {
   } catch (e) {}
 }
 
+export function safeJSONEncode(data) {
+  try {
+    return JSON.stringify(data);
+  } catch (e) {
+    return '';
+  }
+}
+
 /**
  * Returns a memoized version of `fn`.
  *

package/test/pages/consent_mgt_gdpr.html

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <script async src="http://localhost:4444/bundle?modules=appnexusBidAdapter&modules=consentManagement&modules=gpdrEnforcement"></script>
+  <script async src="http://localhost:4444/bundle?modules=appnexusBidAdapter&modules=consentManagement&modules=gdprEnforcement"></script>
   <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
   <script>
     (function (window, document) {

package/test/spec/ajax_spec.js

@@ -0,0 +1,11 @@
+import { expect } from 'chai';
+import { sendBeacon } from '../../src/ajax.js'
+
+describe('test sendBeacon wrapper', () => {
+  it('with legitimate behaviour', () => {
+    sinon.stub(navigator, 'sendBeacon').returns(true);
+    expect(sendBeacon('http://localhost:80/')).to.equal(true);
+    expect(navigator.sendBeacon.callCount).to.equal(1);
+    navigator.sendBeacon.restore();
+  })
+})

package/test/spec/creative/crossDomainCreative_spec.js

@@ -72,12 +72,6 @@ describe('cross-domain creative', () => {
     expect(messages[0].targetOrigin).to.eql('https://domain.com:123')
   });
 
-  it('posts to first parent if no __pb_locator__ can be found', () => {
-    delete win.parent.frames['__pb_locator__'];
-    renderAd({pubUrl: 'https://www.example.com'});
-    expect(messages.length).to.eql(1);
-  })
-
   describe('when there are multiple ancestors', () => {
     let target;
     beforeEach(() => {
@@ -88,16 +82,39 @@ describe('cross-domain creative', () => {
         parent: {
           ...target,
           parent: {
+            top,
             frames: {'__pb_locator__': {}},
-            top
+            parent: {
+              top,
+              frames: {}
+            },
           }
         }
       }
     })
-    it('posts message to the first ancestor with __pb_locator__ child', () => {
+    Object.entries({
+      'throws': () => { throw new DOMException() },
+      'does not throw': () => ({})
+    }).forEach(([t, getFrames]) => {
+      describe(`when an ancestor ${t}`, () => {
+        beforeEach(() => {
+          Object.defineProperty(win.parent.parent.parent.parent, 'frames', {get: getFrames})
+        })
+        it('posts message to the first ancestor with __pb_locator__ child', () => {
+          renderAd({pubUrl: 'https://www.example.com'});
+          expect(messages.length).to.eql(1);
+        });
+      })
+    })
+    it('posts to first restricted parent, if __pb_locator__ cannot be found', () => {
+      Object.defineProperty(win.parent.parent.parent, 'frames', {
+        get() {
+          throw new DOMException();
+        }
+      });
       renderAd({pubUrl: 'https://www.example.com'});
       expect(messages.length).to.eql(1);
-    });
+    })
   })
 
   it('generates request message with adId and clickUrl', () => {

package/test/spec/fpd/gdpr_spec.js

@@ -34,7 +34,7 @@ describe('GDPR FPD enrichment', () => {
     })
   });
 
-  it('sets user.ext.consent, but not regs.ext.gdpr, if gpdrApplies is not a boolean', () => {
+  it('sets user.ext.consent, but not regs.ext.gdpr, if gdprApplies is not a boolean', () => {
     consent = {consentString: 'mock-consent'};
     return callHook().then(ortb2 => {
       expect(ortb2).to.eql({

package/test/spec/libraries/userAgentUtils_spec.js

@@ -0,0 +1,109 @@
+/* globals describe, beforeEach, afterEach, sinon */
+import { expect } from 'chai';
+import { getDeviceType, getBrowser, getOS } from 'libraries/userAgentUtils';
+import { deviceTypes, browserTypes, osTypes } from 'libraries/userAgentUtils/userAgentTypes.enums';
+
+const ORIGINAL_USER_AGENT = window.navigator.userAgent;
+const ORIGINAL_VENDOR = window.navigator.vendor;
+const ORIGINAL_APP_VERSION = window.navigator.appVersion;
+
+describe('Test user agent categorization', () => {
+  afterEach(() => {
+    window.navigator.__defineGetter__('userAgent', () => ORIGINAL_USER_AGENT);
+    window.navigator.__defineGetter__('vendor', () => ORIGINAL_VENDOR);
+    window.navigator.__defineGetter__('appVersion', () => ORIGINAL_APP_VERSION);
+  })
+
+  describe('test getDeviceType', () => {
+    it('user agent device type is tablet', () => {
+      const tabletUserAgent = 'Mozilla/5.0 (iPad; CPU OS 8_4_1 like Mac OS X) AppleWebKit/600.1.4.17.9 (KHTML, like Gecko) Version/5.1 Mobile/9B206 Safari/7534.48.3'
+      window.navigator.__defineGetter__('userAgent', () => tabletUserAgent);
+      expect(getDeviceType()).to.equal(deviceTypes.TABLET);
+    })
+    it('user agent device type is mobile', () => {
+      const mobileUserAgent = 'Mozilla/5.0 (Linux; Android 12; M2102J20SG) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Mobile Safari/537.36'
+      window.navigator.__defineGetter__('userAgent', () => mobileUserAgent);
+      expect(getDeviceType()).to.equal(deviceTypes.MOBILE);
+    })
+    it('user agent device type is desktop', () => {
+      const desktopUserAgent = 'Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36'
+      window.navigator.__defineGetter__('userAgent', () => desktopUserAgent);
+      expect(getDeviceType()).to.equal(deviceTypes.DESKTOP);
+    })
+  })
+
+  describe('test getBrowser', () => {
+    it('user agent browser is edge', () => {
+      const edgeUserAgent = 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36 Edge/12.10532'
+      window.navigator.__defineGetter__('userAgent', () => edgeUserAgent);
+      expect(getBrowser()).to.equal(browserTypes.EDGE);
+    })
+    it('user agent browser is chrome', () => {
+      const chromeUserAgent = 'Mozilla/5.0 (iPad; CPU OS 8_4 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) CriOS/44.0.2403.67 Mobile/12H143 Safari/600.1.4'
+      window.navigator.__defineGetter__('userAgent', () => chromeUserAgent);
+      expect(getBrowser()).to.equal(browserTypes.CHROME);
+    })
+    it('user agent browser is firefox', () => {
+      const firefoxUserAgent = 'Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:40.0) Gecko/20100101 Firefox/40.0.2 Waterfox/40.0.2'
+      window.navigator.__defineGetter__('userAgent', () => firefoxUserAgent);
+      expect(getBrowser()).to.equal(browserTypes.FIREFOX);
+    })
+    it('user agent browser is safari', () => {
+      const safariUserAgent = 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/37.0.2062.124 Safari/537.36'
+      window.navigator.__defineGetter__('userAgent', () => safariUserAgent);
+      window.navigator.__defineGetter__('vendor', () => 'Apple Computer, Inc.');
+      expect(getBrowser()).to.equal(browserTypes.SAFARI);
+    })
+    it('user agent browser is internet explorer', () => {
+      const internetexplorerUserAgent = 'Mozilla/5.0 (MSIE 9.0; Windows NT 6.1; WOW64; Trident/7.0; rv:11.0) like Gecko'
+      window.navigator.__defineGetter__('userAgent', () => internetexplorerUserAgent);
+      expect(getBrowser()).to.equal(browserTypes.INTERNET_EXPLORER);
+    })
+    it('user agent is other', () => {
+      const otherUserAgent = 'Dalvik/2.1.0 (Linux; U; Android 9; ADT-2 Build/PTT5.181126.002)'
+      window.navigator.__defineGetter__('userAgent', () => otherUserAgent);
+      expect(getBrowser()).to.equal(browserTypes.OTHER);
+    })
+  })
+
+  describe('test getOS', () => {
+    it('user agent is android', () => {
+      const androidUserAgent = 'Mozilla/5.0 (Android; Mobile; rv:40.0) Gecko/40.0 Firefox/40.0'
+      window.navigator.__defineGetter__('userAgent', () => androidUserAgent);
+      expect(getOS()).to.equal(osTypes.ANDROID);
+    })
+    it('user agent is ios', () => {
+      const iosUserAgent = 'Mozilla/5.0 (iPad; CPU OS 8_4_1 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12H321 Safari/600.1.4'
+      window.navigator.__defineGetter__('userAgent', () => iosUserAgent);
+      expect(getOS()).to.equal(osTypes.IOS);
+    })
+    it('user agent is windows', () => {
+      const windowsUserAgent = 'Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/33.0.1750.154 Safari/537.36'
+      window.navigator.__defineGetter__('userAgent', () => windowsUserAgent);
+      expect(getOS()).to.equal(osTypes.WINDOWS);
+    })
+    it('user agent is mac', () => {
+      const macUserAgent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:33.0) Gecko/20100101 Firefox/33.0'
+      window.navigator.__defineGetter__('userAgent', () => macUserAgent);
+      expect(getOS()).to.equal(osTypes.MAC);
+    })
+    it('user agent is linux', () => {
+      const linuxUserAgent = 'Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Firefox/31.0'
+      window.navigator.__defineGetter__('userAgent', () => linuxUserAgent);
+      expect(getOS()).to.equal(osTypes.LINUX);
+    })
+    it('user agent is unix', () => {
+      const unixUserAgent = 'Mozilla/5.0 (X11; CrOS armv7l 7077.134.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.156 Safari/537.36'
+      const unixappVersion = '5.0 (X11; CrOS armv7l 7077.134.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.156 Safari/537.36'
+      window.navigator.__defineGetter__('userAgent', () => unixUserAgent);
+      window.navigator.__defineGetter__('appVersion', () => unixappVersion);
+      expect(getOS()).to.equal(osTypes.UNIX);
+    })
+    it('user agent is other', () => {
+      const otherUserAgent = 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)'
+      window.navigator.__defineGetter__('userAgent', () => otherUserAgent);
+      window.navigator.__defineGetter__('appVersion', () => '');
+      expect(getOS()).to.equal(osTypes.OTHER);
+    })
+  })
+})