@splitsoftware/splitio-commons 1.2.1-rc.2 → 1.2.1-rc.3

package/cjs/integrations/ga/GoogleAnalyticsToSplit.js

@@ -4,8 +4,10 @@ exports.GoogleAnalyticsToSplit = void 0;
 var GaToSplit_1 = require("./GaToSplit");
 function GoogleAnalyticsToSplit(options) {
     // GaToSplit integration factory
-    return function (params) {
+    function GoogleAnalyticsToSplitFactory(params) {
         return (0, GaToSplit_1.GaToSplit)(options, params);
-    };
+    }
+    GoogleAnalyticsToSplitFactory.type = 'GOOGLE_ANALYTICS_TO_SPLIT';
+    return GoogleAnalyticsToSplitFactory;
 }
 exports.GoogleAnalyticsToSplit = GoogleAnalyticsToSplit;

package/cjs/integrations/ga/SplitToGoogleAnalytics.js

@@ -5,8 +5,10 @@ var SplitToGa_1 = require("./SplitToGa");
 function SplitToGoogleAnalytics(options) {
     if (options === void 0) { options = {}; }
     // SplitToGa integration factory
-    return function (params) {
+    function SplitToGoogleAnalyticsFactory(params) {
         return new SplitToGa_1.SplitToGa(params.settings.log, options);
-    };
+    }
+    SplitToGoogleAnalyticsFactory.type = 'SPLIT_TO_GOOGLE_ANALYTICS';
+    return SplitToGoogleAnalyticsFactory;
 }
 exports.SplitToGoogleAnalytics = SplitToGoogleAnalytics;

package/cjs/logger/messages/error.js

@@ -16,7 +16,7 @@ exports.codesError = [
     [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock Splits data, no changes will be applied to the current cache. %s'],
     [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
     [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-    [c.ERROR_HTTP, ' Response status is not OK. Status: %s. URL: %s. Message: %s'],
+    [c.ERROR_HTTP, 'Response status is not OK. Status: %s. URL: %s. Message: %s'],
     // client status
     [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
     [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],

package/cjs/logger/messages/info.js

@@ -30,5 +30,5 @@ exports.codesInfo = warn_1.codesWarn.concat([
     [c.STREAMING_DISCONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Disconnecting streaming.'],
     [c.SYNC_START_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming not available. Starting polling.'],
     [c.SYNC_CONTINUE_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming couldn\'t connect. Continue polling.'],
-    [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming (re)connected. Syncing and stopping polling.'],
+    [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming connected. Syncing and stopping polling.'],
 ]);

package/cjs/sync/streaming/pushManager.js

@@ -58,6 +58,7 @@ function pushManagerFactory(params, pollingManager) {
     // It is used to halt the `connectPush` process if it was in progress.
     var disconnected;
     // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+    // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
     var disabled; // `disabled` implies `disconnected === true`
     /** PushManager functions related to initialization */
     var connectPushRetryBackoff = new Backoff_1.Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
@@ -258,13 +259,15 @@ function pushManagerFactory(params, pollingManager) {
     return (0, objectAssign_1.objectAssign)(
     // Expose Event Emitter functionality and Event constants
     Object.create(pushEmitter), {
-        // Stop/pause push mode
+        // Stop/pause push mode.
+        // It doesn't emit events. Neither PUSH_SUBSYSTEM_DOWN to start polling.
         stop: function () {
             disconnectPush(); // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which starts polling.
             if (userKey)
                 this.remove(userKey); // Necessary to properly resume streaming in client-side (e.g., RN SDK transition to foreground).
         },
-        // Start/resume push mode
+        // Start/resume push mode.
+        // It eventually emits PUSH_SUBSYSTEM_DOWN, that starts polling, or PUSH_SUBSYSTEM_UP, that executes a syncAll
         start: function () {
             // Guard condition to avoid calling `connectPush` again if the `start` method is called multiple times or if push has been disabled.
             if (disabled || disconnected === false)
@@ -275,6 +278,10 @@ function pushManagerFactory(params, pollingManager) {
             else
                 setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
         },
+        // true/false if start or stop was called last respectively
+        isRunning: function () {
+            return disconnected === false;
+        },
         // [Only for client-side]
         add: function (userKey, mySegmentsSyncTask) {
             var hash = (0, AuthClient_1.hashUserKey)(userKey);

package/esm/integrations/ga/GoogleAnalyticsToSplit.js

@@ -1,7 +1,9 @@
 import { GaToSplit } from './GaToSplit';
 export function GoogleAnalyticsToSplit(options) {
     // GaToSplit integration factory
-    return function (params) {
+    function GoogleAnalyticsToSplitFactory(params) {
         return GaToSplit(options, params);
-    };
+    }
+    GoogleAnalyticsToSplitFactory.type = 'GOOGLE_ANALYTICS_TO_SPLIT';
+    return GoogleAnalyticsToSplitFactory;
 }

package/esm/integrations/ga/SplitToGoogleAnalytics.js

@@ -2,7 +2,9 @@ import { SplitToGa } from './SplitToGa';
 export function SplitToGoogleAnalytics(options) {
     if (options === void 0) { options = {}; }
     // SplitToGa integration factory
-    return function (params) {
+    function SplitToGoogleAnalyticsFactory(params) {
         return new SplitToGa(params.settings.log, options);
-    };
+    }
+    SplitToGoogleAnalyticsFactory.type = 'SPLIT_TO_GOOGLE_ANALYTICS';
+    return SplitToGoogleAnalyticsFactory;
 }

package/esm/logger/messages/error.js

@@ -12,7 +12,7 @@ export var codesError = [
     [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock Splits data, no changes will be applied to the current cache. %s'],
     [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
     [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-    [c.ERROR_HTTP, ' Response status is not OK. Status: %s. URL: %s. Message: %s'],
+    [c.ERROR_HTTP, 'Response status is not OK. Status: %s. URL: %s. Message: %s'],
     // client status
     [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
     [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],

package/esm/logger/messages/info.js

@@ -26,5 +26,5 @@ export var codesInfo = codesWarn.concat([
     [c.STREAMING_DISCONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Disconnecting streaming.'],
     [c.SYNC_START_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming not available. Starting polling.'],
     [c.SYNC_CONTINUE_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming couldn\'t connect. Continue polling.'],
-    [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming (re)connected. Syncing and stopping polling.'],
+    [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming connected. Syncing and stopping polling.'],
 ]);

package/esm/sync/streaming/pushManager.js

@@ -55,6 +55,7 @@ export function pushManagerFactory(params, pollingManager) {
     // It is used to halt the `connectPush` process if it was in progress.
     var disconnected;
     // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+    // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
     var disabled; // `disabled` implies `disconnected === true`
     /** PushManager functions related to initialization */
     var connectPushRetryBackoff = new Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
@@ -255,13 +256,15 @@ export function pushManagerFactory(params, pollingManager) {
     return objectAssign(
     // Expose Event Emitter functionality and Event constants
     Object.create(pushEmitter), {
-        // Stop/pause push mode
+        // Stop/pause push mode.
+        // It doesn't emit events. Neither PUSH_SUBSYSTEM_DOWN to start polling.
         stop: function () {
             disconnectPush(); // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which starts polling.
             if (userKey)
                 this.remove(userKey); // Necessary to properly resume streaming in client-side (e.g., RN SDK transition to foreground).
         },
-        // Start/resume push mode
+        // Start/resume push mode.
+        // It eventually emits PUSH_SUBSYSTEM_DOWN, that starts polling, or PUSH_SUBSYSTEM_UP, that executes a syncAll
         start: function () {
             // Guard condition to avoid calling `connectPush` again if the `start` method is called multiple times or if push has been disabled.
             if (disabled || disconnected === false)
@@ -272,6 +275,10 @@ export function pushManagerFactory(params, pollingManager) {
             else
                 setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
         },
+        // true/false if start or stop was called last respectively
+        isRunning: function () {
+            return disconnected === false;
+        },
         // [Only for client-side]
         add: function (userKey, mySegmentsSyncTask) {
             var hash = hashUserKey(userKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.1-rc.2",
+  "version": "1.2.1-rc.3",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/integrations/ga/GoogleAnalyticsToSplit.ts

@@ -1,11 +1,14 @@
-import { IIntegrationFactoryParams } from '../types';
+import { IIntegrationFactoryParams, IntegrationFactory } from '../types';
 import { GaToSplit } from './GaToSplit';
 import { GoogleAnalyticsToSplitOptions } from './types';
 
-export function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions) {
+export function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions): IntegrationFactory {
 
   // GaToSplit integration factory
-  return (params: IIntegrationFactoryParams) => {
+  function GoogleAnalyticsToSplitFactory(params: IIntegrationFactoryParams) {
     return GaToSplit(options, params);
-  };
+  }
+
+  GoogleAnalyticsToSplitFactory.type = 'GOOGLE_ANALYTICS_TO_SPLIT';
+  return GoogleAnalyticsToSplitFactory;
 }

package/src/integrations/ga/SplitToGoogleAnalytics.ts

@@ -1,11 +1,14 @@
-import { IIntegrationFactoryParams } from '../types';
+import { IIntegrationFactoryParams, IntegrationFactory } from '../types';
 import { SplitToGa } from './SplitToGa';
 import { SplitToGoogleAnalyticsOptions } from './types';
 
-export function SplitToGoogleAnalytics(options: SplitToGoogleAnalyticsOptions = {}) {
+export function SplitToGoogleAnalytics(options: SplitToGoogleAnalyticsOptions = {}): IntegrationFactory {
 
   // SplitToGa integration factory
-  return (params: IIntegrationFactoryParams) => {
+  function SplitToGoogleAnalyticsFactory(params: IIntegrationFactoryParams) {
     return new SplitToGa(params.settings.log, options);
-  };
+  }
+
+  SplitToGoogleAnalyticsFactory.type = 'SPLIT_TO_GOOGLE_ANALYTICS';
+  return SplitToGoogleAnalyticsFactory;
 }

package/src/integrations/types.ts

@@ -12,3 +12,8 @@ export interface IIntegrationFactoryParams {
   storage: { events: IEventsCacheBase }
   settings: ISettings
 }
+
+export type IntegrationFactory = {
+  readonly type: string
+  (params: IIntegrationFactoryParams): IIntegration | void
+}

package/src/logger/messages/error.ts

@@ -13,7 +13,7 @@ export const codesError: [number, string][] = [
   [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock Splits data, no changes will be applied to the current cache. %s'],
   [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
   [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-  [c.ERROR_HTTP, ' Response status is not OK. Status: %s. URL: %s. Message: %s'],
+  [c.ERROR_HTTP, 'Response status is not OK. Status: %s. URL: %s. Message: %s'],
   // client status
   [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
   [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],

package/src/logger/messages/info.ts

@@ -29,5 +29,5 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.STREAMING_DISCONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Disconnecting streaming.'],
   [c.SYNC_START_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming not available. Starting polling.'],
   [c.SYNC_CONTINUE_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming couldn\'t connect. Continue polling.'],
-  [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming (re)connected. Syncing and stopping polling.'],
+  [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming connected. Syncing and stopping polling.'],
 ]);

package/src/logger/types.ts

@@ -9,15 +9,15 @@ export interface ILoggerOptions {
 export interface ILogger {
   setLogLevel(logLevel: LogLevel): void
 
-  debug(msg: unknown): void
+  debug(msg: any): void
   debug(msg: string | number, args?: any[]): void
 
-  info(msg: unknown): void
+  info(msg: any): void
   info(msg: string | number, args?: any[]): void
 
-  warn(msg: unknown): void
+  warn(msg: any): void
   warn(msg: string | number, args?: any[]): void
 
-  error(msg: unknown): void
+  error(msg: any): void
   error(msg: string | number, args?: any[]): void
 }

package/src/storages/types.ts

@@ -443,7 +443,7 @@ export interface IStorageFactoryParams {
 export type StorageType = 'MEMORY' | 'LOCALSTORAGE' | 'REDIS' | 'PLUGGABLE';
 
 export type IStorageSyncFactory = {
-  type: StorageType,
+  readonly type: StorageType,
   (params: IStorageFactoryParams): IStorageSync
 }
 

package/src/sync/streaming/pushManager.ts

@@ -71,6 +71,7 @@ export function pushManagerFactory(
   // It is used to halt the `connectPush` process if it was in progress.
   let disconnected: boolean | undefined;
   // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+  // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
   let disabled: boolean | undefined; // `disabled` implies `disconnected === true`
 
   /** PushManager functions related to initialization */
@@ -296,12 +297,15 @@ export function pushManagerFactory(
     // Expose Event Emitter functionality and Event constants
     Object.create(pushEmitter),
     {
-      // Stop/pause push mode
+      // Stop/pause push mode.
+      // It doesn't emit events. Neither PUSH_SUBSYSTEM_DOWN to start polling.
       stop() {
         disconnectPush(); // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which starts polling.
         if (userKey) this.remove(userKey); // Necessary to properly resume streaming in client-side (e.g., RN SDK transition to foreground).
       },
-      // Start/resume push mode
+
+      // Start/resume push mode.
+      // It eventually emits PUSH_SUBSYSTEM_DOWN, that starts polling, or PUSH_SUBSYSTEM_UP, that executes a syncAll
       start() {
         // Guard condition to avoid calling `connectPush` again if the `start` method is called multiple times or if push has been disabled.
         if (disabled || disconnected === false) return;
@@ -311,6 +315,11 @@ export function pushManagerFactory(
         else setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
       },
 
+      // true/false if start or stop was called last respectively
+      isRunning(){
+        return disconnected === false;
+      },
+
       // [Only for client-side]
       add(userKey: string, mySegmentsSyncTask: ISegmentsSyncTask) {
         const hash = hashUserKey(userKey);

package/src/utils/settingsValidation/runtime/browser.ts

@@ -1,4 +1,6 @@
-export function validateRuntime() {
+import { ISettings } from '../../../types';
+
+export function validateRuntime(): ISettings['runtime'] {
   return {
     ip: false,
     hostname: false

package/src/utils/settingsValidation/runtime/node.ts

@@ -4,7 +4,7 @@ import ipFunction from 'ip';
 import { UNKNOWN, NA, CONSUMER_MODE } from '../../constants';
 import { ISettings } from '../../../types';
 
-export function validateRuntime(settings: ISettings) {
+export function validateRuntime(settings: ISettings): ISettings['runtime'] {
   const isIPAddressesEnabled = settings.core.IPAddressesEnabled === true;
   const isConsumerMode = settings.mode === CONSUMER_MODE;
 

package/types/integrations/ga/GoogleAnalyticsToSplit.d.ts

@@ -1,3 +1,3 @@
-import { IIntegrationFactoryParams } from '../types';
+import { IntegrationFactory } from '../types';
 import { GoogleAnalyticsToSplitOptions } from './types';
-export declare function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions): (params: IIntegrationFactoryParams) => void;
+export declare function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions): IntegrationFactory;

package/types/integrations/ga/SplitToGoogleAnalytics.d.ts

@@ -1,4 +1,3 @@
-import { IIntegrationFactoryParams } from '../types';
-import { SplitToGa } from './SplitToGa';
+import { IntegrationFactory } from '../types';
 import { SplitToGoogleAnalyticsOptions } from './types';
-export declare function SplitToGoogleAnalytics(options?: SplitToGoogleAnalyticsOptions): (params: IIntegrationFactoryParams) => SplitToGa;
+export declare function SplitToGoogleAnalytics(options?: SplitToGoogleAnalyticsOptions): IntegrationFactory;

package/types/integrations/types.d.ts

@@ -11,3 +11,7 @@ export interface IIntegrationFactoryParams {
     };
     settings: ISettings;
 }
+export declare type IntegrationFactory = {
+    readonly type: string;
+    (params: IIntegrationFactoryParams): IIntegration | void;
+};

package/types/logger/types.d.ts

@@ -6,12 +6,12 @@ export interface ILoggerOptions {
 }
 export interface ILogger {
     setLogLevel(logLevel: LogLevel): void;
-    debug(msg: unknown): void;
+    debug(msg: any): void;
     debug(msg: string | number, args?: any[]): void;
-    info(msg: unknown): void;
+    info(msg: any): void;
     info(msg: string | number, args?: any[]): void;
-    warn(msg: unknown): void;
+    warn(msg: any): void;
     warn(msg: string | number, args?: any[]): void;
-    error(msg: unknown): void;
+    error(msg: any): void;
     error(msg: string | number, args?: any[]): void;
 }

package/types/storages/types.d.ts

@@ -345,7 +345,7 @@ export interface IStorageFactoryParams {
 }
 export declare type StorageType = 'MEMORY' | 'LOCALSTORAGE' | 'REDIS' | 'PLUGGABLE';
 export declare type IStorageSyncFactory = {
-    type: StorageType;
+    readonly type: StorageType;
     (params: IStorageFactoryParams): IStorageSync;
 };
 export declare type IStorageAsyncFactory = {

package/types/utils/settingsValidation/runtime/browser.d.ts

@@ -1,4 +1,2 @@
-export declare function validateRuntime(): {
-    ip: boolean;
-    hostname: boolean;
-};
+import { ISettings } from '../../../types';
+export declare function validateRuntime(): ISettings['runtime'];

package/types/utils/settingsValidation/runtime/node.d.ts

@@ -1,5 +1,2 @@
 import { ISettings } from '../../../types';
-export declare function validateRuntime(settings: ISettings): {
-    ip: string | false;
-    hostname: string | false;
-};
+export declare function validateRuntime(settings: ISettings): ISettings['runtime'];