Merge pull request #188 from CleverTap/task/SDK-3413/remote_config

Feature: Product Experiences

package.json

@@ -1,6 +1,6 @@
 {
   "name": "clevertap-web-sdk",
-  "version": "1.6.10",
+  "version": "1.7.0",
   "description": "",
   "main": "clevertap.js",
   "scripts": {
@@ -28,6 +28,7 @@
     "@babel/eslint-parser": "^7.12.1",
     "@babel/plugin-proposal-class-properties": "^7.10.4",
     "@babel/plugin-proposal-private-methods": "^7.12.1",
+    "@babel/plugin-transform-runtime": "^7.23.7",
     "@babel/preset-env": "^7.11.0",
     "@rollup/plugin-babel": "^5.2.0",
     "@rollup/plugin-node-resolve": "^9.0.0",
@@ -44,5 +45,8 @@
     "rollup-plugin-eslint": "^7.0.0",
     "rollup-plugin-sourcemaps": "^0.6.3",
     "rollup-plugin-terser": "^7.0.2"
+  },
+  "dependencies": {
+    "regenerator-runtime": "^0.14.1"
   }
 }

src/clevertap.js

@@ -27,7 +27,8 @@ import {
   COMMAND_ADD,
   COMMAND_REMOVE,
   COMMAND_DELETE,
-  EVT_PUSH
+  EVT_PUSH,
+  WZRK_FETCH
 } from './util/constants'
 import { EMBED_ERROR } from './util/messages'
 import { StorageManager, $ct } from './util/storage'
@@ -37,6 +38,8 @@ import { compressData } from './util/encoder'
 import Privacy from './modules/privacy'
 import NotificationHandler from './modules/notification'
 import { hasWebInboxSettingsInLS, checkAndRegisterWebInboxElements, initializeWebInbox, getInboxMessages, saveInboxMessages } from './modules/web-inbox/helper'
+import { Variable } from './modules/variables/variable'
+import VariableStore from './modules/variables/variableStore'
 
 export default class CleverTap {
   #logger
@@ -46,6 +49,7 @@ export default class CleverTap {
   #session
   #account
   #request
+  #variableStore
   #isSpa
   #previousUrl
   #boundCheckPageChanged = this.#checkPageChanged.bind(this)
@@ -84,7 +88,7 @@ export default class CleverTap {
     this._isPersonalisationActive = this._isPersonalisationActive.bind(this)
     this.raiseNotificationClicked = () => { }
     this.#logger = new Logger(logLevels.INFO)
-    this.#account = new Account(clevertap.account?.[0], clevertap.region || clevertap.account?.[1], clevertap.targetDomain || clevertap.account?.[2])
+    this.#account = new Account(clevertap.account?.[0], clevertap.region || clevertap.account?.[1], clevertap.targetDomain || clevertap.account?.[2], clevertap.token || clevertap.account?.[3])
     this.#device = new DeviceManager({ logger: this.#logger })
     this.#dismissSpamControl = clevertap.dismissSpamControl || false
     this.#session = new SessionManager({
@@ -132,6 +136,13 @@ export default class CleverTap {
       account: this.#account
     }, clevertap.notifications)
 
+    this.#variableStore = new VariableStore({
+      logger: this.#logger,
+      request: this.#request,
+      account: this.#account,
+      event: this.event
+    })
+
     this.#api = new CleverTapAPI({
       logger: this.#logger,
       request: this.#request,
@@ -567,7 +578,7 @@ export default class CleverTap {
   }
 
   // starts here
-  init (accountId, region, targetDomain) {
+  init (accountId, region, targetDomain, token) {
     if (this.#onloadcalled === 1) {
       // already initailsed
       return
@@ -588,6 +599,9 @@ export default class CleverTap {
     if (targetDomain) {
       this.#account.targetDomain = targetDomain
     }
+    if (token) {
+      this.#account.token = token
+    }
 
     const currLocation = location.href
     const urlParams = getURLParams(currLocation.toLowerCase())
@@ -630,7 +644,7 @@ export default class CleverTap {
     this.notifications._processOldValues()
   }
 
-  debounce (func, delay) {
+  #debounce (func, delay = 300) {
     let timeout
     return function () {
       clearTimeout(timeout)
@@ -639,11 +653,11 @@ export default class CleverTap {
   }
 
   #checkPageChanged () {
-    const debouncedPageChanged = this.debounce(() => {
+    const debouncedPageChanged = this.#debounce(() => {
       if (this.#previousUrl !== location.href) {
         this.pageChanged()
       }
-    }, 300)
+    })
     debouncedPageChanged()
   }
 
@@ -704,14 +718,15 @@ export default class CleverTap {
     if (parseInt(data.pg) === 1) {
       this.#overrideDSyncFlag(data)
     }
-    let proto = document.location.protocol
-    proto = proto.replace(':', '')
-    data.af = { lib: 'web-sdk-v$$PACKAGE_VERSION$$', protocol: proto, ...$ct.flutterVersion }
     pageLoadUrl = addToURL(pageLoadUrl, 'type', 'page')
     pageLoadUrl = addToURL(pageLoadUrl, 'd', compressData(JSON.stringify(data), this.#logger))
 
     this.#request.saveAndFireRequest(pageLoadUrl, $ct.blockRequest)
 
+    if (parseInt(data.pg) === 1) {
+      this.event.push(WZRK_FETCH, { t: 4 })
+    }
+
     this.#previousUrl = currLocation
     setTimeout(() => {
       if (pgCount <= 3) {
@@ -782,7 +797,7 @@ export default class CleverTap {
     if ($ct.location) {
       data.af = { ...data.af, ...$ct.location }
     }
-    data = this.#request.addSystemDataToProfileObject(data, undefined)
+    data = this.#request.addSystemDataToObject(data, undefined)
     this.#request.addFlags(data)
     const compressedData = compressData(JSON.stringify(data), this.#logger)
     let pageLoadUrl = this.#account.dataPostURL
@@ -811,4 +826,28 @@ export default class CleverTap {
       this.#request.processBackupEvents()
     }
   }
+
+  defineVariable (name, defaultValue) {
+    return Variable.define(name, defaultValue, this.#variableStore)
+  }
+
+  async syncVariables (onSyncSuccess, onSyncFailure) {
+    if (this.#logger.logLevel === 4) {
+      return this.#variableStore.syncVariables(onSyncSuccess, onSyncFailure)
+    } else {
+      this.#logger.error('App log level is not set to 4')
+    }
+  }
+
+  async fetchVariables (onFetchCallback) {
+    return this.#variableStore.fetchVariables(onFetchCallback)
+  }
+
+  addVariablesChangedCallback (callback) {
+    this.#variableStore.addVariablesChangedCallback(callback)
+  }
+
+  addOneTimeVariablesChangedCallback (callback) {
+    this.#variableStore.addOneTimeVariablesChangedCallback(callback)
+  }
 }

src/main.js

@@ -1,3 +1,4 @@
+import 'regenerator-runtime/runtime.js'
 import Clevertap from './clevertap'
 
 const clevertap = new Clevertap(window.clevertap)

src/modules/account.js

@@ -5,15 +5,19 @@ export default class Account {
   #region = ''
   #targetDomain = TARGET_DOMAIN
   #dcSdkversion = ''
+  #token = ''
 
-  constructor ({ id } = {}, region = '', targetDomain = TARGET_DOMAIN) {
+  constructor ({ id } = {}, region = '', targetDomain = TARGET_DOMAIN, token = '') {
     this.id = id
     if (region) {
       this.region = region
     }
     if (targetDomain) {
       this.targetDomain = targetDomain
     }
+    if (token) {
+      this.token = token
+    }
   }
 
   get id () {
@@ -48,6 +52,14 @@ export default class Account {
     this.#targetDomain = targetDomain
   }
 
+  get token () {
+    return this.#token
+  }
+
+  set token (token) {
+    this.#token = token
+  }
+
   get finalTargetDomain () {
     if (this.region) {
       return `${this.region}.${this.targetDomain}`
@@ -59,6 +71,10 @@ export default class Account {
     }
   }
 
+  get dataPostPEURL () {
+    return `${TARGET_PROTOCOL}//${this.finalTargetDomain}/defineVars`
+  }
+
   get dataPostURL () {
     return `${TARGET_PROTOCOL}//${this.finalTargetDomain}/a?t=96`
   }

src/modules/logger.js

@@ -6,7 +6,8 @@ export const logLevels = {
   DISABLE: 0,
   ERROR: 1,
   INFO: 2,
-  DEBUG: 3
+  DEBUG: 3,
+  DEBUG_PE: 4
 }
 
 export class Logger {
@@ -43,6 +44,12 @@ export class Logger {
     }
   }
 
+  debugPE (message) {
+    if (this.#logLevel >= logLevels.DEBUG_PE) {
+      this.#log('debug_pe', message)
+    }
+  }
+
   reportError (code, description) {
     this.wzrkError.c = code
     this.wzrkError.d = description

src/modules/profile.js

@@ -154,7 +154,7 @@ export default class ProfileHandler extends Array {
         profileObj.tz = new Date().toString().match(/([A-Z]+[\+-][0-9]+)/)[1]
       }
       data.profile = profileObj
-      data = this.#request.addSystemDataToProfileObject(data, undefined)
+      data = this.#request.addSystemDataToObject(data, undefined)
 
       this.#request.addFlags(data)
       const compressedData = compressData(JSON.stringify(data), this.#logger)
@@ -212,7 +212,6 @@ export default class ProfileHandler extends Array {
     if (typeof propVal === 'string' || typeof propVal === 'number') {
       if ($ct.globalProfileMap.hasOwnProperty(propKey)) {
         array = $ct.globalProfileMap[propKey]
-        // Push the value to the array in a more concise way
         array.push(typeof propVal === 'number' ? propVal : propVal.toLowerCase())
       } else {
         $ct.globalProfileMap[propKey] = propVal
@@ -310,7 +309,7 @@ export default class ProfileHandler extends Array {
       profileObj.tz = new Date().toString().match(/([A-Z]+[\+-][0-9]+)/)[1]
     }
     data.profile = profileObj
-    data = this.#request.addSystemDataToProfileObject(data, undefined)
+    data = this.#request.addSystemDataToObject(data, undefined)
     this.#request.addFlags(data)
     const compressedData = compressData(JSON.stringify(data), this.#logger)
     let pageLoadUrl = this.#account.dataPostURL

src/modules/request.js

@@ -28,6 +28,7 @@ export default class RequestManager {
 
     RequestDispatcher.logger = logger
     RequestDispatcher.device = device
+    RequestDispatcher.account = account
   }
 
   processBackupEvents () {
@@ -72,26 +73,9 @@ export default class RequestManager {
     const obj = this.#session.getSessionCookieObject()
     dataObject.s = obj.s // session cookie
     dataObject.pg = (typeof obj.p === 'undefined') ? 1 : obj.p // Page count
-    if (sessionStorage.hasOwnProperty('WZRK_D')) { dataObject.debug = true }
-
-    return dataObject
-  }
-
-  addSystemDataToProfileObject (dataObject, ignoreTrim) {
-    if (!isObjectEmpty(this.#logger.wzrkError)) {
-      dataObject.wzrk_error = this.#logger.wzrkError
-      this.#logger.wzrkError = {}
-    }
-
-    dataObject.id = this.#account.id
-
-    if (isValueValid(this.#device.gcookie)) {
-      dataObject.g = this.#device.gcookie
-    }
-
-    const obj = this.#session.getSessionCookieObject()
-    dataObject.s = obj.s // session cookie
-    dataObject.pg = (typeof obj.p === 'undefined') ? 1 : obj.p // Page count
+    let proto = document.location.protocol
+    proto = proto.replace(':', '')
+    dataObject.af = { lib: 'web-sdk-v$$PACKAGE_VERSION$$', protocol: proto, ...$ct.flutterVersion } // app fields
     if (sessionStorage.hasOwnProperty('WZRK_D')) { dataObject.debug = true }
 
     return dataObject
@@ -128,7 +112,7 @@ export default class RequestManager {
    * @param {boolean} override whether the request can go through or not
    * @param {Boolean} sendOULFlag - true in case of a On User Login request
    */
-  saveAndFireRequest (url, override, sendOULFlag) {
+  saveAndFireRequest (url, override, sendOULFlag, evtName) {
     const now = getNow()
     url = addToURL(url, 'rn', ++$ct.globalCache.REQ_N)
     const data = url + '&i=' + now + '&sn=' + seqNo
@@ -149,7 +133,7 @@ export default class RequestManager {
         seqNo = 0
       }
       window.oulReqN = $ct.globalCache.REQ_N
-      RequestDispatcher.fireRequest(data, false, sendOULFlag)
+      RequestDispatcher.fireRequest(data, false, sendOULFlag, evtName)
     } else {
       this.#logger.debug(`Not fired due to override - ${$ct.blockRequest} or clearCookie - ${this.#clearCookie} or OUL request in progress - ${window.isOULInProgress}`)
     }
@@ -205,7 +189,7 @@ export default class RequestManager {
     pageLoadUrl = addToURL(pageLoadUrl, 'type', EVT_PUSH)
     pageLoadUrl = addToURL(pageLoadUrl, 'd', compressedData)
 
-    this.saveAndFireRequest(pageLoadUrl, $ct.blockRequest)
+    this.saveAndFireRequest(pageLoadUrl, $ct.blockRequest, false, data.evtName)
   }
 
   #addToLocalEventMap (evtName) {
@@ -232,4 +216,24 @@ export default class RequestManager {
       StorageManager.saveToLSorCookie(EV_COOKIE, $ct.globalEventsMap)
     }
   }
+
+  async post (url, body) {
+    try {
+      const response = await fetch(url, {
+        method: 'post',
+        headers: { 'Content-Type': 'application/json' },
+        body: body
+      })
+      if (response.ok) {
+        const data = await response.json()
+        this.#logger.debug('Sync data successful', data)
+        return data
+      } else {
+        throw response
+      }
+    } catch (e) {
+      this.#logger.debug('Error in syncing variables', e)
+      throw e
+    }
+  }
 }