@splitsoftware/splitio 10.21.0 → 10.21.1-rc.0

package/CHANGES.txt

@@ -1,3 +1,6 @@
+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.

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.21.0';
+export var packageVersion = '10.21.1-rc.0';

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.21.0';
+exports.packageVersion = '10.21.1-rc.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio",
-  "version": "10.21.0",
+  "version": "10.21.1-rc.0",
   "description": "Split SDK",
   "files": [
     "README.md",
@@ -33,7 +33,8 @@
     "node": ">=6"
   },
   "dependencies": {
-    "@splitsoftware/splitio-commons": "1.6.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",
@@ -89,24 +90,24 @@
     "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/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.21.0';
+export const packageVersion = '10.21.1-rc.0';

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
   }
 }
 /**
@@ -903,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