@splitsoftware/splitio-commons 1.17.0 → 1.17.1-rc.1

package/CHANGES.txt

@@ -1,3 +1,11 @@
+2.0.0 (September XX, 2024)
+ - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+ - Added support for targeting rules based on large segments.
+ - BREAKING CHANGES:
+   - Updated default flag spec version to 1.2.
+   - Removed `/mySegments` endpoint from SplitAPI module, as it is replaced by `/memberships` endpoint.
+   - Removed support for MY_SEGMENTS_UPDATE and MY_SEGMENTS_UPDATE_V2 notification types, as they are replaced by MEMBERSHIPS_MS_UPDATE and MEMBERSHIPS_LS_UPDATE notification types.
+
 1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
  - Added `isTimedout` and `lastUpdate` properties to IStatusInterface to keep track of the timestamp of the last SDK event, used on React and Redux SDKs.

package/cjs/evaluator/matchers/index.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.matcherFactory = void 0;
 var all_1 = require("./all");
 var segment_1 = require("./segment");
+var large_segment_1 = require("./large_segment");
 var whitelist_1 = require("./whitelist");
 var eq_1 = require("./eq");
 var gte_1 = require("./gte");
@@ -46,7 +47,8 @@ var matchers = [
     semver_gte_1.greaterThanEqualToSemverMatcherContext,
     semver_lte_1.lessThanEqualToSemverMatcherContext,
     semver_between_1.betweenSemverMatcherContext,
-    semver_inlist_1.inListSemverMatcherContext, // IN_LIST_SEMVER: 22
+    semver_inlist_1.inListSemverMatcherContext,
+    large_segment_1.largeSegmentMatcherContext, // IN_LARGE_SEGMENT: 23
 ];
 /**
  * Matcher factory.

package/cjs/evaluator/matchers/large_segment.js

@@ -0,0 +1,16 @@
+"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;
+    };
+}
+exports.largeSegmentMatcherContext = largeSegmentMatcherContext;

package/cjs/evaluator/matchers/matcherTypes.js

@@ -25,6 +25,7 @@ exports.matcherTypes = {
     LESS_THAN_OR_EQUAL_TO_SEMVER: 20,
     BETWEEN_SEMVER: 21,
     IN_LIST_SEMVER: 22,
+    IN_LARGE_SEGMENT: 23,
 };
 exports.matcherDataTypes = {
     BOOLEAN: 'BOOLEAN',

package/cjs/evaluator/matchersTransform/index.js

@@ -12,7 +12,7 @@ var convertions_1 = require("../convertions");
  */
 function matchersTransform(matchers) {
     var parsedMatchers = matchers.map(function (matcher) {
-        var matcherType = matcher.matcherType, negate = matcher.negate, keySelector = matcher.keySelector, userDefinedSegmentMatcherData = matcher.userDefinedSegmentMatcherData, whitelistMatcherData = matcher.whitelistMatcherData, /* whitelistObject, provided by 'WHITELIST', 'IN_LIST_SEMVER', set and string matchers */ unaryNumericMatcherData = matcher.unaryNumericMatcherData, betweenMatcherData = matcher.betweenMatcherData, dependencyMatcherData = matcher.dependencyMatcherData, booleanMatcherData = matcher.booleanMatcherData, stringMatcherData = matcher.stringMatcherData, betweenStringMatcherData = matcher.betweenStringMatcherData;
+        var matcherType = matcher.matcherType, negate = matcher.negate, keySelector = matcher.keySelector, userDefinedSegmentMatcherData = matcher.userDefinedSegmentMatcherData, userDefinedLargeSegmentMatcherData = matcher.userDefinedLargeSegmentMatcherData, whitelistMatcherData = matcher.whitelistMatcherData, /* whitelistObject, provided by 'WHITELIST', 'IN_LIST_SEMVER', set and string matchers */ unaryNumericMatcherData = matcher.unaryNumericMatcherData, betweenMatcherData = matcher.betweenMatcherData, dependencyMatcherData = matcher.dependencyMatcherData, booleanMatcherData = matcher.booleanMatcherData, stringMatcherData = matcher.stringMatcherData, betweenStringMatcherData = matcher.betweenStringMatcherData;
         var attribute = keySelector && keySelector.attribute;
         var type = (0, matcherTypes_1.matcherTypesMapper)(matcherType);
         // As default input data type we use string (even for ALL_KEYS)
@@ -21,6 +21,9 @@ function matchersTransform(matchers) {
         if (type === matcherTypes_1.matcherTypes.IN_SEGMENT) {
             value = (0, segment_1.segmentTransform)(userDefinedSegmentMatcherData);
         }
+        else if (type === matcherTypes_1.matcherTypes.IN_LARGE_SEGMENT) {
+            value = (0, segment_1.segmentTransform)(userDefinedLargeSegmentMatcherData);
+        }
         else if (type === matcherTypes_1.matcherTypes.EQUAL_TO) {
             value = (0, unaryNumeric_1.numericTransform)(unaryNumericMatcherData);
             dataType = matcherTypes_1.matcherDataTypes.NUMBER;

package/cjs/evaluator/matchersTransform/segment.js

@@ -5,6 +5,8 @@ exports.segmentTransform = void 0;
  * Extract segment name as a plain string.
  */
 function segmentTransform(segment) {
-    return segment ? segment.segmentName : undefined;
+    return segment ?
+        segment.segmentName || segment.largeSegmentName :
+        undefined;
 }
 exports.segmentTransform = segmentTransform;

package/cjs/logger/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ENGINE_VALUE_INVALID = exports.USER_CONSENT_INITIAL = exports.USER_CONSENT_NOT_UPDATED = exports.USER_CONSENT_UPDATED = exports.IMPRESSIONS_TRACKER_SUCCESS = exports.EVENTS_TRACKER_SUCCESS = exports.SYNC_STOP_POLLING = exports.SYNC_CONTINUE_POLLING = exports.SYNC_START_POLLING = exports.SUBMITTERS_PUSH = exports.SUBMITTERS_PUSH_FULL_QUEUE = exports.STREAMING_DISCONNECTING = exports.STREAMING_DISABLED = exports.STREAMING_CONNECTING = exports.STREAMING_RECONNECT = exports.STREAMING_REFRESH_TOKEN = exports.SYNC_SPLITS_FETCH_RETRY = exports.POLLING_STOP = exports.POLLING_START = exports.POLLING_SMART_PAUSING = exports.NEW_FACTORY = exports.NEW_SHARED_CLIENT = exports.IMPRESSION_QUEUEING = exports.IMPRESSION = exports.CLIENT_READY = exports.CLIENT_READY_FROM_CACHE = exports.ENGINE_MATCHER_RESULT = exports.SETTINGS_SPLITS_FILTER = exports.SYNC_TASK_STOP = exports.SYNC_TASK_EXECUTE = exports.SYNC_TASK_START = exports.STREAMING_NEW_MESSAGE = exports.SYNC_SPLITS_SEGMENTS = exports.SYNC_SPLITS_REMOVED = exports.SYNC_SPLITS_NEW = exports.SYNC_SPLITS_FETCH = exports.SYNC_OFFLINE_DATA = exports.RETRIEVE_MANAGER = exports.RETRIEVE_CLIENT_EXISTING = exports.RETRIEVE_CLIENT_DEFAULT = exports.CLEANUP_DEREGISTERING = exports.CLEANUP_REGISTERING = exports.ENGINE_SANITIZE = exports.ENGINE_VALUE = exports.ENGINE_MATCHER_DEPENDENCY_PRE = exports.ENGINE_MATCHER_DEPENDENCY = exports.ENGINE_BUCKET = exports.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = exports.ENGINE_COMBINER_IFELSEIF = exports.ENGINE_COMBINER_AND = void 0;
-exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = void 0;
+exports.ERROR_INVALID_CONFIG_PARAM = exports.ERROR_EMPTY_ARRAY = exports.ERROR_EMPTY = exports.ERROR_INVALID = exports.ERROR_INVALID_KEY_OBJECT = exports.ERROR_TOO_LONG = exports.ERROR_NULL = exports.ERROR_CLIENT_DESTROYED = exports.ERROR_NOT_FINITE = exports.ERROR_SIZE_EXCEEDED = exports.ERROR_NOT_PLAIN_OBJECT = exports.ERROR_EVENT_TYPE_FORMAT = exports.ERROR_EVENTS_TRACKER = exports.ERROR_IMPRESSIONS_LISTENER = exports.ERROR_IMPRESSIONS_TRACKER = exports.ERROR_STREAMING_AUTH = exports.ERROR_STREAMING_SSE = exports.ERROR_SYNC_OFFLINE_LOADING = exports.ERROR_CLIENT_CANNOT_GET_READY = exports.ERROR_CLIENT_LISTENER = exports.ERROR_LOGLEVEL_INVALID = exports.ERROR_ENGINE_COMBINER_IFELSEIF = exports.WARN_FLAGSET_WITHOUT_FLAGS = exports.WARN_FLAGSET_NOT_CONFIGURED = exports.WARN_LOWERCASE_FLAGSET = exports.WARN_INVALID_FLAGSET = exports.STREAMING_PARSING_SPLIT_UPDATE = exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = exports.WARN_SDK_KEY = exports.WARN_SPLITS_FILTER_EMPTY = exports.WARN_SPLITS_FILTER_INVALID = exports.WARN_SPLITS_FILTER_IGNORED = exports.WARN_INTEGRATION_INVALID = exports.WARN_NOT_EXISTENT_TT = exports.WARN_LOWERCASE_TRAFFIC_TYPE = exports.WARN_NOT_EXISTENT_SPLIT = exports.WARN_TRIMMING = exports.WARN_CONVERTING = exports.WARN_TRIMMING_PROPERTIES = exports.WARN_SETTING_NULL = exports.SUBMITTERS_PUSH_RETRY = exports.SUBMITTERS_PUSH_FAILS = exports.STREAMING_FALLBACK = exports.STREAMING_PARSING_MESSAGE_FAILS = exports.STREAMING_PARSING_ERROR_FAILS = exports.SYNC_SPLITS_FETCH_FAILS = exports.SYNC_MYSEGMENTS_FETCH_RETRY = exports.CLIENT_NOT_READY = exports.CLIENT_NO_LISTENER = exports.ENGINE_VALUE_NO_ATTRIBUTES = void 0;
 exports.LOG_PREFIX_CLEANUP = exports.LOG_PREFIX_UNIQUE_KEYS_TRACKER = exports.LOG_PREFIX_EVENTS_TRACKER = exports.LOG_PREFIX_IMPRESSIONS_TRACKER = exports.LOG_PREFIX_SYNC_SUBMITTERS = exports.LOG_PREFIX_SYNC_POLLING = exports.LOG_PREFIX_SYNC_MYSEGMENTS = exports.LOG_PREFIX_SYNC_SEGMENTS = exports.LOG_PREFIX_SYNC_SPLITS = exports.LOG_PREFIX_SYNC_STREAMING = exports.LOG_PREFIX_SYNC_OFFLINE = exports.LOG_PREFIX_SYNC_MANAGER = exports.LOG_PREFIX_SYNC = exports.LOG_PREFIX_ENGINE_VALUE = exports.LOG_PREFIX_ENGINE_MATCHER = exports.LOG_PREFIX_ENGINE_COMBINER = exports.LOG_PREFIX_ENGINE = exports.LOG_PREFIX_CLIENT_INSTANTIATION = exports.LOG_PREFIX_INSTANTIATION = exports.LOG_PREFIX_SETTINGS = exports.ENGINE_MATCHER_ERROR = exports.ERROR_SETS_FILTER_EXCLUSIVE = exports.ERROR_TOO_MANY_SETS = exports.ERROR_MIN_CONFIG_PARAM = exports.ERROR_NOT_BOOLEAN = exports.ERROR_STORAGE_INVALID = exports.ERROR_LOCALHOST_MODULE_REQUIRED = exports.ERROR_HTTP = void 0;
 /**
  * Message codes used to trim string log messages from commons and client-side API modules,
@@ -82,7 +82,7 @@ exports.WARN_SPLITS_FILTER_IGNORED = 219;
 exports.WARN_SPLITS_FILTER_INVALID = 220;
 exports.WARN_SPLITS_FILTER_EMPTY = 221;
 exports.WARN_SDK_KEY = 222;
-exports.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2 = 223;
+exports.STREAMING_PARSING_MEMBERSHIPS_UPDATE = 223;
 exports.STREAMING_PARSING_SPLIT_UPDATE = 224;
 exports.WARN_INVALID_FLAGSET = 225;
 exports.WARN_LOWERCASE_FLAGSET = 226;

package/cjs/logger/messages/info.js

@@ -24,7 +24,7 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
     [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
     [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of feature flags #%s. Reason: %s'],
-    [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
+    [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and resetting timer.'],
     [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s.'],
     [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
     [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],

package/cjs/logger/messages/warn.js

@@ -34,7 +34,7 @@ exports.codesWarn = error_1.codesError.concat([
     [c.WARN_SPLITS_FILTER_INVALID, c.LOG_PREFIX_SETTINGS + ': feature flag filter at position %s is invalid. It must be an object with a valid filter type ("bySet", "byName" or "byPrefix") and a list of "values".'],
     [c.WARN_SPLITS_FILTER_EMPTY, c.LOG_PREFIX_SETTINGS + ': feature flag filter configuration must be a non-empty array of filter objects.'],
     [c.WARN_SDK_KEY, c.LOG_PREFIX_SETTINGS + ': You already have %s. We recommend keeping only one instance of the factory at all times (Singleton pattern) and reusing it throughout your application'],
-    [c.STREAMING_PARSING_MY_SEGMENTS_UPDATE_V2, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching MySegments due to an error processing %s notification: %s'],
+    [c.STREAMING_PARSING_MEMBERSHIPS_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching Memberships due to an error processing %s notification: %s'],
     [c.STREAMING_PARSING_SPLIT_UPDATE, c.LOG_PREFIX_SYNC_STREAMING + 'Fetching SplitChanges due to an error processing SPLIT_UPDATE notification: %s'],
     [c.WARN_INVALID_FLAGSET, '%s: you passed %s, flag set must adhere to the regular expressions %s. This means a flag set must start with a letter or number, be in lowercase, alphanumeric and have a max length of 50 characters. %s was discarded.'],
     [c.WARN_LOWERCASE_FLAGSET, '%s: flag set %s should be all lowercase - converting string to lowercase.'],

package/cjs/readiness/readinessManager.js

@@ -9,7 +9,7 @@ function splitsEventEmitterFactory(EventEmitter) {
         splitsCacheLoaded: false,
     });
     // `isSplitKill` condition avoids an edge-case of wrongly emitting SDK_READY if:
-    // - `/mySegments` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
+    // - `/memberships` fetch and SPLIT_KILL occurs before `/splitChanges` fetch, and
     // - storage has cached splits (for which case `splitsStorage.killLocally` can return true)
     splitsEventEmitter.on(constants_1.SDK_SPLITS_ARRIVED, function (isSplitKill) { if (!isSplitKill)
         splitsEventEmitter.splitsArrived = true; });
@@ -26,9 +26,9 @@ function segmentsEventEmitterFactory(EventEmitter) {
 /**
  * Factory of readiness manager, which handles the ready / update event propagation.
  */
-function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
-    if (readyTimeout === void 0) { readyTimeout = 0; }
+function readinessManagerFactory(EventEmitter, settings, splits) {
     if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
+    var readyTimeout = settings.startup.readyTimeout;
     var segments = segmentsEventEmitterFactory(EventEmitter);
     var gate = new EventEmitter();
     var lastUpdate = 0;
@@ -106,10 +106,9 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         splits: splits,
         segments: segments,
         gate: gate,
-        shared: function (readyTimeout) {
-            if (readyTimeout === void 0) { readyTimeout = 0; }
+        shared: function () {
             refCount++;
-            return readinessManagerFactory(EventEmitter, readyTimeout, splits);
+            return readinessManagerFactory(EventEmitter, settings, splits);
         },
         // @TODO review/remove next methods when non-recoverable errors are reworked
         // Called on consumer mode, when storage fails to connect

package/cjs/readiness/sdkReadinessManager.js

@@ -15,9 +15,9 @@ var REMOVE_LISTENER_EVENT = 'removeListener';
  * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
  * @param readinessManager optional readinessManager to use. only used internally for `shared` method
  */
-function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager) {
-    if (readyTimeout === void 0) { readyTimeout = 0; }
-    if (readinessManager === void 0) { readinessManager = (0, readinessManager_1.readinessManagerFactory)(EventEmitter, readyTimeout); }
+function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
+    if (readinessManager === void 0) { readinessManager = (0, readinessManager_1.readinessManagerFactory)(EventEmitter, settings); }
+    var log = settings.log;
     /** Ready callback warning */
     var internalReadyCbCount = 0;
     var readyCbCount = 0;
@@ -60,9 +60,8 @@ function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessMa
     }
     return {
         readinessManager: readinessManager,
-        shared: function (readyTimeout) {
-            if (readyTimeout === void 0) { readyTimeout = 0; }
-            return sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessManager.shared(readyTimeout));
+        shared: function () {
+            return sdkReadinessManagerFactory(EventEmitter, settings, readinessManager.shared());
         },
         incInternalReadyCbCount: function () {
             internalReadyCbCount++;

package/cjs/sdkClient/identity.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildInstanceId = void 0;
+function buildInstanceId(key, trafficType) {
+    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType ? trafficType : '');
+}
+exports.buildInstanceId = buildInstanceId;

package/cjs/sdkClient/sdkClient.js

@@ -53,11 +53,11 @@ function sdkClientFactory(params, isSharedClient) {
             // Stop background jobs
             syncManager && syncManager.stop();
             return __flush().then(function () {
-                // Cleanup event listeners
-                signalListener && signalListener.stop();
-                // @TODO stop only if last client is destroyed
-                if (uniqueKeysTracker)
-                    uniqueKeysTracker.stop();
+                // For main client, cleanup event listeners and scheduled jobs
+                if (!isSharedClient) {
+                    signalListener && signalListener.stop();
+                    uniqueKeysTracker && uniqueKeysTracker.stop();
+                }
                 // Cleanup storage
                 return storage.destroy();
             });

package/cjs/sdkClient/sdkClientMethod.js

@@ -4,11 +4,13 @@ exports.sdkClientMethodFactory = void 0;
 var sdkClient_1 = require("./sdkClient");
 var constants_1 = require("../logger/constants");
 /**
- * Factory of client method for server-side SDKs (ISDK and IAsyncSDK)
+ * Factory of client method for server-side SDKs
  */
 function sdkClientMethodFactory(params) {
     var log = params.settings.log;
     var clientInstance = (0, sdkClient_1.sdkClientFactory)(params);
+    // Only one client in server-side without bound key
+    params.clients[''] = clientInstance;
     return function client() {
         if (arguments.length > 0) {
             throw new Error('Shared Client not supported by the storage mechanism. Create isolated instances instead.');

package/cjs/sdkClient/sdkClientMethodCS.js

@@ -8,22 +8,18 @@ var sdkClient_1 = require("./sdkClient");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("../logger/constants");
 var constants_2 = require("../readiness/constants");
-function buildInstanceId(key) {
-    // @ts-ignore
-    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-";
-}
+var identity_1 = require("./identity");
 /**
  * Factory of client method for the client-side API variant where TT is ignored.
  * Therefore, clients don't have a bound TT for the track method.
  */
 function sdkClientMethodCSFactory(params) {
-    var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, readyTimeout = _a.startup.readyTimeout, log = _a.log;
+    var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, key = _a.core.key, log = _a.log;
     var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
-    var defaultInstanceId = buildInstanceId(parsedDefaultKey);
+    var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey);
     // Cache instances created per factory.
-    var clientInstances = {};
-    clientInstances[defaultInstanceId] = mainClientInstance;
+    clients[defaultInstanceId] = mainClientInstance;
     return function client(key) {
         if (key === undefined) {
             log.debug(constants_1.RETRIEVE_CLIENT_DEFAULT);
@@ -34,10 +30,10 @@ function sdkClientMethodCSFactory(params) {
         if (validKey === false) {
             throw new Error('Shared Client needs a valid key.');
         }
-        var instanceId = buildInstanceId(validKey);
-        if (!clientInstances[instanceId]) {
+        var instanceId = (0, identity_1.buildInstanceId)(validKey);
+        if (!clients[instanceId]) {
             var matchingKey = (0, key_2.getMatching)(validKey);
-            var sharedSdkReadiness_1 = sdkReadinessManager.shared(readyTimeout);
+            var sharedSdkReadiness_1 = sdkReadinessManager.shared();
             var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
                 if (err) {
                     sharedSdkReadiness_1.readinessManager.timeout();
@@ -54,11 +50,10 @@ function sdkClientMethodCSFactory(params) {
             var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
             // As shared clients reuse all the storage information, we don't need to check here if we
             // will use offline or online mode. We should stick with the original decision.
-            clientInstances[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
+            clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined, // only the main client "destroy" method stops the signal listener
             }), true), validKey);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
@@ -66,7 +61,7 @@ function sdkClientMethodCSFactory(params) {
         else {
             log.debug(constants_1.RETRIEVE_CLIENT_EXISTING);
         }
-        return clientInstances[instanceId];
+        return clients[instanceId];
     };
 }
 exports.sdkClientMethodCSFactory = sdkClientMethodCSFactory;

package/cjs/sdkClient/sdkClientMethodCSWithTT.js

@@ -9,23 +9,19 @@ var sdkClient_1 = require("./sdkClient");
 var objectAssign_1 = require("../utils/lang/objectAssign");
 var constants_1 = require("../logger/constants");
 var constants_2 = require("../readiness/constants");
-function buildInstanceId(key, trafficType) {
-    // @ts-ignore
-    return (key.matchingKey ? key.matchingKey : key) + "-" + (key.bucketingKey ? key.bucketingKey : key) + "-" + (trafficType !== undefined ? trafficType : '');
-}
+var identity_1 = require("./identity");
 /**
  * Factory of client method for the client-side (browser) variant of the Isomorphic JS SDK,
  * where clients can have a bound TT for the track method, which is provided via the settings
  * (default client) or the client method (shared clients).
  */
 function sdkClientMethodCSFactory(params) {
-    var storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, readyTimeout = _a.startup.readyTimeout, log = _a.log;
+    var clients = params.clients, storage = params.storage, syncManager = params.syncManager, sdkReadinessManager = params.sdkReadinessManager, _a = params.settings, _b = _a.core, key = _b.key, trafficType = _b.trafficType, log = _a.log;
     var mainClientInstance = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)(params), key, trafficType);
     var parsedDefaultKey = (0, key_2.keyParser)(key);
-    var defaultInstanceId = buildInstanceId(parsedDefaultKey, trafficType);
+    var defaultInstanceId = (0, identity_1.buildInstanceId)(parsedDefaultKey, trafficType);
     // Cache instances created per factory.
-    var clientInstances = {};
-    clientInstances[defaultInstanceId] = mainClientInstance;
+    clients[defaultInstanceId] = mainClientInstance;
     return function client(key, trafficType) {
         if (key === undefined) {
             log.debug(constants_1.RETRIEVE_CLIENT_DEFAULT);
@@ -43,10 +39,10 @@ function sdkClientMethodCSFactory(params) {
                 throw new Error('Shared Client needs a valid traffic type or no traffic type at all.');
             }
         }
-        var instanceId = buildInstanceId(validKey, validTrafficType);
-        if (!clientInstances[instanceId]) {
+        var instanceId = (0, identity_1.buildInstanceId)(validKey, validTrafficType);
+        if (!clients[instanceId]) {
             var matchingKey = (0, key_2.getMatching)(validKey);
-            var sharedSdkReadiness_1 = sdkReadinessManager.shared(readyTimeout);
+            var sharedSdkReadiness_1 = sdkReadinessManager.shared();
             var sharedStorage = storage.shared && storage.shared(matchingKey, function (err) {
                 if (err) {
                     sharedSdkReadiness_1.readinessManager.timeout();
@@ -63,11 +59,10 @@ function sdkClientMethodCSFactory(params) {
             var sharedSyncManager = syncManager && sharedStorage && syncManager.shared(matchingKey, sharedSdkReadiness_1.readinessManager, sharedStorage);
             // As shared clients reuse all the storage information, we don't need to check here if we
             // will use offline or online mode. We should stick with the original decision.
-            clientInstances[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
+            clients[instanceId] = (0, clientCS_1.clientCSDecorator)(log, (0, sdkClient_1.sdkClientFactory)((0, objectAssign_1.objectAssign)({}, params, {
                 sdkReadinessManager: sharedSdkReadiness_1,
                 storage: sharedStorage || storage,
                 syncManager: sharedSyncManager,
-                signalListener: undefined, // only the main client "destroy" method stops the signal listener
             }), true), validKey, validTrafficType);
             sharedSyncManager && sharedSyncManager.start();
             log.info(constants_1.NEW_SHARED_CLIENT);
@@ -75,7 +70,7 @@ function sdkClientMethodCSFactory(params) {
         else {
             log.debug(constants_1.RETRIEVE_CLIENT_EXISTING);
         }
-        return clientInstances[instanceId];
+        return clients[instanceId];
     };
 }
 exports.sdkClientMethodCSFactory = sdkClientMethodCSFactory;

package/cjs/sdkFactory/index.js

@@ -25,7 +25,7 @@ function sdkFactory(params) {
     // On non-recoverable errors, we should mark the SDK as destroyed and not start synchronization.
     // We will just log and allow for the SDK to end up throwing an SDK_TIMEOUT event for devs to handle.
     (0, apiKey_1.validateAndTrackApiKey)(log, settings.core.authorizationKey);
-    var sdkReadinessManager = (0, sdkReadinessManager_1.sdkReadinessManagerFactory)(log, platform.EventEmitter, settings.startup.readyTimeout);
+    var sdkReadinessManager = (0, sdkReadinessManager_1.sdkReadinessManagerFactory)(platform.EventEmitter, settings);
     var readiness = sdkReadinessManager.readinessManager;
     var storage = storageFactory({
         settings: settings,
@@ -40,6 +40,7 @@ function sdkFactory(params) {
         },
     });
     // @TODO add support for dataloader: `if (params.dataLoader) params.dataLoader(storage);`
+    var clients = {};
     var telemetryTracker = (0, telemetryTracker_1.telemetryTrackerFactory)(storage.telemetry, platform.now);
     var integrationsManager = integrationsManagerFactory && integrationsManagerFactory({ settings: settings, storage: storage, telemetryTracker: telemetryTracker });
     var observer = impressionsObserverFactory();
@@ -59,7 +60,7 @@ function sdkFactory(params) {
     var eventTracker = (0, eventTracker_1.eventTrackerFactory)(settings, storage.events, integrationsManager, storage.telemetry);
     // splitApi is used by SyncManager and Browser signal listener
     var splitApi = splitApiFactory && splitApiFactory(settings, platform, telemetryTracker);
-    var ctx = { splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
+    var ctx = { clients: clients, splitApi: splitApi, eventTracker: eventTracker, impressionsTracker: impressionsTracker, telemetryTracker: telemetryTracker, uniqueKeysTracker: uniqueKeysTracker, sdkReadinessManager: sdkReadinessManager, readiness: readiness, settings: settings, storage: storage, platform: platform };
     var syncManager = syncManagerFactory && syncManagerFactory(ctx);
     ctx.syncManager = syncManager;
     var signalListener = SignalListener && new SignalListener(syncManager, settings, storage, splitApi);
@@ -82,6 +83,9 @@ function sdkFactory(params) {
         // Logger wrapper API
         Logger: (0, sdkLogger_1.createLoggerAPI)(log),
         settings: settings,
+        destroy: function () {
+            return Promise.all(Object.keys(clients).map(function (key) { return clients[key].destroy(); })).then(function () { });
+        }
     }, extraProps && extraProps(ctx));
 }
 exports.sdkFactory = sdkFactory;

package/cjs/services/splitApi.js

@@ -54,15 +54,15 @@ function splitApiFactory(settings, platform, telemetryTracker) {
             var url = urls.sdk + "/segmentChanges/" + segmentName + "?since=" + since + (till ? '&till=' + till : '');
             return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.SEGMENT));
         },
-        fetchMySegments: function (userMatchingKey, noCache) {
+        fetchMemberships: function (userMatchingKey, noCache, till) {
             /**
              * URI encoding of user keys in order to:
-             *  - avoid 400 responses (due to URI malformed). E.g.: '/api/mySegments/%'
-             *  - avoid 404 responses. E.g.: '/api/mySegments/foo/bar'
+             *  - avoid 400 responses (due to URI malformed). E.g.: '/api/memberships/%'
+             *  - avoid 404 responses. E.g.: '/api/memberships/foo/bar'
              *  - match user keys with special characters. E.g.: 'foo%bar', 'foo/bar'
              */
-            var url = urls.sdk + "/mySegments/" + encodeURIComponent(userMatchingKey);
-            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.MY_SEGMENT));
+            var url = urls.sdk + "/memberships/" + encodeURIComponent(userMatchingKey) + (till ? '?till=' + till : '');
+            return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(constants_1.MEMBERSHIPS));
         },
         /**
          * Post events.

package/cjs/storages/AbstractSegmentsCacheSync.js

@@ -9,25 +9,54 @@ var AbstractSegmentsCacheSync = /** @class */ (function () {
     function AbstractSegmentsCacheSync() {
     }
     /**
-     * For server-side synchronizer: add the given list of segments to the cache, with an empty list of keys. The segments that already exist are not modified.
-     * For client-side synchronizer: the method is not used.
-     */
-    AbstractSegmentsCacheSync.prototype.registerSegments = function (names) { return false; };
-    /**
-     * For server-side synchronizer: set the change number of `name` segment.
-     * For client-side synchronizer: the method is not used.
+     * clear the cache.
      */
-    AbstractSegmentsCacheSync.prototype.setChangeNumber = function (name, changeNumber) { return true; };
+    AbstractSegmentsCacheSync.prototype.clear = function () {
+        this.resetSegments({});
+    };
     /**
-     * For server-side synchronizer: get the change number of `name` segment.
+     * For server-side synchronizer: add the given list of segments to the cache, with an empty list of keys. The segments that already exist are not modified.
      * For client-side synchronizer: the method is not used.
      */
-    AbstractSegmentsCacheSync.prototype.getChangeNumber = function (name) { return -1; };
+    AbstractSegmentsCacheSync.prototype.registerSegments = function (names) { return false; };
     /**
      * For server-side synchronizer: the method is not used.
-     * For client-side synchronizer: reset the cache with the given list of segments.
+     * For client-side synchronizer: it resets or updates the cache.
      */
-    AbstractSegmentsCacheSync.prototype.resetSegments = function (names) { return true; };
+    AbstractSegmentsCacheSync.prototype.resetSegments = function (segmentsData) {
+        var _this = this;
+        this.setChangeNumber(undefined, segmentsData.cn);
+        var _a = segmentsData, added = _a.added, removed = _a.removed;
+        if (added && removed) {
+            var isDiff_1 = false;
+            added.forEach(function (segment) {
+                isDiff_1 = _this.addToSegment(segment) || isDiff_1;
+            });
+            removed.forEach(function (segment) {
+                isDiff_1 = _this.removeFromSegment(segment) || isDiff_1;
+            });
+            return isDiff_1;
+        }
+        var names = (segmentsData.k || []).map(function (s) { return s.n; }).sort();
+        var storedSegmentKeys = this.getRegisteredSegments().sort();
+        // Extreme fast => everything is empty
+        if (!names.length && !storedSegmentKeys.length)
+            return false;
+        var index = 0;
+        while (index < names.length && index < storedSegmentKeys.length && names[index] === storedSegmentKeys[index])
+            index++;
+        // Quick path => no changes
+        if (index === names.length && index === storedSegmentKeys.length)
+            return false;
+        // Slowest path => add and/or remove segments
+        for (var removeIndex = index; removeIndex < storedSegmentKeys.length; removeIndex++) {
+            this.removeFromSegment(storedSegmentKeys[removeIndex]);
+        }
+        for (var addIndex = index; addIndex < names.length; addIndex++) {
+            this.addToSegment(names[addIndex]);
+        }
+        return true;
+    };
     return AbstractSegmentsCacheSync;
 }());
 exports.AbstractSegmentsCacheSync = AbstractSegmentsCacheSync;

package/cjs/storages/AbstractSplitsCacheSync.js

@@ -70,7 +70,8 @@ function usesSegments(split) {
     for (var i = 0; i < conditions.length; i++) {
         var matchers = conditions[i].matcherGroup.matchers;
         for (var j = 0; j < matchers.length; j++) {
-            if (matchers[j].matcherType === constants_1.IN_SEGMENT)
+            var matcher = matchers[j].matcherType;
+            if (matcher === constants_1.IN_SEGMENT || matcher === constants_1.IN_LARGE_SEGMENT)
                 return true;
         }
     }

package/cjs/storages/KeyBuilderCS.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyBuilderCS = void 0;
+exports.myLargeSegmentsKeyBuilder = exports.KeyBuilderCS = void 0;
 var tslib_1 = require("tslib");
 var lang_1 = require("../utils/lang");
 var KeyBuilder_1 = require("./KeyBuilder");
@@ -24,10 +24,6 @@ var KeyBuilderCS = /** @class */ (function (_super) {
             return builtSegmentKeyName.substr(prefix.length);
     };
     // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
-    KeyBuilderCS.prototype.buildOldSegmentNameKey = function (segmentName) {
-        return this.matchingKey + "." + this.prefix + ".segment." + segmentName;
-    };
-    // @BREAKING: The key used to start with the matching key instead of the prefix, this was changed on version 10.17.3
     KeyBuilderCS.prototype.extractOldSegmentKey = function (builtSegmentKeyName) {
         var prefix = this.matchingKey + "." + this.prefix + ".segment.";
         if ((0, lang_1.startsWith)(builtSegmentKeyName, prefix))
@@ -39,6 +35,28 @@ var KeyBuilderCS = /** @class */ (function (_super) {
     KeyBuilderCS.prototype.isSplitsCacheKey = function (key) {
         return this.regexSplitsCacheKey.test(key);
     };
+    KeyBuilderCS.prototype.buildTillKey = function () {
+        return this.prefix + "." + this.matchingKey + ".segments.till";
+    };
     return KeyBuilderCS;
 }(KeyBuilder_1.KeyBuilder));
 exports.KeyBuilderCS = KeyBuilderCS;
+function myLargeSegmentsKeyBuilder(prefix, matchingKey) {
+    return {
+        buildSegmentNameKey: function (segmentName) {
+            return prefix + "." + matchingKey + ".largeSegment." + segmentName;
+        },
+        extractSegmentName: function (builtSegmentKeyName) {
+            var p = prefix + "." + matchingKey + ".largeSegment.";
+            if ((0, lang_1.startsWith)(builtSegmentKeyName, p))
+                return builtSegmentKeyName.substr(p.length);
+        },
+        extractOldSegmentKey: function () {
+            return undefined;
+        },
+        buildTillKey: function () {
+            return prefix + "." + matchingKey + ".largeSegments.till";
+        }
+    };
+}
+exports.myLargeSegmentsKeyBuilder = myLargeSegmentsKeyBuilder;

package/cjs/storages/dataLoader.js

@@ -45,7 +45,7 @@ function dataLoaderFactory(preloadedData) {
                 return Array.isArray(userIds) && userIds.indexOf(userId) > -1;
             });
         }
-        storage.segments.resetSegments(mySegmentsData);
+        storage.segments.resetSegments({ k: mySegmentsData.map(function (s) { return ({ n: s }); }) });
     };
 }
 exports.dataLoaderFactory = dataLoaderFactory;