feat(lib): promisify APIs to be able to use async storage service

Author: SakshamGupta

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.68.0] - 2024-02-15
+### Added
+- Promise based approach for all APIs to support async user storage operations
+
 ## [1.64.3] - 2024-01-02
 
 ### Added

dist/vwo-javascript-sdk.js

@@ -50,8 +50,14 @@ class VWO {
     this.userStorageService = config.userStorageService;
     this.logger = config.logger;
     this.returnPromiseFor = config.returnPromiseFor;
+    this.asyncStorageConfig = config.asyncStorageConfig;
     this.optOut = false;
 
+    if (this.userStorageService === undefined && config.asyncStorageConfig) {
+      // replace the userStorageService with the redisObject passed in asyncStorageConfig
+      this.userStorageService = config.asyncStorageConfig.redisStorage;
+      config.userStorageService = this.userStorageService;
+    }
     let settingsFileManager = new SettingsFileService(config);
 
     // Validate the config file i.e. check if required fields contain appropriate data
@@ -152,6 +158,37 @@ class VWO {
     try {
       let self = this;
 
+      if (self.asyncStorageConfig && DataTypeUtil.isObject(self.asyncStorageConfig)) {
+        self.logger.log(
+          LogLevelEnum.INFO,
+          LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.CONFIG_ASYNC_RETURN_PROMISE, {
+            file,
+            method: ApiEnum.ACTIVATE
+          })
+        );
+
+        return new Promise(resolve => {
+          if (this.optOut) {
+            this.logger.log(
+              LogLevelEnum.INFO,
+              LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.API_NOT_ENABLED, {
+                file,
+                api: ApiEnum.ACTIVATE
+              })
+            );
+            resolve(null);
+          } else {
+            return api.activate(self, campaignKey, userId, options).then(function(data) {
+              if (DataTypeUtil.isObject(data)) {
+                resolve(data.variationName);
+              } else {
+                resolve(data);
+              }
+            });
+          }
+        });
+      }
+
       // Check if returnPromiseFor is provided. If yes, return a promise instead of value
       // i.e. wait till the network call is not successful
       if (self.returnPromiseFor && (self.returnPromiseFor.activate || self.returnPromiseFor.all)) {
@@ -180,7 +217,7 @@ class VWO {
             variationName = api.activate(self, campaignKey, userId, options);
 
             // If we get null from the API i.e. no tracking call was sent
-            // In this case, respponseCallback will not be fired and hence we have to manually resolve the promise
+            // In this case, responseCallback will not be fired and hence we have to manually resolve the promise
             if (!variationName) {
               resolve(variationName);
             } else if (DataTypeUtil.isObject(variationName)) {
@@ -227,6 +264,37 @@ class VWO {
     try {
       let self = this;
 
+      if (self.asyncStorageConfig && DataTypeUtil.isObject(self.asyncStorageConfig)) {
+        self.logger.log(
+          LogLevelEnum.INFO,
+          LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.CONFIG_ASYNC_RETURN_PROMISE, {
+            file,
+            method: ApiEnum.GET_VARIATION_NAME
+          })
+        );
+
+        return new Promise(resolve => {
+          if (this.optOut) {
+            this.logger.log(
+              LogLevelEnum.INFO,
+              LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.API_NOT_ENABLED, {
+                file,
+                api: ApiEnum.GET_VARIATION_NAME
+              })
+            );
+            resolve(null);
+          } else {
+            return api.getVariation(self, campaignKey, userId, options).then(function(data) {
+              if (DataTypeUtil.isObject(data)) {
+                resolve(data.variationName);
+              } else {
+                resolve(data);
+              }
+            });
+          }
+        });
+      }
+
       // Check if returnPromiseFor is provided. If yes, return a promise instead of value
       if (self.returnPromiseFor && (self.returnPromiseFor.getVariationName || self.returnPromiseFor.all)) {
         self.logger.log(
@@ -283,6 +351,34 @@ class VWO {
     try {
       let self = this;
 
+      // In case we use any asyncStorage like redis, promisify track
+      if (self.asyncStorageConfig && DataTypeUtil.isObject(self.asyncStorageConfig)) {
+        self.logger.log(
+          LogLevelEnum.INFO,
+          LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.CONFIG_ASYNC_RETURN_PROMISE, {
+            file,
+            method: ApiEnum.TRACK
+          })
+        );
+
+        return new Promise(resolve => {
+          if (this.optOut) {
+            this.logger.log(
+              LogLevelEnum.INFO,
+              LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.API_NOT_ENABLED, {
+                file,
+                api: ApiEnum.TRACK
+              })
+            );
+            resolve(null);
+          } else {
+            return api.track(self, campaignSpecifier, userId, goalIdentifier, options).then(function(trackResponse) {
+              resolve(trackResponse);
+            });
+          }
+        });
+      }
+
       // Check if returnPromiseFor is provided. If yes, return a promise instead of value
       // i.e. wait till the network call is not successful
       if (self.returnPromiseFor && (self.returnPromiseFor.track || self.returnPromiseFor.all)) {
@@ -368,6 +464,37 @@ class VWO {
     try {
       let self = this;
 
+      if (self.asyncStorageConfig && DataTypeUtil.isObject(self.asyncStorageConfig)) {
+        self.logger.log(
+          LogLevelEnum.INFO,
+          LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.CONFIG_ASYNC_RETURN_PROMISE, {
+            file,
+            method: ApiEnum.IS_FEATURE_ENABLED
+          })
+        );
+
+        return new Promise(resolve => {
+          if (this.optOut) {
+            this.logger.log(
+              LogLevelEnum.INFO,
+              LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.API_NOT_ENABLED, {
+                file,
+                api: ApiEnum.IS_FEATURE_ENABLED
+              })
+            );
+            resolve(null);
+          } else {
+            return api.isFeatureEnabled(self, campaignKey, userId, options).then(function(data) {
+              if (DataTypeUtil.isObject(data)) {
+                resolve(data.isFeatureEnabled);
+              } else {
+                resolve(data);
+              }
+            });
+          }
+        });
+      }
+
       // Check if returnPromiseFor is provided. If yes, return a promise instead of value
       // i.e. wait till the network call is not successful
       if (self.returnPromiseFor && (self.returnPromiseFor.isFeatureEnabled || self.returnPromiseFor.all)) {
@@ -446,6 +573,37 @@ class VWO {
     try {
       let self = this;
 
+      if (self.asyncStorageConfig && DataTypeUtil.isObject(self.asyncStorageConfig)) {
+        self.logger.log(
+          LogLevelEnum.INFO,
+          LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.CONFIG_ASYNC_RETURN_PROMISE, {
+            file,
+            method: ApiEnum.GET_FEATURE_VARIABLE_VALUE
+          })
+        );
+
+        return new Promise(resolve => {
+          if (this.optOut) {
+            this.logger.log(
+              LogLevelEnum.INFO,
+              LogMessageUtil.build(LogMessageEnum.INFO_MESSAGES.API_NOT_ENABLED, {
+                file,
+                api: ApiEnum.GET_FEATURE_VARIABLE_VALUE
+              })
+            );
+            resolve(null);
+          } else {
+            return api.getFeatureVariableValue(self, campaignKey, variableKey, userId, options).then(function(data) {
+              if (DataTypeUtil.isObject(data)) {
+                resolve(data.typeCastedValue);
+              } else {
+                resolve(data);
+              }
+            });
+          }
+        });
+      }
+
       // Check if returnPromiseFor is provided. If yes, return a promise instead of value
       if (self.returnPromiseFor && (self.returnPromiseFor.getFeatureVariableValue || self.returnPromiseFor.all)) {
         self.logger.log(

dist/vwo-javascript-sdk.js.map

@@ -154,7 +154,7 @@ function activate(vwoInstance, campaignKey, userId, options = {}) {
   }
 
   // Once the matching RUNNING campaign is found, assign the deterministic variation to the userId provided
-  const { variationId, variationName, isStoredVariation } = DecisionUtil.getVariation(
+  const result = DecisionUtil.getVariation(
     config,
     settingsFile,
     campaign,
@@ -165,10 +165,62 @@ function activate(vwoInstance, campaignKey, userId, options = {}) {
     userStorageData,
     metaData,
     true,
+    false,
     undefined,
     api
   );
 
+  if (DataTypeUtil.isPromise(result)) {
+    return result.then(function(data) {
+      return _validateAndReturnVariation(
+        vwoInstance,
+        campaignKey,
+        userId,
+        config,
+        api,
+        shouldTrackReturningUser,
+        settingsFile,
+        campaign,
+        visitorUserAgent,
+        userIpAddress,
+        responseCallback,
+        data
+      );
+    });
+  }
+
+  return _validateAndReturnVariation(
+    vwoInstance,
+    campaignKey,
+    userId,
+    config,
+    api,
+    shouldTrackReturningUser,
+    settingsFile,
+    campaign,
+    visitorUserAgent,
+    userIpAddress,
+    responseCallback,
+    result
+  );
+}
+
+function _validateAndReturnVariation(
+  vwoInstance,
+  campaignKey,
+  userId,
+  config,
+  api,
+  shouldTrackReturningUser,
+  settingsFile,
+  campaign,
+  visitorUserAgent,
+  userIpAddress,
+  responseCallback,
+  result
+) {
+  var { variationId, variationName, isStoredVariation } = result;
+
   // Check if variation-name has been assigned to the userId. If not, return no variation
   if (!ValidateUtil.isValidValue(variationName)) {
     vwoInstance.logger.log(
@@ -243,5 +295,4 @@ function activate(vwoInstance, campaignKey, userId, options = {}) {
 
   return variationName;
 }
-
 module.exports = activate;