@splitsoftware/splitio-commons 1.6.2-rc.0 → 1.6.2-rc.1

package/types/trackers/filter/types.d.ts

@@ -0,0 +1,5 @@
+export interface IFilter {
+    add(data: string): boolean;
+    contains(data: string): boolean;
+    clear(): void;
+}

package/types/trackers/impressionsTracker.d.ts

@@ -1,7 +1,6 @@
-import { IImpressionCountsCacheSync, IImpressionsCacheBase, ITelemetryCacheSync, ITelemetryCacheAsync } from '../storages/types';
-import { IImpressionsHandler, IImpressionsTracker } from './types';
+import { IImpressionsCacheBase, ITelemetryCacheSync, ITelemetryCacheAsync } from '../storages/types';
+import { IImpressionsHandler, IImpressionsTracker, IStrategy } from './types';
 import { ISettings } from '../types';
-import { IImpressionObserver } from './impressionObserver/types';
 /**
  * Impressions tracker stores impressions in cache and pass them to the listener and integrations manager if provided.
  *
@@ -9,7 +8,6 @@ import { IImpressionObserver } from './impressionObserver/types';
  * @param metadata runtime metadata (ip, hostname and version)
  * @param impressionListener optional impression listener
  * @param integrationsManager optional integrations manager
- * @param observer optional impression observer. If provided, previous time (pt property) is included in impression instances
- * @param countsCache optional cache to save impressions count. If provided, impressions will be deduped (OPTIMIZED mode)
+ * @param strategy strategy for impressions tracking.
  */
-export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, integrationsManager?: IImpressionsHandler, observer?: IImpressionObserver, countsCache?: IImpressionCountsCacheSync, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IImpressionsTracker;
+export declare function impressionsTrackerFactory(settings: ISettings, impressionsCache: IImpressionsCacheBase, strategy: IStrategy, integrationsManager?: IImpressionsHandler, telemetryCache?: ITelemetryCacheSync | ITelemetryCacheAsync): IImpressionsTracker;

package/types/trackers/types.d.ts

@@ -2,6 +2,7 @@ import { SplitIO, ImpressionDTO } from '../types';
 import { StreamingEventType, Method, OperationType } from '../sync/submitters/types';
 import { IEventsCacheBase } from '../storages/types';
 import { NetworkError } from '../services/types';
+import { ISet } from '../utils/lang/sets';
 /** Events tracker */
 export interface IEventsHandler {
     handleEvent(eventData: SplitIO.EventData): any;
@@ -34,3 +35,31 @@ export interface ITelemetryTracker {
      */
     streamingEvent(e: StreamingEventType | AUTH_REJECTION, d?: number): void;
 }
+export interface IFilterAdapter {
+    add(featureName: string, key: string): boolean;
+    contains(featureName: string, key: string): boolean;
+    clear(): void;
+}
+export interface IImpressionSenderAdapter {
+    recordUniqueKeys(data: Object): void;
+    recordImpressionCounts(data: Object): void;
+}
+/** Unique keys tracker */
+export interface IUniqueKeysTracker {
+    track(featureName: string, key: string): void;
+    pop(toMerge?: {
+        [featureName: string]: ISet<string>;
+    }): {
+        [featureName: string]: ISet<string>;
+    };
+    clear(): void;
+    isEmpty(): boolean;
+}
+export interface IStrategyResult {
+    impressionsToStore: ImpressionDTO[];
+    impressionsToListener: ImpressionDTO[];
+    deduped: number;
+}
+export interface IStrategy {
+    process(impressions: ImpressionDTO[]): IStrategyResult;
+}

package/types/types.d.ts

@@ -74,6 +74,7 @@ export interface ISettings {
         featuresRefreshRate: number;
         impressionsRefreshRate: number;
         impressionsQueueSize: number;
+        uniqueKeysRefreshRate: number;
         /**
          * @deprecated
          */
@@ -715,7 +716,7 @@ export declare namespace SplitIO {
     * ImpressionsMode type
     * @typedef {string} ImpressionsMode
     */
-    type ImpressionsMode = 'OPTIMIZED' | 'DEBUG';
+    type ImpressionsMode = 'OPTIMIZED' | 'DEBUG' | 'NONE';
     /**
      * Defines the format of Split data to preload on the factory storage (cache).
      */

package/types/utils/constants/index.d.ts

@@ -11,6 +11,7 @@ export declare const SPLIT_IMPRESSION = "IMPRESSION";
 export declare const SPLIT_EVENT = "EVENT";
 export declare const DEBUG = "DEBUG";
 export declare const OPTIMIZED = "OPTIMIZED";
+export declare const NONE = "NONE";
 export declare const LOCALHOST_MODE: SDKMode;
 export declare const STANDALONE_MODE: SDKMode;
 export declare const PRODUCER_MODE = "producer";

package/types/utils/settingsValidation/index.d.ts

@@ -14,6 +14,7 @@ export declare const base: {
         segmentsRefreshRate: number;
         telemetryRefreshRate: number;
         impressionsRefreshRate: number;
+        uniqueKeysRefreshRate: number;
         offlineRefreshRate: number;
         eventsPushRate: number;
         eventsQueueSize: number;

package/types/utils/timeTracker/index.d.ts

@@ -1 +1,70 @@
-export declare function timeTracker(now: () => number): () => () => number;
+import { ILogger } from '../../logger/types';
+import { IResponse } from '../../services/types';
+interface MetricsCollector {
+    countException(): void;
+    count(status: number): void;
+    latency(ms: number): void;
+    ready(ms: number): void;
+    getTreatment(ms: number): void;
+    getTreatments(ms: number): void;
+    getTreatmentWithConfig(ms: number): void;
+    getTreatmentsWithConfig(ms: number): void;
+    [method: string]: (ms: number) => void;
+}
+export declare const TrackerAPI: {
+    /**
+     * "Private" method, used to attach count/countException and stop callbacks to a promise.
+     *
+     * @param {ILogger} log - Logger.
+     * @param {Promise} promise - The promise we want to attach the callbacks.
+     * @param {string} task - The name of the task.
+     * @param {number | string} modifier - (optional) The modifier for the task, if any.
+     */
+    __attachToPromise(log: ILogger, promise: Promise<IResponse>, task: string, collector: false | MetricsCollector, modifier?: string | number | undefined): Promise<IResponse>;
+    /**
+     * Starts tracking the time for a given task. All tasks tracked are considered "unique" because
+     * there may be multiple SDK instances tracking a "generic" task, making any task non-generic.
+     *
+     * @param {ILogger} log - Logger.
+     * @param {string} task - The task we are starting.
+     * @param {Object} collectors - The collectors map.
+     * @param {Promise} promise - (optional) The promise we are tracking.
+     * @return {Function | Promise} The stop function for this specific task or the promise received with the callbacks registered.
+     */
+    start(log: ILogger, task: string, collectors?: Record<string, MetricsCollector> | undefined, promise?: Promise<IResponse> | undefined, now?: (() => number) | undefined): Promise<IResponse> | (() => number);
+    /**
+     * Setup the collector for a task that reports metrics.
+     *
+     * @param {string} task - The task name
+     * @param {number | string} taskUniqueId - The unique identifier for this task
+     * @param {Object} collectors - The collectors map.
+     */
+    setCollectorForTask(task: string, taskUniqueId: number | string, collectors: Record<string, MetricsCollector>): void;
+    /**
+     * Stops the tracking of a given task.
+     *
+     * @param {ILogger} log - Logger.
+     * @param {string} task - The task we are starting.
+     * @param {number | string} modifier - (optional) The modifier for that specific task.
+     */
+    stop(log: ILogger, task: string, modifier?: string | number | undefined): number | undefined;
+    /**
+     * The constants shortcut for the task names.
+     */
+    TaskNames: {
+        SDK_READY: string;
+        SDK_GET_TREATMENT: string;
+        SDK_GET_TREATMENTS: string;
+        SDK_GET_TREATMENT_WITH_CONFIG: string;
+        SDK_GET_TREATMENTS_WITH_CONFIG: string;
+        SPLITS_READY: string;
+        SEGMENTS_READY: string;
+        METRICS_PUSH: string;
+        IMPRESSIONS_PUSH: string;
+        EVENTS_PUSH: string;
+        MY_SEGMENTS_FETCH: string;
+        SEGMENTS_FETCH: string;
+        SPLITS_FETCH: string;
+    };
+};
+export {};