@splitsoftware/splitio 10.17.3-rc.0 → 10.17.3-rc.1

package/src/platform/browser.js

@@ -1,5 +1,4 @@
-// @TODO check 'events': it is a CommonJS module. Can have issues with ESM bundlers.
-import EventEmitter from 'events';
+import { EventEmitter } from './EventEmitter';
 import { getFetch } from '../platform/getFetch/browser';
 import { getEventSource } from '../platform/getEventSource/browser';
 import { BrowserSignalListener } from '@splitsoftware/splitio-commons/src/listeners/browser';
@@ -10,4 +9,4 @@ export const platform = {
   EventEmitter
 };
 
-export const signalListener = BrowserSignalListener;
+export const SignalListener = BrowserSignalListener;

package/src/platform/node.js

@@ -1,4 +1,3 @@
-// @TODO check 'events': Node is using events API or the installed dependency?
 import EventEmitter from 'events';
 import { getFetch } from '../platform/getFetch/node';
 import { getEventSource } from '../platform/getEventSource/node';
@@ -12,4 +11,4 @@ export const platform = {
   EventEmitter
 };
 
-export const signalListener = NodeSignalListener;
+export const SignalListener = NodeSignalListener;

package/src/settings/defaults/version.js

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

package/src/settings/package.json

@@ -1,4 +1,4 @@
 {
-  "main": "./serverSide.js",
-  "browser": "./clientSide.js"
+  "main": "./node.js",
+  "browser": "./browser.js"
 }

package/src/settings/storage/browser.js

@@ -21,6 +21,7 @@ const STORAGE_LOCALSTORAGE = 'LOCALSTORAGE';
 
 export function validateStorage(settings) {
   let {
+    log,
     mode,
     storage: {
       type,
@@ -41,8 +42,8 @@ export function validateStorage(settings) {
     type = STORAGE_MEMORY;
   };
 
-  // In localhost mode, fallback to Memory storage and track original
-  // type to emit SDK_READY_FROM_CACHE if corresponds
+  // In localhost mode, fallback to Memory storage and track original type to emit SDK_READY_FROM_CACHE if corresponds.
+  // ATM, other mode settings (e.g., 'consumer') are ignored in client-side API, and so treated as standalone.
   if (mode === LOCALHOST_MODE && type === STORAGE_LOCALSTORAGE) {
     fallbackToMemory();
   }
@@ -52,7 +53,7 @@ export function validateStorage(settings) {
   if (type !== STORAGE_MEMORY && type !== STORAGE_LOCALSTORAGE ||
     type === STORAGE_LOCALSTORAGE && !isLocalStorageAvailable()) {
     fallbackToMemory();
-    settings.log.warn('Invalid or unavailable storage. Fallbacking into MEMORY storage');
+    log.error('Invalid or unavailable storage. Fallbacking into MEMORY storage');
   }
 
   return {

package/src/settings/storage/node.js

@@ -13,12 +13,11 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 **/
-import { LOCALHOST_MODE, STORAGE_MEMORY } from '@splitsoftware/splitio-commons/src/utils/constants';
-
-const STORAGE_REDIS = 'REDIS';
+import { LOCALHOST_MODE, STORAGE_MEMORY, STORAGE_REDIS, CONSUMER_MODE, STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
 
 export function validateStorage(settings) {
   let {
+    log,
     mode,
     storage: {
       type,
@@ -33,15 +32,17 @@ export function validateStorage(settings) {
     prefix = 'SPLITIO';
   }
 
-  // In localhost mode we should force the user to use the MEMORY storage
-  if (mode === LOCALHOST_MODE) return {
-    type: STORAGE_MEMORY,
-    prefix
-  };
-
-  // In other cases we can have MEMORY or REDIS
+  // We can have MEMORY, REDIS or an invalid storage type
   switch (type) {
     case STORAGE_REDIS: {
+      // If passing REDIS storage in localhost or standalone mode, we log an error and fallback to MEMORY storage
+      if (mode === STANDALONE_MODE || mode === LOCALHOST_MODE) {
+        log.error('The provided REDIS storage is invalid for this mode. It requires consumer mode. Fallbacking into default MEMORY storage.');
+        return {
+          type: STORAGE_MEMORY,
+          prefix
+        };
+      }
       let {
         host,
         port,
@@ -86,6 +87,10 @@ export function validateStorage(settings) {
     // For now, we don't have modifiers or settings for MEMORY in NodeJS
     case STORAGE_MEMORY:
     default: {
+      // If passing MEMORY storage in consumer mode, throw an error (no way to fallback to REDIS storage)
+      if (mode === CONSUMER_MODE) throw new Error('A REDIS storage is required on consumer mode');
+      // If passing an invalid storage type, log an error
+      if (type !== STORAGE_MEMORY) log.error(`The provided '${type}' storage type is invalid. Fallbacking into default MEMORY storage.`);
       return {
         type: STORAGE_MEMORY,
         prefix

package/types/client/index.d.ts

@@ -0,0 +1,14 @@
+// Declaration file for Javascript Split Software SDK
+// Project: http://www.split.io/
+
+/// <reference path="../splitio.d.ts" />
+export = JsSdk;
+
+declare module JsSdk {
+  /**
+   * Split.io sdk factory function.
+   * The settings parameter should be an object that complies with the SplitIO.IBrowserSettings.
+   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#configuration}
+   */
+  export function SplitFactory(settings: SplitIO.IBrowserSettings): SplitIO.IBrowserSDK;
+}

package/types/server/index.d.ts

@@ -0,0 +1,20 @@
+// Declaration file for Javascript Split Software SDK
+// Project: http://www.split.io/
+
+/// <reference path="../splitio.d.ts" />
+export = JsSdk;
+
+declare module JsSdk {
+  /**
+   * Split.io sdk factory function.
+   * The settings parameter should be an object that complies with the SplitIO.INodeAsyncSettings.
+   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
+   */
+  export function SplitFactory(settings: SplitIO.INodeAsyncSettings): SplitIO.IAsyncSDK;
+  /**
+   * Split.io sdk factory function.
+   * The settings parameter should be an object that complies with the SplitIO.INodeSettings.
+   * For more information read the corresponding article: @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#configuration}
+   */
+  export function SplitFactory(settings: SplitIO.INodeSettings): SplitIO.ISDK;
+}

package/types/splitio.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Javascript and Node Split Software SDK v8.1.0
+// Type definitions for Javascript and Node Split Software SDK
 // Project: http://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
@@ -336,7 +336,8 @@ interface INodeBasicSettings extends ISharedSettings {
     prefix?: string
   },
   /**
-   * The SDK mode. Possible values are "standalone" (which is the default) and "consumer". For "localhost" mode, use "localhost" as authorizationKey.
+   * The SDK mode. Possible values are "standalone", which is the default when using a synchronous storage, like 'MEMORY' and 'LOCALSTORAGE',
+   * and "consumer", which must be set when using an asynchronous storage, like 'REDIS'. For "localhost" mode, use "localhost" as authorizationKey.
    * @property {SDKMode} mode
    * @default standalone
    */
@@ -1020,7 +1021,15 @@ declare namespace SplitIO {
        * @default SPLITIO
        */
       prefix?: string
-    }
+    },
+    /**
+     * The SDK mode. When using the default 'MEMORY' storage, the only possible value is "standalone", which is the default.
+     * For "localhost" mode, use "localhost" as authorizationKey.
+     *
+     * @property {'standalone'} mode
+     * @default standalone
+     */
+    mode?: 'standalone'
   }
   /**
    * Settings interface with async storage for SDK instances created on NodeJS.
@@ -1032,7 +1041,7 @@ declare namespace SplitIO {
   interface INodeAsyncSettings extends INodeBasicSettings {
     storage: {
       /**
-       * Redis storage type to be instantiated by the SDK.
+       * 'REDIS' storage type to be instantiated by the SDK.
        * @property {NodeAsyncStorage} type
        */
       type: NodeAsyncStorage,
@@ -1047,7 +1056,15 @@ declare namespace SplitIO {
        * @default SPLITIO
        */
       prefix?: string
-    }
+    },
+    /**
+     * The SDK mode. When using 'REDIS' storage type, the only possible value is "consumer", which is required.
+     *
+     * @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#state-sharing-redis-integration}
+     *
+     * @property {'consumer'} mode
+     */
+    mode: 'consumer'
   }
   /**
    * This represents the interface for the SDK instance with synchronous storage.

package/es/factory/commons.js

@@ -1,16 +0,0 @@
-import { OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '@splitsoftware/splitio-commons/esm/utils/constants';
-/**
- * Checks if impressions previous time should be added or not.
- */
-
-export function shouldAddPt(settings) {
-  return [PRODUCER_MODE, STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
-}
-/**
- * Checks if it should dedupe impressions or not.
- */
-
-export function shouldBeOptimized(settings) {
-  if (!shouldAddPt(settings)) return false;
-  return settings.sync.impressionsMode === OPTIMIZED ? true : false;
-}

package/lib/factory/commons.js

@@ -1,23 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.shouldAddPt = shouldAddPt;
-exports.shouldBeOptimized = shouldBeOptimized;
-
-var _constants = require("@splitsoftware/splitio-commons/cjs/utils/constants");
-
-/**
- * Checks if impressions previous time should be added or not.
- */
-function shouldAddPt(settings) {
-  return [_constants.PRODUCER_MODE, _constants.STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
-}
-/**
- * Checks if it should dedupe impressions or not.
- */
-
-
-function shouldBeOptimized(settings) {
-  if (!shouldAddPt(settings)) return false;
-  return settings.sync.impressionsMode === _constants.OPTIMIZED ? true : false;
-}

package/src/factory/commons.js

@@ -1,16 +0,0 @@
-import { OPTIMIZED, PRODUCER_MODE, STANDALONE_MODE } from '@splitsoftware/splitio-commons/src/utils/constants';
-
-/**
- * Checks if impressions previous time should be added or not.
- */
-export function shouldAddPt(settings) {
-  return [PRODUCER_MODE, STANDALONE_MODE].indexOf(settings.mode) > -1 ? true : false;
-}
-
-/**
- * Checks if it should dedupe impressions or not.
- */
-export function shouldBeOptimized(settings) {
-  if (!shouldAddPt(settings)) return false;
-  return settings.sync.impressionsMode === OPTIMIZED ? true : false;
-}