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

package/esm/sync/polling/fetchers/splitChangesFetcher.js

@@ -1,22 +1,31 @@
 import { FLAG_SPEC_VERSION } from '../../../utils/constants';
 import { base } from '../../../utils/settingsValidation';
-import { LOG_PREFIX_SYNC_SPLITS } from '../../../logger/constants';
+import { LOG_PREFIX_SYNC } from '../../../logger/constants';
 import { checkIfServerSide } from '../../../utils/key';
 var PROXY_CHECK_INTERVAL_MILLIS_CS = 60 * 60 * 1000; // 1 hour in Client Side
 var PROXY_CHECK_INTERVAL_MILLIS_SS = 24 * PROXY_CHECK_INTERVAL_MILLIS_CS; // 24 hours in Server Side
 function sdkEndpointOverridden(settings) {
     return settings.urls.sdk !== base.urls.sdk;
 }
+function isSplitChangesLegacyResponse(data) {
+    return data.splits != null;
+}
+function partitionByStatus(items, till, since) {
+    var updated = [], removed = [];
+    items.forEach(function (item) { return item.status === 'ARCHIVED' ? removed.push(item.name) : updated.push(item); });
+    return { updated: updated, removed: removed, till: till, since: since };
+}
 /**
  * Factory of SplitChanges fetcher.
  * SplitChanges fetcher is a wrapper around `splitChanges` API service that parses the response and handle errors.
  */
 // @TODO breaking: drop support for Split Proxy below v5.10.0 and simplify the implementation
-export function splitChangesFetcherFactory(fetchSplitChanges, settings, storage) {
+export function splitChangesFetcherFactory(params) {
+    var fetchSplitChanges = params.serviceApi.fetchSplitChanges, settings = params.settings, storage = params.storage;
     var log = settings.log;
     var PROXY_CHECK_INTERVAL_MILLIS = checkIfServerSide(settings) ? PROXY_CHECK_INTERVAL_MILLIS_SS : PROXY_CHECK_INTERVAL_MILLIS_CS;
     var lastProxyCheckTimestamp;
-    return function splitChangesFetcher(since, noCache, till, rbSince, 
+    function splitChangesFetcher(since, noCache, till, rbSince, 
     // Optional decorator for `fetchSplitChanges` promise, such as timeout or time tracker
     decorator) {
         // Recheck proxy
@@ -27,7 +36,7 @@ export function splitChangesFetcherFactory(fetchSplitChanges, settings, storage)
             .catch(function (err) {
             // Handle proxy error with spec 1.3
             if ((!err.statusCode || err.statusCode === 400) && sdkEndpointOverridden(settings) && settings.sync.flagSpecVersion === FLAG_SPEC_VERSION) {
-                log.error(LOG_PREFIX_SYNC_SPLITS + 'Proxy error detected. Retrying with spec 1.2. If you are using Split Proxy, please upgrade to latest version');
+                log.error(LOG_PREFIX_SYNC + 'Proxy error detected. Retrying with spec 1.2. If you are using Split Proxy, please upgrade to latest version');
                 lastProxyCheckTimestamp = Date.now();
                 settings.sync.flagSpecVersion = '1.2'; // fallback to 1.2 spec
                 return fetchSplitChanges(since, noCache, till); // retry request without rbSince
@@ -40,26 +49,26 @@ export function splitChangesFetcherFactory(fetchSplitChanges, settings, storage)
             .then(function (resp) { return resp.json(); })
             .then(function (data) {
             // Using flag spec version 1.2 or below
-            if (data.splits) {
-                return {
-                    ff: {
-                        d: data.splits,
-                        s: data.since,
-                        t: data.till
-                    }
-                };
+            if (isSplitChangesLegacyResponse(data)) {
+                return { d: partitionByStatus(data.splits || [], data.till, data.since) };
             }
             // Proxy recovery
             if (lastProxyCheckTimestamp) {
-                log.info(LOG_PREFIX_SYNC_SPLITS + 'Proxy error recovered');
+                log.info(LOG_PREFIX_SYNC + 'Proxy error recovered');
                 lastProxyCheckTimestamp = undefined;
                 return splitChangesFetcher(-1, undefined, undefined, -1)
                     .then(function (splitChangesResponse) {
-                    return Promise.all([storage.splits.clear(), storage.rbSegments.clear()])
+                    return Promise.all([storage.definitions.clear(), storage.rbSegments.clear()])
                         .then(function () { return splitChangesResponse; });
                 });
             }
-            return data;
+            var ff = data.ff, rbs = data.rbs;
+            return {
+                d: (ff === null || ff === void 0 ? void 0 : ff.d) ? partitionByStatus(ff.d, ff.t, ff.s) : undefined,
+                rbs: (rbs === null || rbs === void 0 ? void 0 : rbs.d) ? partitionByStatus(rbs.d, rbs.t, rbs.s) : undefined,
+            };
         });
-    };
+    }
+    splitChangesFetcher.type = 'feature flags';
+    return splitChangesFetcher;
 }

package/esm/sync/polling/pollingManagerCS.js

@@ -1,96 +1,101 @@
 import { forOwn } from '../../utils/lang';
 import { mySegmentsSyncTaskFactory } from './syncTasks/mySegmentsSyncTask';
-import { splitsSyncTaskFactory } from './syncTasks/splitsSyncTask';
+import { definitionsSyncTaskFactory } from './syncTasks/definitionsSyncTask';
 import { getMatching } from '../../utils/key';
-import { SDK_SPLITS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../../readiness/constants';
+import { SDK_DEFINITIONS_ARRIVED, SDK_SEGMENTS_ARRIVED } from '../../readiness/constants';
 import { POLLING_SMART_PAUSING, POLLING_START, POLLING_STOP } from '../../logger/constants';
-import { usesSegmentsSync } from '../../storages/AbstractSplitsCacheSync';
+import { usesSegmentsSync } from '../../storages/AbstractDefinitionsCacheSync';
+import { splitChangesFetcherFactory } from './fetchers/splitChangesFetcher';
 /**
  * Expose start / stop mechanism for polling data from services.
  * For client-side API with multiple clients.
  */
-export function pollingManagerCSFactory(params) {
-    var splitApi = params.splitApi, storage = params.storage, readiness = params.readiness, settings = params.settings;
-    var log = settings.log;
-    var splitsSyncTask = splitsSyncTaskFactory(splitApi.fetchSplitChanges, storage, readiness, settings, true);
-    // Map of matching keys to their corresponding MySegmentsSyncTask.
-    var mySegmentsSyncTasks = {};
-    var matchingKey = getMatching(settings.core.key);
-    var mySegmentsSyncTask = add(matchingKey, readiness, storage);
-    function startMySegmentsSyncTasks() {
-        forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
-            mySegmentsSyncTask.start();
-        });
-    }
-    function stopMySegmentsSyncTasks() {
-        forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
-            if (mySegmentsSyncTask.isRunning())
-                mySegmentsSyncTask.stop();
-        });
-    }
-    // smart pausing
-    readiness.splits.on(SDK_SPLITS_ARRIVED, function () {
-        if (!splitsSyncTask.isRunning())
-            return; // noop if not doing polling
-        var usingSegments = usesSegmentsSync(storage);
-        if (usingSegments !== mySegmentsSyncTask.isRunning()) {
-            log.info(POLLING_SMART_PAUSING, [usingSegments ? 'ON' : 'OFF']);
-            if (usingSegments) {
-                startMySegmentsSyncTasks();
-            }
-            else {
-                stopMySegmentsSyncTasks();
-            }
-        }
-    });
-    function add(matchingKey, readiness, storage) {
-        var mySegmentsSyncTask = mySegmentsSyncTaskFactory(splitApi.fetchMemberships, storage, readiness, settings, matchingKey);
-        // smart ready
-        function smartReady(metadata) {
-            if (!readiness.isReady() && !usesSegmentsSync(storage))
-                readiness.segments.emit(SDK_SEGMENTS_ARRIVED, metadata);
+export function pollingManagerCSFactory(definitionFetcherFactory) {
+    if (definitionFetcherFactory === void 0) { definitionFetcherFactory = splitChangesFetcherFactory; }
+    return function (params) {
+        var serviceApi = params.serviceApi, storage = params.storage, readiness = params.readiness, settings = params.settings;
+        var log = settings.log;
+        var definitionChangesFetcher = definitionFetcherFactory(params);
+        var definitionsSyncTask = definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings);
+        // Map of matching keys to their corresponding MySegmentsSyncTask.
+        var mySegmentsSyncTasks = {};
+        var matchingKey = getMatching(settings.core.key);
+        var mySegmentsSyncTask = add(matchingKey, readiness, storage);
+        function startMySegmentsSyncTasks() {
+            forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
+                mySegmentsSyncTask.start();
+            });
         }
-        if (!usesSegmentsSync(storage))
-            setTimeout(smartReady, 0);
-        else
-            readiness.splits.once(SDK_SPLITS_ARRIVED, smartReady);
-        mySegmentsSyncTasks[matchingKey] = mySegmentsSyncTask;
-        return mySegmentsSyncTask;
-    }
-    return {
-        splitsSyncTask: splitsSyncTask,
-        segmentsSyncTask: mySegmentsSyncTask,
-        // Start periodic fetching (polling)
-        start: function () {
-            log.info(POLLING_START);
-            splitsSyncTask.start();
-            if (usesSegmentsSync(storage))
-                startMySegmentsSyncTasks();
-        },
-        // Stop periodic fetching (polling)
-        stop: function () {
-            log.info(POLLING_STOP);
-            if (splitsSyncTask.isRunning())
-                splitsSyncTask.stop();
-            stopMySegmentsSyncTasks();
-        },
-        // Used by SyncManager to know if running in polling mode.
-        isRunning: splitsSyncTask.isRunning,
-        // fetch splits and segments
-        syncAll: function () {
-            var promises = [splitsSyncTask.execute()];
+        function stopMySegmentsSyncTasks() {
             forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
-                promises.push(mySegmentsSyncTask.execute());
+                if (mySegmentsSyncTask.isRunning())
+                    mySegmentsSyncTask.stop();
             });
-            return Promise.all(promises);
-        },
-        // Support for handling mySegments sync of multiple clients
-        add: add,
-        remove: function (matchingKey) {
-            delete mySegmentsSyncTasks[matchingKey];
-        },
-        get: function (matchingKey) {
-            return mySegmentsSyncTasks[matchingKey];
         }
+        // smart pausing
+        readiness.definitions.on(SDK_DEFINITIONS_ARRIVED, function () {
+            if (!definitionsSyncTask.isRunning())
+                return; // noop if not doing polling
+            var usingSegments = usesSegmentsSync(storage);
+            if (usingSegments !== mySegmentsSyncTask.isRunning()) {
+                log.info(POLLING_SMART_PAUSING, [usingSegments ? 'ON' : 'OFF']);
+                if (usingSegments) {
+                    startMySegmentsSyncTasks();
+                }
+                else {
+                    stopMySegmentsSyncTasks();
+                }
+            }
+        });
+        function add(matchingKey, readiness, storage) {
+            var mySegmentsSyncTask = mySegmentsSyncTaskFactory(serviceApi.fetchMemberships, storage, readiness, settings, matchingKey);
+            // smart ready
+            function smartReady(metadata) {
+                if (!readiness.isReady() && !usesSegmentsSync(storage))
+                    readiness.segments.emit(SDK_SEGMENTS_ARRIVED, metadata);
+            }
+            if (!usesSegmentsSync(storage))
+                setTimeout(smartReady, 0);
+            else
+                readiness.definitions.once(SDK_DEFINITIONS_ARRIVED, smartReady);
+            mySegmentsSyncTasks[matchingKey] = mySegmentsSyncTask;
+            return mySegmentsSyncTask;
+        }
+        return {
+            definitionsSyncTask: definitionsSyncTask,
+            segmentsSyncTask: mySegmentsSyncTask,
+            // Start periodic fetching (polling)
+            start: function () {
+                log.info(POLLING_START);
+                definitionsSyncTask.start();
+                if (usesSegmentsSync(storage))
+                    startMySegmentsSyncTasks();
+            },
+            // Stop periodic fetching (polling)
+            stop: function () {
+                log.info(POLLING_STOP);
+                if (definitionsSyncTask.isRunning())
+                    definitionsSyncTask.stop();
+                stopMySegmentsSyncTasks();
+            },
+            // Used by SyncManager to know if running in polling mode.
+            isRunning: definitionsSyncTask.isRunning,
+            // fetch definitions and segments
+            syncAll: function () {
+                var promises = [definitionsSyncTask.execute()];
+                forOwn(mySegmentsSyncTasks, function (mySegmentsSyncTask) {
+                    promises.push(mySegmentsSyncTask.execute());
+                });
+                return Promise.all(promises);
+            },
+            // Support for handling mySegments sync of multiple clients
+            add: add,
+            remove: function (matchingKey) {
+                delete mySegmentsSyncTasks[matchingKey];
+            },
+            get: function (matchingKey) {
+                return mySegmentsSyncTasks[matchingKey];
+            }
+        };
     };
 }

package/esm/sync/polling/pollingManagerSS.js

@@ -1,45 +1,53 @@
-import { splitsSyncTaskFactory } from './syncTasks/splitsSyncTask';
+import { definitionsSyncTaskFactory } from './syncTasks/definitionsSyncTask';
 import { segmentsSyncTaskFactory } from './syncTasks/segmentsSyncTask';
 import { POLLING_START, POLLING_STOP, LOG_PREFIX_SYNC_POLLING } from '../../logger/constants';
+import { segmentChangesFetcherFactory } from './fetchers/segmentChangesFetcher';
+import { splitChangesFetcherFactory } from './fetchers/splitChangesFetcher';
 /**
  * Expose start / stop mechanism for pulling data from services.
  */
-export function pollingManagerSSFactory(params) {
-    var splitApi = params.splitApi, storage = params.storage, readiness = params.readiness, settings = params.settings;
-    var log = settings.log;
-    var splitsSyncTask = splitsSyncTaskFactory(splitApi.fetchSplitChanges, storage, readiness, settings);
-    var segmentsSyncTask = segmentsSyncTaskFactory(splitApi.fetchSegmentChanges, storage, readiness, settings);
-    return {
-        splitsSyncTask: splitsSyncTask,
-        segmentsSyncTask: segmentsSyncTask,
-        // Start periodic fetching (polling)
-        start: function () {
-            log.info(POLLING_START);
-            log.debug(LOG_PREFIX_SYNC_POLLING + "Splits will be refreshed each ".concat(settings.scheduler.featuresRefreshRate, " millis"));
-            log.debug(LOG_PREFIX_SYNC_POLLING + "Segments will be refreshed each ".concat(settings.scheduler.segmentsRefreshRate, " millis"));
-            var startingUp = splitsSyncTask.start();
-            if (startingUp) {
-                startingUp.then(function () {
-                    if (splitsSyncTask.isRunning())
-                        segmentsSyncTask.start();
+export function pollingManagerSSFactory(definitionFetcherFactory, segmentFetcherFactory) {
+    if (definitionFetcherFactory === void 0) { definitionFetcherFactory = splitChangesFetcherFactory; }
+    if (segmentFetcherFactory === void 0) { segmentFetcherFactory = function (params) { return segmentChangesFetcherFactory(params.serviceApi.fetchSegmentChanges); }; }
+    return function (params) {
+        var storage = params.storage, readiness = params.readiness, settings = params.settings;
+        var log = settings.log;
+        var definitionChangesFetcher = definitionFetcherFactory(params);
+        var segmentChangesFetcher = segmentFetcherFactory(params);
+        var segmentsSyncTask = segmentsSyncTaskFactory(segmentChangesFetcher, storage, readiness, settings);
+        var definitionsSyncTask = definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings, segmentsSyncTask);
+        return {
+            definitionsSyncTask: definitionsSyncTask,
+            segmentsSyncTask: segmentsSyncTask,
+            // Start periodic fetching (polling)
+            start: function () {
+                log.info(POLLING_START);
+                log.debug(LOG_PREFIX_SYNC_POLLING + "".concat(definitionChangesFetcher.type, " will be refreshed each ").concat(settings.scheduler.featuresRefreshRate, " millis"));
+                log.debug(LOG_PREFIX_SYNC_POLLING + "segments will be refreshed each ".concat(settings.scheduler.segmentsRefreshRate, " millis"));
+                var startingUp = definitionsSyncTask.start();
+                if (startingUp) {
+                    startingUp.then(function () {
+                        if (definitionsSyncTask.isRunning())
+                            segmentsSyncTask.start();
+                    });
+                }
+            },
+            // Stop periodic fetching (polling)
+            stop: function () {
+                log.info(POLLING_STOP);
+                if (definitionsSyncTask.isRunning())
+                    definitionsSyncTask.stop();
+                if (segmentsSyncTask.isRunning())
+                    segmentsSyncTask.stop();
+            },
+            // Used by SyncManager to know if running in polling mode.
+            isRunning: definitionsSyncTask.isRunning,
+            syncAll: function () {
+                // fetch definitions and segments. There is no need to catch this promise (`DefinitionChangesUpdater` is always resolved with a boolean value)
+                return definitionsSyncTask.execute().then(function () {
+                    return segmentsSyncTask.execute();
                 });
             }
-        },
-        // Stop periodic fetching (polling)
-        stop: function () {
-            log.info(POLLING_STOP);
-            if (splitsSyncTask.isRunning())
-                splitsSyncTask.stop();
-            if (segmentsSyncTask.isRunning())
-                segmentsSyncTask.stop();
-        },
-        // Used by SyncManager to know if running in polling mode.
-        isRunning: splitsSyncTask.isRunning,
-        syncAll: function () {
-            // fetch splits and segments. There is no need to catch this promise (`SplitChangesUpdater` is always resolved with a boolean value)
-            return splitsSyncTask.execute().then(function () {
-                return segmentsSyncTask.execute();
-            });
-        }
+        };
     };
 }

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

@@ -0,0 +1,9 @@
+import { syncTaskFactory } from '../../syncTask';
+import { definitionChangesUpdaterFactory } from '../updaters/definitionChangesUpdater';
+/**
+ * Creates a sync task that periodically executes a `definitionChangesUpdater` task
+ */
+export function definitionsSyncTaskFactory(definitionChangesFetcher, storage, readiness, settings, segmentsSyncTask // undefined for client-side
+) {
+    return syncTaskFactory(settings.log, definitionChangesUpdaterFactory(settings.log, definitionChangesFetcher, storage, settings.sync.__splitFiltersValidation, readiness.definitions, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady, segmentsSyncTask), settings.scheduler.featuresRefreshRate, 'definitionChangesUpdater');
+}

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

@@ -1,9 +1,8 @@
 import { syncTaskFactory } from '../../syncTask';
-import { segmentChangesFetcherFactory } from '../fetchers/segmentChangesFetcher';
 import { segmentChangesUpdaterFactory } from '../updaters/segmentChangesUpdater';
 /**
  * Creates a sync task that periodically executes a `segmentChangesUpdater` task
  */
-export function segmentsSyncTaskFactory(fetchSegmentChanges, storage, readiness, settings) {
-    return syncTaskFactory(settings.log, segmentChangesUpdaterFactory(settings.log, segmentChangesFetcherFactory(fetchSegmentChanges), storage.segments, readiness, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady), settings.scheduler.segmentsRefreshRate, 'segmentChangesUpdater');
+export function segmentsSyncTaskFactory(segmentChangesFetcher, storage, readiness, settings) {
+    return syncTaskFactory(settings.log, segmentChangesUpdaterFactory(settings.log, segmentChangesFetcher, storage.segments, readiness, settings.startup.requestTimeoutBeforeReady, settings.startup.retriesOnFailureBeforeReady), settings.scheduler.segmentsRefreshRate, 'segmentChangesUpdater');
 }

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

@@ -0,0 +1,191 @@
+import { timeout } from '../../../utils/promise/timeout';
+import { SDK_DEFINITIONS_ARRIVED, FLAGS_UPDATE, SEGMENTS_UPDATE, CONFIGS_UPDATE } from '../../../readiness/constants';
+import { SYNC_FETCH, SYNC_UPDATE, SYNC_FETCH_FAILS, SYNC_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 { RB_SEGMENT_UPDATE } from '../../streaming/constants';
+/**
+ * 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 definition 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 definition - definition to be evaluated
+ * @param filters - splitFiltersValidation bySet | byName
+ */
+function matchFilters(definition, filters) {
+    var _a = filters.groupedFilters, setsFilter = _a.bySet, namesFilter = _a.byName, prefixFilter = _a.byPrefix;
+    if (setsFilter.length > 0)
+        return definition.sets && definition.sets.some(function (definitionSet) { return setsFilter.indexOf(definitionSet) > -1; });
+    var namesFilterConfigured = namesFilter.length > 0;
+    var prefixFilterConfigured = prefixFilter.length > 0;
+    if (!namesFilterConfigured && !prefixFilterConfigured)
+        return true;
+    var matchNames = namesFilterConfigured && namesFilter.indexOf(definition.name) > -1;
+    var matchPrefix = prefixFilterConfigured && prefixFilter.some(function (prefix) { return startsWith(definition.name, prefix); });
+    return matchNames || matchPrefix;
+}
+/**
+ * Given the list of definitions from /splitChanges or /configs endpoint, it returns the mutations,
+ * i.e., an object with added definitions, removed definitions, and used segments.
+ * Exported for testing purposes.
+ */
+export function computeMutation(update, segments, filters) {
+    return update.updated.reduce(function (accum, ruleEntity) {
+        if (!filters || matchFilters(ruleEntity, filters)) {
+            accum.updated.push(ruleEntity);
+            parseSegments(ruleEntity).forEach(function (segmentName) {
+                segments.add(segmentName);
+            });
+        }
+        else {
+            accum.removed.push(ruleEntity.name);
+        }
+        accum.names.push(ruleEntity.name);
+        return accum;
+    }, { updated: [], removed: update.removed, names: update.removed.slice() });
+}
+function convertInstantUpdateToDefinitionChanges(instantUpdate) {
+    var payload = instantUpdate.payload, changeNumber = instantUpdate.changeNumber;
+    return payload.status === 'ARCHIVED' ?
+        { till: changeNumber, updated: [], removed: [payload.name] } :
+        { till: changeNumber, updated: [payload], removed: [] };
+}
+/**
+ * Factory of DefinitionChanges updater, a task that:
+ *  - fetches definition changes using `definitionChangesFetcher`
+ *  - updates definitions storage
+ *  - uses `definitionsEventEmitter` to emit events related to definition data updates
+ *
+ * @param log -  Logger instance
+ * @param definitionChangesFetcher -  Fetcher of `/splitChanges` or `/configs`
+ * @param definitions -  Definitions storage, with sync or async methods
+ * @param segments -  Segments storage, with sync or async methods
+ * @param definitionsEventEmitter -  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` or `/configs` we the updater do in case of failure or timeout. Default 0, i.e., no retries.
+ */
+export function definitionChangesUpdaterFactory(log, definitionChangesFetcher, storage, splitFiltersValidation, definitionsEventEmitter, requestTimeoutBeforeReady, retriesOnFailureBeforeReady, segmentsSyncTask // undefined for client-side
+) {
+    if (requestTimeoutBeforeReady === void 0) { requestTimeoutBeforeReady = 0; }
+    if (retriesOnFailureBeforeReady === void 0) { retriesOnFailureBeforeReady = 0; }
+    var definitions = storage.definitions, rbSegments = storage.rbSegments, segments = storage.segments;
+    var startingUp = true;
+    /** timeout decorator for `definitionChangesFetcher` promise  */
+    function _promiseDecorator(promise) {
+        if (startingUp && requestTimeoutBeforeReady)
+            promise = timeout(requestTimeoutBeforeReady, promise);
+        return promise;
+    }
+    /**
+     * DefinitionChanges updater returns a promise that resolves with a `false` boolean value if it fails to fetch definitions 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 definitionChangesUpdater(noCache, till, instantUpdate) {
+        /**
+         * @param since - current changeNumber at definitionsCache
+         * @param retry - current number of retry attempts
+         */
+        function _definitionChangesUpdater(sinces, retry) {
+            if (retry === void 0) { retry = 0; }
+            var since = sinces[0], rbSince = sinces[1];
+            log.debug(SYNC_FETCH, [definitionChangesFetcher.type, since, rbSince]);
+            return Promise.resolve(instantUpdate ?
+                instantUpdate.type === RB_SEGMENT_UPDATE ?
+                    { rbs: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
+                    // IFFU edge case: a change to definition 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 ?
+                            { d: convertInstantUpdateToDefinitionChanges(instantUpdate) } :
+                            definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator);
+                    }) :
+                definitionChangesFetcher(since, noCache, till, rbSince, _promiseDecorator))
+                .then(function (definitionChanges) {
+                var usedSegments = new Set();
+                var updatedDefinitions = [];
+                var ffUpdate = false;
+                if (definitionChanges.d) {
+                    var _a = computeMutation(definitionChanges.d, usedSegments, splitFiltersValidation), updated = _a.updated, removed = _a.removed, names = _a.names;
+                    updatedDefinitions = names;
+                    log.debug(SYNC_UPDATE, [definitionChangesFetcher.type, updated.length, removed.length]);
+                    ffUpdate = definitions.update(updated, removed, definitionChanges.d.till);
+                }
+                var rbsUpdate = false;
+                if (definitionChanges.rbs) {
+                    var _b = computeMutation(definitionChanges.rbs, usedSegments), updated = _b.updated, removed = _b.removed;
+                    log.debug(SYNC_UPDATE, ['rule-based segments', updated.length, removed.length]);
+                    rbsUpdate = rbSegments.update(updated, removed, definitionChanges.rbs.till);
+                }
+                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 (definitionsEventEmitter) {
+                        // To emit SDK_DEFINITIONS_ARRIVED for server-side SDK, we must wait for all registered segments to be fetched
+                        return Promise.resolve(!definitionsEventEmitter.definitionsArrived || ((ffChanged || rbsChanged) && (!segmentsSyncTask || segmentsSyncTask.execute(true))))
+                            .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: updatedDefinitions.length > 0 ? definitionChangesFetcher.type === 'configs' ? CONFIGS_UPDATE : FLAGS_UPDATE : SEGMENTS_UPDATE,
+                                    names: updatedDefinitions.length > 0 ? updatedDefinitions : []
+                                };
+                                definitionsEventEmitter.emit(SDK_DEFINITIONS_ARRIVED, metadata);
+                            }
+                            return true;
+                        });
+                    }
+                    return true;
+                });
+            })
+                .catch(function (error) {
+                if (startingUp && retriesOnFailureBeforeReady > retry) {
+                    retry += 1;
+                    log.warn(SYNC_FETCH_RETRY, [definitionChangesFetcher.type, retry, error]);
+                    return _definitionChangesUpdater(sinces, retry);
+                }
+                else {
+                    startingUp = false;
+                    log.warn(SYNC_FETCH_FAILS, [definitionChangesFetcher.type, error]);
+                }
+                return false;
+            });
+        }
+        // `getChangeNumber` never rejects or throws error
+        return Promise.all([definitions.getChangeNumber(), rbSegments.getChangeNumber()]).then(_definitionChangesUpdater);
+    };
+}

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

@@ -1,8 +1,8 @@
 import { timeout } from '../../../utils/promise/timeout';
 import { SDK_SEGMENTS_ARRIVED, SEGMENTS_UPDATE } from '../../../readiness/constants';
-import { SYNC_MYSEGMENTS_FETCH_RETRY } from '../../../logger/constants';
+import { SYNC_FETCH_RETRY } from '../../../logger/constants';
 import { MEMBERSHIPS_LS_UPDATE } from '../../streaming/constants';
-import { usesSegmentsSync } from '../../../storages/AbstractSplitsCacheSync';
+import { usesSegmentsSync } from '../../../storages/AbstractDefinitionsCacheSync';
 /**
  * factory of MySegments updater, a task that:
  *  - fetches mySegments using `mySegmentsFetcher`
@@ -53,7 +53,7 @@ export function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmen
         return updaterPromise.catch(function (error) {
             if (startingUp && retriesOnFailureBeforeReady > retry) {
                 retry += 1;
-                log.warn(SYNC_MYSEGMENTS_FETCH_RETRY, [retry, error]);
+                log.warn(SYNC_FETCH_RETRY, ['memberships', retry, error]);
                 return _mySegmentsUpdater(retry); // no need to forward `segmentList` and `noCache` params
             }
             else {