New features and improvements

.eslintrc

@@ -15,7 +15,6 @@
 
   "globals": {
     // global TS types
-    "Response": "readonly",
     "EventSource": "readonly", // @TODO remove. Configure as a type declaration
     "MessageEvent": "readonly", // @TODO remove. Configure as a type declaration
     "Event": "readonly", // @TODO remove. Configure as a type declaration
@@ -66,7 +65,21 @@
         "plugin:compat/recommended"
       ],
       "rules": {
-        "no-restricted-syntax": ["error", "ForOfStatement", "ForInStatement", "ArrayPattern"],
+        "no-restricted-syntax": [
+          "error",
+          {
+            "selector": "ForOfStatement",
+            "message": "Avoid for-of syntax in favor of a smaller transpiled code"
+          },
+          {
+            "selector": "ForInStatement",
+            "message": "Don't use for-in syntax in libraries, because it iterates over members inherited from the prototype chain"
+          },
+          {
+            "selector": "TSEnumDeclaration[const=true]",
+            "message": "Don't declare const enum, because it is not supported by Babel used for building RN SDK"
+          }
+        ],
         "compat/compat": ["error", "defaults, not ie < 10, not node < 6"],
         "no-throw-literal": "error"
       },

README.md

@@ -24,16 +24,18 @@ To learn more about Split, contact hello@split.io, or get started with feature f
 
 Split has built and maintains SDKs for:
 
-* .NET [Github](https://github.com/splitio/.net-core-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
+* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://help.split.io/hc/en-us/articles/360020240172--NET-SDK)
 * Android [Github](https://github.com/splitio/android-client) [Docs](https://help.split.io/hc/en-us/articles/360020343291-Android-SDK)
 * GO [Github](https://github.com/splitio/go-client) [Docs](https://help.split.io/hc/en-us/articles/360020093652-Go-SDK)
 * iOS [Github](https://github.com/splitio/ios-client) [Docs](https://help.split.io/hc/en-us/articles/360020401491-iOS-SDK)
 * Java [Github](https://github.com/splitio/java-client) [Docs](https://help.split.io/hc/en-us/articles/360020405151-Java-SDK)
 * Javascript [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK)
 * Node [Github](https://github.com/splitio/javascript-client) [Docs](https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK)
+* Javascript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://help.split.io/hc/en-us/articles/360058730852)
 * PHP [Github](https://github.com/splitio/php-client) [Docs](https://help.split.io/hc/en-us/articles/360020350372-PHP-SDK)
 * Python [Github](https://github.com/splitio/python-client) [Docs](https://help.split.io/hc/en-us/articles/360020359652-Python-SDK)
 * React [Github](https://github.com/splitio/react-client) [Docs](https://help.split.io/hc/en-us/articles/360038825091-React-SDK)
+* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://help.split.io/hc/en-us/articles/4406066357901-React-Native-SDK)
 * Redux [Github](https://github.com/splitio/redux-client) [Docs](https://help.split.io/hc/en-us/articles/360038851551-Redux-SDK)
 * Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://help.split.io/hc/en-us/articles/360020673251-Ruby-SDK)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "0.1.0",
+  "version": "0.1.1-rc.20",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -50,26 +50,26 @@
   "devDependencies": {
     "@types/google.analytics": "0.0.40",
     "@types/ioredis": "^4.14.1",
-    "@types/jest": "^26.0.10",
+    "@types/jest": "^27.0.0",
     "@types/lodash": "^4.14.162",
     "@types/node": "^14.14.7",
     "@types/object-assign": "^4.0.30",
     "@typescript-eslint/eslint-plugin": "^4.2.0",
     "@typescript-eslint/parser": "^4.2.0",
     "cross-env": "^7.0.2",
     "csv-streamify": "^4.0.0",
-    "eslint": "^7.9.0",
+    "eslint": "^7.32.0",
     "eslint-plugin-compat": "3.7.0",
     "fetch-mock": "^9.10.7",
-    "ioredis": "4.18.0",
-    "jest": "^26.6.3",
+    "ioredis": "^4.26.0",
+    "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
     "js-yaml": "^3.14.0",
-    "lodash": "^4.17.20",
+    "lodash": "^4.17.21",
     "node-fetch": "^2.6.1",
     "redis-server": "1.2.2",
     "rimraf": "^3.0.2",
-    "ts-jest": "^26.3.0",
+    "ts-jest": "^27.0.5",
     "typescript": "^4.0.2"
   },
   "sideEffects": false

src/__tests__/mocks/message.STREAMING_RESET.json

@@ -0,0 +1,4 @@
+{
+  "type": "message",
+  "data": "{\"timestamp\":1457552660000,\"data\":\"{\\\"type\\\":\\\"CONTROL\\\",\\\"controlType\\\":\\\"STREAMING_RESET\\\"}\"}"
+}

src/__tests__/mocks/message.V2.BOUNDED.GZIP.1457552651000.json

@@ -0,0 +1,4 @@
+{
+  "type": "message",
+  "data": "{\"data\":\"{\\\"type\\\":\\\"MY_SEGMENTS_UPDATE_V2\\\",\\\"changeNumber\\\":1457552651000,\\\"segmentName\\\":\\\"\\\",\\\"c\\\": 1,\\\"u\\\": 1,\\\"d\\\":\\\"H4sIAAAAAAAA/2JABxzYeIxQLguYFIBLN8Bl4EABjc+EzOnAsA4QAAD//8YBvWeAAAAA\\\"}\"}"
+}

src/__tests__/mocks/message.V2.KEYLIST.GZIP.1457552652000.json

@@ -0,0 +1,4 @@
+{
+  "type": "message",
+  "data": "{\"data\":\"{\\\"type\\\":\\\"MY_SEGMENTS_UPDATE_V2\\\",\\\"changeNumber\\\":1457552652000,\\\"segmentName\\\":\\\"splitters\\\",\\\"c\\\": 1,\\\"u\\\": 2,\\\"d\\\":\\\"H4sIAAAAAAAA/wTAsRHDUAgD0F2ofwEIkPAqPhdZIW0uu/v97GPXHU004ULuMGrYR6XUbIjlXULPPse+dt1yhJibBODjrTmj3GJ4emduuDDP/w0AAP//18WLsl0AAAA=\\\"}\"}"
+}

src/__tests__/mocks/message.V2.SEGMENT_REMOVAL.1457552653000.json

@@ -0,0 +1,4 @@
+{
+  "type": "message",
+  "data": "{\"data\":\"{\\\"type\\\":\\\"MY_SEGMENTS_UPDATE_V2\\\",\\\"changeNumber\\\":1457552653000,\\\"segmentName\\\":\\\"splitters\\\",\\\"c\\\": 0,\\\"u\\\": 3,\\\"d\\\":\\\"\\\"}\"}"
+}

src/__tests__/mocks/message.V2.UNBOUNDED.1457552650000.json

@@ -0,0 +1,4 @@
+{
+  "type": "message",
+  "data": "{\"data\":\"{\\\"type\\\":\\\"MY_SEGMENTS_UPDATE_V2\\\",\\\"changeNumber\\\":1457552650000,\\\"segmentName\\\":\\\"\\\",\\\"c\\\": 0,\\\"u\\\": 0,\\\"d\\\":\\\"\\\"}\"}"
+}

src/__tests__/testUtils/eventSourceMock.ts

@@ -47,7 +47,8 @@ export default class EventSource {
   static readonly CLOSED: ReadyStateType = 2;
 
   private readonly __emitter: IEventEmitter;
-  onerror?: (evt: MessageEvent) => any;;
+  private readonly __eventSourceInitDict: EventSourceInitDict;
+  onerror?: (evt: MessageEvent) => any;
   onmessage?: (evt: MessageEvent) => any;
   onopen?: (evt?: MessageEvent) => any;
   readyState: ReadyStateType;
@@ -56,13 +57,14 @@ export default class EventSource {
 
   constructor(
     url: string,
-    configuration: EventSourceInitDict = defaultOptions
+    eventSourceInitDict: EventSourceInitDict = defaultOptions
   ) {
     this.url = url;
-    this.withCredentials = configuration.withCredentials;
+    this.withCredentials = eventSourceInitDict.withCredentials;
     this.readyState = 0;
     // @ts-ignore
     this.__emitter = new EventEmitter();
+    this.__eventSourceInitDict = arguments[1];
     sources[url] = this;
     if (__listener) setTimeout(__listener, 0, this);
   }
@@ -81,24 +83,28 @@ export default class EventSource {
 
   emit(eventName: string, messageEvent?: MessageEvent) {
     this.__emitter.emit(eventName, messageEvent);
+
+    let listener: ((evt: any) => any) | undefined;
+    switch (eventName) {
+      case 'error': listener = this.onerror; break;
+      case 'open': listener = this.onopen; break;
+      case 'message': listener = this.onmessage; break;
+    }
+    if (typeof listener === 'function') {
+      listener(messageEvent);
+    }
   }
 
   emitError(error: MessageEvent) {
-    if (typeof this.onerror === 'function') {
-      this.onerror(error);
-    }
+    this.emit('error', error);
   }
 
   emitOpen() {
     this.readyState = 1;
-    if (typeof this.onopen === 'function') {
-      this.onopen();
-    }
+    this.emit('open');
   }
 
   emitMessage(message: MessageEvent) {
-    if (typeof this.onmessage === 'function') {
-      this.onmessage(message);
-    }
+    this.emit('message', message);
   }
 }

src/dtos/types.ts

@@ -194,18 +194,15 @@ export interface IMySegmentsResponse {
   mySegments: IMySegmentsResponseItem[]
 }
 
-/** Metadata internal types */
+/** Metadata internal type for storages */
 
 export interface IMetadata {
-  version: string // SDK version
-  ip: string | false // host IP
-  hostname: string | false // host name
-}
-
-export interface IRedisMetadata {
-  s: string // SDK version
-  i: string // host IP
-  n: string // host name
+  /** SDK version */
+  s: string
+  /** host IP */
+  i: string
+  /** host name */
+  n: string
 }
 
 export type ISplitFiltersValidation = {

src/evaluator/index.ts

@@ -15,6 +15,14 @@ const treatmentException = {
   config: null
 };
 
+function treatmentsException(splitNames: string[]) {
+  const evaluations: Record<string, IEvaluationResult> = {};
+  splitNames.forEach(splitName => {
+    evaluations[splitName] = treatmentException;
+  });
+  return evaluations;
+}
+
 export function evaluateFeature(
   log: ILogger,
   key: SplitIO.SplitKey,
@@ -27,10 +35,8 @@ export function evaluateFeature(
   try {
     stringifiedSplit = storage.splits.getSplit(splitName);
   } catch (e) {
-    // the only scenario where getSplit can throw an error is when the storage
-    // is redis and there is a connection issue and we can't retrieve the split
-    // to be evaluated
-    return Promise.resolve(treatmentException);
+    // Exception on sync `getSplit` storage. Not possible ATM with InMemory and InLocal storages.
+    return treatmentException;
   }
 
   if (thenable(stringifiedSplit)) {
@@ -40,7 +46,11 @@ export function evaluateFeature(
       key,
       attributes,
       storage,
-    ));
+    )).catch(
+      // Exception on async `getSplit` storage. For example, when the storage is redis or
+      // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
+      () => treatmentException
+    );
   }
 
   return getEvaluation(
@@ -60,22 +70,21 @@ export function evaluateFeatures(
   storage: IStorageSync | IStorageAsync,
 ): MaybeThenable<Record<string, IEvaluationResult>> {
   let stringifiedSplits;
-  const evaluations: Record<string, IEvaluationResult> = {};
 
   try {
     stringifiedSplits = storage.splits.getSplits(splitNames);
   } catch (e) {
-    // the only scenario where `getSplits` can throw an error is when the storage
-    // is redis and there is a connection issue and we can't retrieve the split
-    // to be evaluated
-    splitNames.forEach(splitName => {
-      evaluations[splitName] = treatmentException;
-    });
-    return Promise.resolve(evaluations);
+    // Exception on sync `getSplits` storage. Not possible ATM with InMemory and InLocal storages.
+    return treatmentsException(splitNames);
   }
 
   return (thenable(stringifiedSplits)) ?
-    stringifiedSplits.then(splits => getEvaluations(log, splitNames, splits, key, attributes, storage)) :
+    stringifiedSplits.then(splits => getEvaluations(log, splitNames, splits, key, attributes, storage))
+      .catch(() => {
+        // Exception on async `getSplits` storage. For example, when the storage is redis or
+        // pluggable and there is a connection issue and we can't retrieve the split to be evaluated
+        return treatmentsException(splitNames);
+      }) :
     getEvaluations(log, splitNames, stringifiedSplits, key, attributes, storage);
 }
 

src/evaluator/matchers/matcherTypes.ts

@@ -19,7 +19,7 @@ export const matcherTypes: Record<string, number> = {
   MATCHES_STRING: 17
 };
 
-export const dataTypes = {
+export const matcherDataTypes = {
   BOOLEAN: 'BOOLEAN',
   STRING: 'STRING',
   NUMBER: 'NUMBER',
@@ -28,7 +28,7 @@ export const dataTypes = {
   NOT_SPECIFIED: 'NOT_SPECIFIED'
 };
 
-export function mapper(matcherType: string) {
+export function matcherTypesMapper(matcherType: string) {
   const type = matcherTypes[matcherType];
   if (type) return type;
   else return matcherTypes.UNDEFINED;

src/evaluator/matchersTransform/index.ts

@@ -1,5 +1,5 @@
 import { findIndex } from '../../utils/lang';
-import { matcherTypes, mapper, dataTypes } from '../matchers/matcherTypes';
+import { matcherTypes, matcherTypesMapper, matcherDataTypes } from '../matchers/matcherTypes';
 import segmentTransform from './segment';
 import whitelistTransform from './whitelist';
 import setTransform from './set';
@@ -28,9 +28,9 @@ export default function matchersTransform(matchers: ISplitMatcher[]): IMatcherDt
     } = matcher;
 
     let attribute = keySelector && keySelector.attribute;
-    let type = mapper(matcherType);
+    let type = matcherTypesMapper(matcherType);
     // As default input data type we use string (even for ALL_KEYS)
-    let dataType = dataTypes.STRING;
+    let dataType = matcherDataTypes.STRING;
     let value = undefined;
 
     if (type === matcherTypes.IN_SEGMENT) {
@@ -39,29 +39,29 @@ export default function matchersTransform(matchers: ISplitMatcher[]): IMatcherDt
       value = whitelistTransform(whitelistObject as IWhitelistMatcherData);
     } else if (type === matcherTypes.EQUAL_TO) {
       value = numericTransform(unaryNumericObject as IUnaryNumericMatcherData);
-      dataType = dataTypes.NUMBER;
+      dataType = matcherDataTypes.NUMBER;
 
       if ((unaryNumericObject as IUnaryNumericMatcherData).dataType === 'DATETIME') {
         value = zeroSinceHH(value);
-        dataType = dataTypes.DATETIME;
+        dataType = matcherDataTypes.DATETIME;
       }
     } else if (type === matcherTypes.GREATER_THAN_OR_EQUAL_TO ||
       type === matcherTypes.LESS_THAN_OR_EQUAL_TO) {
       value = numericTransform(unaryNumericObject as IUnaryNumericMatcherData);
-      dataType = dataTypes.NUMBER;
+      dataType = matcherDataTypes.NUMBER;
 
       if ((unaryNumericObject as IUnaryNumericMatcherData).dataType === 'DATETIME') {
         value = zeroSinceSS(value);
-        dataType = dataTypes.DATETIME;
+        dataType = matcherDataTypes.DATETIME;
       }
     } else if (type === matcherTypes.BETWEEN) {
       value = betweenObject as IBetweenMatcherData;
-      dataType = dataTypes.NUMBER;
+      dataType = matcherDataTypes.NUMBER;
 
       if (value.dataType === 'DATETIME') {
         value.start = zeroSinceSS(value.start);
         value.end = zeroSinceSS(value.end);
-        dataType = dataTypes.DATETIME;
+        dataType = matcherDataTypes.DATETIME;
       }
     } else if (
       type === matcherTypes.EQUAL_TO_SET ||
@@ -70,7 +70,7 @@ export default function matchersTransform(matchers: ISplitMatcher[]): IMatcherDt
       type === matcherTypes.PART_OF_SET
     ) {
       value = setTransform(whitelistObject as IWhitelistMatcherData);
-      dataType = dataTypes.SET;
+      dataType = matcherDataTypes.SET;
     } else if (
       type === matcherTypes.STARTS_WITH ||
       type === matcherTypes.ENDS_WITH ||
@@ -79,9 +79,9 @@ export default function matchersTransform(matchers: ISplitMatcher[]): IMatcherDt
       value = setTransform(whitelistObject as IWhitelistMatcherData);
     } else if (type === matcherTypes.IN_SPLIT_TREATMENT) {
       value = dependencyObject;
-      dataType = dataTypes.NOT_SPECIFIED;
+      dataType = matcherDataTypes.NOT_SPECIFIED;
     } else if (type === matcherTypes.EQUAL_TO_BOOLEAN) {
-      dataType = dataTypes.BOOLEAN;
+      dataType = matcherDataTypes.BOOLEAN;
       value = booleanMatcherData;
     } else if (type === matcherTypes.MATCHES_STRING) {
       value = stringMatcherData;