@splitsoftware/splitio-commons 2.4.2-rc.3 → 2.5.0-rc.0

package/src/sync/syncManagerOnline.ts

@@ -89,41 +89,36 @@ export function syncManagerOnlineFactory(
       start() {
         running = true;
 
-        // @TODO once event, impression and telemetry storages support persistence, call when `validateCache` promise is resolved
-        submitterManager.start(!isConsentGranted(settings));
-
-        return Promise.resolve(storage.validateCache ? storage.validateCache() : false).then((isCacheLoaded) => {
-          if (!running) return;
-
-          if (startFirstTime) {
-            // Emits SDK_READY_FROM_CACHE
-            if (isCacheLoaded) readiness.splits.emit(SDK_SPLITS_CACHE_LOADED);
+        if (startFirstTime) {
+          const isCacheLoaded = storage.validateCache ? storage.validateCache() : false;
+          if (isCacheLoaded) Promise.resolve().then(() => { readiness.splits.emit(SDK_SPLITS_CACHE_LOADED); });
+        }
 
-          }
+        // start syncing splits and segments
+        if (pollingManager) {
 
-          // start syncing splits and segments
-          if (pollingManager) {
-
-            // If synchronization is disabled pushManager and pollingManager should not start
-            if (syncEnabled) {
-              if (pushManager) {
-                // Doesn't call `syncAll` when the syncManager is resuming
-                if (startFirstTime) {
-                  pollingManager.syncAll();
-                }
-                pushManager.start();
-              } else {
-                pollingManager.start();
-              }
-            } else {
+          // If synchronization is disabled pushManager and pollingManager should not start
+          if (syncEnabled) {
+            if (pushManager) {
+              // Doesn't call `syncAll` when the syncManager is resuming
               if (startFirstTime) {
                 pollingManager.syncAll();
               }
+              pushManager.start();
+            } else {
+              pollingManager.start();
+            }
+          } else {
+            if (startFirstTime) {
+              pollingManager.syncAll();
             }
           }
+        }
+
+        // start periodic data recording (events, impressions, telemetry).
+        submitterManager.start(!isConsentGranted(settings));
 
-          startFirstTime = false;
-        });
+        startFirstTime = false;
       },
 
       /**

package/src/types.ts

@@ -42,38 +42,3 @@ export interface IBasicClient extends SplitIO.IBasicClient {
   isClientSide?: boolean;
   key?: SplitIO.SplitKey;
 }
-/**
- * Defines the format of rollout plan data to preload the factory storage (cache).
- */
-export interface PreloadedData {
-  /**
-   * Timestamp of the last moment the data was synchronized with Split servers.
-   * If this value is older than 10 days ago (expiration time policy), the data is not used to update the storage content.
-   */
-  // @TODO configurable expiration time policy?
-  lastUpdated: number;
-  /**
-   * Change number of the preloaded data.
-   * If this value is older than the current changeNumber at the storage, the data is not used to update the storage content.
-   */
-  since: number;
-  /**
-   * Map of feature flags to their stringified definitions.
-   */
-  splitsData: {
-    [splitName: string]: string;
-  };
-  /**
-   * Optional map of user keys to their list of segments.
-   */
-  mySegmentsData?: {
-    [key: string]: string[];
-  };
-  /**
-   * Optional map of segments to their stringified definitions.
-   * This property is ignored if `mySegmentsData` was provided.
-   */
-  segmentsData?: {
-    [segmentName: string]: string;
-  };
-}

package/src/utils/env/isLocalStorageAvailable.ts

@@ -1,32 +1,11 @@
+/* eslint-disable no-undef */
 export function isLocalStorageAvailable(): boolean {
-  try {
-    // eslint-disable-next-line no-undef
-    return isValidStorageWrapper(localStorage);
-  } catch (e) {
-    return false;
-  }
-}
-
-export function isValidStorageWrapper(wrapper: any): boolean {
   var mod = '__SPLITSOFTWARE__';
   try {
-    wrapper.setItem(mod, mod);
-    wrapper.getItem(mod);
-    wrapper.removeItem(mod);
+    localStorage.setItem(mod, mod);
+    localStorage.removeItem(mod);
     return true;
   } catch (e) {
     return false;
   }
 }
-
-export function isWebStorage(wrapper: any): boolean {
-  if (typeof wrapper.length === 'number') {
-    try {
-      wrapper.key(0);
-      return true;
-    } catch (e) {
-      return false;
-    }
-  }
-  return false;
-}

package/src/utils/settingsValidation/storage/storageCS.ts

@@ -8,7 +8,7 @@ import { IStorageFactoryParams, IStorageSync } from '../../../storages/types';
 
 export function __InLocalStorageMockFactory(params: IStorageFactoryParams): IStorageSync {
   const result = InMemoryStorageCSFactory(params);
-  result.validateCache = () => Promise.resolve(true); // to emit SDK_READY_FROM_CACHE
+  result.validateCache = () => true; // to emit SDK_READY_FROM_CACHE
   return result;
 }
 __InLocalStorageMockFactory.type = STORAGE_MEMORY;

package/types/splitio.d.ts

@@ -350,6 +350,10 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
    * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#localhost-mode}
    */
   features?: SplitIO.MockedFeaturesMap;
+  /**
+   * Data to initialize the SDK storage with. If provided and valid, the SDK will be ready from cache immediately.
+   */
+  preloadedData?: SplitIO.PreloadedData;
   /**
    * SDK Startup settings.
    */
@@ -458,36 +462,6 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
  */
 declare namespace SplitIO {
 
-  interface SyncStorageWrapper {
-    /**
-     * Returns the value associated with the given key, or null if the key does not exist.
-     */
-    getItem(key: string): string | null;
-    /**
-     * Sets the value for the given key, creating a new key/value pair if key does not exist.
-     */
-    setItem(key: string, value: string): void;
-    /**
-     * Removes the key/value pair for the given key, if the key exists.
-     */
-    removeItem(key: string): void;
-  }
-
-  interface AsyncStorageWrapper {
-    /**
-     * Returns a promise that resolves to the value associated with the given key, or null if the key does not exist.
-     */
-    getItem(key: string): Promise<string | null>;
-    /**
-     * Returns a promise that resolves when the value of the pair identified by key is set to value, creating a new key/value pair if key does not exist.
-     */
-    setItem(key: string, value: string): Promise<void>;
-    /**
-     * Returns a promise that resolves when the key/value pair for the given key is removed, if the key exists.
-     */
-    removeItem(key: string): Promise<void>;
-  }
-
   /**
    * EventEmitter interface based on a subset of the Node.js EventEmitter methods.
    */
@@ -585,6 +559,7 @@ declare namespace SplitIO {
       eventsFirstPushWindow: number;
     };
     readonly storage: StorageSyncFactory | StorageAsyncFactory | StorageOptions;
+    readonly preloadedData?: SplitIO.PreloadedData;
     readonly urls: {
       events: string;
       sdk: string;
@@ -1002,12 +977,6 @@ declare namespace SplitIO {
      * @defaultValue `false`
      */
     clearOnInit?: boolean;
-    /**
-     * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
-     *
-     * @defaultValue `window.localStorage`
-     */
-    wrapper?: SyncStorageWrapper | AsyncStorageWrapper;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1057,6 +1026,40 @@ declare namespace SplitIO {
     prefix?: string;
     options?: Object;
   }
+  /**
+   * Defines the format of rollout plan data to preload the factory storage (cache).
+   */
+  type PreloadedData = {
+    /**
+     * Change number of feature flags.
+     */
+    since: number;
+    /**
+     * List of feature flags.
+     */
+    flags: Object[],
+    /**
+     * Change number of rule-based segments.
+     */
+    rbSince?: number,
+    /**
+     * List of rule-based segments.
+     */
+    rbSegments?: Object[],
+    /**
+     * Optional map of user keys to their memberships.
+     */
+    memberships?: {
+      [key: string]: Object
+    },
+    /**
+     * Optional map of segments to their list of keys.
+     * This property is ignored if `memberships` is provided.
+     */
+    segments?: {
+      [segmentName: string]: string[]
+    },
+  }
   /**
    * Impression listener interface. This is the interface that needs to be implemented
    * by the element you provide to the SDK as impression listener.
@@ -1348,12 +1351,6 @@ declare namespace SplitIO {
        * @defaultValue `false`
        */
       clearOnInit?: boolean;
-      /**
-       * Optional storage wrapper to persist rollout plan related data. If not provided, the SDK will use the default localStorage Web API.
-       *
-       * @defaultValue `window.localStorage`
-       */
-      wrapper?: SyncStorageWrapper | AsyncStorageWrapper;
     };
   }
   /**
@@ -1606,6 +1603,13 @@ declare namespace SplitIO {
      * @returns The manager instance.
      */
     manager(): IManager;
+    /**
+     * Returns the current snapshot of the SDK rollout plan in cache.
+     *
+     * @param keys - Optional list of keys to generate the rollout plan snapshot with the memberships of the given keys, rather than the complete segments data.
+     * @returns The current snapshot of the SDK rollout plan.
+     */
+    getCache(keys?: SplitKey[]): PreloadedData,
   }
   /**
    * This represents the interface for the SDK instance for server-side with asynchronous storage.

package/cjs/storages/inLocalStorage/storageAdapter.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.storageAdapter = void 0;
-var constants_1 = require("./constants");
-function storageAdapter(log, prefix, wrapper) {
-    var keys = [];
-    var cache = {};
-    var loadPromise;
-    var savePromise = Promise.resolve();
-    return {
-        load: function () {
-            return loadPromise || (loadPromise = Promise.resolve().then(function () {
-                return wrapper.getItem(prefix);
-            }).then(function (storedCache) {
-                cache = JSON.parse(storedCache || '{}');
-                keys = Object.keys(cache);
-            }).catch(function (e) {
-                log.error(constants_1.LOG_PREFIX + 'Rejected promise calling wrapper `getItem` method, with error: ' + e);
-            }));
-        },
-        save: function () {
-            return savePromise = savePromise.then(function () {
-                return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
-            }).catch(function (e) {
-                log.error(constants_1.LOG_PREFIX + 'Rejected promise calling wrapper `setItem` method, with error: ' + e);
-            });
-        },
-        whenSaved: function () {
-            return savePromise;
-        },
-        get length() {
-            return keys.length;
-        },
-        getItem: function (key) {
-            return cache[key] || null;
-        },
-        key: function (index) {
-            return keys[index] || null;
-        },
-        removeItem: function (key) {
-            var index = keys.indexOf(key);
-            if (index === -1)
-                return;
-            keys.splice(index, 1);
-            delete cache[key];
-        },
-        setItem: function (key, value) {
-            if (keys.indexOf(key) === -1)
-                keys.push(key);
-            cache[key] = value;
-        }
-    };
-}
-exports.storageAdapter = storageAdapter;

package/esm/storages/inLocalStorage/storageAdapter.js

@@ -1,50 +0,0 @@
-import { LOG_PREFIX } from './constants';
-export function storageAdapter(log, prefix, wrapper) {
-    var keys = [];
-    var cache = {};
-    var loadPromise;
-    var savePromise = Promise.resolve();
-    return {
-        load: function () {
-            return loadPromise || (loadPromise = Promise.resolve().then(function () {
-                return wrapper.getItem(prefix);
-            }).then(function (storedCache) {
-                cache = JSON.parse(storedCache || '{}');
-                keys = Object.keys(cache);
-            }).catch(function (e) {
-                log.error(LOG_PREFIX + 'Rejected promise calling wrapper `getItem` method, with error: ' + e);
-            }));
-        },
-        save: function () {
-            return savePromise = savePromise.then(function () {
-                return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
-            }).catch(function (e) {
-                log.error(LOG_PREFIX + 'Rejected promise calling wrapper `setItem` method, with error: ' + e);
-            });
-        },
-        whenSaved: function () {
-            return savePromise;
-        },
-        get length() {
-            return keys.length;
-        },
-        getItem: function (key) {
-            return cache[key] || null;
-        },
-        key: function (index) {
-            return keys[index] || null;
-        },
-        removeItem: function (key) {
-            var index = keys.indexOf(key);
-            if (index === -1)
-                return;
-            keys.splice(index, 1);
-            delete cache[key];
-        },
-        setItem: function (key, value) {
-            if (keys.indexOf(key) === -1)
-                keys.push(key);
-            cache[key] = value;
-        }
-    };
-}

package/src/storages/inLocalStorage/storageAdapter.ts

@@ -1,62 +0,0 @@
-import { ILogger } from '../../logger/types';
-import SplitIO from '../../../types/splitio';
-import { LOG_PREFIX } from './constants';
-import { StorageAdapter } from '../types';
-
-
-export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.SyncStorageWrapper | SplitIO.AsyncStorageWrapper): Required<StorageAdapter> {
-  let keys: string[] = [];
-  let cache: Record<string, string> = {};
-
-  let loadPromise: Promise<void> | undefined;
-  let savePromise = Promise.resolve();
-
-  return {
-    load() {
-      return loadPromise || (loadPromise = Promise.resolve().then(() => {
-        return wrapper.getItem(prefix);
-      }).then((storedCache) => {
-        cache = JSON.parse(storedCache || '{}');
-        keys = Object.keys(cache);
-      }).catch((e) => {
-        log.error(LOG_PREFIX + 'Rejected promise calling wrapper `getItem` method, with error: ' + e);
-      }));
-    },
-
-    save() {
-      return savePromise = savePromise.then(() => {
-        return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
-      }).catch((e) => {
-        log.error(LOG_PREFIX + 'Rejected promise calling wrapper `setItem` method, with error: ' + e);
-      });
-    },
-
-    whenSaved() {
-      return savePromise;
-    },
-
-    get length() {
-      return keys.length;
-    },
-
-    getItem(key: string) {
-      return cache[key] || null;
-    },
-
-    key(index: number) {
-      return keys[index] || null;
-    },
-
-    removeItem(key: string) {
-      const index = keys.indexOf(key);
-      if (index === -1) return;
-      keys.splice(index, 1);
-      delete cache[key];
-    },
-
-    setItem(key: string, value: string) {
-      if (keys.indexOf(key) === -1) keys.push(key);
-      cache[key] = value;
-    }
-  };
-}