@splitsoftware/splitio-commons 3.1.1-rc.10 → 3.1.1-rc.12

package/esm/storages/pluggable/SplitsCachePluggable.js

@@ -1,209 +0,0 @@
-import { __extends, __spreadArray } from "tslib";
-import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
-import { LOG_PREFIX } from './constants';
-import { AbstractSplitsCacheAsync } from '../AbstractSplitsCacheAsync';
-import { returnDifference } from '../../utils/lang/sets';
-/**
- * ISplitsCacheAsync implementation for pluggable storages.
- */
-var SplitsCachePluggable = /** @class */ (function (_super) {
-    __extends(SplitsCachePluggable, _super);
-    /**
-     * Create a SplitsCache that uses a storage wrapper.
-     * @param log -  Logger instance.
-     * @param keys -  Key builder.
-     * @param wrapper -  Adapted wrapper storage.
-     */
-    function SplitsCachePluggable(log, keys, wrapper, splitFiltersValidation) {
-        var _this = _super.call(this) || this;
-        _this.log = log;
-        _this.keys = keys;
-        _this.wrapper = wrapper;
-        _this.flagSetsFilter = splitFiltersValidation ? splitFiltersValidation.groupedFilters.bySet : [];
-        return _this;
-    }
-    SplitsCachePluggable.prototype._decrementCounts = function (split) {
-        var _this = this;
-        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-        return this.wrapper.decr(ttKey).then(function (count) {
-            if (count === 0)
-                return _this.wrapper.del(ttKey);
-        });
-    };
-    SplitsCachePluggable.prototype._incrementCounts = function (split) {
-        var ttKey = this.keys.buildTrafficTypeKey(split.trafficTypeName);
-        return this.wrapper.incr(ttKey);
-    };
-    SplitsCachePluggable.prototype._updateFlagSets = function (featureFlagName, flagSetsOfRemovedFlag, flagSetsOfAddedFlag) {
-        var _this = this;
-        var removeFromFlagSets = returnDifference(flagSetsOfRemovedFlag, flagSetsOfAddedFlag);
-        var addToFlagSets = returnDifference(flagSetsOfAddedFlag, flagSetsOfRemovedFlag);
-        if (this.flagSetsFilter.length > 0) {
-            addToFlagSets = addToFlagSets.filter(function (flagSet) {
-                return _this.flagSetsFilter.some(function (filterFlagSet) { return filterFlagSet === flagSet; });
-            });
-        }
-        var items = [featureFlagName];
-        return Promise.all(__spreadArray(__spreadArray([], removeFromFlagSets.map(function (flagSetName) { return _this.wrapper.removeItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true), addToFlagSets.map(function (flagSetName) { return _this.wrapper.addItems(_this.keys.buildFlagSetKey(flagSetName), items); }), true));
-    };
-    /**
-     * Add a given split.
-     * The returned promise is resolved when the operation success
-     * or rejected if it fails (e.g., wrapper operation fails)
-     */
-    SplitsCachePluggable.prototype.addSplit = function (split) {
-        var _this = this;
-        var name = split.name;
-        var splitKey = this.keys.buildSplitKey(name);
-        return this.wrapper.get(splitKey).then(function (splitFromStorage) {
-            // handling parsing error
-            var parsedPreviousSplit, stringifiedNewSplit;
-            try {
-                parsedPreviousSplit = splitFromStorage ? JSON.parse(splitFromStorage) : undefined;
-                stringifiedNewSplit = JSON.stringify(split);
-            }
-            catch (e) {
-                throw new Error('Error parsing feature flag definition: ' + e);
-            }
-            return _this.wrapper.set(splitKey, stringifiedNewSplit).then(function () {
-                // avoid unnecessary increment/decrement operations
-                if (parsedPreviousSplit && parsedPreviousSplit.trafficTypeName === split.trafficTypeName)
-                    return;
-                // update traffic type counts
-                return _this._incrementCounts(split).then(function () {
-                    if (parsedPreviousSplit)
-                        return _this._decrementCounts(parsedPreviousSplit);
-                });
-            }).then(function () { return _this._updateFlagSets(name, parsedPreviousSplit && parsedPreviousSplit.sets, split.sets); });
-        }).then(function () { return true; });
-    };
-    /**
-     * Remove a given split.
-     * The returned promise is resolved when the operation success, with a boolean indicating if the split existed or not.
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    SplitsCachePluggable.prototype.removeSplit = function (name) {
-        var _this = this;
-        return this.getSplit(name).then(function (split) {
-            if (split) {
-                return _this._decrementCounts(split).then(function () { return _this._updateFlagSets(name, split.sets); });
-            }
-        }).then(function () {
-            return _this.wrapper.del(_this.keys.buildSplitKey(name));
-        });
-    };
-    /**
-     * Get split.
-     * The returned promise is resolved with the split definition or null if it's not defined,
-     * or rejected if wrapper operation fails.
-     */
-    SplitsCachePluggable.prototype.getSplit = function (name) {
-        return this.wrapper.get(this.keys.buildSplitKey(name))
-            .then(function (maybeSplit) { return maybeSplit && JSON.parse(maybeSplit); });
-    };
-    /**
-     * Get list of splits.
-     * The returned promise is resolved with a map of split names to their split definition or null if it's not defined,
-     * or rejected if wrapper operation fails.
-     */
-    SplitsCachePluggable.prototype.getSplits = function (names) {
-        var _this = this;
-        var keys = names.map(function (name) { return _this.keys.buildSplitKey(name); });
-        return this.wrapper.getMany(keys).then(function (splitDefinitions) {
-            var splits = {};
-            names.forEach(function (name, idx) {
-                var split = splitDefinitions[idx];
-                splits[name] = split && JSON.parse(split);
-            });
-            return Promise.resolve(splits);
-        });
-    };
-    /**
-     * Get list of all split definitions.
-     * The returned promise is resolved with the list of split definitions,
-     * or rejected if wrapper operation fails.
-     */
-    SplitsCachePluggable.prototype.getAll = function () {
-        var _this = this;
-        return this.wrapper.getKeysByPrefix(this.keys.buildSplitKeyPrefix())
-            .then(function (listOfKeys) { return _this.wrapper.getMany(listOfKeys); })
-            .then(function (splitDefinitions) { return splitDefinitions.map(function (splitDefinition) {
-            return JSON.parse(splitDefinition);
-        }); });
-    };
-    /**
-     * Get list of split names.
-     * The returned promise is resolved with the list of split names,
-     * or rejected if wrapper operation fails.
-     */
-    SplitsCachePluggable.prototype.getSplitNames = function () {
-        var _this = this;
-        return this.wrapper.getKeysByPrefix(this.keys.buildSplitKeyPrefix()).then(function (listOfKeys) { return listOfKeys.map(_this.keys.extractKey); });
-    };
-    /**
-     * Get list of feature flag names related to a given list of flag set names.
-     * The returned promise is resolved with the list of feature flag names per flag set.
-     * It never rejects (If there is a wrapper error for some flag set, an empty set is returned for it).
-     */
-    SplitsCachePluggable.prototype.getNamesByFlagSets = function (flagSets) {
-        var _this = this;
-        return Promise.all(flagSets.map(function (flagSet) {
-            var flagSetKey = _this.keys.buildFlagSetKey(flagSet);
-            return _this.wrapper.getItems(flagSetKey).catch(function () { return []; });
-        })).then(function (namesByFlagSets) { return namesByFlagSets.map(function (namesByFlagSet) { return new Set(namesByFlagSet); }); });
-    };
-    /**
-     * Check traffic type existence.
-     * The returned promise is resolved with a boolean indicating whether the TT exist or not.
-     * In case of wrapper operation failures, the promise resolves with a true value, assuming that the TT might exist.
-     * It will never be rejected.
-     */
-    SplitsCachePluggable.prototype.trafficTypeExists = function (trafficType) {
-        var _this = this;
-        // If there is a number there should be > 0, otherwise the TT is considered as not existent.
-        return this.wrapper.get(this.keys.buildTrafficTypeKey(trafficType))
-            .then(function (ttCount) {
-            if (ttCount === null)
-                return false; // if entry doesn't exist, means that TT doesn't exist
-            ttCount = parseInt(ttCount, 10);
-            if (!isFiniteNumber(ttCount) || ttCount < 0) {
-                _this.log.info(LOG_PREFIX + "Could not validate traffic type existence of ".concat(trafficType, " due to data corruption of some sorts."));
-                return false;
-            }
-            return ttCount > 0;
-        }).catch(function (e) {
-            _this.log.error(LOG_PREFIX + "Could not validate traffic type existence of ".concat(trafficType, " due to an error: ").concat(e, "."));
-            // If there is an error, bypass the validation so the event can get tracked.
-            return true;
-        });
-    };
-    /**
-     * Set till number.
-     * The returned promise is resolved when the operation success,
-     * or rejected if it fails (e.g., wrapper operation fails).
-     */
-    SplitsCachePluggable.prototype.setChangeNumber = function (changeNumber) {
-        return this.wrapper.set(this.keys.buildSplitsTillKey(), changeNumber + '');
-    };
-    /**
-     * Get till number or -1 if it's not defined.
-     * The returned promise is resolved with the changeNumber or -1 if it doesn't exist or a wrapper operation fails.
-     * The promise will never be rejected.
-     */
-    SplitsCachePluggable.prototype.getChangeNumber = function () {
-        var _this = this;
-        return this.wrapper.get(this.keys.buildSplitsTillKey()).then(function (value) {
-            var i = parseInt(value, 10);
-            return isNaNNumber(i) ? -1 : i;
-        }).catch(function (e) {
-            _this.log.error(LOG_PREFIX + 'Could not retrieve changeNumber from storage. Error: ' + e);
-            return -1;
-        });
-    };
-    // @TODO implement if required by DataLoader or producer mode
-    SplitsCachePluggable.prototype.clear = function () {
-        return Promise.resolve(true);
-    };
-    return SplitsCachePluggable;
-}(AbstractSplitsCacheAsync));
-export { SplitsCachePluggable };

package/esm/sync/polling/syncTasks/splitsSyncTask.js

@@ -1,9 +0,0 @@
-import { syncTaskFactory } from '../../syncTask';
-import { splitChangesFetcherFactory } from '../fetchers/splitChangesFetcher';
-import { splitChangesUpdaterFactory } from '../updaters/splitChangesUpdater';
-/**
- * Creates a sync task that periodically executes a `splitChangesUpdater` task
- */
-export function splitsSyncTaskFactory(fetchSplitChanges, storage, readiness, settings, isClientSide) {
-    return syncTaskFactory(settings.log, splitChangesUpdaterFactory(settings.log, splitChangesFetcherFactory(fetchSplitChanges, settings, storage), storage, settings.sync.__splitFiltersValidation, readiness.splits, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, isClientSide), settings.scheduler.featuresRefreshRate, 'splitChangesUpdater');
-}

package/esm/sync/polling/updaters/splitChangesUpdater.js

@@ -1,194 +0,0 @@
-import { timeout } from '../../../utils/promise/timeout';
-import { SDK_SPLITS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE } from '../../../readiness/constants';
-import { SYNC_SPLITS_FETCH, SYNC_SPLITS_UPDATE, SYNC_RBS_UPDATE, SYNC_SPLITS_FETCH_FAILS, SYNC_SPLITS_FETCH_RETRY } from '../../../logger/constants';
-import { startsWith } from '../../../utils/lang';
-import { IN_RULE_BASED_SEGMENT, IN_SEGMENT, RULE_BASED_SEGMENT, STANDARD_SEGMENT } from '../../../utils/constants';
-import { setToArray } from '../../../utils/lang/sets';
-import { SPLIT_UPDATE } from '../../streaming/constants';
-// Checks that all registered segments have been fetched (changeNumber !== -1 for every segment).
-// Returns a promise that could be rejected.
-// @TODO review together with Segments and MySegments storage APIs
-function checkAllSegmentsExist(segments) {
-    var registeredSegments = Promise.resolve(segments.getRegisteredSegments());
-    return registeredSegments.then(function (segmentNames) {
-        return Promise.all(segmentNames.map(function (segmentName) { return segments.getChangeNumber(segmentName); }))
-            .then(function (changeNumbers) { return changeNumbers.every(function (changeNumber) { return changeNumber !== undefined; }); });
-    });
-}
-/**
- * Collect segments from a raw FF or RBS definition.
- * Exported for testing purposes.
- */
-export function parseSegments(ruleEntity, matcherType) {
-    if (matcherType === void 0) { matcherType = IN_SEGMENT; }
-    var _a = ruleEntity, conditions = _a.conditions, excluded = _a.excluded;
-    var segments = new Set();
-    if (excluded && excluded.segments) {
-        excluded.segments.forEach(function (_a) {
-            var type = _a.type, name = _a.name;
-            if ((type === STANDARD_SEGMENT && matcherType === IN_SEGMENT) || (type === RULE_BASED_SEGMENT && matcherType === IN_RULE_BASED_SEGMENT)) {
-                segments.add(name);
-            }
-        });
-    }
-    if (conditions) {
-        for (var i = 0; i < conditions.length; i++) {
-            var matchers = conditions[i].matcherGroup.matchers;
-            matchers.forEach(function (matcher) {
-                if (matcher.matcherType === matcherType)
-                    segments.add(matcher.userDefinedSegmentMatcherData.segmentName);
-            });
-        }
-    }
-    return segments;
-}
-/**
- * If there are defined filters and one feature flag doesn't match with them, its status is changed to 'ARCHIVE' to avoid storing it
- * If there is `bySet` filter, `byName` and `byPrefix` filters are ignored
- *
- * @param featureFlag - feature flag to be evaluated
- * @param filters - splitFiltersValidation bySet | byName
- */
-function matchFilters(featureFlag, filters) {
-    var _a = filters.groupedFilters, setsFilter = _a.bySet, namesFilter = _a.byName, prefixFilter = _a.byPrefix;
-    if (setsFilter.length > 0)
-        return featureFlag.sets && featureFlag.sets.some(function (featureFlagSet) { return setsFilter.indexOf(featureFlagSet) > -1; });
-    var namesFilterConfigured = namesFilter.length > 0;
-    var prefixFilterConfigured = prefixFilter.length > 0;
-    if (!namesFilterConfigured && !prefixFilterConfigured)
-        return true;
-    var matchNames = namesFilterConfigured && namesFilter.indexOf(featureFlag.name) > -1;
-    var matchPrefix = prefixFilterConfigured && prefixFilter.some(function (prefix) { return startsWith(featureFlag.name, prefix); });
-    return matchNames || matchPrefix;
-}
-/**
- * Given the list of splits from /splitChanges endpoint, it returns the mutations,
- * i.e., an object with added splits, removed splits and used segments.
- * Exported for testing purposes.
- */
-export function computeMutation(rules, segments, filters) {
-    return rules.reduce(function (accum, ruleEntity) {
-        if (ruleEntity.status !== 'ARCHIVED' && (!filters || matchFilters(ruleEntity, filters))) {
-            accum.added.push(ruleEntity);
-            parseSegments(ruleEntity).forEach(function (segmentName) {
-                segments.add(segmentName);
-            });
-        }
-        else {
-            accum.removed.push(ruleEntity);
-        }
-        accum.names.push(ruleEntity.name);
-        return accum;
-    }, { added: [], removed: [], names: [] });
-}
-/**
- * factory of SplitChanges updater, a task that:
- *  - fetches split changes using `splitChangesFetcher`
- *  - updates `splitsCache`
- *  - uses `splitsEventEmitter` to emit events related to split data updates
- *
- * @param log -  Logger instance
- * @param splitChangesFetcher -  Fetcher of `/splitChanges`
- * @param splits -  Splits storage, with sync or async methods
- * @param segments -  Segments storage, with sync or async methods
- * @param splitsEventEmitter -  Optional readiness manager. Not required for synchronizer or producer mode.
- * @param requestTimeoutBeforeReady -  How long the updater will wait for the request to timeout. Default 0, i.e., never timeout.
- * @param retriesOnFailureBeforeReady -  How many retries on `/splitChanges` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
- */
-export function splitChangesUpdaterFactory(log, splitChangesFetcher, storage, splitFiltersValidation, splitsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, isClientSide) {
-    if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
-    if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
-    var splits = storage.splits, rbSegments = storage.rbSegments, segments = storage.segments;
-    var startingUp = true;
-    /** timeout decorator for `splitChangesFetcher` promise  */
-    function _promiseDecorator(promise) {
-        if (startingUp && requestTimeoutBeforeReady)
-            promise = timeout(requestTimeoutBeforeReady, promise);
-        return promise;
-    }
-    /**
-     * SplitChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch splits or synchronize them with the storage.
-     * Returned promise will not be rejected.
-     *
-     * @param noCache - true to revalidate data to fetch
-     * @param till - query param to bypass CDN requests
-     */
-    return function splitChangesUpdater(noCache, till, instantUpdate) {
-        /**
-         * @param since - current changeNumber at splitsCache
-         * @param retry - current number of retry attempts
-         */
-        function _splitChangesUpdater(sinces, retry) {
-            if (retry === void 0) { retry = 0; }
-            var since = sinces[0], rbSince = sinces[1];
-            log.debug(SYNC_SPLITS_FETCH, sinces);
-            return Promise.resolve(instantUpdate ?
-                instantUpdate.type === SPLIT_UPDATE ?
-                    // IFFU edge case: a change to a flag that adds an IN_RULE_BASED_SEGMENT matcher that is not present yet
-                    Promise.resolve(rbSegments.contains(parseSegments(instantUpdate.payload, IN_RULE_BASED_SEGMENT))).then(function (contains) {
-                        return contains ?
-                            { ff: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
-                            splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
-                    }) :
-                    { rbs: { d: [instantUpdate.payload], t: instantUpdate.changeNumber } } :
-                splitChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
-                .then(function (splitChanges) {
-                var usedSegments = new Set();
-                var updatedFlags = [];
-                var ffUpdate = false;
-                if (splitChanges.ff) {
-                    var _a = computeMutation(splitChanges.ff.d || [], usedSegments, splitFiltersValidation), added = _a.added, removed = _a.removed, names = _a.names;
-                    updatedFlags = names;
-                    log.debug(SYNC_SPLITS_UPDATE, [added.length, removed.length]);
-                    ffUpdate = splits.update(added, removed, splitChanges.ff.t);
-                }
-                var rbsUpdate = false;
-                if (splitChanges.rbs) {
-                    var _b = computeMutation(splitChanges.rbs.d || [], usedSegments), added = _b.added, removed = _b.removed;
-                    log.debug(SYNC_RBS_UPDATE, [added.length, removed.length]);
-                    rbsUpdate = rbSegments.update(added, removed, splitChanges.rbs.t);
-                }
-                return Promise.all([ffUpdate, rbsUpdate,
-                    // @TODO if at least 1 segment fetch fails due to 404 and other segments are updated in the storage, SDK_UPDATE is not emitted
-                    segments.registerSegments(setToArray(usedSegments))
-                ]).then(function (_a) {
-                    var ffChanged = _a[0], rbsChanged = _a[1];
-                    if (storage.save)
-                        storage.save();
-                    startingUp = false;
-                    if (splitsEventEmitter) {
-                        // To emit SDK_SPLITS_ARRIVED for server-side SDK, we must check that all registered segments have been fetched
-                        return Promise.resolve(!splitsEventEmitter.splitsArrived || ((ffChanged || rbsChanged) && (isClientSide || checkAllSegmentsExist(segments))))
-                            .catch(function () { return false; } /** noop. just to handle a possible `checkAllSegmentsExist` rejection, before emitting SDK event */)
-                            .then(function (emitSplitsArrivedEvent) {
-                            // emit SDK events
-                            if (emitSplitsArrivedEvent) {
-                                var metadata = {
-                                    type: updatedFlags.length > 0 ? FLAGS_UPDATE : SEGMENTS_UPDATE,
-                                    names: updatedFlags.length > 0 ? updatedFlags : []
-                                };
-                                splitsEventEmitter.emit(SDK_SPLITS_ARRIVED, metadata);
-                            }
-                            return true;
-                        });
-                    }
-                    return true;
-                });
-            })
-                .catch(function (error) {
-                if (startingUp && retriesOnFailureBeforeReady > retry) {
-                    retry += 1;
-                    log.warn(SYNC_SPLITS_FETCH_RETRY, [retry, error]);
-                    return _splitChangesUpdater(sinces, retry);
-                }
-                else {
-                    startingUp = false;
-                    log.warn(SYNC_SPLITS_FETCH_FAILS, [error]);
-                }
-                return false;
-            });
-        }
-        // `getChangeNumber` never rejects or throws error
-        return Promise.all([splits.getChangeNumber(), rbSegments.getChangeNumber()]).then(_splitChangesUpdater);
-    };
-}

package/esm/sync/streaming/AuthClient/types.js

@@ -1 +0,0 @@
-export {};

package/esm/utils/inputValidation/splitExistence.js

@@ -1,15 +0,0 @@
-import { FALLBACK_SPLIT_NOT_FOUND, SPLIT_NOT_FOUND } from '../labels';
-import { WARN_NOT_EXISTENT_SPLIT } from '../../logger/constants';
-/**
- * This is defined here and in this format mostly because of the logger and the fact that it's considered a validation at product level.
- * But it's not going to run on the input validation layer. In any case, the most compelling reason to use it as we do is to avoid going to Redis and get a split twice.
- */
-export function validateSplitExistence(log, readinessManager, splitName, labelOrSplitObj, method) {
-    if (readinessManager.isReady()) { // Only if it's ready (synced with BE) we validate this, otherwise it may just be that the SDK is still syncing
-        if (labelOrSplitObj === SPLIT_NOT_FOUND || labelOrSplitObj === FALLBACK_SPLIT_NOT_FOUND || labelOrSplitObj == null) {
-            log.warn(WARN_NOT_EXISTENT_SPLIT, [method, splitName]);
-            return false;
-        }
-    }
-    return true;
-}

package/esm/utils/inputValidation/splits.js

@@ -1,21 +0,0 @@
-import { ERROR_EMPTY_ARRAY } from '../../logger/constants';
-import { uniq } from '../lang';
-import { validateSplit } from './split';
-export function validateSplits(log, maybeSplits, method, listName, item) {
-    if (listName === void 0) { listName = 'feature flag names'; }
-    if (item === void 0) { item = 'feature flag name'; }
-    if (Array.isArray(maybeSplits) && maybeSplits.length > 0) {
-        var validatedArray_1 = [];
-        // Remove invalid values
-        maybeSplits.forEach(function (maybeSplit) {
-            var splitName = validateSplit(log, maybeSplit, method, item);
-            if (splitName)
-                validatedArray_1.push(splitName);
-        });
-        // Strip off duplicated values if we have valid split names then return
-        if (validatedArray_1.length)
-            return uniq(validatedArray_1);
-    }
-    log.error(ERROR_EMPTY_ARRAY, [method, listName]);
-    return false;
-}

package/src/sync/streaming/AuthClient/types.ts

@@ -1,19 +0,0 @@
-import { IDecodedJWTToken } from '../../../utils/jwt/types';
-
-export type IJwtCredential = {
-  token: string; // empty string ("") when `"pushEnabled": false`
-  decodedToken: IDecodedJWTToken
-  channels: { [channel: string]: string[] }
-  // /api/v2/auth fields
-  pushEnabled?: boolean | null;
-  connDelay?: number | null;
-  // /api/v3/auth fields
-  config?: {
-    streaming?: {
-      delay?: number | null;
-      enabled?: boolean | null;
-    } | null;
-  } | null;
-}
-
-export type IFetchAuth = (userKeys?: string[]) => Promise<IJwtCredential>