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

package/types/sync/submitters/telemetrySubmitter.d.ts

@@ -5,7 +5,7 @@ import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 /**
  * Converts data from telemetry cache into /metrics/usage request payload.
  */
-export declare function telemetryCacheStatsAdapter(telemetry: ITelemetryCacheSync, splits: ISplitsCacheSync, segments: ISegmentsCacheSync): {
+export declare function telemetryCacheStatsAdapter(telemetry: ITelemetryCacheSync, splits?: ISplitsCacheSync, segments?: ISegmentsCacheSync): {
     isEmpty(): boolean;
     clear(): void;
     pop(): TelemetryUsageStatsPayload;

package/types/sync/submitters/types.d.ts

@@ -1,5 +1,6 @@
 import { IMetadata } from '../../dtos/types';
 import { SplitIO } from '../../types';
+import { IMap } from '../../utils/lang/maps';
 import { ISyncTask } from '../types';
 export declare type ImpressionsPayload = {
     /** Split name */
@@ -75,6 +76,9 @@ export declare type StoredEventWithMetadata = {
     /** Stored event */
     e: SplitIO.EventData;
 };
+export declare type MultiMethodLatencies = IMap<string, MethodLatencies>;
+export declare type MultiMethodExceptions = IMap<string, MethodExceptions>;
+export declare type MultiConfigs = IMap<string, TelemetryConfigStats>;
 /**
  * Telemetry usage stats
  */
@@ -119,10 +123,12 @@ export declare type StreamingEvent = {
     d?: number;
     t: number;
 };
-export declare type TelemetryUsageStatsPayload = {
+export declare type TelemetryUsageStats = {
+    mL?: MethodLatencies;
+    mE?: MethodExceptions;
+};
+export declare type TelemetryUsageStatsPayload = TelemetryUsageStats & {
     lS: LastSync;
-    mL: MethodLatencies;
-    mE: MethodExceptions;
     hE: HttpErrors;
     hL: HttpLatencies;
     tR: number;
@@ -130,9 +136,9 @@ export declare type TelemetryUsageStatsPayload = {
     iQ: number;
     iDe: number;
     iDr: number;
-    spC: number;
-    seC: number;
-    skC: number;
+    spC?: number;
+    seC?: number;
+    skC?: number;
     sL?: number;
     eQ: number;
     eD: number;

package/types/sync/submitters/uniqueKeysSubmitter.d.ts

@@ -1,18 +1,4 @@
 import { ISdkFactoryContextSync } from '../../sdkFactory/types';
-import { ISet } from '../../utils/lang/sets';
-import { UniqueKeysPayloadCs, UniqueKeysPayloadSs } from './types';
-/**
- * Converts `uniqueKeys` data from cache into request payload for CS.
- */
-export declare function fromUniqueKeysCollectorCs(uniqueKeys: {
-    [featureName: string]: ISet<string>;
-}): UniqueKeysPayloadCs;
-/**
- * Converts `uniqueKeys` data from cache into request payload for SS.
- */
-export declare function fromUniqueKeysCollectorSs(uniqueKeys: {
-    [featureName: string]: ISet<string>;
-}): UniqueKeysPayloadSs;
 /**
  * Submitter that periodically posts impression counts
  */

package/types/trackers/types.d.ts

@@ -2,7 +2,6 @@ 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,11 +33,16 @@ export interface ITelemetryTracker {
      * Records streaming event
      */
     streamingEvent(e: StreamingEventType | AUTH_REJECTION, d?: number): void;
+    /**
+     * Records tag
+     */
+    addTag(tag: string): void;
 }
 export interface IFilterAdapter {
-    add(featureName: string, key: string): boolean;
-    contains(featureName: string, key: string): boolean;
+    add(key: string, featureName: string): boolean;
+    contains(key: string, featureName: string): boolean;
     clear(): void;
+    refreshRate?: number;
 }
 export interface IImpressionSenderAdapter {
     recordUniqueKeys(data: Object): void;
@@ -46,14 +50,8 @@ export interface IImpressionSenderAdapter {
 }
 /** 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;
+    stop(): void;
+    track(key: string, featureName: string): void;
 }
 export interface IStrategyResult {
     impressionsToStore: ImpressionDTO[];

package/types/trackers/uniqueKeysTracker.d.ts

@@ -1,4 +1,5 @@
 import { ILogger } from '../logger/types';
+import { IUniqueKeysCacheBase } from '../storages/types';
 import { IFilterAdapter, IUniqueKeysTracker } from './types';
 /**
  * Trackes uniques keys
@@ -6,8 +7,7 @@ import { IFilterAdapter, IUniqueKeysTracker } from './types';
  *  or schedule to be sent; if not it will be added in an internal cache and sent in the next post.
  *
  * @param log Logger instance
+ * @param uniqueKeysCache cache to save unique keys
  * @param filterAdapter filter adapter
- * @param cacheSize optional internal cache size
- * @param maxBulkSize optional max MTKs bulk size
  */
-export declare function uniqueKeysTrackerFactory(log: ILogger, filterAdapter?: IFilterAdapter, cacheSize?: number): IUniqueKeysTracker;
+export declare function uniqueKeysTrackerFactory(log: ILogger, uniqueKeysCache: IUniqueKeysCacheBase, filterAdapter?: IFilterAdapter): IUniqueKeysTracker;

package/types/types.d.ts

@@ -74,7 +74,6 @@ export interface ISettings {
         featuresRefreshRate: number;
         impressionsRefreshRate: number;
         impressionsQueueSize: number;
-        uniqueKeysRefreshRate: number;
         /**
          * @deprecated
          */

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

@@ -32,6 +32,7 @@ export declare const CONSUMER_ENUM = 1;
 export declare const CONSUMER_PARTIAL_ENUM = 2;
 export declare const OPTIMIZED_ENUM = 0;
 export declare const DEBUG_ENUM = 1;
+export declare const NONE_ENUM = 2;
 export declare const SPLITS = "sp";
 export declare const IMPRESSIONS = "im";
 export declare const IMPRESSIONS_COUNT = "ic";

package/types/utils/lang/maps.d.ts

@@ -23,10 +23,12 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 **/
 export interface IMap<K, V> {
-    set(key: K, value: V): this;
     clear(): void;
     delete(key: K): boolean;
+    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
     get(key: K): V | undefined;
+    has(key: K): boolean;
+    set(key: K, value: V): this;
     readonly size: number;
 }
 export declare class MapPoly<K, V> implements IMap<K, V> {
@@ -34,9 +36,11 @@ export declare class MapPoly<K, V> implements IMap<K, V> {
     private __mapValuesData__;
     constructor(entries?: readonly (readonly [K, V])[] | null);
     clear(): void;
-    set(key: K, value: V): this;
     delete(key: K): boolean;
+    forEach(callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any): void;
     get(key: K): V | undefined;
+    has(key: K): boolean;
+    set(key: K, value: V): this;
     get size(): number;
 }
 interface IMapConstructor {

package/types/utils/redis/RedisMock.d.ts

@@ -0,0 +1,4 @@
+export declare class RedisMock {
+    private pipelineMethods;
+    constructor();
+}

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

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

package/types/sdkClient/types.d.ts

@@ -1,18 +0,0 @@
-import { ISignalListener } from '../listeners/types';
-import { ISdkReadinessManager } from '../readiness/types';
-import { IStorageAsync, IStorageSync } from '../storages/types';
-import { ISyncManager } from '../sync/types';
-import { IEventTracker, IImpressionsTracker } from '../trackers/types';
-import { ISettings } from '../types';
-export interface IClientFactoryParams {
-    storage: IStorageSync | IStorageAsync;
-    sdkReadinessManager: ISdkReadinessManager;
-    settings: ISettings;
-    impressionsTracker: IImpressionsTracker;
-    eventTracker: IEventTracker;
-}
-export interface ISdkClientFactoryParams extends IClientFactoryParams {
-    signalListener?: ISignalListener;
-    syncManager?: ISyncManager;
-    sharedClient?: boolean;
-}

package/types/storages/inMemory/CountsCacheInMemory.d.ts

@@ -1,20 +0,0 @@
-import { ICountsCacheSync } from '../types';
-export declare class CountsCacheInMemory implements ICountsCacheSync {
-    private counters;
-    /**
-     * Add counts.
-     */
-    track(metricName: string): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

package/types/storages/inMemory/LatenciesCacheInMemory.d.ts

@@ -1,20 +0,0 @@
-import { ILatenciesCacheSync } from '../types';
-export declare class LatenciesCacheInMemory implements ILatenciesCacheSync {
-    private counters;
-    /**
-     * Add latencies.
-     */
-    track(metricName: string, latency: number): boolean;
-    /**
-     * Clear the collector
-     */
-    clear(): void;
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    state(): Record<string, number[]>;
-    /**
-     * Check if the cache is empty.
-     */
-    isEmpty(): boolean;
-}

package/types/storages/inRedis/CountsCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ICountsCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class CountsCacheInRedis implements ICountsCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string): Promise<boolean>;
-}

package/types/storages/inRedis/LatenciesCacheInRedis.d.ts

@@ -1,9 +0,0 @@
-import { ILatenciesCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-export declare class LatenciesCacheInRedis implements ILatenciesCacheAsync {
-    private readonly redis;
-    private readonly keys;
-    constructor(keys: KeyBuilderSS, redis: Redis);
-    track(metricName: string, latency: number): Promise<boolean>;
-}

package/types/sync/offline/LocalhostFromFile.d.ts

@@ -1,2 +0,0 @@
-import { SplitIO } from '../../types';
-export declare function LocalhostFromFile(): SplitIO.LocalhostFactory;

package/types/sync/offline/splitsParser/splitsParserFromFile.d.ts

@@ -1,2 +0,0 @@
-import { ISplitsParser } from './types';
-export declare function splitsParserFromFileFactory(): ISplitsParser;

package/types/sync/submitters/eventsSyncTask.d.ts

@@ -1,8 +0,0 @@
-import { IEventsCacheSync } from '../../storages/types';
-import { IPostEventsBulk } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts tracked events
- */
-export declare function eventsSyncTaskFactory(log: ILogger, postEventsBulk: IPostEventsBulk, eventsCache: IEventsCacheSync, eventsPushRate: number, eventsFirstPushWindow: number, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/impressionCountsSyncTask.d.ts

@@ -1,13 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsCount } from '../../services/types';
-import { IImpressionCountsCacheSync } from '../../storages/types';
-import { ImpressionCountsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressionCounts` data from cache into request payload.
- */
-export declare function fromImpressionCountsCollector(impressionsCount: Record<string, number>): ImpressionCountsPayload;
-/**
- * Sync task that periodically posts impression counts
- */
-export declare function impressionCountsSyncTaskFactory(log: ILogger, postTestImpressionsCount: IPostTestImpressionsCount, impressionCountsCache: IImpressionCountsCacheSync, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/impressionsSyncTask.d.ts

@@ -1,14 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IPostTestImpressionsBulk } from '../../services/types';
-import { IImpressionsCacheSync } from '../../storages/types';
-import { ImpressionDTO } from '../../types';
-import { ImpressionsPayload } from './types';
-import { ILogger } from '../../logger/types';
-/**
- * Converts `impressions` data from cache into request payload.
- */
-export declare function fromImpressionsCollector(sendLabels: boolean, data: ImpressionDTO[]): ImpressionsPayload;
-/**
- * Sync task that periodically posts impressions data
- */
-export declare function impressionsSyncTaskFactory(log: ILogger, postTestImpressionsBulk: IPostTestImpressionsBulk, impressionsCache: IImpressionsCacheSync, impressionsRefreshRate: number, sendLabels?: boolean, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/metricsSyncTask.d.ts

@@ -1,12 +0,0 @@
-import { ICountsCacheSync, ILatenciesCacheSync } from '../../storages/types';
-import { IPostMetricsCounters, IPostMetricsTimes } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { ILogger } from '../../logger/types';
-/**
- * Sync task that periodically posts telemetry counts
- */
-export declare function countsSyncTaskFactory(log: ILogger, postMetricsCounters: IPostMetricsCounters, countsCache: ICountsCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;
-/**
- * Sync task that periodically posts telemetry latencies
- */
-export declare function latenciesSyncTaskFactory(log: ILogger, postMetricsLatencies: IPostMetricsTimes, latenciesCache: ILatenciesCacheSync, metricsRefreshRate: number, latencyTracker?: ITimeTracker): ISyncTask;

package/types/sync/submitters/submitterSyncTask.d.ts

@@ -1,10 +0,0 @@
-import { ISyncTask, ITimeTracker } from '../types';
-import { IRecorderCacheProducerSync } from '../../storages/types';
-import { ILogger } from '../../logger/types';
-import { IResponse } from '../../services/types';
-/**
- * Base function to create submitter sync tasks, such as ImpressionsSyncTask and EventsSyncTask
- */
-export declare function submitterSyncTaskFactory<TState extends {
-    length?: number;
-}>(log: ILogger, postClient: (body: string) => Promise<IResponse>, sourceCache: IRecorderCacheProducerSync<TState>, postRate: number, dataName: string, latencyTracker?: ITimeTracker, fromCacheToPayload?: (cacheData: TState) => any, maxRetries?: number, debugLogs?: boolean): ISyncTask<[], void>;

package/types/sync/syncTaskComposite.d.ts

@@ -1,5 +0,0 @@
-import { ISyncTask } from './types';
-/**
- * Composite Sync Task: group of sync tasks that are treated as a single one.
- */
-export declare function syncTaskComposite(syncTasks: ISyncTask[]): ISyncTask;

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

@@ -1,10 +0,0 @@
-import { IFilter } from './types';
-export declare class BloomFilterImp implements IFilter {
-    private spectedInsertions;
-    private errorRate;
-    private filter;
-    constructor(spectedInsertions: number, errorRate: number);
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

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

@@ -1,8 +0,0 @@
-import { IFilter } from './types';
-export declare class DictionaryFilter implements IFilter {
-    private filter;
-    constructor();
-    add(data: string): boolean;
-    contains(data: string): boolean;
-    clear(): void;
-}

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

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

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

@@ -1,70 +0,0 @@
-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 {};