expf-sigma-node.js 3.2.4 → 3.2.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expf-sigma-node.js",
-  "version": "3.2.4",
+  "version": "3.2.6",
   "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

@@ -784,9 +784,41 @@ var MD5 = new sigmaHashes_default.MD5();
 var expirationDate = 24 * 60 * 60 * 1e3;
 var secondsIn24Hours = 24 * 60 * 60;
 var sigmaGeoData = "sigmaGeoData";
+var defaultGeoCacheTTL = 5 * 60;
+var cacheStandardTimeToLive = 3600;
+var cacheCheckPeriod = 600;
+var errorMessages = {
+  emptyToken: "Please specify a token",
+  APIRequestErrorConfig: {
+    token: "%token%",
+    userData: "%userData%",
+    detail: "Invalid request to sigma config json",
+    time: new Date().toLocaleString("ru-RU"),
+    cache: true
+  },
+  APIRequestErrorGeoData: {
+    token: "%token%",
+    userData: "%userData%",
+    detail: "Invalid request to sigma geo data",
+    time: new Date().toLocaleString("ru-RU")
+  },
+  saveLastUpdateError: "Save last update to cache",
+  isNoExperimentInCache: "Experiments not found in cache",
+  badConfig: "Bad config.json"
+};
+var signsForHash = ["equal", "not equal", "any of", "none of"];
+var prefixGroup = "sigma_group";
+var errorTypesInConfig = {
+  invalidJson: 'Sigma warning. Invalid type json "%value%" in config.',
+  invalidType: 'Sigma warning. Invalid type "%type%" in config.'
+};
+var sdkName = "node.js";
 
 // src/modules/sigmaCache.js
-var sigmaCache = new import_node_cache.default({ stdTTL: secondsIn24Hours });
+var sigmaCache = new import_node_cache.default({
+  stdTTL: cacheStandardTimeToLive,
+  checkperiod: cacheCheckPeriod
+});
 var SigmaCache = class {
   constructor(postfix) {
     this.postfix = "";
@@ -825,14 +857,16 @@ var SigmaCache = class {
 
 // src/modules/sigmaGeoCache.js
 var import_node_cache2 = __toESM(require("node-cache"));
-var defaultGeoCacheTTL = 5 * 60;
-var maxGeoCacheTTL = 120 * 60;
-var minGeoCacheTTL = 1 * 60;
-var sigmaGeoCache = new import_node_cache2.default({ stdTTL: secondsIn24Hours });
+var sigmaGeoCache = new import_node_cache2.default({
+  stdTTL: cacheStandardTimeToLive,
+  checkperiod: cacheCheckPeriod
+});
 var SigmaGeoCache = class {
+  maxGeoCacheTTL = 120 * 60;
+  minGeoCacheTTL = 1 * 60;
   constructor(postfix, geoCacheTTL) {
     this.geoCacheTTL = geoCacheTTL || defaultGeoCacheTTL;
-    if (geoCacheTTL > maxGeoCacheTTL || geoCacheTTL < minGeoCacheTTL) {
+    if (geoCacheTTL > this.maxGeoCacheTTL || geoCacheTTL < this.minGeoCacheTTL) {
       this.geoCacheTTL = defaultGeoCacheTTL;
     }
     this.postfix = "";
@@ -856,6 +890,12 @@ var SigmaGeoCache = class {
   keys() {
     return sigmaGeoCache.keys();
   }
+  parse(data) {
+    if (!this.get(data)) {
+      throw new Error(`${data} not found in cache`);
+    }
+    return JSON.parse(String(this.get(data)));
+  }
 };
 
 // src/helpers/checkBoolValue.js
@@ -910,20 +950,20 @@ function conditionOperation(userValue, conditionValues, operation, date, time) {
     return false;
   userValue = String(userValue);
   if (!Array.isArray(conditionValues))
-    conditionValues = String(conditionValues);
+    conditionValues = String(conditionValues).toLowerCase().trim();
   switch (operation.trim()) {
     case "equal":
-      return userValue.toLowerCase().trim() == conditionValues.toLowerCase().trim();
+      return userValue.toLowerCase().trim() == conditionValues;
     case "not equal":
-      return userValue.toLowerCase().trim() != conditionValues.toLowerCase().trim();
+      return userValue.toLowerCase().trim() != conditionValues;
     case "greater":
-      return compareVersions(userValue.trim(), conditionValues.trim());
+      return compareVersions(userValue.trim(), conditionValues);
     case "less":
-      return compareVersions(conditionValues.trim(), userValue.trim());
+      return compareVersions(conditionValues, userValue.trim());
     case "greater equal":
-      return compareVersions(userValue.trim(), conditionValues.trim(), false);
+      return compareVersions(userValue.trim(), conditionValues, false);
     case "less equal":
-      return compareVersions(conditionValues.trim(), userValue.trim(), false);
+      return compareVersions(conditionValues, userValue.trim(), false);
     case "any of":
       return conditionValues.includes(userValue);
     case "none of":
@@ -943,13 +983,11 @@ function conditionOperation(userValue, conditionValues, operation, date, time) {
       }
       return true;
     case "on date":
-      return Math.floor(
-        new Date(conditionValues.trim()).getTime() / (1e3 * 60 * 60 * 24)
-      ) == date;
+      return Math.floor(new Date(conditionValues.toString()).getTime() / (1e3 * 60 * 60 * 24)) == date;
     case "after time":
-      return new Date(conditionValues.trim()).getTime() / (1e3 * 60 * 60) < time;
+      return new Date(conditionValues.toString()).getTime() / (1e3 * 60 * 60) < time;
     case "before time":
-      return new Date(conditionValues.trim()).getTime() / (1e3 * 60 * 60) > time;
+      return new Date(conditionValues.toString()).getTime() / (1e3 * 60 * 60) > time;
     case "starts with":
       return userValue.startsWith(conditionValues);
     case "not starts with":
@@ -987,14 +1025,24 @@ function digestHash(string) {
 
 // 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;
+  switch (type) {
+    case "string":
+      return value;
+    case "bool":
+      return value === "true" ? true : false;
+    case "integer":
+    case "number":
+      return parseFloat(value);
+    case "json":
+      try {
+        return JSON.parse(value);
+      } catch (e) {
+        console.error(errorTypesInConfig.invalidJson.replace("%value%", value), e);
+        return null;
+      }
+    default:
+      return value;
+  }
 }
 
 // src/helpers/generateRandomId.js
@@ -1059,6 +1107,12 @@ function generateFilteredList(array, name) {
   return array;
 }
 
+// package.json
+var version = "3.2.6";
+
+// src/helpers/sdkVersion.js
+var sdkVersion = version;
+
 // src/sigma.js
 if (typeof import_node_fetch.default.default !== "undefined")
   import_node_fetch.default.default;
@@ -1070,17 +1124,17 @@ var Sigma = class {
     geoCacheTTL: null
   }) {
     if (!token) {
-      throw new Error("Please specify a token");
+      throw new Error(errorMessages.emptyToken);
     }
     this.token = token;
     this.userData = userData || {};
     cacheTTL < 10 ? this.cacheTTL = 10 : this.cacheTTL = cacheTTL;
-    this.api = options.api || `${defaultApi}`;
-    this.retries = options.retries || 3;
-    this.sigmaUserData = new SigmaUserData();
+    this.api = options.api || defaultApi;
+    this.retries = options.retries || 2;
     this.postfix = options.postfix || "";
+    this.geoCacheTTL = options.geoCacheTTL || defaultGeoCacheTTL;
+    this.sigmaUserData = new SigmaUserData();
     this.cache = new SigmaCache(this.postfix);
-    this.geoCache = new SigmaGeoCache(`${this.userData.ip}__${this.token}`, options.geoCacheTTL);
     this.sigmaUserData.init({
       userId: this.userData.userId || null,
       profileId: this.userData.profileId || null,
@@ -1092,7 +1146,7 @@ var Sigma = class {
       deviceCategory: this.userData.deviceCategory || null,
       browser: this.userData.browser || { version: null, name: null },
       os: this.userData.os || { version: null, name: null },
-      geo: this.userData.ip ? this.geoCache.get(sigmaGeoData) : this.userData.geo || this.sigmaUserData.user.geo,
+      geo: this.userData.geo || null,
       domain: this.userData.domain || null,
       url: this.userData.url || null,
       query: this.userData.query || null,
@@ -1100,6 +1154,7 @@ var Sigma = class {
     });
     this.setSplitIdsToCache(this.userData);
     this.makePrivateIdInCache();
+    this.geoCache = new SigmaGeoCache(`${this.cache.get(sigmaPrivateId)}__${this.token}`, options.geoCacheTTL);
   }
   setSplitIdsToCache(userData) {
     for (let [key, value] of Object.entries(userData)) {
@@ -1120,12 +1175,9 @@ var Sigma = class {
     }
   }
   makePrivateIdInCache() {
-    let privateId = this.cache.get(sigmaPrivateId);
-    if (!privateId) {
-      privateId = generateRandomId();
-      this.cache.set(sigmaPrivateId, privateId);
+    if (!this.cache.get(sigmaPrivateId)) {
+      this.cache.set(sigmaPrivateId, generateRandomId());
     }
-    return privateId;
   }
   retryFetch(url, fetchOptions, retries = 3, timeout) {
     return new Promise((resolve, reject) => {
@@ -1134,7 +1186,7 @@ var Sigma = class {
       const wrapper = (n) => {
         (0, import_node_fetch.default)(url, fetchOptions).then((res) => resolve(res)).catch((err) => {
           if (n > 0) {
-            delay(1e3).then(() => {
+            delay(0).then(() => {
               wrapper(--n);
             });
           } else {
@@ -1154,88 +1206,75 @@ var Sigma = class {
         "ip": this.userData.ip,
         "X-Real-IP": this.userData.ip,
         token: this.token,
-        "user-id": this.cache.get(sigmaPrivateId)
+        "user-id": this.cache.get(sigmaPrivateId),
+        "sdk-name": sdkName,
+        "sdk-version": sdkVersion
       }
     };
-    if (method !== "GET") {
-      options.headers["Content-Type"] = "application/json; charset=utf-8";
-    }
     const data = await this.retryFetch(
       url,
       options,
       this.retries
     );
-    if (data.status !== 200) {
-      throw new Error(`${data.status} Token: ${this.token}`);
-    }
     return data.json();
   }
+  async getConfig() {
+    let data;
+    const localStorageHash = this.cache.get(sigmaHash);
+    let hash;
+    data = await this.getDataFile(`${this.api}/config.json`);
+    if (this.sigmaUserData.platform) {
+      data = filterByPlatform(data, this.sigmaUserData.user.platform);
+    }
+    hash = await SHA256.hex(JSON.stringify(data));
+    if (!localStorageHash || localStorageHash !== hash) {
+      this.cache.set(sigmaHash, hash);
+      this.cache.set(sigmaDataFile, JSON.stringify(data));
+    }
+  }
   async getUserGeoData() {
-    try {
-      const data = await this.getDataFile(`${this.api}/geo`);
-      return data;
-    } catch (error) {
-      throw new Error(`Get geo: ${error}`);
+    if (this.userData.ip) {
+      const userGeoData = await this.getDataFile(`${this.api}/geo`);
+      this.geoCache.set(sigmaGeoData, JSON.stringify(userGeoData));
+    } else if (this.userData.geo) {
+      this.geoCache.set(sigmaGeoData, JSON.stringify(this.userData.geo));
+    } else {
+      this.geoCache.set(sigmaGeoData, JSON.stringify({ location: "none" }));
     }
   }
+  recordLastUpdateInCache() {
+    const timeRecord = Math.floor(Date.now() / 1e3);
+    this.cache.set(sigmaDataFileLastUpdate, timeRecord);
+  }
   async saveToCache() {
-    const { api } = this;
-    const localStorageHash = this.cache.get(sigmaHash);
-    let data;
     try {
-      data = await this.getDataFile(`${api}/config.json`);
-    } catch (error) {
+      await this.getConfig();
+    } catch {
+      errorMessages.APIRequestErrorConfig.userData = JSON.stringify(this.userData);
+      errorMessages.APIRequestErrorConfig.token = this.token;
       if (!this.cache.get(sigmaDataFile)) {
-        throw new Error(` Get config: ${error}`);
+        errorMessages.APIRequestErrorConfig.cache = false;
+        console.error(errorMessages.APIRequestErrorConfig);
+        throw new Error(JSON.stringify(errorMessages.APIRequestErrorConfig));
       } else {
-        console.error(`Get config: ${error}`);
-        return true;
-      }
-    }
-    let hash;
-    try {
-      if (typeof data !== "object") {
-        throw new Error(`typeof config.json is not an object`);
-      }
-      data = filterByPlatform(data, this.userData.platform || this.sigmaUserData.platform);
-      hash = await SHA256.hex(JSON.stringify(data));
-      if (!localStorageHash || localStorageHash !== hash) {
-        this.cache.set(sigmaHash, hash);
-        this.cache.set(sigmaDataFile, JSON.stringify(data));
-        this.sigmaUserData.clearFlags();
+        errorMessages.APIRequestErrorConfig.cache = true;
+        console.error(errorMessages.APIRequestErrorConfig);
       }
-    } catch (error) {
-      throw new Error(`Save data to local storage`);
     }
     try {
-      if (this.userData.ip) {
-        const userGeoData = await this.getUserGeoData();
-        this.geoCache.set(sigmaGeoData, JSON.stringify(userGeoData));
-        this.sigmaUserData.setGeo(userGeoData);
-      } else if (this.userData.geo) {
-        this.geoCache.set(sigmaGeoData, JSON.stringify(this.userData.geo));
-        this.sigmaUserData.setGeo(this.userData.geo);
-      } else {
+      await this.getUserGeoData();
+    } catch {
+      if (!this.geoCache.get(sigmaGeoData)) {
         this.geoCache.set(sigmaGeoData, JSON.stringify({ location: "none" }));
-        this.sigmaUserData.setGeo({ location: "none" });
       }
-    } catch {
-      this.geoCache.set(sigmaGeoData, JSON.stringify({ location: "none" }));
-      this.sigmaUserData.setGeo({ location: "none" });
-    }
-    try {
-      const timeRecord = Math.floor(Date.now() / 1e3);
-      this.cache.set(sigmaDataFileLastUpdate, timeRecord);
-    } catch (error) {
-      throw new Error(`save last update to cache: ${error},
-       token: ${this.token}
-      `);
+      errorMessages.APIRequestErrorGeoData.token = this.token;
+      errorMessages.APIRequestErrorGeoData.userData = JSON.stringify(this.userData);
+      console.error(errorMessages.APIRequestErrorGeoData);
     }
+    this.recordLastUpdateInCache();
   }
   hasExpireCache() {
-    const lastUpdate = parseInt(
-      this.cache.get(sigmaDataFileLastUpdate)
-    );
+    const lastUpdate = Number(this.cache.get(sigmaDataFileLastUpdate));
     const currentTime = Math.floor(Date.now() / 1e3);
     if (currentTime > lastUpdate + this.cacheTTL) {
       return true;
@@ -1256,13 +1295,13 @@ var Sigma = class {
     return flags.feature_flags;
   }
   async checkFlag(flagName) {
-    if (!flagName) {
+    if (!flagName)
       return null;
-    }
     await this.updateCache();
     const cacheKey = this.cache.parse(sigmaDataFile);
     if (!cacheKey.feature_flags)
       return;
+    this.sigmaUserData.setGeo(this.geoCache.parse(sigmaGeoData));
     let flag = null;
     const expName = this.getExperimentByFeatureFlag(cacheKey, flagName);
     if (expName) {
@@ -1321,9 +1360,8 @@ var Sigma = class {
       if (!child)
         return false;
       const isSetParentInUserData = Object.keys(user).find((i) => i === parent);
-      if (!user[isSetParentInUserData]) {
+      if (!user[isSetParentInUserData])
         return false;
-      }
       const userObject = Object.entries(user[isSetParentInUserData]);
       for (let [userParamKey, userParamValue] of userObject) {
         if (userParamKey == child) {
@@ -1368,17 +1406,13 @@ var Sigma = class {
     }
     return null;
   }
-  getSplitById(experiment) {
-    if (!experiment)
-      return;
+  switchSplitById(splitBy) {
     let id = null;
-    if (!experiment.split_by) {
-      experiment.split_by = "userId";
-    }
-    switch (experiment.split_by) {
+    const cacheSigmaExpiration = this.cache.get(sigmaExpiration);
+    switch (splitBy) {
       case "userId":
         id = this.cache.get(sigmaUserId) || null;
-        if (this.cache.get(sigmaExpiration) && parseInt(new Date().getTime()) >= parseInt(this.cache.get(sigmaExpiration))) {
+        if (typeof cacheSigmaExpiration !== "undefined" && new Date().getTime() >= Number(cacheSigmaExpiration)) {
           id = null;
         }
         break;
@@ -1391,6 +1425,14 @@ var Sigma = class {
     }
     return id;
   }
+  getSplitById(experiment) {
+    if (!experiment)
+      return null;
+    if (!experiment.split_by) {
+      experiment.split_by = "userId";
+    }
+    return this.switchSplitById(experiment.split_by);
+  }
   checkTargetConditions(experiment) {
     if (experiment.targets && experiment.targets.conditions && experiment.targets.conditions.length > 0) {
       const targets = experiment.targets;
@@ -1416,7 +1458,7 @@ var Sigma = class {
     return false;
   }
   checkConditionSignForHash(condition) {
-    return ["equal", "not equal", "any of", "none of"].includes(condition);
+    return signsForHash.includes(condition);
   }
   experimentDefinition(experiment, forcedUserInGroup) {
     if (forcedUserInGroup) {
@@ -1429,14 +1471,13 @@ var Sigma = class {
     return null;
   }
   async getExperiment(experimentName) {
-    if (!experimentName) {
+    if (!experimentName)
       return null;
-    }
     await this.updateCache();
     const sigmaDataLs = await this.cache.parse(sigmaDataFile);
-    if (!sigmaDataLs.experiments) {
-      throw new Error("Experiments not found in cache");
-    }
+    this.sigmaUserData.setGeo(this.geoCache.parse(sigmaGeoData));
+    if (!sigmaDataLs.experiments)
+      throw new Error(errorMessages.isNoExperimentInCache);
     let experiment = null;
     let layer = null;
     let bounds = [];
@@ -1457,7 +1498,7 @@ var Sigma = class {
         break;
       }
     }
-    const localStorageGroupName = `sigma_group_${experimentName}`;
+    const localStorageGroupName = `${prefixGroup}_${experimentName}`;
     if (experiment) {
       if (!groupName) {
         groupName = this.calcUserInGroup(
@@ -1597,7 +1638,7 @@ var Sigma = class {
       }
     }
     if (!flagDefaultResult) {
-      throw new Error("bad config.json");
+      throw new Error(errorMessages.badConfig);
     }
     for (let flagIndex in flagRules) {
       const statement = flagRules[flagIndex].conditional_statement;