@splitsoftware/splitio 10.20.1-rc.1 → 10.21.1-rc.0

package/CHANGES.txt

@@ -1,3 +1,13 @@
+10.21.1 (July 25, 2022)
+- Bugfixing - Added missed type definitions `enabled` from `sync`.
+
+10.21.0 (July 22, 2022)
+- Added `autoRequire` configuration option to the Google Analytics to Split integration, which takes care of requiring the splitTracker plugin on trackers dynamically created by Google tag managers (See https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js).
+- Updated browser listener to push remaining impressions and events on 'visibilitychange' and 'pagehide' DOM events, instead of 'unload', which is not reliable in modern mobile and desktop Web browsers.
+- Updated the synchronization flow to be more reliable in the event of an edge case generating delay in cache purge propagation, keeping the SDK cache properly synced.
+- Updated some dependencies for vulnerability fixes.
+- Bugfixing - Moved js-yaml dependency from @splitsoftware/splitio-commons to avoid resolution to an incompatible version on certain npm versions when installing third-party dependencies that also define js-yaml as transitive dependency (Related to issue https://github.com/splitio/javascript-client/issues/662).
+
 10.20.0 (June 29, 2022)
 - Added a new config option to control the tasks that listen or poll for updates on feature flags and segments, via the new config sync.enabled . Running online Split will always pull the most recent updates upon initialization, this only affects updates fetching on a running instance. Useful when a consistent session experience is a must or to save resources when updates are not being used.
 - Updated telemetry logic to track the anonymous config for user consent flag set to declined or unknown.

package/es/factory/browser.js

@@ -11,7 +11,6 @@ import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/esm/i
 import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/storage/storageCS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/esm/utils/constants';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/esm/consent/sdkUserConsent';
 import { settingsFactory } from '../settings/browser';
 import { platform, SignalListener } from '../platform';
@@ -38,7 +37,7 @@ function getModules(settings) {
         sdkClientMethodFactory: sdkClientMethodCSFactory,
         SignalListener: SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
-        impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+        impressionsObserverFactory: impressionObserverCSFactory,
         extraProps: function (params) {
             return {
                 UserConsent: createUserConsentAPI(params)

package/es/factory/node.js

@@ -9,9 +9,9 @@ import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/esm/sdkCl
 import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/impressionObserverSS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/esm/sdkFactory';
 import { CONSUMER_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/esm/trackers/impressionObserver/utils';
 import { settingsFactory } from '../settings/node';
 import { platform, SignalListener } from '../platform';
+import { bloomFilterFactory } from '../platform/filter/bloomFilter';
 var syncManagerOnlineSSFactory = syncManagerOnlineFactory(pollingManagerSSFactory, pushManagerFactory);
 function getStorage(settings) {
     return settings.storage.type === 'REDIS' ?
@@ -32,7 +32,8 @@ function getModules(settings) {
         sdkManagerFactory: sdkManagerFactory,
         sdkClientMethodFactory: sdkClientMethodFactory,
         SignalListener: SignalListener,
-        impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverSSFactory : undefined,
+        impressionsObserverFactory: impressionObserverSSFactory,
+        filterAdapterFactory: bloomFilterFactory
     };
     switch (settings.mode) {
         case LOCALHOST_MODE:

package/es/platform/filter/bloomFilter.js

@@ -0,0 +1,25 @@
+import { BloomFilter } from '@ably/bloomit';
+var EXPECTED_INSERTIONS = 10000000;
+var ERROR_RATE = 0.01;
+export function bloomFilterFactory(expectedInsertions, errorRate) {
+    if (expectedInsertions === void 0) { expectedInsertions = EXPECTED_INSERTIONS; }
+    if (errorRate === void 0) { errorRate = ERROR_RATE; }
+    var filter = BloomFilter.create(expectedInsertions, errorRate);
+    return {
+        add: function (key, value) {
+            var data = key + ":" + value;
+            if (filter.has(data)) {
+                return false;
+            }
+            filter.add(data);
+            return true;
+        },
+        contains: function (key, value) {
+            var data = key + ":" + value;
+            return filter.has(data);
+        },
+        clear: function () {
+            filter = BloomFilter.create(expectedInsertions, errorRate);
+        }
+    };
+}

package/es/settings/defaults/version.js

@@ -1 +1 @@
-export var packageVersion = '10.20.1-rc.1';
+export var packageVersion = '10.21.1-rc.0';

package/es/settings/node.js

@@ -1,6 +1,6 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation';
 import { validateLogger } from '@splitsoftware/splitio-commons/esm/utils/settingsValidation/logger/builtinLogger';
-import { LocalhostFromFile } from '@splitsoftware/splitio-commons/esm/sync/offline/LocalhostFromFile';
+import { LocalhostFromFile } from '../sync/offline/LocalhostFromFile';
 import { defaults } from './defaults/node';
 import { validateStorage } from './storage/node';
 import { validateRuntime } from './runtime/node';

package/es/sync/offline/LocalhostFromFile.js

@@ -0,0 +1,9 @@
+import { splitsParserFromFileFactory } from './splitsParserFromFile';
+import { syncManagerOfflineFactory } from '@splitsoftware/splitio-commons/esm/sync/offline/syncManagerOffline';
+// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
+// It uses NodeJS APIs.
+var localhostFromFile = syncManagerOfflineFactory(splitsParserFromFileFactory);
+localhostFromFile.type = 'LocalhostFromFile';
+export function LocalhostFromFile() {
+    return localhostFromFile;
+}

package/es/sync/offline/splitsParserFromFile.js

@@ -0,0 +1,142 @@
+import fs from 'fs';
+import path from 'path';
+import yaml from 'js-yaml';
+import { isString, endsWith, find, forOwn, uniq, } from '@splitsoftware/splitio-commons/esm/utils/lang';
+import { parseCondition } from '@splitsoftware/splitio-commons/esm/sync/offline/splitsParser/parseCondition';
+var logPrefix = 'sync:offline:splits-fetcher: ';
+var DEFAULT_FILENAME = '.split';
+function configFilesPath(configFilePath) {
+    if (configFilePath === DEFAULT_FILENAME || !isString(configFilePath)) {
+        var root = process.env.HOME;
+        if (process.env.SPLIT_CONFIG_ROOT)
+            root = process.env.SPLIT_CONFIG_ROOT;
+        if (!root)
+            throw new Error('Missing split mock configuration root.');
+        configFilePath = path.join(root, DEFAULT_FILENAME);
+    }
+    // Validate the extensions
+    if (!(endsWith(configFilePath, '.yaml', true) || endsWith(configFilePath, '.yml', true) || endsWith(configFilePath, '.split', true)))
+        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
+    if (!fs.existsSync(configFilePath))
+        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
+    return configFilePath;
+}
+// This function is not pure nor meant to be. Here we apply modifications to cover
+// for behaviour that's ensured by the BE.
+function arrangeConditions(mocksData) {
+    // Iterate through each Split data
+    forOwn(mocksData, function (data) {
+        var conditions = data.conditions;
+        // On the manager, as the split jsons come with all treatments on the partitions prop,
+        // we'll add all the treatments to the first condition.
+        var firstRolloutCondition = find(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
+        // Malformed mocks may have
+        var treatments = uniq(data.treatments);
+        // If they're only specifying a whitelist we add the treatments there.
+        var allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
+        var fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
+        treatments.forEach(function (treatment) {
+            if (treatment !== fullyAllocatedTreatment) {
+                allTreatmentsCondition.partitions.push({
+                    treatment: treatment,
+                    size: 0
+                });
+            }
+        });
+        // Don't need these anymore
+        delete data.treatments;
+    });
+}
+export function splitsParserFromFileFactory() {
+    var previousMock = 'NO_MOCK_LOADED';
+    // Parse `.split` configuration file and return a map of "Split Objects"
+    function readSplitConfigFile(log, filePath) {
+        var SPLIT_POSITION = 0;
+        var TREATMENT_POSITION = 1;
+        var data;
+        try {
+            data = fs.readFileSync(filePath, 'utf-8');
+        }
+        catch (e) {
+            log.error(e && e.message);
+            return {};
+        }
+        if (data === previousMock)
+            return false;
+        previousMock = data;
+        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
+            var tuple = line.trim();
+            if (tuple === '' || tuple.charAt(0) === '#') {
+                log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
+            }
+            else {
+                tuple = tuple.split(/\s+/);
+                if (tuple.length !== 2) {
+                    log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
+                }
+                else {
+                    var splitName = tuple[SPLIT_POSITION];
+                    var condition = parseCondition({ treatment: tuple[TREATMENT_POSITION] });
+                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
+                }
+            }
+            return accum;
+        }, {});
+        return splitObjects;
+    }
+    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
+    function readYAMLConfigFile(log, filePath) {
+        var data = '';
+        var yamldoc = null;
+        try {
+            data = fs.readFileSync(filePath, 'utf8');
+            if (data === previousMock)
+                return false;
+            previousMock = data;
+            yamldoc = yaml.safeLoad(data);
+        }
+        catch (e) {
+            log.error(e);
+            return {};
+        }
+        // Each entry will be mapped to a condition, but we'll also keep the configurations map.
+        var mocksData = (yamldoc).reduce(function (accum, splitEntry) {
+            var splitName = Object.keys(splitEntry)[0];
+            if (!splitName || !isString(splitEntry[splitName].treatment))
+                log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
+            var mockData = splitEntry[splitName];
+            // "Template" for each split accumulated data
+            if (!accum[splitName]) {
+                accum[splitName] = {
+                    configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
+                };
+            }
+            // Assign the config if there is one on the mock
+            if (mockData.config)
+                accum[splitName].configurations[mockData.treatment] = mockData.config;
+            // Parse the condition from the entry.
+            var condition = parseCondition(mockData);
+            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
+            // Also keep track of the treatments, will be useful for manager functionality.
+            accum[splitName].treatments.push(mockData.treatment);
+            return accum;
+        }, {});
+        arrangeConditions(mocksData);
+        return mocksData;
+    }
+    // Load the content of a configuration file into an Object
+    return function splitsParserFromFile(_a) {
+        var features = _a.features, log = _a.log;
+        var filePath = configFilesPath(features);
+        var mockData;
+        // If we have a filePath, it means the extension is correct, choose the parser.
+        if (endsWith(filePath, '.split')) {
+            log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
+            mockData = readSplitConfigFile(log, filePath);
+        }
+        else {
+            mockData = readYAMLConfigFile(log, filePath);
+        }
+        return mockData;
+    };
+}

package/lib/factory/browser.js

@@ -14,7 +14,6 @@ var browser_1 = require("@splitsoftware/splitio-commons/cjs/integrations/browser
 var storageCS_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/storage/storageCS");
 var sdkFactory_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
 var sdkUserConsent_1 = require("@splitsoftware/splitio-commons/cjs/consent/sdkUserConsent");
 var browser_2 = require("../settings/browser");
 var platform_1 = require("../platform");
@@ -41,7 +40,7 @@ function getModules(settings) {
         sdkClientMethodFactory: sdkClientMethodCSWithTT_1.sdkClientMethodCSFactory,
         SignalListener: platform_1.SignalListener,
         integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? browser_1.integrationsManagerFactory.bind(null, settings.integrations) : undefined,
-        impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverCS_1.impressionObserverCSFactory : undefined,
+        impressionsObserverFactory: impressionObserverCS_1.impressionObserverCSFactory,
         extraProps: function (params) {
             return {
                 UserConsent: (0, sdkUserConsent_1.createUserConsentAPI)(params)

package/lib/factory/node.js

@@ -12,9 +12,9 @@ var sdkClientMethod_1 = require("@splitsoftware/splitio-commons/cjs/sdkClient/sd
 var impressionObserverSS_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/impressionObserverSS");
 var sdkFactory_1 = require("@splitsoftware/splitio-commons/cjs/sdkFactory");
 var constants_1 = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-var utils_1 = require("@splitsoftware/splitio-commons/cjs/trackers/impressionObserver/utils");
 var node_1 = require("../settings/node");
 var platform_1 = require("../platform");
+var bloomFilter_1 = require("../platform/filter/bloomFilter");
 var syncManagerOnlineSSFactory = (0, syncManagerOnline_1.syncManagerOnlineFactory)(pollingManagerSS_1.pollingManagerSSFactory, pushManager_1.pushManagerFactory);
 function getStorage(settings) {
     return settings.storage.type === 'REDIS' ?
@@ -35,7 +35,8 @@ function getModules(settings) {
         sdkManagerFactory: sdkManager_1.sdkManagerFactory,
         sdkClientMethodFactory: sdkClientMethod_1.sdkClientMethodFactory,
         SignalListener: platform_1.SignalListener,
-        impressionsObserverFactory: (0, utils_1.shouldAddPt)(settings) ? impressionObserverSS_1.impressionObserverSSFactory : undefined,
+        impressionsObserverFactory: impressionObserverSS_1.impressionObserverSSFactory,
+        filterAdapterFactory: bloomFilter_1.bloomFilterFactory
     };
     switch (settings.mode) {
         case constants_1.LOCALHOST_MODE:

package/lib/platform/filter/bloomFilter.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bloomFilterFactory = void 0;
+var bloomit_1 = require("@ably/bloomit");
+var EXPECTED_INSERTIONS = 10000000;
+var ERROR_RATE = 0.01;
+function bloomFilterFactory(expectedInsertions, errorRate) {
+    if (expectedInsertions === void 0) { expectedInsertions = EXPECTED_INSERTIONS; }
+    if (errorRate === void 0) { errorRate = ERROR_RATE; }
+    var filter = bloomit_1.BloomFilter.create(expectedInsertions, errorRate);
+    return {
+        add: function (key, value) {
+            var data = key + ":" + value;
+            if (filter.has(data)) {
+                return false;
+            }
+            filter.add(data);
+            return true;
+        },
+        contains: function (key, value) {
+            var data = key + ":" + value;
+            return filter.has(data);
+        },
+        clear: function () {
+            filter = bloomit_1.BloomFilter.create(expectedInsertions, errorRate);
+        }
+    };
+}
+exports.bloomFilterFactory = bloomFilterFactory;

package/lib/settings/defaults/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageVersion = void 0;
-exports.packageVersion = '10.20.1-rc.1';
+exports.packageVersion = '10.21.1-rc.0';

package/lib/settings/node.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.settingsFactory = void 0;
 var settingsValidation_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation");
 var builtinLogger_1 = require("@splitsoftware/splitio-commons/cjs/utils/settingsValidation/logger/builtinLogger");
-var LocalhostFromFile_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/LocalhostFromFile");
+var LocalhostFromFile_1 = require("../sync/offline/LocalhostFromFile");
 var node_1 = require("./defaults/node");
 var node_2 = require("./storage/node");
 var node_3 = require("./runtime/node");

package/lib/sync/offline/LocalhostFromFile.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalhostFromFile = void 0;
+var splitsParserFromFile_1 = require("./splitsParserFromFile");
+var syncManagerOffline_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/syncManagerOffline");
+// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
+// It uses NodeJS APIs.
+var localhostFromFile = (0, syncManagerOffline_1.syncManagerOfflineFactory)(splitsParserFromFile_1.splitsParserFromFileFactory);
+localhostFromFile.type = 'LocalhostFromFile';
+function LocalhostFromFile() {
+    return localhostFromFile;
+}
+exports.LocalhostFromFile = LocalhostFromFile;

package/lib/sync/offline/splitsParserFromFile.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitsParserFromFileFactory = void 0;
+var tslib_1 = require("tslib");
+var fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+var path_1 = (0, tslib_1.__importDefault)(require("path"));
+var js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
+var lang_1 = require("@splitsoftware/splitio-commons/cjs/utils/lang");
+var parseCondition_1 = require("@splitsoftware/splitio-commons/cjs/sync/offline/splitsParser/parseCondition");
+var logPrefix = 'sync:offline:splits-fetcher: ';
+var DEFAULT_FILENAME = '.split';
+function configFilesPath(configFilePath) {
+    if (configFilePath === DEFAULT_FILENAME || !(0, lang_1.isString)(configFilePath)) {
+        var root = process.env.HOME;
+        if (process.env.SPLIT_CONFIG_ROOT)
+            root = process.env.SPLIT_CONFIG_ROOT;
+        if (!root)
+            throw new Error('Missing split mock configuration root.');
+        configFilePath = path_1.default.join(root, DEFAULT_FILENAME);
+    }
+    // Validate the extensions
+    if (!((0, lang_1.endsWith)(configFilePath, '.yaml', true) || (0, lang_1.endsWith)(configFilePath, '.yml', true) || (0, lang_1.endsWith)(configFilePath, '.split', true)))
+        throw new Error("Invalid extension specified for Splits mock file. Accepted extensions are \".yml\" and \".yaml\". Your specified file is " + configFilePath);
+    if (!fs_1.default.existsSync(configFilePath))
+        throw new Error("Split configuration not found in " + configFilePath + " - Please review your Split file location.");
+    return configFilePath;
+}
+// This function is not pure nor meant to be. Here we apply modifications to cover
+// for behaviour that's ensured by the BE.
+function arrangeConditions(mocksData) {
+    // Iterate through each Split data
+    (0, lang_1.forOwn)(mocksData, function (data) {
+        var conditions = data.conditions;
+        // On the manager, as the split jsons come with all treatments on the partitions prop,
+        // we'll add all the treatments to the first condition.
+        var firstRolloutCondition = (0, lang_1.find)(conditions, function (cond) { return cond.conditionType === 'ROLLOUT'; });
+        // Malformed mocks may have
+        var treatments = (0, lang_1.uniq)(data.treatments);
+        // If they're only specifying a whitelist we add the treatments there.
+        var allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
+        var fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
+        treatments.forEach(function (treatment) {
+            if (treatment !== fullyAllocatedTreatment) {
+                allTreatmentsCondition.partitions.push({
+                    treatment: treatment,
+                    size: 0
+                });
+            }
+        });
+        // Don't need these anymore
+        delete data.treatments;
+    });
+}
+function splitsParserFromFileFactory() {
+    var previousMock = 'NO_MOCK_LOADED';
+    // Parse `.split` configuration file and return a map of "Split Objects"
+    function readSplitConfigFile(log, filePath) {
+        var SPLIT_POSITION = 0;
+        var TREATMENT_POSITION = 1;
+        var data;
+        try {
+            data = fs_1.default.readFileSync(filePath, 'utf-8');
+        }
+        catch (e) {
+            log.error(e && e.message);
+            return {};
+        }
+        if (data === previousMock)
+            return false;
+        previousMock = data;
+        var splitObjects = data.split(/\r?\n/).reduce(function (accum, line, index) {
+            var tuple = line.trim();
+            if (tuple === '' || tuple.charAt(0) === '#') {
+                log.debug(logPrefix + ("Ignoring empty line or comment at #" + index));
+            }
+            else {
+                tuple = tuple.split(/\s+/);
+                if (tuple.length !== 2) {
+                    log.debug(logPrefix + ("Ignoring line since it does not have exactly two columns #" + index));
+                }
+                else {
+                    var splitName = tuple[SPLIT_POSITION];
+                    var condition = (0, parseCondition_1.parseCondition)({ treatment: tuple[TREATMENT_POSITION] });
+                    accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
+                }
+            }
+            return accum;
+        }, {});
+        return splitObjects;
+    }
+    // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
+    function readYAMLConfigFile(log, filePath) {
+        var data = '';
+        var yamldoc = null;
+        try {
+            data = fs_1.default.readFileSync(filePath, 'utf8');
+            if (data === previousMock)
+                return false;
+            previousMock = data;
+            yamldoc = js_yaml_1.default.safeLoad(data);
+        }
+        catch (e) {
+            log.error(e);
+            return {};
+        }
+        // Each entry will be mapped to a condition, but we'll also keep the configurations map.
+        var mocksData = (yamldoc).reduce(function (accum, splitEntry) {
+            var splitName = Object.keys(splitEntry)[0];
+            if (!splitName || !(0, lang_1.isString)(splitEntry[splitName].treatment))
+                log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
+            var mockData = splitEntry[splitName];
+            // "Template" for each split accumulated data
+            if (!accum[splitName]) {
+                accum[splitName] = {
+                    configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
+                };
+            }
+            // Assign the config if there is one on the mock
+            if (mockData.config)
+                accum[splitName].configurations[mockData.treatment] = mockData.config;
+            // Parse the condition from the entry.
+            var condition = (0, parseCondition_1.parseCondition)(mockData);
+            accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
+            // Also keep track of the treatments, will be useful for manager functionality.
+            accum[splitName].treatments.push(mockData.treatment);
+            return accum;
+        }, {});
+        arrangeConditions(mocksData);
+        return mocksData;
+    }
+    // Load the content of a configuration file into an Object
+    return function splitsParserFromFile(_a) {
+        var features = _a.features, log = _a.log;
+        var filePath = configFilesPath(features);
+        var mockData;
+        // If we have a filePath, it means the extension is correct, choose the parser.
+        if ((0, lang_1.endsWith)(filePath, '.split')) {
+            log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
+            mockData = readSplitConfigFile(log, filePath);
+        }
+        else {
+            mockData = readYAMLConfigFile(log, filePath);
+        }
+        return mockData;
+    };
+}
+exports.splitsParserFromFileFactory = splitsParserFromFileFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.20.1-rc.1",
+  "version": "10.21.1-rc.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -10,7 +10,8 @@
     "lib",
     "types",
     "es",
-    "src"
+    "src",
+    "scripts/ga-to-split-autorequire.js"
   ],
   "repository": "splitio/javascript-client",
   "homepage": "https://github.com/splitio/javascript-client#readme",
@@ -32,11 +33,12 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.5.1-rc.1",
+    "@ably/bloomit": "^1.4.2",
+    "@splitsoftware/splitio-commons": "1.6.2-rc.2",
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.28.0",
     "ioredis": "^4.28.0",
-    "js-yaml": "3.13.1",
+    "js-yaml": "^3.13.1",
     "node-fetch": "^2.6.7",
     "unfetch": "^4.2.0"
   },
@@ -83,28 +85,29 @@
     "postbuild-cjs": "cross-env NODE_ENV=cjs node scripts/copy.packages.json.js && ./scripts/build_cjs_replace_imports.sh",
     "build-umd": "webpack --config webpack.dev.js --env branch=$BUILD_BRANCH --env commit_hash=$BUILD_COMMIT && webpack --config webpack.prod.js --env branch=$BUILD_BRANCH --env commit_hash=$BUILD_COMMIT && ./scripts/clean_umd_build.sh",
     "build:npm": "rimraf lib es && npm run build-cjs && npm run build-esm",
+    "build:ga-to-split-autorequire": "terser ./node_modules/@splitsoftware/splitio-commons/src/integrations/ga/autoRequire.js --mangle --output ./scripts/ga-to-split-autorequire.js && cp ./scripts/ga-to-split-autorequire.js umd/ga-to-split-autorequire.js",
     "build": "rimraf lib umd es && npm run build-cjs && npm run build-esm && npm run build-umd",
     "check": "npm run check:lint && npm run check:version",
     "check:lint": "eslint src",
     "check:version": "cross-env NODE_ENV=test tape -r ./ts-node.register src/settings/__tests__/defaults.spec.js",
-    "test-browser-local": "cross-env NODE_ENV=test karma start karma/local.karma.conf.js",
-    "test-browser-e2e-local": "cross-env NODE_ENV=test karma start karma/e2e.local.karma.conf.js",
-    "test-browser": "npm run test-browser-unit && npm run test-browser-online && npm run test-browser-offline && npm run test-browser-destroy && npm run test-browser-errors && npm run test-browser-push && npm run test-browser-gaintegration",
-    "test-browser-unit": "cross-env NODE_ENV=test karma start karma/ci.karma.conf.js",
-    "test-browser-online": "cross-env NODE_ENV=test karma start karma/e2e.ci.karma.conf.js",
-    "test-browser-offline": "cross-env NODE_ENV=test karma start karma/offline.karma.conf.js",
-    "test-browser-destroy": "cross-env NODE_ENV=test karma start karma/destroy.ci.karma.conf.js",
-    "test-browser-errors": "cross-env NODE_ENV=test karma start karma/errors.ci.karma.conf.js",
-    "test-browser-gaintegration": "cross-env NODE_ENV=test karma start karma/gaintegration.ci.karma.conf.js",
-    "test-browser-push": "cross-env NODE_ENV=test karma start karma/push.ci.karma.conf.js",
-    "test-node": "npm run test-node-unit && npm run test-node-online && npm run test-node-redis && npm run test-node-offline && npm run test-node-destroy && npm run test-node-errors && npm run test-node-push",
+    "test-browser": "npm run test-browser-unit && npm run test-browser-e2e",
+    "test-browser-unit": "cross-env NODE_ENV=test karma start karma/unit.karma.conf.js",
+    "test-browser-e2e": "npm run test-browser-e2e-online && npm run test-browser-e2e-offline && npm run test-browser-e2e-destroy && npm run test-browser-e2e-errorCatching && npm run test-browser-e2e-push && npm run test-browser-e2e-gaIntegration",
+    "test-browser-e2e-online": "cross-env NODE_ENV=test karma start karma/e2e.online.karma.conf.js",
+    "test-browser-e2e-offline": "cross-env NODE_ENV=test karma start karma/e2e.offline.karma.conf.js",
+    "test-browser-e2e-destroy": "cross-env NODE_ENV=test karma start karma/e2e.destroy.karma.conf.js",
+    "test-browser-e2e-errorCatching": "cross-env NODE_ENV=test karma start karma/e2e.errorCatching.karma.conf.js",
+    "test-browser-e2e-push": "cross-env NODE_ENV=test karma start karma/e2e.push.karma.conf.js",
+    "test-browser-e2e-gaIntegration": "cross-env NODE_ENV=test karma start karma/e2e.gaIntegration.karma.conf.js",
+    "test-node": "npm run test-node-unit && npm run test-node-e2e",
     "test-node-unit": "cross-env NODE_ENV=test tape -r ./ts-node.register \"src/*/**/__tests__/**/!(browser).spec.js\" | tap-min",
-    "test-node-online": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/node.spec.js | tap-min",
-    "test-node-destroy": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/destroy/node.spec.js | tap-min",
-    "test-node-errors": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/errorCatching/node.spec.js | tap-min",
-    "test-node-offline": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/offline/node.spec.js | tap-min",
-    "test-node-redis": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/node_redis.spec.js | tap-min",
-    "test-node-push": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/push/node.spec.js | tap-min",
+    "test-node-e2e": "npm run test-node-e2e-online && npm run test-node-e2e-offline && npm run test-node-e2e-destroy && npm run test-node-e2e-errorCatching && npm run test-node-e2e-push && npm run test-node-e2e-redis",
+    "test-node-e2e-online": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/online/node.spec.js | tap-min",
+    "test-node-e2e-offline": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/offline/node.spec.js | tap-min",
+    "test-node-e2e-destroy": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/destroy/node.spec.js | tap-min",
+    "test-node-e2e-errorCatching": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/errorCatching/node.spec.js | tap-min",
+    "test-node-e2e-push": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/push/node.spec.js | tap-min",
+    "test-node-e2e-redis": "cross-env NODE_ENV=test tape -r ./ts-node.register src/__tests__/consumer/node_redis.spec.js | tap-min",
     "pretest-ts-decls": "npm run build-esm && npm run build-cjs && npm link",
     "test-ts-decls": "./scripts/ts-tests.sh",
     "posttest-ts-decls": "npm unlink && npm install",

package/scripts/ga-to-split-autorequire.js

@@ -0,0 +1 @@
+(function(n,t,e){n[e]=n[e]||t;n[t]=n[t]||function(){n[t].q.push(arguments)};n[t].q=n[t].q||[];var r={};function i(n){return typeof n==="object"&&typeof n.name==="string"&&n.name}function o(e){if(e&&e[0]==="create"){var o=i(e[1])||i(e[2])||i(e[3])||(typeof e[3]==="string"?e[3]:undefined);if(!r[o]){r[o]=true;n[t]((o?o+".":"")+"require","splitTracker")}}}n[t].q.forEach(o);var u=n[t].q.push;n[t].q.push=function(n){var t=u.apply(this,arguments);o(n);return t}})(window,"ga","GoogleAnalyticsObject");

package/src/factory/browser.js

@@ -11,7 +11,6 @@ import { integrationsManagerFactory } from '@splitsoftware/splitio-commons/src/i
 import { __InLocalStorageMockFactory } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/storage/storageCS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
 import { LOCALHOST_MODE, STORAGE_LOCALSTORAGE } from '@splitsoftware/splitio-commons/src/utils/constants';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
 import { createUserConsentAPI } from '@splitsoftware/splitio-commons/src/consent/sdkUserConsent';
 
 import { settingsFactory } from '../settings/browser';
@@ -52,7 +51,7 @@ function getModules(settings) {
 
     integrationsManagerFactory: settings.integrations && settings.integrations.length > 0 ? integrationsManagerFactory.bind(null, settings.integrations) : undefined,
 
-    impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverCSFactory : undefined,
+    impressionsObserverFactory: impressionObserverCSFactory,
 
     extraProps: (params) => {
       return {

package/src/factory/node.js

@@ -9,10 +9,10 @@ import { sdkClientMethodFactory } from '@splitsoftware/splitio-commons/src/sdkCl
 import { impressionObserverSSFactory } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/impressionObserverSS';
 import { sdkFactory } from '@splitsoftware/splitio-commons/src/sdkFactory';
 import { CONSUMER_MODE, LOCALHOST_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
-import { shouldAddPt } from '@splitsoftware/splitio-commons/src/trackers/impressionObserver/utils';
 
 import { settingsFactory } from '../settings/node';
 import { platform, SignalListener } from '../platform';
+import { bloomFilterFactory } from '../platform/filter/bloomFilter';
 
 const syncManagerOnlineSSFactory = syncManagerOnlineFactory(pollingManagerSSFactory, pushManagerFactory);
 
@@ -45,7 +45,9 @@ function getModules(settings) {
 
     SignalListener,
 
-    impressionsObserverFactory: shouldAddPt(settings) ? impressionObserverSSFactory : undefined,
+    impressionsObserverFactory: impressionObserverSSFactory,
+    
+    filterAdapterFactory: bloomFilterFactory
   };
 
   switch (settings.mode) {

package/src/platform/filter/bloomFilter.js

@@ -0,0 +1,30 @@
+import { BloomFilter } from '@ably/bloomit';
+
+const EXPECTED_INSERTIONS = 10000000;
+const ERROR_RATE = 0.01;
+
+export function bloomFilterFactory(expectedInsertions = EXPECTED_INSERTIONS, errorRate = ERROR_RATE) {
+  let filter = BloomFilter.create(expectedInsertions, errorRate);
+  
+  return {  
+  
+    add(key, value) {
+      const data = `${key}:${value}`;
+      if (filter.has(data)) {
+        return false;
+      }
+      filter.add(data);
+      return true;
+    },
+  
+    contains(key, value) {
+      const data = `${key}:${value}`;
+      return filter.has(data);
+    },
+  
+    clear() {
+      filter = BloomFilter.create(expectedInsertions, errorRate);
+    }
+  
+  };
+}

package/src/settings/defaults/version.js

@@ -1 +1 @@
-export const packageVersion = '10.20.1-rc.1';
+export const packageVersion = '10.21.1-rc.0';

package/src/settings/node.js

@@ -1,6 +1,6 @@
 import { settingsValidation } from '@splitsoftware/splitio-commons/src/utils/settingsValidation';
 import { validateLogger } from '@splitsoftware/splitio-commons/src/utils/settingsValidation/logger/builtinLogger';
-import { LocalhostFromFile } from '@splitsoftware/splitio-commons/src/sync/offline/LocalhostFromFile';
+import { LocalhostFromFile } from '../sync/offline/LocalhostFromFile';
 
 import { defaults } from './defaults/node';
 import { validateStorage } from './storage/node';

package/src/sync/offline/LocalhostFromFile.js

@@ -0,0 +1,11 @@
+import { splitsParserFromFileFactory } from './splitsParserFromFile';
+import { syncManagerOfflineFactory } from '@splitsoftware/splitio-commons/src/sync/offline/syncManagerOffline';
+
+// Singleton instance of the factory function for offline SyncManager from YAML file (a.k.a. localhostFromFile)
+// It uses NodeJS APIs.
+const localhostFromFile = syncManagerOfflineFactory(splitsParserFromFileFactory);
+localhostFromFile.type = 'LocalhostFromFile';
+
+export function LocalhostFromFile() {
+  return localhostFromFile;
+}

package/src/sync/offline/splitsParserFromFile.js

@@ -0,0 +1,172 @@
+import fs from 'fs';
+import path from 'path';
+import yaml from 'js-yaml';
+import { isString, endsWith, find, forOwn, uniq, } from '@splitsoftware/splitio-commons/src/utils/lang';
+import { parseCondition } from '@splitsoftware/splitio-commons/src/sync/offline/splitsParser/parseCondition';
+
+const logPrefix = 'sync:offline:splits-fetcher: ';
+
+const DEFAULT_FILENAME = '.split';
+
+function configFilesPath(configFilePath) {
+  if (configFilePath === DEFAULT_FILENAME || !isString(configFilePath)) {
+    let root = process.env.HOME;
+
+    if (process.env.SPLIT_CONFIG_ROOT) root = process.env.SPLIT_CONFIG_ROOT;
+
+    if (!root) throw new Error('Missing split mock configuration root.');
+
+    configFilePath = path.join(root, DEFAULT_FILENAME);
+  }
+
+  // Validate the extensions
+  if (!(endsWith(configFilePath, '.yaml', true) || endsWith(configFilePath, '.yml', true) || endsWith(configFilePath, '.split', true)))
+    throw new Error(`Invalid extension specified for Splits mock file. Accepted extensions are ".yml" and ".yaml". Your specified file is ${configFilePath}`);
+
+  if (!fs.existsSync(configFilePath))
+    throw new Error(`Split configuration not found in ${configFilePath} - Please review your Split file location.`);
+
+  return configFilePath;
+}
+
+// This function is not pure nor meant to be. Here we apply modifications to cover
+// for behaviour that's ensured by the BE.
+function arrangeConditions(mocksData) {
+  // Iterate through each Split data
+  forOwn(mocksData, data => {
+    const conditions = data.conditions;
+
+    // On the manager, as the split jsons come with all treatments on the partitions prop,
+    // we'll add all the treatments to the first condition.
+    const firstRolloutCondition = find(conditions, cond => cond.conditionType === 'ROLLOUT');
+    // Malformed mocks may have
+    const treatments = uniq(data.treatments);
+    // If they're only specifying a whitelist we add the treatments there.
+    const allTreatmentsCondition = firstRolloutCondition ? firstRolloutCondition : conditions[0];
+
+    const fullyAllocatedTreatment = allTreatmentsCondition.partitions[0].treatment;
+
+    treatments.forEach(treatment => {
+      if (treatment !== fullyAllocatedTreatment) {
+        allTreatmentsCondition.partitions.push({
+          treatment, size: 0
+        });
+      }
+    });
+
+    // Don't need these anymore
+    delete data.treatments;
+  });
+}
+
+export function splitsParserFromFileFactory() {
+
+  let previousMock = 'NO_MOCK_LOADED';
+
+  // Parse `.split` configuration file and return a map of "Split Objects"
+  function readSplitConfigFile(log, filePath) {
+    const SPLIT_POSITION = 0;
+    const TREATMENT_POSITION = 1;
+    let data;
+
+    try {
+      data = fs.readFileSync(filePath, 'utf-8');
+    } catch (e) {
+      log.error(e && e.message);
+
+      return {};
+    }
+
+    if (data === previousMock) return false;
+    previousMock = data;
+
+    const splitObjects = data.split(/\r?\n/).reduce((accum, line, index) => {
+      let tuple = line.trim();
+
+      if (tuple === '' || tuple.charAt(0) === '#') {
+        log.debug(logPrefix + `Ignoring empty line or comment at #${index}`);
+      } else {
+        tuple = tuple.split(/\s+/);
+
+        if (tuple.length !== 2) {
+          log.debug(logPrefix + `Ignoring line since it does not have exactly two columns #${index}`);
+        } else {
+          const splitName = tuple[SPLIT_POSITION];
+          const condition = parseCondition({ treatment: tuple[TREATMENT_POSITION] });
+          accum[splitName] = { conditions: [condition], configurations: {}, trafficTypeName: 'localhost' };
+        }
+      }
+
+      return accum;
+    }, {});
+
+    return splitObjects;
+  }
+
+  // Parse `.yml` or `.yaml` configuration files and return a map of "Split Objects"
+  function readYAMLConfigFile(log, filePath) {
+    let data = '';
+    let yamldoc = null;
+
+    try {
+      data = fs.readFileSync(filePath, 'utf8');
+
+      if (data === previousMock) return false;
+      previousMock = data;
+
+      yamldoc = yaml.safeLoad(data);
+    } catch (e) {
+      log.error(e);
+
+      return {};
+    }
+
+    // Each entry will be mapped to a condition, but we'll also keep the configurations map.
+    const mocksData = (yamldoc).reduce((accum, splitEntry) => {
+      const splitName = Object.keys(splitEntry)[0];
+
+      if (!splitName || !isString(splitEntry[splitName].treatment))
+        log.error(logPrefix + 'Ignoring entry on YAML since the format is incorrect.');
+
+      const mockData = splitEntry[splitName];
+
+      // "Template" for each split accumulated data
+      if (!accum[splitName]) {
+        accum[splitName] = {
+          configurations: {}, conditions: [], treatments: [], trafficTypeName: 'localhost'
+        };
+      }
+
+      // Assign the config if there is one on the mock
+      if (mockData.config) accum[splitName].configurations[mockData.treatment] = mockData.config;
+      // Parse the condition from the entry.
+      const condition = parseCondition(mockData);
+      accum[splitName].conditions[condition.conditionType === 'ROLLOUT' ? 'push' : 'unshift'](condition);
+      // Also keep track of the treatments, will be useful for manager functionality.
+      accum[splitName].treatments.push(mockData.treatment);
+
+      return accum;
+    }, {});
+
+    arrangeConditions(mocksData);
+
+    return mocksData;
+  }
+
+  // Load the content of a configuration file into an Object
+  return function splitsParserFromFile({ features, log }) {
+    const filePath = configFilesPath(features);
+    let mockData;
+
+    // If we have a filePath, it means the extension is correct, choose the parser.
+    if (endsWith(filePath, '.split')) {
+      log.warn(logPrefix + '.split mocks will be deprecated soon in favor of YAML files, which provide more targeting power. Take a look in our documentation.');
+      mockData = readSplitConfigFile(log, filePath);
+    } else {
+      mockData = readYAMLConfigFile(log, filePath);
+    }
+
+    return mockData;
+  };
+
+}

package/types/splitio.d.ts

@@ -110,6 +110,7 @@ interface ISettings {
   readonly sync: {
     splitFilters: SplitIO.SplitFilter[],
     impressionsMode: SplitIO.ImpressionsMode,
+    enabled: boolean
   }
   /**
    * User consent status if using in browser. Undefined if using in NodeJS.
@@ -234,6 +235,16 @@ interface ISharedSettings {
      * @default 'OPTIMIZED'
      */
     impressionsMode?: SplitIO.ImpressionsMode,
+    /**
+     * Controls the SDK continuous synchronization flags.
+     *
+     * When `true` a running SDK will process rollout plan updates performed on the UI (default).
+     * When false it'll just fetch all data upon init
+     *
+     * @property {boolean} enabled
+     * @default true
+     */
+    enabled?: boolean
   }
 }
 /**
@@ -716,7 +727,7 @@ declare namespace SplitIO {
   /**
    * Enable 'Google Analytics to Split' integration, to track Google Analytics hits as Split events.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#google-analytics-to-split}
    */
   interface IGoogleAnalyticsToSplitConfig {
     type: 'GOOGLE_ANALYTICS_TO_SPLIT',
@@ -758,6 +769,17 @@ declare namespace SplitIO {
      * If not provided, events are sent using the key and traffic type provided at SDK config
      */
     identities?: Identity[],
+    /**
+     * Optional flag to log an error if the `auto-require` script is not detected.
+     * The auto-require script automatically requires the `splitTracker` plugin for created trackers,
+     * and should be placed right after your Google Analytics, Google Tag Manager or gtag.js script tag.
+     *
+     * @see {@link https://help.split.io/hc/en-us/articles/360040838752#set-up-with-gtm-and-gtag.js}
+     *
+     * @property {boolean} autoRequire
+     * @default false
+     */
+    autoRequire?: boolean,
   }
   /**
    * Object representing the data sent by Split (events and impressions).
@@ -769,7 +791,7 @@ declare namespace SplitIO {
   /**
    * Enable 'Split to Google Analytics' integration, to track Split impressions and events as Google Analytics hits.
    *
-   * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#integrations}
+   * @see {@link https://help.split.io/hc/en-us/articles/360040838752#split-to-google-analytics}
    */
   interface ISplitToGoogleAnalyticsConfig {
     type: 'SPLIT_TO_GOOGLE_ANALYTICS',
@@ -892,7 +914,7 @@ declare namespace SplitIO {
   * ImpressionsMode type
   * @typedef {string} ImpressionsMode
   */
-  type ImpressionsMode = 'OPTIMIZED' | 'DEBUG';
+  type ImpressionsMode = 'OPTIMIZED' | 'DEBUG' | 'NONE';
   /**
    * User consent status.
    * @typedef {string} ConsentStatus