@splitsoftware/splitio-commons 2.1.0-rc.0 → 2.1.0-rc.1

package/CHANGES.txt

@@ -1,3 +1,10 @@
+2.1.0 (January XX, 2025)
+ - Added two new configuration options for the SDK storage in browsers when using storage type `LOCALSTORAGE`:
+    - `storage.expirationDays` to specify the validity period of the rollout cache.
+    - `storage.clearOnInit` to clear the rollout cache on SDK initialization.
+ - Updated SDK_READY_FROM_CACHE event when using `LOCALSTORAGE` storage type to be emitted alongside SDK_READY event in case it has not been emitted.
+ - Bugfixing - Properly handle rejected promises when using targeting rules with segment matchers in consumer modes (e.g., Redis and Pluggable storages).
+
 2.0.2 (December 3, 2024)
  - Updated the factory `init` and `destroy` methods to support re-initialization after destruction. This update ensures compatibility of the React SDK with React Strict Mode, where the factory's `init` and `destroy` effects are executed an extra time to validate proper resource cleanup.
  - Bugfixing - Sanitize the `SplitSDKMachineName` header value to avoid exceptions on HTTP/S requests when it contains non ISO-8859-1 characters (Related to issue https://github.com/splitio/javascript-client/issues/847).

package/cjs/evaluator/matchers/large_segment.js

@@ -1,15 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.largeSegmentMatcherContext = void 0;
-var thenable_1 = require("../../utils/promise/thenable");
 function largeSegmentMatcherContext(largeSegmentName, storage) {
     return function largeSegmentMatcher(key) {
         var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-        if ((0, thenable_1.thenable)(isInLargeSegment)) {
-            isInLargeSegment.then(function (result) {
-                return result;
-            });
-        }
         return isInLargeSegment;
     };
 }

package/cjs/evaluator/matchers/segment.js

@@ -1,15 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.segmentMatcherContext = void 0;
-var thenable_1 = require("../../utils/promise/thenable");
 function segmentMatcherContext(segmentName, storage) {
     return function segmentMatcher(key) {
         var isInSegment = storage.segments.isInSegment(segmentName, key);
-        if ((0, thenable_1.thenable)(isInSegment)) {
-            isInSegment.then(function (result) {
-                return result;
-            });
-        }
         return isInSegment;
     };
 }

package/cjs/readiness/readinessManager.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readinessManagerFactory = void 0;
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("./constants");
+var constants_2 = require("../utils/constants");
 function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = (0, objectAssign_1.objectAssign)(new EventEmitter(), {
         splitsArrived: false,
@@ -83,6 +84,7 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
         }
     }
     function checkIsReadyOrUpdate(diff) {
+        var _a;
         if (isDestroyed)
             return;
         if (isReady) {
@@ -101,6 +103,10 @@ function readinessManagerFactory(EventEmitter, settings, splits, isShared) {
                 isReady = true;
                 try {
                     syncLastUpdate();
+                    if (!isReadyFromCache && ((_a = settings.storage) === null || _a === void 0 ? void 0 : _a.type) === constants_2.STORAGE_LOCALSTORAGE) {
+                        isReadyFromCache = true;
+                        gate.emit(constants_1.SDK_READY_FROM_CACHE);
+                    }
                     gate.emit(constants_1.SDK_READY);
                 }
                 catch (e) {

package/cjs/storages/inLocalStorage/validateCache.js

@@ -4,7 +4,6 @@ exports.validateCache = void 0;
 var lang_1 = require("../../utils/lang");
 var KeyBuilder_1 = require("../KeyBuilder");
 var constants_1 = require("./constants");
-// milliseconds in a day
 var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
 var MILLIS_IN_A_DAY = 86400000;
 /**
@@ -36,7 +35,7 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
             log.error(constants_1.LOG_PREFIX + e);
         }
         if (isThereCache) {
-            log.info(constants_1.LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version has changed. Cleaning up cache');
+            log.info(constants_1.LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
             return true;
         }
         return false; // No cache to clear

package/cjs/storages/inRedis/SplitsCacheInRedis.js

@@ -241,9 +241,9 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
             this.log.error(constants_1.LOG_PREFIX + this.redisError);
             return Promise.reject(this.redisError);
         }
-        var splits = {};
         var keys = names.map(function (name) { return _this.keys.buildSplitKey(name); });
         return (_a = this.redis).mget.apply(_a, keys).then(function (splitDefinitions) {
+            var splits = {};
             names.forEach(function (name, idx) {
                 var split = splitDefinitions[idx];
                 splits[name] = split && JSON.parse(split);

package/esm/evaluator/matchers/large_segment.js

@@ -1,12 +1,6 @@
-import { thenable } from '../../utils/promise/thenable';
 export function largeSegmentMatcherContext(largeSegmentName, storage) {
     return function largeSegmentMatcher(key) {
         var isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
-        if (thenable(isInLargeSegment)) {
-            isInLargeSegment.then(function (result) {
-                return result;
-            });
-        }
         return isInLargeSegment;
     };
 }

package/esm/evaluator/matchers/segment.js

@@ -1,12 +1,6 @@
-import { thenable } from '../../utils/promise/thenable';
 export function segmentMatcherContext(segmentName, storage) {
     return function segmentMatcher(key) {
         var isInSegment = storage.segments.isInSegment(segmentName, key);
-        if (thenable(isInSegment)) {
-            isInSegment.then(function (result) {
-                return result;
-            });
-        }
         return isInSegment;
     };
 }

package/esm/readiness/readinessManager.js

@@ -1,5 +1,6 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
+import { STORAGE_LOCALSTORAGE } from '../utils/constants';
 function splitsEventEmitterFactory(EventEmitter) {
     var splitsEventEmitter = objectAssign(new EventEmitter(), {
         splitsArrived: false,
@@ -80,6 +81,7 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
         }
     }
     function checkIsReadyOrUpdate(diff) {
+        var _a;
         if (isDestroyed)
             return;
         if (isReady) {
@@ -98,6 +100,10 @@ export function readinessManagerFactory(EventEmitter, settings, splits, isShared
                 isReady = true;
                 try {
                     syncLastUpdate();
+                    if (!isReadyFromCache && ((_a = settings.storage) === null || _a === void 0 ? void 0 : _a.type) === STORAGE_LOCALSTORAGE) {
+                        isReadyFromCache = true;
+                        gate.emit(SDK_READY_FROM_CACHE);
+                    }
                     gate.emit(SDK_READY);
                 }
                 catch (e) {

package/esm/storages/inLocalStorage/validateCache.js

@@ -1,7 +1,6 @@
 import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
 import { getStorageHash } from '../KeyBuilder';
 import { LOG_PREFIX } from './constants';
-// milliseconds in a day
 var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
 var MILLIS_IN_A_DAY = 86400000;
 /**
@@ -33,7 +32,7 @@ function validateExpiration(options, settings, keys, currentTimestamp, isThereCa
             log.error(LOG_PREFIX + e);
         }
         if (isThereCache) {
-            log.info(LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version has changed. Cleaning up cache');
+            log.info(LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
             return true;
         }
         return false; // No cache to clear

package/esm/storages/inRedis/SplitsCacheInRedis.js

@@ -238,9 +238,9 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
             this.log.error(LOG_PREFIX + this.redisError);
             return Promise.reject(this.redisError);
         }
-        var splits = {};
         var keys = names.map(function (name) { return _this.keys.buildSplitKey(name); });
         return (_a = this.redis).mget.apply(_a, keys).then(function (splitDefinitions) {
+            var splits = {};
             names.forEach(function (name, idx) {
                 var split = splitDefinitions[idx];
                 splits[name] = split && JSON.parse(split);

package/package.json

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

package/src/evaluator/matchers/large_segment.ts

@@ -1,18 +1,11 @@
 import { MaybeThenable } from '../../dtos/types';
 import { ISegmentsCacheBase } from '../../storages/types';
-import { thenable } from '../../utils/promise/thenable';
 
 export function largeSegmentMatcherContext(largeSegmentName: string, storage: { largeSegments?: ISegmentsCacheBase }) {
 
   return function largeSegmentMatcher(key: string): MaybeThenable<boolean> {
     const isInLargeSegment = storage.largeSegments ? storage.largeSegments.isInSegment(largeSegmentName, key) : false;
 
-    if (thenable(isInLargeSegment)) {
-      isInLargeSegment.then(result => {
-        return result;
-      });
-    }
-
     return isInLargeSegment;
   };
 }

package/src/evaluator/matchers/segment.ts

@@ -1,18 +1,11 @@
 import { MaybeThenable } from '../../dtos/types';
 import { ISegmentsCacheBase } from '../../storages/types';
-import { thenable } from '../../utils/promise/thenable';
 
 export function segmentMatcherContext(segmentName: string, storage: { segments: ISegmentsCacheBase }) {
 
   return function segmentMatcher(key: string): MaybeThenable<boolean> {
     const isInSegment = storage.segments.isInSegment(segmentName, key);
 
-    if (thenable(isInSegment)) {
-      isInSegment.then(result => {
-        return result;
-      });
-    }
-
     return isInSegment;
   };
 }

package/src/readiness/readinessManager.ts

@@ -3,6 +3,7 @@ import { ISettings } from '../types';
 import SplitIO from '../../types/splitio';
 import { SDK_SPLITS_ARRIVED, SDK_SPLITS_CACHE_LOADED, SDK_SEGMENTS_ARRIVED, SDK_READY_TIMED_OUT, SDK_READY_FROM_CACHE, SDK_UPDATE, SDK_READY } from './constants';
 import { IReadinessEventEmitter, IReadinessManager, ISegmentsEventEmitter, ISplitsEventEmitter } from './types';
+import { STORAGE_LOCALSTORAGE } from '../utils/constants';
 
 function splitsEventEmitterFactory(EventEmitter: new () => SplitIO.IEventEmitter): ISplitsEventEmitter {
   const splitsEventEmitter = objectAssign(new EventEmitter(), {
@@ -114,6 +115,10 @@ export function readinessManagerFactory(
         isReady = true;
         try {
           syncLastUpdate();
+          if (!isReadyFromCache && settings.storage?.type === STORAGE_LOCALSTORAGE) {
+            isReadyFromCache = true;
+            gate.emit(SDK_READY_FROM_CACHE);
+          }
           gate.emit(SDK_READY);
         } catch (e) {
           // throws user callback exceptions in next tick

package/src/storages/inLocalStorage/validateCache.ts

@@ -7,7 +7,6 @@ import type { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
 import { KeyBuilderCS } from '../KeyBuilderCS';
 import SplitIO from '../../../types/splitio';
 
-// milliseconds in a day
 const DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
 const MILLIS_IN_A_DAY = 86400000;
 
@@ -42,7 +41,7 @@ function validateExpiration(options: SplitIO.InLocalStorageOptions, settings: IS
       log.error(LOG_PREFIX + e);
     }
     if (isThereCache) {
-      log.info(LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version has changed. Cleaning up cache');
+      log.info(LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
       return true;
     }
     return false; // No cache to clear

package/src/storages/inRedis/SplitsCacheInRedis.ts

@@ -266,10 +266,10 @@ export class SplitsCacheInRedis extends AbstractSplitsCacheAsync {
       return Promise.reject(this.redisError);
     }
 
-    const splits: Record<string, ISplit | null> = {};
     const keys = names.map(name => this.keys.buildSplitKey(name));
     return this.redis.mget(...keys)
       .then(splitDefinitions => {
+        const splits: Record<string, ISplit | null> = {};
         names.forEach((name, idx) => {
           const split = splitDefinitions[idx];
           splits[name] = split && JSON.parse(split);