@splitsoftware/splitio-commons 2.1.0-rc.1 → 2.1.0

package/src/trackers/uniqueKeysTracker.ts

@@ -10,7 +10,7 @@ const noopFilterAdapter = {
 };
 
 /**
- * Trackes uniques keys
+ * Tracks uniques keys
  * Unique Keys Tracker will be in charge of checking if the MTK was already sent to the BE in the last period
  * or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
  *

package/src/utils/constants/browser.ts

@@ -0,0 +1,2 @@
+// This value might be eventually set via a config parameter
+export const DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days

package/src/utils/lang/index.ts

@@ -120,7 +120,7 @@ export function isBoolean(val: any): boolean {
  * Unlike `Number.isFinite`, it also tests Number object instances.
  * Unlike global `isFinite`, it returns false if the value is not a number or Number object instance.
  */
-export function isFiniteNumber(val: any): val is number {
+export function isFiniteNumber(val: any): boolean {
   if (val instanceof Number) val = val.valueOf();
   return typeof val === 'number' ?
     Number.isFinite ? Number.isFinite(val) : isFinite(val) :

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 = () => true; // to emit SDK_READY_FROM_CACHE
+  result.splits.checkCache = () => true; // to emit SDK_READY_FROM_CACHE
   return result;
 }
 __InLocalStorageMockFactory.type = STORAGE_MEMORY;

package/types/splitio.d.ts

@@ -862,6 +862,10 @@ declare namespace SplitIO {
      * The default treatment of the feature flag.
      */
     defaultTreatment: string;
+    /**
+     * Whether the feature flag has impressions tracking disabled or not.
+     */
+    impressionsDisabled: boolean;
   };
   /**
    * A promise that resolves to a feature flag view or null if the feature flag is not found.
@@ -906,18 +910,6 @@ declare namespace SplitIO {
      * @defaultValue `'SPLITIO'`
      */
     prefix?: string;
-    /**
-     * Number of days before cached data expires if it was not updated. If cache expires, it is cleared on initialization.
-     *
-     * @defaultValue `10`
-     */
-    expirationDays?: number;
-    /**
-     * Optional settings to clear the cache. If set to `true`, the SDK clears the cached data on initialization, unless the cache was cleared within the last 24 hours.
-     *
-     * @defaultValue `false`
-     */
-    clearOnInit?: boolean;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1241,23 +1233,11 @@ declare namespace SplitIO {
        */
       type?: BrowserStorage;
       /**
-       * Optional prefix to prevent any kind of data collision between SDK versions when using 'LOCALSTORAGE'.
+       * Optional prefix to prevent any kind of data collision between SDK versions.
        *
        * @defaultValue `'SPLITIO'`
        */
       prefix?: string;
-      /**
-       * Optional settings for the 'LOCALSTORAGE' storage type. It specifies the number of days before cached data expires if it was not updated. If cache expires, it is cleared on initialization.
-       *
-       * @defaultValue `10`
-       */
-      expirationDays?: number;
-      /**
-       * Optional settings for the 'LOCALSTORAGE' storage type. If set to `true`, the SDK clears the cached data on initialization, unless the cache was cleared within the last 24 hours.
-       *
-       * @defaultValue `false`
-       */
-      clearOnInit?: boolean;
     };
   }
   /**

package/cjs/storages/inLocalStorage/validateCache.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCache = void 0;
-var lang_1 = require("../../utils/lang");
-var KeyBuilder_1 = require("../KeyBuilder");
-var constants_1 = require("./constants");
-var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
-var MILLIS_IN_A_DAY = 86400000;
-/**
- * Validates if cache should be cleared and sets the cache `hash` if needed.
- *
- * @returns `true` if cache should be cleared, `false` otherwise
- */
-function validateExpiration(options, settings, keys, currentTimestamp, isThereCache) {
-    var log = settings.log;
-    // Check expiration
-    var lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()), 10);
-    if (!(0, lang_1.isNaNNumber)(lastUpdatedTimestamp)) {
-        var cacheExpirationInDays = (0, lang_1.isFiniteNumber)(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
-        var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
-        if (lastUpdatedTimestamp < expirationTimestamp) {
-            log.info(constants_1.LOG_PREFIX + 'Cache expired more than ' + cacheExpirationInDays + ' days ago. Cleaning up cache');
-            return true;
-        }
-    }
-    // Check hash
-    var storageHashKey = keys.buildHashKey();
-    var storageHash = localStorage.getItem(storageHashKey);
-    var currentStorageHash = (0, KeyBuilder_1.getStorageHash)(settings);
-    if (storageHash !== currentStorageHash) {
-        try {
-            localStorage.setItem(storageHashKey, currentStorageHash);
-        }
-        catch (e) {
-            log.error(constants_1.LOG_PREFIX + e);
-        }
-        if (isThereCache) {
-            log.info(constants_1.LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
-            return true;
-        }
-        return false; // No cache to clear
-    }
-    // Clear on init
-    if (options.clearOnInit) {
-        var lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()), 10);
-        if ((0, lang_1.isNaNNumber)(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
-            log.info(constants_1.LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
-            return true;
-        }
-    }
-}
-/**
- * Clean cache if:
- * - it has expired, i.e., its `lastUpdated` timestamp is older than the given `expirationTimestamp`
- * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
- * - `clearOnInit` was set and cache was not cleared in the last 24 hours
- *
- * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
- */
-function validateCache(options, settings, keys, splits, segments, largeSegments) {
-    var currentTimestamp = Date.now();
-    var isThereCache = splits.getChangeNumber() > -1;
-    if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
-        splits.clear();
-        segments.clear();
-        largeSegments.clear();
-        // Update last clear timestamp
-        try {
-            localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
-        }
-        catch (e) {
-            settings.log.error(constants_1.LOG_PREFIX + e);
-        }
-        return false;
-    }
-    // Check if ready from cache
-    return isThereCache;
-}
-exports.validateCache = validateCache;

package/esm/storages/inLocalStorage/validateCache.js

@@ -1,75 +0,0 @@
-import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
-import { getStorageHash } from '../KeyBuilder';
-import { LOG_PREFIX } from './constants';
-var DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
-var MILLIS_IN_A_DAY = 86400000;
-/**
- * Validates if cache should be cleared and sets the cache `hash` if needed.
- *
- * @returns `true` if cache should be cleared, `false` otherwise
- */
-function validateExpiration(options, settings, keys, currentTimestamp, isThereCache) {
-    var log = settings.log;
-    // Check expiration
-    var lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()), 10);
-    if (!isNaNNumber(lastUpdatedTimestamp)) {
-        var cacheExpirationInDays = isFiniteNumber(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
-        var expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
-        if (lastUpdatedTimestamp < expirationTimestamp) {
-            log.info(LOG_PREFIX + 'Cache expired more than ' + cacheExpirationInDays + ' days ago. Cleaning up cache');
-            return true;
-        }
-    }
-    // Check hash
-    var storageHashKey = keys.buildHashKey();
-    var storageHash = localStorage.getItem(storageHashKey);
-    var currentStorageHash = getStorageHash(settings);
-    if (storageHash !== currentStorageHash) {
-        try {
-            localStorage.setItem(storageHashKey, currentStorageHash);
-        }
-        catch (e) {
-            log.error(LOG_PREFIX + e);
-        }
-        if (isThereCache) {
-            log.info(LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
-            return true;
-        }
-        return false; // No cache to clear
-    }
-    // Clear on init
-    if (options.clearOnInit) {
-        var lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()), 10);
-        if (isNaNNumber(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
-            log.info(LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
-            return true;
-        }
-    }
-}
-/**
- * Clean cache if:
- * - it has expired, i.e., its `lastUpdated` timestamp is older than the given `expirationTimestamp`
- * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
- * - `clearOnInit` was set and cache was not cleared in the last 24 hours
- *
- * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
- */
-export function validateCache(options, settings, keys, splits, segments, largeSegments) {
-    var currentTimestamp = Date.now();
-    var isThereCache = splits.getChangeNumber() > -1;
-    if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
-        splits.clear();
-        segments.clear();
-        largeSegments.clear();
-        // Update last clear timestamp
-        try {
-            localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
-        }
-        catch (e) {
-            settings.log.error(LOG_PREFIX + e);
-        }
-        return false;
-    }
-    // Check if ready from cache
-    return isThereCache;
-}

package/src/storages/inLocalStorage/validateCache.ts

@@ -1,91 +0,0 @@
-import { ISettings } from '../../types';
-import { isFiniteNumber, isNaNNumber } from '../../utils/lang';
-import { getStorageHash } from '../KeyBuilder';
-import { LOG_PREFIX } from './constants';
-import type { SplitsCacheInLocal } from './SplitsCacheInLocal';
-import type { MySegmentsCacheInLocal } from './MySegmentsCacheInLocal';
-import { KeyBuilderCS } from '../KeyBuilderCS';
-import SplitIO from '../../../types/splitio';
-
-const DEFAULT_CACHE_EXPIRATION_IN_DAYS = 10;
-const MILLIS_IN_A_DAY = 86400000;
-
-/**
- * Validates if cache should be cleared and sets the cache `hash` if needed.
- *
- * @returns `true` if cache should be cleared, `false` otherwise
- */
-function validateExpiration(options: SplitIO.InLocalStorageOptions, settings: ISettings, keys: KeyBuilderCS, currentTimestamp: number, isThereCache: boolean) {
-  const { log } = settings;
-
-  // Check expiration
-  const lastUpdatedTimestamp = parseInt(localStorage.getItem(keys.buildLastUpdatedKey()) as string, 10);
-  if (!isNaNNumber(lastUpdatedTimestamp)) {
-    const cacheExpirationInDays = isFiniteNumber(options.expirationDays) && options.expirationDays >= 1 ? options.expirationDays : DEFAULT_CACHE_EXPIRATION_IN_DAYS;
-    const expirationTimestamp = currentTimestamp - MILLIS_IN_A_DAY * cacheExpirationInDays;
-    if (lastUpdatedTimestamp < expirationTimestamp) {
-      log.info(LOG_PREFIX + 'Cache expired more than ' + cacheExpirationInDays + ' days ago. Cleaning up cache');
-      return true;
-    }
-  }
-
-  // Check hash
-  const storageHashKey = keys.buildHashKey();
-  const storageHash = localStorage.getItem(storageHashKey);
-  const currentStorageHash = getStorageHash(settings);
-
-  if (storageHash !== currentStorageHash) {
-    try {
-      localStorage.setItem(storageHashKey, currentStorageHash);
-    } catch (e) {
-      log.error(LOG_PREFIX + e);
-    }
-    if (isThereCache) {
-      log.info(LOG_PREFIX + 'SDK key, flags filter criteria, or flags spec version has changed. Cleaning up cache');
-      return true;
-    }
-    return false; // No cache to clear
-  }
-
-  // Clear on init
-  if (options.clearOnInit) {
-    const lastClearTimestamp = parseInt(localStorage.getItem(keys.buildLastClear()) as string, 10);
-
-    if (isNaNNumber(lastClearTimestamp) || lastClearTimestamp < currentTimestamp - MILLIS_IN_A_DAY) {
-      log.info(LOG_PREFIX + 'clearOnInit was set and cache was not cleared in the last 24 hours. Cleaning up cache');
-      return true;
-    }
-  }
-}
-
-/**
- * Clean cache if:
- * - it has expired, i.e., its `lastUpdated` timestamp is older than the given `expirationTimestamp`
- * - its hash has changed, i.e., the SDK key, flags filter criteria or flags spec version was modified
- * - `clearOnInit` was set and cache was not cleared in the last 24 hours
- *
- * @returns `true` if cache is ready to be used, `false` otherwise (cache was cleared or there is no cache)
- */
-export function validateCache(options: SplitIO.InLocalStorageOptions, settings: ISettings, keys: KeyBuilderCS, splits: SplitsCacheInLocal, segments: MySegmentsCacheInLocal, largeSegments: MySegmentsCacheInLocal): boolean {
-
-  const currentTimestamp = Date.now();
-  const isThereCache = splits.getChangeNumber() > -1;
-
-  if (validateExpiration(options, settings, keys, currentTimestamp, isThereCache)) {
-    splits.clear();
-    segments.clear();
-    largeSegments.clear();
-
-    // Update last clear timestamp
-    try {
-      localStorage.setItem(keys.buildLastClear(), currentTimestamp + '');
-    } catch (e) {
-      settings.log.error(LOG_PREFIX + e);
-    }
-
-    return false;
-  }
-
-  // Check if ready from cache
-  return isThereCache;
-}