@splitsoftware/splitio-commons 2.0.3-rc.0 → 2.1.0-rc.0

package/src/trackers/impressionsTracker.ts

@@ -9,11 +9,16 @@ import SplitIO from '../../types/splitio';
 
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
+ *
+ * @param impressionsCache - cache to save impressions
+ * @param metadata - runtime metadata (ip, hostname and version)
+ * @param impressionListener - optional impression listener
+ * @param integrationsManager - optional integrations manager
+ * @param strategy - strategy for impressions tracking.
  */
 export function impressionsTrackerFactory(
   settings: ISettings,
   impressionsCache: IImpressionsCacheBase,
-  noneStrategy: IStrategy,
   strategy: IStrategy,
   whenInit: (cb: () => void) => void,
   integrationsManager?: IImpressionsHandler,
@@ -23,44 +28,40 @@ export function impressionsTrackerFactory(
   const { log, impressionListener, runtime: { ip, hostname }, version } = settings;
 
   return {
-    track(impressions: [impression: SplitIO.ImpressionDTO, track?: boolean][], attributes?: SplitIO.Attributes) {
+    track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes) {
       if (settings.userConsent === CONSENT_DECLINED) return;
 
-      const impressionsToStore = impressions.filter(([impression, track]) => {
-        return track === false ?
-          noneStrategy.process(impression) :
-          strategy.process(impression);
-      });
+      const impressionsCount = impressions.length;
+      const { impressionsToStore, impressionsToListener, deduped } = strategy.process(impressions);
 
-      const impressionsLength = impressions.length;
-      const impressionsToStoreLength = impressionsToStore.length;
+      const impressionsToListenerCount = impressionsToListener.length;
 
-      if (impressionsToStoreLength) {
-        const res = impressionsCache.track(impressionsToStore.map((item) => item[0]));
+      if (impressionsToStore.length > 0) {
+        const res = impressionsCache.track(impressionsToStore);
 
         // If we're on an async storage, handle error and log it.
         if (thenable(res)) {
           res.then(() => {
-            log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsLength]);
+            log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsCount]);
           }).catch(err => {
-            log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsLength, err]);
+            log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsCount, err]);
           });
         } else {
           // Record when impressionsCache is sync only (standalone mode)
           // @TODO we are not dropping impressions on full queue yet, so DROPPED stats are not recorded
           if (telemetryCache) {
-            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(QUEUED, impressionsToStoreLength);
-            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, impressionsLength - impressionsToStoreLength);
+            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(QUEUED, impressionsToStore.length);
+            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, deduped);
           }
         }
       }
 
       // @TODO next block might be handled by the integration manager. In that case, the metadata object doesn't need to be passed in the constructor
       if (impressionListener || integrationsManager) {
-        for (let i = 0; i < impressionsLength; i++) {
+        for (let i = 0; i < impressionsToListenerCount; i++) {
           const impressionData: SplitIO.ImpressionData = {
-            // copy of impression, to avoid unexpected behaviour if modified by integrations or impressionListener
-            impression: objectAssign({}, impressions[i][0]),
+            // copy of impression, to avoid unexpected behavior if modified by integrations or impressionListener
+            impression: objectAssign({}, impressionsToListener[i]),
             attributes,
             ip,
             hostname,

package/src/trackers/strategy/strategyDebug.ts

@@ -6,16 +6,23 @@ import { IStrategy } from '../types';
  * Debug strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
  *
  * @param impressionsObserver - impression observer. Previous time (pt property) is included in impression instances
- * @returns Debug strategy
+ * @returns IStrategyResult
  */
 export function strategyDebugFactory(
   impressionsObserver: IImpressionObserver
 ): IStrategy {
 
   return {
-    process(impression: SplitIO.ImpressionDTO) {
-      impression.pt = impressionsObserver.testAndSet(impression);
-      return true;
+    process(impressions: SplitIO.ImpressionDTO[]) {
+      impressions.forEach((impression) => {
+        // Adds previous time if it is enabled
+        impression.pt = impressionsObserver.testAndSet(impression);
+      });
+      return {
+        impressionsToStore: impressions,
+        impressionsToListener: impressions,
+        deduped: 0
+      };
     }
   };
 }

package/src/trackers/strategy/strategyNone.ts

@@ -5,24 +5,30 @@ import { IStrategy, IUniqueKeysTracker } from '../types';
 /**
  * None strategy for impressions tracker.
  *
- * @param impressionCounts - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
  * @param uniqueKeysTracker - unique keys tracker in charge of tracking the unique keys per split.
- * @returns None strategy
+ * @returns IStrategyResult
  */
 export function strategyNoneFactory(
-  impressionCounts: IImpressionCountsCacheBase,
+  impressionsCounter: IImpressionCountsCacheBase,
   uniqueKeysTracker: IUniqueKeysTracker
 ): IStrategy {
 
   return {
-    process(impression: SplitIO.ImpressionDTO) {
-      const now = Date.now();
-      // Increments impression counter per featureName
-      impressionCounts.track(impression.feature, now, 1);
-      // Keep track by unique key
-      uniqueKeysTracker.track(impression.keyName, impression.feature);
-      // Do not store impressions
-      return false;
+    process(impressions: SplitIO.ImpressionDTO[]) {
+      impressions.forEach((impression) => {
+        const now = Date.now();
+        // Increments impression counter per featureName
+        impressionsCounter.track(impression.feature, now, 1);
+        // Keep track by unique key
+        uniqueKeysTracker.track(impression.keyName, impression.feature);
+      });
+
+      return {
+        impressionsToStore: [],
+        impressionsToListener: impressions,
+        deduped: 0
+      };
     }
   };
 }

package/src/trackers/strategy/strategyOptimized.ts

@@ -8,25 +8,35 @@ import { IStrategy } from '../types';
  * Optimized strategy for impressions tracker. Wraps impressions to store and adds previousTime if it corresponds
  *
  * @param impressionsObserver - impression observer. previous time (pt property) is included in impression instances
- * @param impressionCounts - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @returns Optimized strategy
+ * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @returns IStrategyResult
  */
 export function strategyOptimizedFactory(
   impressionsObserver: IImpressionObserver,
-  impressionCounts: IImpressionCountsCacheBase,
+  impressionsCounter: IImpressionCountsCacheBase,
 ): IStrategy {
 
   return {
-    process(impression: SplitIO.ImpressionDTO) {
-      impression.pt = impressionsObserver.testAndSet(impression);
+    process(impressions: SplitIO.ImpressionDTO[]) {
+      const impressionsToStore: SplitIO.ImpressionDTO[] = [];
+      impressions.forEach((impression) => {
+        impression.pt = impressionsObserver.testAndSet(impression);
 
-      const now = Date.now();
+        const now = Date.now();
 
-      // Increments impression counter per featureName
-      if (impression.pt) impressionCounts.track(impression.feature, now, 1);
+        // Increments impression counter per featureName
+        if (impression.pt) impressionsCounter.track(impression.feature, now, 1);
 
-      // Checks if the impression should be added in queue to be sent
-      return (!impression.pt || impression.pt < truncateTimeFrame(now)) ? true : false;
+        // Checks if the impression should be added in queue to be sent
+        if (!impression.pt || impression.pt < truncateTimeFrame(now)) {
+          impressionsToStore.push(impression);
+        }
+      });
+      return {
+        impressionsToStore: impressionsToStore,
+        impressionsToListener: impressions,
+        deduped: impressions.length - impressionsToStore.length
+      };
     }
   };
 }

package/src/trackers/types.ts

@@ -18,7 +18,7 @@ export interface IImpressionsHandler {
 }
 
 export interface IImpressionsTracker {
-  track(impressions: [impression: SplitIO.ImpressionDTO, track?: boolean][], attributes?: SplitIO.Attributes): void
+  track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes): void
 }
 
 /** Telemetry tracker */
@@ -70,6 +70,12 @@ export interface IUniqueKeysTracker {
   track(key: string, featureName: string): void;
 }
 
+export interface IStrategyResult {
+  impressionsToStore: SplitIO.ImpressionDTO[],
+  impressionsToListener: SplitIO.ImpressionDTO[],
+  deduped: number
+}
+
 export interface IStrategy {
-  process(impression:  SplitIO.ImpressionDTO): boolean
+  process(impressions:  SplitIO.ImpressionDTO[]): IStrategyResult
 }

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): boolean {
+export function isFiniteNumber(val: any): val is number {
   if (val instanceof Number) val = val.valueOf();
   return typeof val === 'number' ?
     Number.isFinite ? Number.isFinite(val) : isFinite(val) :

package/src/utils/settingsValidation/index.ts

@@ -159,7 +159,7 @@ export function settingsValidation(config: unknown, validationParams: ISettingsV
     if (withDefaults.mode === LOCALHOST_MODE && maybeKey === undefined) {
       withDefaults.core.key = 'localhost_key';
     } else {
-      // Keeping same behaviour than JS SDK: if settings key or TT are invalid,
+      // Keeping same behavior than JS SDK: if settings key or TT are invalid,
       // `false` value is used as bound key/TT of the default client, which leads to some issues.
       // @ts-ignore, @TODO handle invalid keys as a non-recoverable error?
       withDefaults.core.key = validateKey(log, maybeKey, LOG_PREFIX_CLIENT_INSTANTIATION);

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

package/types/index.d.ts

@@ -1,5 +1,5 @@
 // Declaration file for JavaScript Browser Split Software SDK
-// Project: http://www.split.io/
+// Project: https://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
 /// <reference path="./splitio.d.ts" />

package/types/splitio.d.ts

@@ -1,5 +1,5 @@
 // Type definitions for Split Software SDKs
-// Project: http://www.split.io/
+// Project: https://www.split.io/
 
 import { RedisOptions } from 'ioredis';
 import { RequestOptions } from 'http';
@@ -862,10 +862,6 @@ declare namespace SplitIO {
      * The default treatment of the feature flag.
      */
     defaultTreatment: string;
-    /**
-     * Whether the feature flag has impressions tracking enabled or not.
-     */
-    trackImpressions: boolean;
   };
   /**
    * A promise that resolves to a feature flag view or null if the feature flag is not found.
@@ -910,6 +906,18 @@ 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.
@@ -1233,11 +1241,23 @@ declare namespace SplitIO {
        */
       type?: BrowserStorage;
       /**
-       * Optional prefix to prevent any kind of data collision between SDK versions.
+       * Optional prefix to prevent any kind of data collision between SDK versions when using 'LOCALSTORAGE'.
        *
        * @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/utils/constants/browser.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_CACHE_EXPIRATION_IN_MILLIS = void 0;
-// This value might be eventually set via a config parameter
-exports.DEFAULT_CACHE_EXPIRATION_IN_MILLIS = 864000000; // 10 days

package/esm/utils/constants/browser.js

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

package/src/utils/constants/browser.ts

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