Novatiq ID System: allow configuration of the sync URL & allow callbacks for specific custom integrations

modules/novatiqIdSystem.js

@@ -5,10 +5,10 @@
  * @requires module:modules/userId
  */
 
-import { logInfo } from '../src/utils.js';
+import { logInfo, getWindowLocation } from '../src/utils.js';
 import { ajax } from '../src/ajax.js';
 import { submodule } from '../src/hook.js';
-import {getStorageManager} from '../src/storageManager.js';
+import { getStorageManager } from '../src/storageManager.js';
 
 /** @type {Submodule} */
 export const novatiqIdSubmodule = {
@@ -40,60 +40,168 @@ export const novatiqIdSubmodule = {
  * @returns {id: string}
  */
   getId(config) {
-    function snowflakeId(placeholder) {
-      return placeholder
-        ? (placeholder ^ Math.random() * 16 >> placeholder / 4).toString(16)
-        : ([1e7] + -1e3 + -4e3 + -8e3 + -1e11 + 1e3).replace(/[018]/g, snowflakeId);
-    }
-
     const configParams = config.params || {};
-    const srcId = this.getSrcId(configParams);
+    const urlParams = this.getUrlParams(configParams);
+    const srcId = this.getSrcId(configParams, urlParams);
     const sharedId = this.getSharedId(configParams);
+    const useCallbacks = this.useCallbacks(configParams);
 
     logInfo('NOVATIQ config params: ' + JSON.stringify(configParams));
     logInfo('NOVATIQ Sync request used sourceid param: ' + srcId);
     logInfo('NOVATIQ Sync request Shared ID: ' + sharedId);
 
-    let partnerhost;
-    partnerhost = window.location.hostname;
-    logInfo('NOVATIQ partner hostname: ' + partnerhost);
-
-    const novatiqId = snowflakeId();
+    return this.sendSyncRequest(useCallbacks, sharedId, srcId, urlParams);
+  },
 
-    let url = 'https://spadsync.com/sync?sptoken=' + novatiqId + '&sspid=' + srcId + '&ssphost=' + partnerhost;
+  sendSyncRequest(useCallbacks, sharedId, sspid, urlParams) {
+    const syncUrl = this.getSyncUrl(sharedId, sspid, urlParams);
+    const url = syncUrl.url;
+    const novatiqId = syncUrl.novatiqId;
 
     // for testing
-    let sharedStatus = 'Not Found';
+    const sharedStatus = (sharedId != undefined && sharedId != false) ? 'Found' : 'Not Found';
+
+    if (useCallbacks) {
+      let res = this.sendAsyncSyncRequest(novatiqId, url); ;
+      res.sharedStatus = sharedStatus;
+
+      return res;
+    } else {
+      this.sendSimpleSyncRequest(novatiqId, url);
+
+      return { 'id': novatiqId,
+        'sharedStatus': sharedStatus }
+    }
+  },
+
+  sendAsyncSyncRequest(novatiqId, url) {
+    logInfo('NOVATIQ Setting up ASYNC sync request');
+
+    const resp = function (callback) {
+      logInfo('NOVATIQ *** Calling ASYNC sync request');
+
+      function onSuccess(response, responseObj) {
+        let syncrc;
+        var novatiqIdJson = { syncResponse: 0 };
+        syncrc = responseObj.status;
+        logInfo('NOVATIQ Sync Response Code:' + syncrc);
+        logInfo('NOVATIQ *** ASYNC request returned ' + syncrc);
+        if (syncrc === 200) {
+          novatiqIdJson = { 'id': novatiqId, syncResponse: 1 };
+        } else {
+          if (syncrc === 204) {
+            novatiqIdJson = { 'id': novatiqId, syncResponse: 2 };
+          }
+        }
+        callback(novatiqIdJson);
+      }
+
+      ajax(url,
+        { success: onSuccess },
+        undefined, { method: 'GET', withCredentials: false });
+    }
+
+    return {callback: resp};
+  },
+
+  sendSimpleSyncRequest(novatiqId, url) {
+    logInfo('NOVATIQ Sending SIMPLE sync request');
+
+    ajax(url, undefined, undefined, { method: 'GET', withCredentials: false });
+
+    logInfo('NOVATIQ snowflake: ' + novatiqId);
+  },
+
+  getNovatiqId(urlParams) {
+    // standard uuid format
+    let uuidFormat = [1e7] + -1e3 + -4e3 + -8e3 + -1e11;
+    if (urlParams.useStandardUuid == false) {
+      // novatiq standard uuid(like) format
+      uuidFormat = uuidFormat + 1e3;
+    }
+
+    return (uuidFormat).replace(/[018]/g, c =>
+      (c ^ crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> c / 4).toString(16)
+    );
+  },
+
+  getSyncUrl(sharedId, sspid, urlParams) {
+    let novatiqId = this.getNovatiqId(urlParams);
+
+    let url = 'https://spadsync.com/sync?' + urlParams.novatiqId + '=' + novatiqId;
+
+    if (urlParams.useSspId) {
+      url = url + '&sspid=' + sspid;
+    }
+
+    if (urlParams.useSspHost) {
+      let ssphost = getWindowLocation().hostname;
+      logInfo('NOVATIQ partner hostname: ' + ssphost);
+
+      url = url + '&ssphost=' + ssphost;
+    }
 
     // append on the shared ID if we have one
     if (sharedId != null) {
       url = url + '&sharedId=' + sharedId;
-      sharedStatus = 'Found';
     }
 
-    ajax(url, undefined, undefined, { method: 'GET', withCredentials: false });
+    return {
+      url: url,
+      novatiqId: novatiqId
+    }
+  },
 
-    logInfo('NOVATIQ snowflake: ' + novatiqId);
-    return { 'id': novatiqId,
-      'sharedStatus': sharedStatus }
+  getUrlParams(configParams) {
+    let urlParams = {
+      novatiqId: 'snowflake',
+      useStandardUuid: false,
+      useSspId: true,
+      useSspHost: true
+    }
+
+    if (typeof configParams.urlParams != 'undefined') {
+      if (configParams.urlParams.novatiqId != undefined) {
+        urlParams.novatiqId = configParams.urlParams.novatiqId;
+      }
+      if (configParams.urlParams.useStandardUuid != undefined) {
+        urlParams.useStandardUuid = configParams.urlParams.useStandardUuid;
+      }
+      if (configParams.urlParams.useSspId != undefined) {
+        urlParams.useSspId = configParams.urlParams.useSspId;
+      }
+      if (configParams.urlParams.useSspHost != undefined) {
+        urlParams.useSspHost = configParams.urlParams.useSspHost;
+      }
+    }
+
+    return urlParams;
+  },
+
+  useCallbacks(configParams) {
+    return typeof configParams.useCallbacks != 'undefined' && configParams.useCallbacks === true;
   },
 
   useSharedId(configParams) {
     return typeof configParams.useSharedId != 'undefined' && configParams.useSharedId === true;
   },
 
+  getCookieOrStorageID(configParams) {
+    let cookieOrStorageID = '_pubcid';
+
+    if (typeof configParams.sharedIdName != 'undefined' && configParams.sharedIdName != null && configParams.sharedIdName != '') {
+      cookieOrStorageID = configParams.sharedIdName;
+      logInfo('NOVATIQ sharedID name redefined: ' + cookieOrStorageID);
+    }
+
+    return cookieOrStorageID;
+  },
+
   // return null if we aren't supposed to use one or we are but there isn't one present
   getSharedId(configParams) {
     let sharedId = null;
     if (this.useSharedId(configParams)) {
-      let cookieOrStorageID = '_pubcid';
-
-      // Has the cookieOrStorageID been redefined?
-      if (typeof configParams.sharedIdName != 'undefined' && configParams.sharedIdName != null && configParams.sharedIdName != '') {
-        cookieOrStorageID = configParams.sharedIdName;
-        logInfo('NOVATIQ sharedID name redefined: ' + cookieOrStorageID);
-      }
-
+      let cookieOrStorageID = this.getCookieOrStorageID(configParams);
       const storage = getStorageManager({moduleName: 'pubCommonId'});
 
       // first check local storage
@@ -114,24 +222,21 @@ export const novatiqIdSubmodule = {
     return sharedId;
   },
 
-  getSrcId(configParams) {
-    logInfo('NOVATIQ Configured sourceid param: ' + configParams.sourceid);
-
-    function isHex(str) {
-      var a = parseInt(str, 16);
-      return (a.toString(16) === str)
+  getSrcId(configParams, urlParams) {
+    if (urlParams.useSspId == false) {
+      logInfo('NOVATIQ Configured to NOT use sspid');
+      return '';
     }
 
+    logInfo('NOVATIQ Configured sourceid param: ' + configParams.sourceid);
+
     let srcId;
     if (typeof configParams.sourceid === 'undefined' || configParams.sourceid === null || configParams.sourceid === '') {
       srcId = '000';
       logInfo('NOVATIQ sourceid param set to value 000 due to undefined parameter or missing value in config section');
     } else if (configParams.sourceid.length < 3 || configParams.sourceid.length > 3) {
       srcId = '001';
       logInfo('NOVATIQ sourceid param set to value 001 due to wrong size in config section 3 chars max e.g. 1ab');
-    } else if (isHex(configParams.sourceid) == false) {
-      srcId = '002';
-      logInfo('NOVATIQ sourceid param set to value 002 due to wrong format in config section expecting hex value only');
     } else {
       srcId = configParams.sourceid;
     }

modules/novatiqIdSystem.md

@@ -27,14 +27,22 @@ pbjs.setConfig({
     auctionDelay: 50             
   }
 });
-```    
+```
 
 ### Parameters for the Novatiq Module
 | Param  | Scope | Type | Description | Example |
 | --- | --- | --- | --- | --- |
 | name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
 | params | Required | Object | Configuration specifications for the Novatiq module. | |
-| params.sourceid | Required | String | This is the Novatiq Partner Number obtained via Novatiq registration. | `1a3` |
+| params.sourceid | Required | String | The Novatiq Partner Number obtained via Novatiq | `1a3` |
+| params.useSharedId | Optional | Boolean | Use the sharedID module if it's activated. | `true` |
+| params.sharedIdName | Optional | String | Same as the SharedID "name" parameter <br /> Defaults to "_pubcid" | `"demo_pubcid"` |
+| params.useCallbacks | Optional | Boolean | Use callbacks for custom integrations | `false` |
+| params.urlParams | Optional | Object | Sync URl configuration for custom integrations | |
+| params.urlParams.novatiqId | Optional | String | The name of the parameter used to indicate the novatiq ID uuid | `snowflake` |
+| params.urlParams.useStandardUuid | Optional | Boolean | Use a standard UUID format, or the Novatiq UUID format | `false` |
+| params.urlParams.useSspId | Optional | Boolean | Send the sspid (sourceid) along with the sync request | `false` |
+| params.urlParams.useSspHost | Optional | Boolean | Send the ssphost along with the sync request | `false` |
 
 # Novatiq Hyper ID with Prebid SharedID support
 You can make use of the Prebid.js SharedId module as follows. 
@@ -86,13 +94,4 @@ pbjs.setConfig({
 });
 ```
 
-### Parameters for the Novatiq Module
-| Param  | Scope | Type | Description | Example |
-| --- | --- | --- | --- | --- |
-| name | Required | String | Module identification: `"novatiq"` | `"novatiq"` |
-| params | Required | Object | Configuration specifications for the Novatiq module. | |
-| params.sourceid | Required | String | The Novatiq Partner Number obtained via Novatiq | `1a3` |
-| params.useSharedId | Optional | Boolean | Use the sharedID module if it's activated. | `true` |
-| params.sharedIdName | Optional | String | Same as the SharedID "name" parameter <br /> Defaults to "_pubcid" | `"demo_pubcid"` |
-
 If you have any questions, please reach out to us at prebid@novatiq.com.