@splitsoftware/splitio-commons 1.12.1-rc.6 → 1.12.1

package/CHANGES.txt

@@ -1,3 +1,7 @@
+1.12.1 (December 12, 2023)
+ - Updated PluggableStorage, for producer mode, and LocalStorage, for standalone mode, to clear the storage before initiating the synchronization process if it was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria.
+ - Bugfixing - Fixed an issue when tracking telemetry latencies for the new `getTreatmentsByFlagSet(s)` methods in Redis and Pluggable storages, which was causing the SDK to not track those stats.
+
 1.12.0 (December 4, 2023)
  - Added support for Flag Sets in "consumer" and "partial consumer" modes for Pluggable and Redis storages.
  - Updated evaluation flow to log a warning when using flag sets that don't contain cached feature flags.

package/cjs/storages/KeyBuilderCS.js

@@ -9,7 +9,7 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     function KeyBuilderCS(prefix, matchingKey) {
         var _this = _super.call(this, prefix) || this;
         _this.matchingKey = matchingKey;
-        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.");
+        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.(splits?|trafficType|flagSet)\\.");
         return _this;
     }
     /**

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -126,7 +126,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         // when using a new split query, we must update it at the store
         if (this.updateNewFilter) {
-            this.log.info(constants_1.LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache.');
+            this.log.info(constants_1.LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
             var storageHashKey = this.keys.buildHashKey();
             try {
                 localStorage.setItem(storageHashKey, this.storageHash);

package/cjs/storages/inRedis/TelemetryCacheInRedis.js

@@ -59,15 +59,10 @@ var TelemetryCacheInRedis = /** @class */ (function () {
                     _this.log.error("Ignoring latency with invalid bucket: " + bucket);
                     return;
                 }
-                if (!result.has(metadata))
-                    result.set(metadata, {
-                        t: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                        ts: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                        tc: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                        tcs: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                        tr: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                    });
-                result.get(metadata)[method][bucket] = count;
+                var methodLatencies = result.get(metadata) || {};
+                methodLatencies[method] = methodLatencies[method] || (0, TelemetryCacheInMemory_1.newBuckets)();
+                methodLatencies[method][bucket] = count;
+                result.set(metadata, methodLatencies);
             });
             return _this.redis.del(_this.keys.latencyPrefix).then(function () { return result; });
         });
@@ -93,13 +88,7 @@ var TelemetryCacheInRedis = /** @class */ (function () {
                 }
                 var metadata = parsedField[0], method = parsedField[1];
                 if (!result.has(metadata))
-                    result.set(metadata, {
-                        t: 0,
-                        ts: 0,
-                        tc: 0,
-                        tcs: 0,
-                        tr: 0,
-                    });
+                    result.set(metadata, {});
                 result.get(metadata)[method] = count;
             });
             return _this.redis.del(_this.keys.exceptionPrefix).then(function () { return result; });

package/cjs/storages/pluggable/TelemetryCachePluggable.js

@@ -60,15 +60,10 @@ var TelemetryCachePluggable = /** @class */ (function () {
                             _this.log.error("Ignoring latency with invalid bucket: " + bucket);
                             continue;
                         }
-                        if (!result.has(metadata))
-                            result.set(metadata, {
-                                t: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                                ts: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                                tc: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                                tcs: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                                tr: (0, TelemetryCacheInMemory_1.newBuckets)(),
-                            });
-                        result.get(metadata)[method][bucket] = count;
+                        var methodLatencies = result.get(metadata) || {};
+                        methodLatencies[method] = methodLatencies[method] || (0, TelemetryCacheInMemory_1.newBuckets)();
+                        methodLatencies[method][bucket] = count;
+                        result.set(metadata, methodLatencies);
                     }
                     return Promise.all(latencyKeys.map(function (latencyKey) { return _this.wrapper.del(latencyKey); })).then(function () { return result; });
                 }) :
@@ -101,13 +96,7 @@ var TelemetryCachePluggable = /** @class */ (function () {
                         }
                         var metadata = parsedField[0], method = parsedField[1];
                         if (!result.has(metadata))
-                            result.set(metadata, {
-                                t: 0,
-                                ts: 0,
-                                tc: 0,
-                                tcs: 0,
-                                tr: 0,
-                            });
+                            result.set(metadata, {});
                         result.get(metadata)[method] = count;
                     }
                     return Promise.all(exceptionKeys.map(function (exceptionKey) { return _this.wrapper.del(exceptionKey); })).then(function () { return result; });

package/cjs/storages/pluggable/index.js

@@ -21,6 +21,7 @@ var UniqueKeysCachePluggable_1 = require("./UniqueKeysCachePluggable");
 var UniqueKeysCacheInMemory_1 = require("../inMemory/UniqueKeysCacheInMemory");
 var UniqueKeysCacheInMemoryCS_1 = require("../inMemory/UniqueKeysCacheInMemoryCS");
 var utils_1 = require("../utils");
+var constants_2 = require("../pluggable/constants");
 var NO_VALID_WRAPPER = 'Expecting pluggable storage `wrapper` in options, but no valid wrapper instance was provided.';
 var NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow the expected interface. Check our docs.';
 /**
@@ -81,6 +82,7 @@ function PluggableStorage(options) {
                 return wrapper.get(keys.buildHashKey()).then(function (hash) {
                     var currentHash = (0, KeyBuilder_1.getStorageHash)(settings);
                     if (hash !== currentHash) {
+                        log.info(constants_2.LOG_PREFIX + 'Storage HASH has changed (SDK key or feature flag filter criteria was modified). Clearing cache');
                         return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
                             return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
                         }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });

package/esm/storages/KeyBuilderCS.js

@@ -6,7 +6,7 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     function KeyBuilderCS(prefix, matchingKey) {
         var _this = _super.call(this, prefix) || this;
         _this.matchingKey = matchingKey;
-        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.");
+        _this.regexSplitsCacheKey = new RegExp("^" + prefix + "\\.(splits?|trafficType|flagSet)\\.");
         return _this;
     }
     /**

package/esm/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -123,7 +123,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     SplitsCacheInLocal.prototype.setChangeNumber = function (changeNumber) {
         // when using a new split query, we must update it at the store
         if (this.updateNewFilter) {
-            this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache.');
+            this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
             var storageHashKey = this.keys.buildHashKey();
             try {
                 localStorage.setItem(storageHashKey, this.storageHash);

package/esm/storages/inRedis/TelemetryCacheInRedis.js

@@ -56,15 +56,10 @@ var TelemetryCacheInRedis = /** @class */ (function () {
                     _this.log.error("Ignoring latency with invalid bucket: " + bucket);
                     return;
                 }
-                if (!result.has(metadata))
-                    result.set(metadata, {
-                        t: newBuckets(),
-                        ts: newBuckets(),
-                        tc: newBuckets(),
-                        tcs: newBuckets(),
-                        tr: newBuckets(),
-                    });
-                result.get(metadata)[method][bucket] = count;
+                var methodLatencies = result.get(metadata) || {};
+                methodLatencies[method] = methodLatencies[method] || newBuckets();
+                methodLatencies[method][bucket] = count;
+                result.set(metadata, methodLatencies);
             });
             return _this.redis.del(_this.keys.latencyPrefix).then(function () { return result; });
         });
@@ -90,13 +85,7 @@ var TelemetryCacheInRedis = /** @class */ (function () {
                 }
                 var metadata = parsedField[0], method = parsedField[1];
                 if (!result.has(metadata))
-                    result.set(metadata, {
-                        t: 0,
-                        ts: 0,
-                        tc: 0,
-                        tcs: 0,
-                        tr: 0,
-                    });
+                    result.set(metadata, {});
                 result.get(metadata)[method] = count;
             });
             return _this.redis.del(_this.keys.exceptionPrefix).then(function () { return result; });

package/esm/storages/pluggable/TelemetryCachePluggable.js

@@ -57,15 +57,10 @@ var TelemetryCachePluggable = /** @class */ (function () {
                             _this.log.error("Ignoring latency with invalid bucket: " + bucket);
                             continue;
                         }
-                        if (!result.has(metadata))
-                            result.set(metadata, {
-                                t: newBuckets(),
-                                ts: newBuckets(),
-                                tc: newBuckets(),
-                                tcs: newBuckets(),
-                                tr: newBuckets(),
-                            });
-                        result.get(metadata)[method][bucket] = count;
+                        var methodLatencies = result.get(metadata) || {};
+                        methodLatencies[method] = methodLatencies[method] || newBuckets();
+                        methodLatencies[method][bucket] = count;
+                        result.set(metadata, methodLatencies);
                     }
                     return Promise.all(latencyKeys.map(function (latencyKey) { return _this.wrapper.del(latencyKey); })).then(function () { return result; });
                 }) :
@@ -98,13 +93,7 @@ var TelemetryCachePluggable = /** @class */ (function () {
                         }
                         var metadata = parsedField[0], method = parsedField[1];
                         if (!result.has(metadata))
-                            result.set(metadata, {
-                                t: 0,
-                                ts: 0,
-                                tc: 0,
-                                tcs: 0,
-                                tr: 0,
-                            });
+                            result.set(metadata, {});
                         result.get(metadata)[method] = count;
                     }
                     return Promise.all(exceptionKeys.map(function (exceptionKey) { return _this.wrapper.del(exceptionKey); })).then(function () { return result; });

package/esm/storages/pluggable/index.js

@@ -18,6 +18,7 @@ import { UniqueKeysCachePluggable } from './UniqueKeysCachePluggable';
 import { UniqueKeysCacheInMemory } from '../inMemory/UniqueKeysCacheInMemory';
 import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
 import { metadataBuilder } from '../utils';
+import { LOG_PREFIX } from '../pluggable/constants';
 var NO_VALID_WRAPPER = 'Expecting pluggable storage `wrapper` in options, but no valid wrapper instance was provided.';
 var NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow the expected interface. Check our docs.';
 /**
@@ -78,6 +79,7 @@ export function PluggableStorage(options) {
                 return wrapper.get(keys.buildHashKey()).then(function (hash) {
                     var currentHash = getStorageHash(settings);
                     if (hash !== currentHash) {
+                        log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key or feature flag filter criteria was modified). Clearing cache');
                         return wrapper.getKeysByPrefix(keys.prefix + ".").then(function (storageKeys) {
                             return Promise.all(storageKeys.map(function (storageKey) { return wrapper.del(storageKey); }));
                         }).then(function () { return wrapper.set(keys.buildHashKey(), currentHash); });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.12.1-rc.6",
+  "version": "1.12.1",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/storages/KeyBuilderCS.ts

@@ -9,7 +9,7 @@ export class KeyBuilderCS extends KeyBuilder {
   constructor(prefix: string, matchingKey: string) {
     super(prefix);
     this.matchingKey = matchingKey;
-    this.regexSplitsCacheKey = new RegExp(`^${prefix}\\.`);
+    this.regexSplitsCacheKey = new RegExp(`^${prefix}\\.(splits?|trafficType|flagSet)\\.`);
   }
 
   /**

package/src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -146,7 +146,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
     // when using a new split query, we must update it at the store
     if (this.updateNewFilter) {
-      this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache.');
+      this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
       const storageHashKey = this.keys.buildHashKey();
       try {
         localStorage.setItem(storageHashKey, this.storageHash);

package/src/storages/inRedis/TelemetryCacheInRedis.ts

@@ -69,15 +69,10 @@ export class TelemetryCacheInRedis implements ITelemetryCacheAsync {
           return;
         }
 
-        if (!result.has(metadata)) result.set(metadata, {
-          t: newBuckets(),
-          ts: newBuckets(),
-          tc: newBuckets(),
-          tcs: newBuckets(),
-          tr: newBuckets(),
-        });
-
-        result.get(metadata)![method]![bucket] = count;
+        const methodLatencies = result.get(metadata) || {};
+        methodLatencies[method] = methodLatencies[method] || newBuckets();
+        methodLatencies[method]![bucket] = count;
+        result.set(metadata, methodLatencies);
       });
 
       return this.redis.del(this.keys.latencyPrefix).then(() => result);
@@ -109,14 +104,7 @@ export class TelemetryCacheInRedis implements ITelemetryCacheAsync {
 
         const [metadata, method] = parsedField;
 
-        if (!result.has(metadata)) result.set(metadata, {
-          t: 0,
-          ts: 0,
-          tc: 0,
-          tcs: 0,
-          tr: 0,
-        });
-
+        if (!result.has(metadata)) result.set(metadata, {});
         result.get(metadata)![method] = count;
       });
 

package/src/storages/pluggable/TelemetryCachePluggable.ts

@@ -68,15 +68,10 @@ export class TelemetryCachePluggable implements ITelemetryCacheAsync {
               continue;
             }
 
-            if (!result.has(metadata)) result.set(metadata, {
-              t: newBuckets(),
-              ts: newBuckets(),
-              tc: newBuckets(),
-              tcs: newBuckets(),
-              tr: newBuckets(),
-            });
-
-            result.get(metadata)![method]![bucket] = count;
+            const methodLatencies = result.get(metadata) || {};
+            methodLatencies[method] = methodLatencies[method] || newBuckets();
+            methodLatencies[method]![bucket] = count;
+            result.set(metadata, methodLatencies);
           }
 
           return Promise.all(latencyKeys.map((latencyKey) => this.wrapper.del(latencyKey))).then(() => result);
@@ -115,14 +110,7 @@ export class TelemetryCachePluggable implements ITelemetryCacheAsync {
 
             const [metadata, method] = parsedField;
 
-            if (!result.has(metadata)) result.set(metadata, {
-              t: 0,
-              ts: 0,
-              tc: 0,
-              tcs: 0,
-              tr: 0,
-            });
-
+            if (!result.has(metadata)) result.set(metadata, {});
             result.get(metadata)![method] = count;
           }
 

package/src/storages/pluggable/index.ts

@@ -19,6 +19,7 @@ import { UniqueKeysCachePluggable } from './UniqueKeysCachePluggable';
 import { UniqueKeysCacheInMemory } from '../inMemory/UniqueKeysCacheInMemory';
 import { UniqueKeysCacheInMemoryCS } from '../inMemory/UniqueKeysCacheInMemoryCS';
 import { metadataBuilder } from '../utils';
+import { LOG_PREFIX } from '../pluggable/constants';
 
 const NO_VALID_WRAPPER = 'Expecting pluggable storage `wrapper` in options, but no valid wrapper instance was provided.';
 const NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow the expected interface. Check our docs.';
@@ -95,6 +96,7 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
         return wrapper.get(keys.buildHashKey()).then((hash) => {
           const currentHash = getStorageHash(settings);
           if (hash !== currentHash) {
+            log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key or feature flag filter criteria was modified). Clearing cache');
             return wrapper.getKeysByPrefix(`${keys.prefix}.`).then(storageKeys => {
               return Promise.all(storageKeys.map(storageKey => wrapper.del(storageKey)));
             }).then(() => wrapper.set(keys.buildHashKey(), currentHash));