prebid.js 7.11.0 → 7.12.0

package/modules/id5IdSystem.js

@@ -7,19 +7,19 @@
 
 import {
   deepAccess,
-  logInfo,
   deepSetValue,
-  logError,
   isEmpty,
   isEmptyStr,
+  logError,
+  logInfo,
   logWarn,
   safeJSONParse
 } from '../src/utils.js';
-import { ajax } from '../src/ajax.js';
-import { submodule } from '../src/hook.js';
-import { getRefererInfo } from '../src/refererDetection.js';
-import { getStorageManager } from '../src/storageManager.js';
-import { uspDataHandler } from '../src/adapterManager.js';
+import {ajax} from '../src/ajax.js';
+import {submodule} from '../src/hook.js';
+import {getRefererInfo} from '../src/refererDetection.js';
+import {getStorageManager} from '../src/storageManager.js';
+import {uspDataHandler} from '../src/adapterManager.js';
 
 const MODULE_NAME = 'id5Id';
 const GVLID = 131;
@@ -28,10 +28,11 @@ export const ID5_STORAGE_NAME = 'id5id';
 export const ID5_PRIVACY_STORAGE_NAME = `${ID5_STORAGE_NAME}_privacy`;
 const LOCAL_STORAGE = 'html5';
 const LOG_PREFIX = 'User ID - ID5 submodule: ';
+const ID5_API_CONFIG_URL = 'https://id5-sync.com/api/config/prebid'
 
 // order the legacy cookie names in reverse priority order so the last
 // cookie in the array is the most preferred to use
-const LEGACY_COOKIE_NAMES = [ 'pbjs-id5id', 'id5id.1st', 'id5id' ];
+const LEGACY_COOKIE_NAMES = ['pbjs-id5id', 'id5id.1st', 'id5id'];
 
 export const storage = getStorageManager({gvlid: GVLID, moduleName: MODULE_NAME});
 
@@ -102,92 +103,27 @@ export const id5IdSubmodule = {
   /**
    * performs action to obtain id and return a value in the callback's response argument
    * @function getId
-   * @param {SubmoduleConfig} config
+   * @param {SubmoduleConfig} submoduleConfig
    * @param {ConsentData} consentData
    * @param {(Object|undefined)} cacheIdObj
    * @returns {IdResponse|undefined}
    */
-  getId(config, consentData, cacheIdObj) {
-    if (!hasRequiredConfig(config)) {
+  getId(submoduleConfig, consentData, cacheIdObj) {
+    if (!hasRequiredConfig(submoduleConfig)) {
       return undefined;
     }
 
-    const url = `https://id5-sync.com/g/v2/${config.params.partner}.json`;
-    const hasGdpr = (consentData && typeof consentData.gdprApplies === 'boolean' && consentData.gdprApplies) ? 1 : 0;
-    const usp = uspDataHandler.getConsentData();
-    const referer = getRefererInfo();
-    const signature = (cacheIdObj && cacheIdObj.signature) ? cacheIdObj.signature : getLegacyCookieSignature();
-    const data = {
-      'partner': config.params.partner,
-      'gdpr': hasGdpr,
-      'nbPage': incrementNb(config.params.partner),
-      'o': 'pbjs',
-      'rf': referer.topmostLocation,
-      'top': referer.reachedTop ? 1 : 0,
-      'u': referer.stack[0] || window.location.href,
-      'v': '$prebid.version$'
-    };
-
-    // pass in optional data, but only if populated
-    if (hasGdpr && typeof consentData.consentString !== 'undefined' && !isEmpty(consentData.consentString) && !isEmptyStr(consentData.consentString)) {
-      data.gdpr_consent = consentData.consentString;
-    }
-    if (typeof usp !== 'undefined' && !isEmpty(usp) && !isEmptyStr(usp)) {
-      data.us_privacy = usp;
-    }
-    if (typeof signature !== 'undefined' && !isEmptyStr(signature)) {
-      data.s = signature;
-    }
-    if (typeof config.params.pd !== 'undefined' && !isEmptyStr(config.params.pd)) {
-      data.pd = config.params.pd;
-    }
-    if (typeof config.params.provider !== 'undefined' && !isEmptyStr(config.params.provider)) {
-      data.provider = config.params.provider;
-    }
-
-    const abTestingConfig = getAbTestingConfig(config);
-    if (abTestingConfig.enabled === true) {
-      data.ab_testing = {
-        enabled: true,
-        control_group_pct: abTestingConfig.controlGroupPct // The server validates
-      };
-    }
-
-    const resp = function (callback) {
-      const callbacks = {
-        success: response => {
-          let responseObj;
-          if (response) {
-            try {
-              responseObj = JSON.parse(response);
-              logInfo(LOG_PREFIX + 'response received from the server', responseObj);
-
-              resetNb(config.params.partner);
-
-              if (responseObj.privacy) {
-                storeInLocalStorage(ID5_PRIVACY_STORAGE_NAME, JSON.stringify(responseObj.privacy), NB_EXP_DAYS);
-              }
-
-              // TODO: remove after requiring publishers to use localstorage and
-              // all publishers have upgraded
-              if (config.storage.type === LOCAL_STORAGE) {
-                removeLegacyCookies(config.params.partner);
-              }
-            } catch (error) {
-              logError(LOG_PREFIX + error);
-            }
-          }
-          callback(responseObj);
-        },
-        error: error => {
+    const resp = function (cbFunction) {
+      new IdFetchFlow(submoduleConfig, consentData, cacheIdObj, uspDataHandler.getConsentData()).execute()
+        .then(response => {
+          cbFunction(response)
+        })
+        .catch(error => {
           logError(LOG_PREFIX + 'getId fetch encountered an error', error);
-          callback();
-        }
-      };
-      logInfo(LOG_PREFIX + 'requesting an ID from the server', data);
-      ajax(url, callbacks, JSON.stringify(data), { method: 'POST', withCredentials: true });
+          cbFunction();
+        });
     };
-    return { callback: resp };
+    return {callback: resp};
   },
 
   /**
@@ -212,6 +148,139 @@ export const id5IdSubmodule = {
   }
 };
 
+class IdFetchFlow {
+  constructor(submoduleConfig, gdprConsentData, cacheIdObj, usPrivacyData) {
+    this.submoduleConfig = submoduleConfig
+    this.gdprConsentData = gdprConsentData
+    this.cacheIdObj = cacheIdObj
+    this.usPrivacyData = usPrivacyData
+  }
+
+  execute() {
+    return this.#callForConfig(this.submoduleConfig)
+      .then(fetchFlowConfig => {
+        return this.#callForExtensions(fetchFlowConfig.extensionsCall)
+          .then(extensionsData => {
+            return this.#callId5Fetch(fetchFlowConfig.fetchCall, extensionsData)
+          })
+      })
+      .then(fetchCallResponse => {
+        try {
+          resetNb(this.submoduleConfig.params.partner);
+          if (fetchCallResponse.privacy) {
+            storeInLocalStorage(ID5_PRIVACY_STORAGE_NAME, JSON.stringify(fetchCallResponse.privacy), NB_EXP_DAYS);
+          }
+        } catch (error) {
+          logError(LOG_PREFIX + error);
+        }
+        return fetchCallResponse;
+      })
+  }
+
+  #ajaxPromise(url, data, options) {
+    return new Promise((resolve, reject) => {
+      ajax(url,
+        {
+          success: function (res) {
+            resolve(res)
+          },
+          error: function (err) {
+            reject(err)
+          }
+        }, data, options)
+    })
+  }
+
+  // eslint-disable-next-line no-dupe-class-members
+  #callForConfig(submoduleConfig) {
+    let url = submoduleConfig.params.configUrl || ID5_API_CONFIG_URL; // override for debug/test purposes only
+    return this.#ajaxPromise(url, JSON.stringify(submoduleConfig), {method: 'POST'})
+      .then(response => {
+        let responseObj = JSON.parse(response);
+        logInfo(LOG_PREFIX + 'config response received from the server', responseObj);
+        return responseObj;
+      });
+  }
+
+  // eslint-disable-next-line no-dupe-class-members
+  #callForExtensions(extensionsCallConfig) {
+    if (extensionsCallConfig === undefined) {
+      return Promise.resolve(undefined)
+    }
+    let extensionsUrl = extensionsCallConfig.url
+    let method = extensionsCallConfig.method || 'GET'
+    let data = method === 'GET' ? undefined : JSON.stringify(extensionsCallConfig.body || {})
+    return this.#ajaxPromise(extensionsUrl, data, {'method': method})
+      .then(response => {
+        let responseObj = JSON.parse(response);
+        logInfo(LOG_PREFIX + 'extensions response received from the server', responseObj);
+        return responseObj;
+      })
+  }
+
+  // eslint-disable-next-line no-dupe-class-members
+  #callId5Fetch(fetchCallConfig, extensionsData) {
+    let url = fetchCallConfig.url;
+    let additionalData = fetchCallConfig.overrides || {};
+    let data = {
+      ...this.#createFetchRequestData(),
+      ...additionalData,
+      extensions: extensionsData
+    };
+    return this.#ajaxPromise(url, JSON.stringify(data), {method: 'POST', withCredentials: true})
+      .then(response => {
+        let responseObj = JSON.parse(response);
+        logInfo(LOG_PREFIX + 'fetch response received from the server', responseObj);
+        return responseObj;
+      });
+  }
+
+  // eslint-disable-next-line no-dupe-class-members
+  #createFetchRequestData() {
+    const params = this.submoduleConfig.params;
+    const hasGdpr = (this.gdprConsentData && typeof this.gdprConsentData.gdprApplies === 'boolean' && this.gdprConsentData.gdprApplies) ? 1 : 0;
+    const referer = getRefererInfo();
+    const signature = (this.cacheIdObj && this.cacheIdObj.signature) ? this.cacheIdObj.signature : getLegacyCookieSignature();
+    const nbPage = incrementNb(params.partner);
+    const data = {
+      'partner': params.partner,
+      'gdpr': hasGdpr,
+      'nbPage': nbPage,
+      'o': 'pbjs',
+      'rf': referer.topmostLocation,
+      'top': referer.reachedTop ? 1 : 0,
+      'u': referer.stack[0] || window.location.href,
+      'v': '$prebid.version$',
+      'storage': this.submoduleConfig.storage
+    };
+
+    // pass in optional data, but only if populated
+    if (hasGdpr && this.gdprConsentData.consentString !== undefined && !isEmpty(this.gdprConsentData.consentString) && !isEmptyStr(this.gdprConsentData.consentString)) {
+      data.gdpr_consent = this.gdprConsentData.consentString;
+    }
+    if (this.usPrivacyData !== undefined && !isEmpty(this.usPrivacyData) && !isEmptyStr(this.usPrivacyData)) {
+      data.us_privacy = this.usPrivacyData;
+    }
+    if (signature !== undefined && !isEmptyStr(signature)) {
+      data.s = signature;
+    }
+    if (params.pd !== undefined && !isEmptyStr(params.pd)) {
+      data.pd = params.pd;
+    }
+    if (params.provider !== undefined && !isEmptyStr(params.provider)) {
+      data.provider = params.provider;
+    }
+    const abTestingConfig = params.abTesting || {enabled: false};
+
+    if (abTestingConfig.enabled) {
+      data.ab_testing = {
+        enabled: true, control_group_pct: abTestingConfig.controlGroupPct // The server validates
+      };
+    }
+    return data
+  }
+}
+
 function hasRequiredConfig(config) {
   if (!config || !config.params || !config.params.partner || typeof config.params.partner !== 'number') {
     logError(LOG_PREFIX + 'partner required to be defined as a number');
@@ -242,25 +311,29 @@ export function expDaysStr(expDays) {
 export function nbCacheName(partnerId) {
   return `${ID5_STORAGE_NAME}_${partnerId}_nb`;
 }
+
 export function storeNbInCache(partnerId, nb) {
   storeInLocalStorage(nbCacheName(partnerId), nb, NB_EXP_DAYS);
 }
+
 export function getNbFromCache(partnerId) {
   let cacheNb = getFromLocalStorage(nbCacheName(partnerId));
   return (cacheNb) ? parseInt(cacheNb) : 0;
 }
+
 function incrementNb(partnerId) {
   const nb = (getNbFromCache(partnerId) + 1);
   storeNbInCache(partnerId, nb);
   return nb;
 }
+
 function resetNb(partnerId) {
   storeNbInCache(partnerId, 0);
 }
 
 function getLegacyCookieSignature() {
   let legacyStoredValue;
-  LEGACY_COOKIE_NAMES.forEach(function(cookie) {
+  LEGACY_COOKIE_NAMES.forEach(function (cookie) {
     if (storage.getCookie(cookie)) {
       legacyStoredValue = safeJSONParse(storage.getCookie(cookie)) || legacyStoredValue;
     }
@@ -268,21 +341,6 @@ function getLegacyCookieSignature() {
   return (legacyStoredValue && legacyStoredValue.signature) || '';
 }
 
-/**
- * Remove our legacy cookie values. Needed until we move all publishers
- * to html5 storage in a future release
- * @param {integer} partnerId
- */
-function removeLegacyCookies(partnerId) {
-  logInfo(LOG_PREFIX + 'removing legacy cookies');
-  LEGACY_COOKIE_NAMES.forEach(function(cookie) {
-    storage.setCookie(`${cookie}`, ' ', expDaysStr(-1));
-    storage.setCookie(`${cookie}_nb`, ' ', expDaysStr(-1));
-    storage.setCookie(`${cookie}_${partnerId}_nb`, ' ', expDaysStr(-1));
-    storage.setCookie(`${cookie}_last`, ' ', expDaysStr(-1));
-  });
-}
-
 /**
  * This will make sure we check for expiration before accessing local storage
  * @param {string} key
@@ -303,6 +361,7 @@ export function getFromLocalStorage(key) {
   storage.removeDataFromLocalStorage(key);
   return null;
 }
+
 /**
  * Ensure that we always set an expiration in local storage since
  * by default it's not required
@@ -315,14 +374,4 @@ export function storeInLocalStorage(key, value, expDays) {
   storage.setDataInLocalStorage(`${key}`, value);
 }
 
-/**
- * gets the existing abTesting config or generates a default config with abTesting off
- *
- * @param {SubmoduleConfig|undefined} config
- * @returns {Object} an object which always contains at least the property "enabled"
- */
-function getAbTestingConfig(config) {
-  return deepAccess(config, 'params.abTesting', { enabled: false });
-}
-
 submodule('userId', id5IdSubmodule);

package/modules/id5IdSystem.md

@@ -29,7 +29,8 @@ pbjs.setConfig({
         abTesting: {             // optional
           enabled: true,         // false by default
           controlGroupPct: 0.1   // valid values are 0.0 - 1.0 (inclusive)
-        }
+        }, 
+        disableExtensions: false // optional
       },
       storage: {
         type: 'html5',           // "html5" is the required storage type
@@ -43,21 +44,22 @@ pbjs.setConfig({
 });
 ```
 
-| Param under userSync.userIds[] | Scope | Type | Description | Example |
+| Param under userSync.userIds[] | Scope | Type | Description                                                                                                                                                                                                                                                                    | Example |
 | --- | --- | --- | --- | --- |
-| name | Required | String | The name of this module: `"id5Id"` | `"id5Id"` |
-| params | Required | Object | Details for the ID5 ID. | |
-| params.partner | Required | Number | This is the ID5 Partner Number obtained from registering with ID5. | `173` |
-| params.pd | Optional | String | Partner-supplied data used for linking ID5 IDs across domains. See [our documentation](https://support.id5.io/portal/en/kb/articles/passing-partner-data-to-id5) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply | `"MT1iNTBjY..."` |
-| params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage Prebid setups on behalf of publishers. Reach out to [ID5](mailto:prebid@id5.io) if you have questions about this parameter  | `pubmatic-identity-hub` |
-| params.abTesting | Optional | Object | Allows publishers to easily run an A/B Test. If enabled and the user is in the Control Group, the ID5 ID will NOT be exposed to bid adapters for that request | Disabled by default |
-| params.abTesting.enabled | Optional | Boolean | Set this to `true` to turn on this feature | `true` or `false` |
+| name | Required | String | The name of this module: `"id5Id"`                                                                                                                                                                                                                                             | `"id5Id"` |
+| params | Required | Object | Details for the ID5 ID.                                                                                                                                                                                                                                                        | |
+| params.partner | Required | Number | This is the ID5 Partner Number obtained from registering with ID5.                                                                                                                                                                                                             | `173` |
+| params.pd | Optional | String | Partner-supplied data used for linking ID5 IDs across domains. See [our documentation](https://support.id5.io/portal/en/kb/articles/passing-partner-data-to-id5) for details on generating the string. Omit the parameter or leave as an empty string if no data to supply     | `"MT1iNTBjY..."` |
+| params.provider | Optional | String | An identifier provided by ID5 to technology partners who manage Prebid setups on behalf of publishers. Reach out to [ID5](mailto:prebid@id5.io) if you have questions about this parameter                                                                                     | `pubmatic-identity-hub` |
+| params.abTesting | Optional | Object | Allows publishers to easily run an A/B Test. If enabled and the user is in the Control Group, the ID5 ID will NOT be exposed to bid adapters for that request                                                                                                                  | Disabled by default |
+| params.abTesting.enabled | Optional | Boolean | Set this to `true` to turn on this feature                                                                                                                                                                                                                                     | `true` or `false` |
 | params.abTesting.controlGroupPct | Optional | Number | Must be a number between `0.0` and `1.0` (inclusive) and is used to determine the percentage of requests that fall into the control group (and thus not exposing the ID5 ID). For example, a value of `0.20` will result in 20% of requests without an ID5 ID and 80% with an ID. | `0.1` |
-| storage | Required | Object | Storage settings for how the User ID module will cache the ID5 ID locally | |
-| storage.type | Required | String | This is where the results of the user ID will be stored. ID5 **requires** `"html5"`. | `"html5"` |
-| storage.name | Required | String | The name of the local storage where the user ID will be stored. ID5 **requires** `"id5id"`. | `"id5id"` |
-| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. ID5 recommends `90`. | `90` |
-| storage.refreshInSeconds | Optional | Integer | How many seconds until the ID5 ID will be refreshed. ID5 strongly recommends 8 hours between refreshes | `8*3600` |
+| params.disableExtensions | Optional | Boolean | Set this to `true` to force turn off extensions call. Default `false`                                                                                                                                                                                                          | `true` or `false` |
+| storage | Required | Object | Storage settings for how the User ID module will cache the ID5 ID locally                                                                                                                                                                                                      | |
+| storage.type | Required | String | This is where the results of the user ID will be stored. ID5 **requires** `"html5"`.                                                                                                                                                                                           | `"html5"` |
+| storage.name | Required | String | The name of the local storage where the user ID will be stored. ID5 **requires** `"id5id"`.                                                                                                                                                                                    | `"id5id"` |
+| storage.expires | Optional | Integer | How long (in days) the user ID information will be stored. ID5 recommends `90`.                                                                                                                                                                                                | `90` |
+| storage.refreshInSeconds | Optional | Integer | How many seconds until the ID5 ID will be refreshed. ID5 strongly recommends 8 hours between refreshes                                                                                                                                                                         | `8*3600` |
 
 **ATTENTION:** As of Prebid.js v4.14.0, ID5 requires `storage.type` to be `"html5"` and `storage.name` to be `"id5id"`. Using other values will display a warning today, but in an upcoming release, it will prevent the ID5 module from loading. This change is to ensure the ID5 module in Prebid.js interoperates properly with the [ID5 API](https://github.com/id5io/id5-api.js) and to reduce the size of publishers' first-party cookies that are sent to their web servers. If you have any questions, please reach out to us at [prebid@id5.io](mailto:prebid@id5.io).
 

package/modules/improvedigitalBidAdapter.js

@@ -19,6 +19,7 @@ import {Renderer} from '../src/Renderer.js';
 import {createEidsArray} from './userId/eids.js';
 import {hasPurpose1Consent} from '../src/utils/gpdr.js';
 import { convertOrtbRequestToProprietaryNative } from '../src/native.js';
+import {loadExternalScript} from '../src/adloader.js';
 
 const BIDDER_CODE = 'improvedigital';
 const CREATIVE_TTL = 300;
@@ -212,7 +213,7 @@ export const spec = {
 
         ID_RESPONSE.buildAd(bid, bidRequest, bidObject);
 
-        ID_RAZR.addBidData({
+        ID_RAZR.forwardBid({
           bidRequest,
           bid
         });
@@ -640,37 +641,58 @@ const ID_OUTSTREAM = {
 };
 
 const ID_RAZR = {
-  RENDERER_URL: 'https://razr.improvedigital.com/renderer.js',
-  addBidData({bid, bidRequest}) {
-    if (this.isValidBid(bid)) {
-      bid.renderer = Renderer.install({
-        url: this.RENDERER_URL,
-        config: {bidRequest}
-      });
-      bid.renderer.setRender(this.render);
+  RENDERER_URL: 'https://cdn.360yield.com/razr/tag.js',
+
+  forwardBid({bidRequest, bid}) {
+    if (bid.mediaType !== BANNER) {
+      return;
     }
-  },
 
-  isValidBid(bid) {
-    return bid && /razr:\/\//.test(bid.ad);
+    const cfg = {
+      prebid: {
+        bidRequest,
+        bid
+      }
+    };
+
+    const cfgStr = JSON.stringify(cfg).replace(/<\/script>/g, '\\x3C/script>');
+    const s = `<script>window.__razr_config = ${cfgStr};</script>`;
+    bid.ad = bid.ad.replace(/<body[^>]*>/, match => match + s);
+
+    this.installListener();
   },
 
-  render(bid) {
-    const {bidRequest} = bid.renderer.getConfig();
-
-    const payload = {
-      type: 'prebid',
-      bidRequest,
-      bid,
-      config: mergeDeep(
-        {},
-        config.getConfig('improvedigital.rendererConfig'),
-        deepAccess(bidRequest, 'params.rendererConfig')
-      )
-    };
+  installListener() {
+    if (this._listenerInstalled) {
+      return;
+    }
+
+    window.addEventListener('message', function(e) {
+      const data = e.data?.razr?.load;
+      if (!data) {
+        return;
+      }
+
+      if (e.source) {
+        data.source = e.source;
+        if (data.id) {
+          e.source.postMessage({
+            razr: {
+              id: data.id
+            }
+          }, '*');
+        }
+      }
+
+      const ns = window.razr = window.razr || {};
+      ns.q = ns.q || [];
+      ns.q.push(data);
+
+      if (!ns.loaded) {
+        loadExternalScript(ID_RAZR.RENDERER_URL, BIDDER_CODE);
+      }
+    });
 
-    const razr = window.razr = window.razr || {};
-    razr.queue = razr.queue || [];
-    razr.queue.push(payload);
+    this._listenerInstalled = true;
   }
 };