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

package/src/sync/submitters/uniqueKeysSubmitter.ts

@@ -19,10 +19,10 @@ export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
   const isClientSide = key !== undefined;
   const postUniqueKeysBulk = isClientSide ? postUniqueKeysBulkCs : postUniqueKeysBulkSs;
 
-  const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys!, UNIQUE_KEYS_RATE, DATA_NAME);
+  const syncTask = submitterFactory(log, postUniqueKeysBulk, uniqueKeys, UNIQUE_KEYS_RATE, DATA_NAME);
 
   // register unique keys submitter to be executed when uniqueKeys cache is full
-  uniqueKeys!.setOnFullQueueCb(() => {
+  uniqueKeys.setOnFullQueueCb(() => {
     if (syncTask.isRunning()) {
       log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
       syncTask.execute();
@@ -33,4 +33,3 @@ export function uniqueKeysSubmitterFactory(params: ISdkFactoryContextSync) {
 
   return syncTask;
 }
-

package/src/trackers/impressionsTracker.ts

@@ -1,7 +1,7 @@
 import { objectAssign } from '../utils/lang/objectAssign';
 import { thenable } from '../utils/promise/thenable';
 import { IImpressionsCacheBase, ITelemetryCacheSync, ITelemetryCacheAsync } from '../storages/types';
-import { IImpressionsHandler, IImpressionsTracker, IStrategy } from './types';
+import { IImpressionsHandler, IImpressionsTracker, ImpressionDecorated, IStrategy } from './types';
 import { ISettings } from '../types';
 import { IMPRESSIONS_TRACKER_SUCCESS, ERROR_IMPRESSIONS_TRACKER, ERROR_IMPRESSIONS_LISTENER } from '../logger/constants';
 import { CONSENT_DECLINED, DEDUPED, QUEUED } from '../utils/constants';
@@ -9,16 +9,11 @@ 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,
@@ -28,40 +23,44 @@ export function impressionsTrackerFactory(
   const { log, impressionListener, runtime: { ip, hostname }, version } = settings;
 
   return {
-    track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes) {
+    track(impressions: ImpressionDecorated[], attributes?: SplitIO.Attributes) {
       if (settings.userConsent === CONSENT_DECLINED) return;
 
-      const impressionsCount = impressions.length;
-      const { impressionsToStore, impressionsToListener, deduped } = strategy.process(impressions);
+      const impressionsToStore = impressions.filter(({ imp, disabled }) => {
+        return disabled ?
+          noneStrategy.process(imp) :
+          strategy.process(imp);
+      });
 
-      const impressionsToListenerCount = impressionsToListener.length;
+      const impressionsLength = impressions.length;
+      const impressionsToStoreLength = impressionsToStore.length;
 
-      if (impressionsToStore.length > 0) {
-        const res = impressionsCache.track(impressionsToStore);
+      if (impressionsToStoreLength) {
+        const res = impressionsCache.track(impressionsToStore.map((item) => item.imp));
 
         // If we're on an async storage, handle error and log it.
         if (thenable(res)) {
           res.then(() => {
-            log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsCount]);
+            log.info(IMPRESSIONS_TRACKER_SUCCESS, [impressionsLength]);
           }).catch(err => {
-            log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsCount, err]);
+            log.error(ERROR_IMPRESSIONS_TRACKER, [impressionsLength, 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, impressionsToStore.length);
-            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, deduped);
+            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(QUEUED, impressionsToStoreLength);
+            (telemetryCache as ITelemetryCacheSync).recordImpressionStats(DEDUPED, impressionsLength - impressionsToStoreLength);
           }
         }
       }
 
       // @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 < impressionsToListenerCount; i++) {
+        for (let i = 0; i < impressionsLength; i++) {
           const impressionData: SplitIO.ImpressionData = {
             // copy of impression, to avoid unexpected behavior if modified by integrations or impressionListener
-            impression: objectAssign({}, impressionsToListener[i]),
+            impression: objectAssign({}, impressions[i].imp),
             attributes,
             ip,
             hostname,

package/src/trackers/strategy/strategyDebug.ts

@@ -6,23 +6,16 @@ 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 IStrategyResult
+ * @returns Debug strategy
  */
 export function strategyDebugFactory(
   impressionsObserver: IImpressionObserver
 ): IStrategy {
 
   return {
-    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
-      };
+    process(impression: SplitIO.ImpressionDTO) {
+      impression.pt = impressionsObserver.testAndSet(impression);
+      return true;
     }
   };
 }

package/src/trackers/strategy/strategyNone.ts

@@ -5,30 +5,24 @@ import { IStrategy, IUniqueKeysTracker } from '../types';
 /**
  * None strategy for impressions tracker.
  *
- * @param impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @param impressionCounts - 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 IStrategyResult
+ * @returns None strategy
  */
 export function strategyNoneFactory(
-  impressionsCounter: IImpressionCountsCacheBase,
+  impressionCounts: IImpressionCountsCacheBase,
   uniqueKeysTracker: IUniqueKeysTracker
 ): IStrategy {
 
   return {
-    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
-      };
+    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;
     }
   };
 }

package/src/trackers/strategy/strategyOptimized.ts

@@ -8,35 +8,25 @@ 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 impressionsCounter - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
- * @returns IStrategyResult
+ * @param impressionCounts - cache to save impressions count. impressions will be deduped (OPTIMIZED mode)
+ * @returns Optimized strategy
  */
 export function strategyOptimizedFactory(
   impressionsObserver: IImpressionObserver,
-  impressionsCounter: IImpressionCountsCacheBase,
+  impressionCounts: IImpressionCountsCacheBase,
 ): IStrategy {
 
   return {
-    process(impressions: SplitIO.ImpressionDTO[]) {
-      const impressionsToStore: SplitIO.ImpressionDTO[] = [];
-      impressions.forEach((impression) => {
-        impression.pt = impressionsObserver.testAndSet(impression);
+    process(impression: SplitIO.ImpressionDTO) {
+      impression.pt = impressionsObserver.testAndSet(impression);
 
-        const now = Date.now();
+      const now = Date.now();
 
-        // Increments impression counter per featureName
-        if (impression.pt) impressionsCounter.track(impression.feature, now, 1);
+      // Increments impression counter per featureName
+      if (impression.pt) impressionCounts.track(impression.feature, now, 1);
 
-        // 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
-      };
+      // Checks if the impression should be added in queue to be sent
+      return (!impression.pt || impression.pt < truncateTimeFrame(now)) ? true : false;
     }
   };
 }

package/src/trackers/types.ts

@@ -17,8 +17,19 @@ export interface IImpressionsHandler {
   handleImpression(impressionData: SplitIO.ImpressionData): any
 }
 
+export type ImpressionDecorated = {
+  /**
+   * Impression DTO
+   */
+  imp: SplitIO.ImpressionDTO,
+  /**
+   * Whether the impression should be tracked or not
+   */
+  disabled?: boolean
+};
+
 export interface IImpressionsTracker {
-  track(impressions: SplitIO.ImpressionDTO[], attributes?: SplitIO.Attributes): void
+  track(impressions: ImpressionDecorated[], attributes?: SplitIO.Attributes): void
 }
 
 /** Telemetry tracker */
@@ -70,12 +81,6 @@ export interface IUniqueKeysTracker {
   track(key: string, featureName: string): void;
 }
 
-export interface IStrategyResult {
-  impressionsToStore: SplitIO.ImpressionDTO[],
-  impressionsToListener: SplitIO.ImpressionDTO[],
-  deduped: number
-}
-
 export interface IStrategy {
-  process(impressions:  SplitIO.ImpressionDTO[]): IStrategyResult
+  process(impression:  SplitIO.ImpressionDTO): boolean
 }

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.