expf-sigma-node.js 2.0.2 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expf-sigma-node.js",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "expf-sigma-node.js lets you manage features flags and remote config across web, server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features.",
   "main": "public/sigma.js",
   "keywords": [

package/public/sigma.js

@@ -35,6 +35,8 @@ var SigmaUserData = class {
   constructor() {
     this.user = {
       userId: null,
+      profileId: null,
+      deviceId: null,
       ip: null,
       email: null,
       appVersion: null,
@@ -68,6 +70,8 @@ var SigmaUserData = class {
   }
   init({
     userId,
+    profileId,
+    deviceId,
     ip,
     email,
     appVersion,
@@ -82,6 +86,8 @@ var SigmaUserData = class {
     pathname
   }) {
     this.user.userId = userId;
+    this.user.profileId = profileId;
+    this.user.deviceId = deviceId;
     this.user.ip = ip;
     this.user.email = email;
     this.user.appVersion = appVersion;
@@ -185,6 +191,107 @@ var SigmaGeoCache = class {
   }
 };
 
+// src/helpers/checkBoolValue.js
+function checkBoolValue(value) {
+  if (value)
+    return true;
+  return false;
+}
+
+// src/helpers/checkForcedList.js
+function checkForcedList(usersList, data) {
+  if (usersList.length) {
+    for (let id in usersList) {
+      if (usersList[id] == data) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+// src/helpers/compareVersions.js
+function compareVersions(versionA, versionB, strict = true) {
+  let resultCompare;
+  const versionsLength = Math.max(versionA.length, versionB.length);
+  versionA = (versionA + "").split(".");
+  versionB = (versionB + "").split(".");
+  for (let i = 0; i < versionsLength; i++) {
+    if (versionA[i] === void 0) {
+      versionA[i] = "0";
+    }
+    if (versionB[i] === void 0) {
+      versionB[i] = "0";
+    }
+    resultCompare = parseInt(versionA[i], 10) - parseInt(versionB[i], 10);
+    if (resultCompare !== 0) {
+      return resultCompare < 0 ? false : true;
+    }
+  }
+  if (strict) {
+    return false;
+  }
+  if (!strict) {
+    return true;
+  }
+}
+
+// src/helpers/delay.js
+function delay(ms) {
+  new Promise((resolve) => setTimeout(() => resolve(void 0), ms));
+}
+
+// src/helpers/digestHash.js
+function digestHash(string) {
+  let hash = 0, i, chr;
+  if (string.length === 0)
+    return hash;
+  for (i = 0; i < string.length; i++) {
+    chr = string.charCodeAt(i);
+    hash = (hash << 5) - hash + chr;
+    hash |= 0;
+  }
+  return hash;
+}
+
+// src/helpers/doTypeConversion.js
+function doTypeConversion(type, value) {
+  if (type === "string")
+    return value;
+  if (type === "bool") {
+    return value === "true" ? true : false;
+  }
+  if (type === "integer" || type === "number")
+    return parseFloat(value);
+  return value;
+}
+
+// src/helpers/makeIdCookie.js
+function makeIdCookie() {
+  let text = "";
+  let possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+  for (let i = 0; i < 80; i++)
+    text += possible.charAt(Math.floor(Math.random() * possible.length));
+  return text;
+}
+
+// src/helpers/getUserGroup.js
+function getUserGroup(salt, exposureRate, controlBucketPerc, forcedExp) {
+  let userInGroup = "a";
+  let currentDiapason = 0;
+  if (Math.abs(salt) / 100 <= parseFloat(exposureRate) * 100 || forcedExp) {
+    let bucket = Math.abs(salt) % 100;
+    for (let i = 0; i < controlBucketPerc.length; i++) {
+      currentDiapason += controlBucketPerc[i].weight * 100;
+      if (bucket <= currentDiapason) {
+        return userInGroup = controlBucketPerc[i].name;
+      }
+    }
+    return userInGroup;
+  }
+  return false;
+}
+
 // src/modules/sigmaHashes.js
 var Hashes;
 function utf8Encode(str) {
@@ -820,118 +927,23 @@ Hashes = {
 };
 var sigmaHashes_default = Hashes;
 
-// src/helpers/checkBoolValue.js
-function checkBoolValue(value) {
-  if (value)
-    return true;
-  return false;
-}
-
-// src/helpers/checkForcedList.js
-function checkForcedList(usersList, data) {
-  if (usersList.length) {
-    for (let id in usersList) {
-      if (usersList[id] == data) {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
-// src/helpers/compareVersions.js
-function compareVersions(versionA, versionB, strict = true) {
-  let resultCompare;
-  const versionsLength = Math.max(versionA.length, versionB.length);
-  versionA = (versionA + "").split(".");
-  versionB = (versionB + "").split(".");
-  for (let i = 0; i < versionsLength; i++) {
-    if (versionA[i] === void 0) {
-      versionA[i] = "0";
-    }
-    if (versionB[i] === void 0) {
-      versionB[i] = "0";
-    }
-    resultCompare = parseInt(versionA[i], 10) - parseInt(versionB[i], 10);
-    if (resultCompare !== 0) {
-      return resultCompare < 0 ? false : true;
-    }
-  }
-  if (strict) {
-    return false;
-  }
-  if (!strict) {
-    return true;
-  }
-}
-
-// src/helpers/delay.js
-function delay(ms) {
-  new Promise((resolve) => setTimeout(() => resolve(void 0), ms));
-}
-
-// src/helpers/digestHash.js
-function digestHash(string) {
-  let hash = 0, i, chr;
-  if (string.length === 0)
-    return hash;
-  for (i = 0; i < string.length; i++) {
-    chr = string.charCodeAt(i);
-    hash = (hash << 5) - hash + chr;
-    hash |= 0;
-  }
-  return hash;
-}
-
-// src/helpers/doTypeConversion.js
-function doTypeConversion(type, value) {
-  if (type === "string")
-    return value;
-  if (type === "bool") {
-    return value === "true" ? true : false;
-  }
-  if (type === "integer" || type === "number")
-    return parseFloat(value);
-  return value;
-}
-
-// src/helpers/makeIdCookie.js
-function makeIdCookie() {
-  let text = "";
-  let possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
-  for (let i = 0; i < 80; i++)
-    text += possible.charAt(Math.floor(Math.random() * possible.length));
-  return text;
-}
-
-// src/helpers/getUserGroup.js
-function getUserGroup(salt, exposureRate, controlBucketPerc, forcedExp) {
-  let userInGroup = "a";
-  let currentDiapason = 0;
-  if (Math.abs(salt) / 100 <= parseFloat(exposureRate) * 100 || forcedExp) {
-    let bucket = Math.abs(salt) % 100;
-    for (let i = 0; i < controlBucketPerc.length; i++) {
-      currentDiapason += controlBucketPerc[i].weight * 100;
-      if (bucket <= currentDiapason) {
-        return userInGroup = controlBucketPerc[i].name;
-      }
-    }
-    return userInGroup;
-  }
-  return false;
-}
-
-// src/sigma.js
-if (typeof import_node_fetch.default.default !== "undefined")
-  import_node_fetch.default.default;
+// src/helpers/constants.js
 var defaultApi = "https://api.expf.ru/api/v1";
 var sigmaUserId = "sigmaUserId";
+var sigmaProfileId = "sigmaProfileId";
+var sigmaDeviceId = "sigmaDeviceId";
+var sigmaHash = "sigmaHash";
+var sigmaDataFileLastUpdate = "sigmaDataFileLastUpdate";
 var sigmaDataFile = "sigmaDataFile";
 var sigmaExperiments = "sigmaExperiments";
-var SHA256 = new sigmaHashes_default.SHA256();
-var MD5 = new sigmaHashes_default.MD5();
 var max_decimal_64 = 18446744073709552e3;
 var zeta = 8540717056e4;
+var SHA256 = new sigmaHashes_default.SHA256();
+var MD5 = new sigmaHashes_default.MD5();
+
+// src/sigma.js
+if (typeof import_node_fetch.default.default !== "undefined")
+  import_node_fetch.default.default;
 var Sigma = class {
   constructor(token, userData, cacheTTL = 10, options = {
     api: "",
@@ -950,9 +962,10 @@ var Sigma = class {
     this.sigmaUserData = new SigmaUserData();
     this.postfix = options.postfix || "";
     this.cache = new SigmaCache(this.postfix);
-    this.userData.userId = this.validateUserDataUserId(this.userData.userId);
     this.sigmaUserData.init({
       userId: this.userData.userId || null,
+      profileId: this.userData.profileId || null,
+      deviceId: this.userData.deviceId || null,
       ip: this.userData.ip || null,
       email: this.userData.email || null,
       appVersion: this.userData.appVersion || null,
@@ -967,8 +980,25 @@ var Sigma = class {
       pathname: this.userData.pathname || null
     });
     this.geoCache = new SigmaGeoCache(this.token, options.geoCacheTTL);
-    this.cache.set(sigmaUserId, this.userData.userId);
-    this.setUserCookie();
+    this.setSplitIdsToCache(this.userData);
+  }
+  setSplitIdsToCache(userData) {
+    for (let [key, value] of Object.entries(userData)) {
+      switch (key) {
+        case "userId":
+          if (value)
+            this.cache.set(sigmaUserId, String(value).trim());
+          break;
+        case "profileId":
+          if (value)
+            this.cache.set(sigmaProfileId, String(value).trim());
+          break;
+        case "deviceId":
+          if (value)
+            this.cache.set(sigmaDeviceId, String(value).trim());
+          break;
+      }
+    }
   }
   validateUserDataUserId(userId) {
     let hasMakeId = false;
@@ -1012,7 +1042,7 @@ var Sigma = class {
         "ip": this.userData.ip,
         "X-Real-IP": this.userData.ip,
         token: this.token,
-        "user-id": this.userData.userId ? this.userData.userId : this.sigmaUserData.user.userId
+        "user-id": this.validateUserDataUserId(this.userData.userId)
       }
     };
     if (method !== "GET") {
@@ -1053,10 +1083,10 @@ var Sigma = class {
   }
   async saveToCache() {
     const { api } = this;
-    const localStorageHash = this.cache.get("sigmaHash");
+    const localStorageHash = this.cache.get(sigmaHash);
     try {
       const timeRecord = Math.floor(Date.now() / 1e3);
-      this.cache.set("sigmaDataFileLastUpdate", timeRecord);
+      this.cache.set(sigmaDataFileLastUpdate, timeRecord);
     } catch (error) {
       throw new Error(`save last update to cache: ${error},
        token: ${this.token}
@@ -1080,7 +1110,7 @@ var Sigma = class {
       }
       hash = await SHA256.hex(JSON.stringify(data));
       if (!localStorageHash || localStorageHash !== hash) {
-        this.cache.set("sigmaHash", hash);
+        this.cache.set(sigmaHash, hash);
         this.cache.set(sigmaDataFile, JSON.stringify(data));
         this.sigmaUserData.clearFlags();
       }
@@ -1088,17 +1118,9 @@ var Sigma = class {
       throw new Error(`Save data to local storage`);
     }
   }
-  setUserCookie() {
-    let uin = this.cache.get(sigmaUserId);
-    if (!uin) {
-      uin = makeIdCookie();
-      this.cache.set(sigmaUserId, uin);
-    }
-    return;
-  }
   hasExpireCache() {
     const lastUpdate = parseInt(
-      this.cache.get("sigmaDataFileLastUpdate")
+      this.cache.get(sigmaDataFileLastUpdate)
     );
     const currentTime = Math.floor(Date.now() / 1e3);
     if (currentTime > lastUpdate + this.cacheTTL) {
@@ -1107,14 +1129,14 @@ var Sigma = class {
     return false;
   }
   updateCache() {
-    if (!this.cache.get("sigmaDataFile") || this.hasExpireCache()) {
+    if (!this.cache.get(sigmaDataFile) || this.hasExpireCache()) {
       return this.saveToCache();
     }
     return true;
   }
   async getFlags() {
     await this.updateCache();
-    const flags = this.cache.parse("sigmaDataFile");
+    const flags = this.cache.parse(sigmaDataFile);
     if (!flags.feature_flags)
       return;
     return flags.feature_flags;
@@ -1261,15 +1283,16 @@ var Sigma = class {
     }
     return defaultValue;
   }
-  calcUserInGroup(salt, exposureRate, controlBucketPerc, forcedExp = false, layer = null, layerBounds = []) {
-    const userId = this.sigmaUserData.user.userId ? this.sigmaUserData.user.userId : this.cache.get(sigmaUserId);
-    const md5R = MD5.hex(String(userId) + salt);
+  calcUserInGroup(salt, exposureRate, controlBucketPerc, forcedExp = false, layer = null, layerBounds = [], splitBy) {
+    if (!splitBy)
+      return false;
+    const md5R = MD5.hex(String(splitBy) + salt);
     const R = digestHash(md5R) * zeta / max_decimal_64;
     let md5L = null;
     if (!layer && !layerBounds.length || forcedExp) {
       return getUserGroup(R, exposureRate, controlBucketPerc, forcedExp);
     } else {
-      md5L = MD5.hex(String(userId) + layer);
+      md5L = MD5.hex(String(splitBy) + layer);
       const L = digestHash(md5L) * zeta / max_decimal_64;
       for (let i in layerBounds) {
         const result = Math.abs(L / 10);
@@ -1282,6 +1305,23 @@ var Sigma = class {
     }
     return false;
   }
+  getSplitById(experiment) {
+    if (!experiment)
+      return;
+    let id = null;
+    switch (experiment.split_by) {
+      case "userId":
+        id = this.cache.get(sigmaUserId) || null;
+        break;
+      case "profileId":
+        id = this.cache.get(sigmaProfileId) || null;
+        break;
+      case "deviceId":
+        id = this.cache.get(sigmaDeviceId) || null;
+        break;
+    }
+    return id;
+  }
   checkTargetConditions(experiment) {
     if (experiment.targets && experiment.targets.conditions && experiment.targets.conditions.length > 0) {
       const targets = experiment.targets;
@@ -1332,12 +1372,14 @@ var Sigma = class {
     let bounds = [];
     let userInGroupExperiment = null;
     let forcedUser = false;
+    let splitById = null;
     for (let i = 0; i < sigmaDataLs.experiments.length; i++) {
       if (sigmaDataLs.experiments[i]["name"] === experimentName && checkBoolValue(sigmaDataLs.experiments[i]["layer_id"])) {
         layer = sigmaDataLs.experiments[i]["layer_id"];
         bounds = sigmaDataLs.experiments[i]["layer_bounds"];
       }
       if (sigmaDataLs.experiments[i]["name"] === experimentName && !experiment) {
+        splitById = this.getSplitById(sigmaDataLs.experiments[i]);
         forcedUser = checkForcedList(sigmaDataLs.experiments[i].forced_user_list, this.sigmaUserData.user.userId);
         userInGroupExperiment = this.findUserInForcedGroup(sigmaDataLs.experiments[i]);
         experiment = this.experimentDefinition(sigmaDataLs.experiments[i], userInGroupExperiment);
@@ -1353,7 +1395,8 @@ var Sigma = class {
           experiment.groups,
           forcedUser,
           layer,
-          bounds
+          bounds,
+          splitById
         );
       }
       this.cache.set(localStorageGroupName, userInGroupExperiment);
@@ -1421,6 +1464,7 @@ var Sigma = class {
     for (let i in sigmaDataLs.experiments) {
       let layer = null;
       let bounds = [];
+      let splitById = this.getSplitById(sigmaDataLs.experiments[i]);
       let userInGroupExperiment = this.findUserInForcedGroup(sigmaDataLs.experiments[i]);
       let experiment = this.experimentDefinition(sigmaDataLs.experiments[i], userInGroupExperiment);
       if (experiment) {
@@ -1433,9 +1477,10 @@ var Sigma = class {
             experiment.salt,
             experiment.allocation,
             experiment.groups,
-            checkForcedList(experiment.forced_user_list, this.sigmaUserData.user.userId),
+            checkForcedList(experiment.forced_user_list, splitById),
             layer,
-            bounds
+            bounds,
+            splitById
           );
         }
       }
@@ -1456,7 +1501,7 @@ var Sigma = class {
       const forcedList = experiment.groups[groupItem].forced_user_list;
       if (forcedList && forcedList.length) {
         for (const item in forcedList) {
-          if (forcedList[item] === this.sigmaUserData.user.userId) {
+          if (forcedList[item] === this.getSplitById(experiment)) {
             return groupName = experiment.groups[groupItem].name;
           }
         }
@@ -1528,7 +1573,7 @@ var Sigma = class {
     return this.cache.parse(sigmaDataFile);
   }
   async getCacheHash() {
-    const data = await this.cache.get("sigmaHash");
+    const data = await this.cache.get(sigmaHash);
     return data;
   }
   async getCacheUserId() {