@splitsoftware/splitio-commons 1.3.1 → 1.3.2-rc.2

package/cjs/sync/submitters/submitterSyncTask.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.submitterSyncTaskFactory = void 0;
-var syncTask_1 = require("../syncTask");
-var constants_1 = require("../../logger/constants");
-/**
- * Base function to create submitter sync tasks, such as ImpressionsSyncTask and EventsSyncTask
- */
-function submitterSyncTaskFactory(log, postClient, sourceCache, postRate, dataName, latencyTracker, fromCacheToPayload, maxRetries, debugLogs) {
-    if (maxRetries === void 0) { maxRetries = 0; }
-    var retries = 0;
-    function postData() {
-        if (sourceCache.isEmpty())
-            return Promise.resolve();
-        var data = sourceCache.state();
-        var dataCount = typeof data.length === 'number' ? data.length : '';
-        log[debugLogs ? 'debug' : 'info'](constants_1.SUBMITTERS_PUSH, [dataCount, dataName]);
-        var latencyTrackerStop = latencyTracker && latencyTracker.start();
-        var jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
-        if (!maxRetries)
-            sourceCache.clear();
-        var postPromise = postClient(jsonPayload).then(function () {
-            retries = 0;
-            sourceCache.clear(); // we clear the queue if request successes.
-        }).catch(function (err) {
-            if (!maxRetries) {
-                log.warn(constants_1.SUBMITTERS_PUSH_FAILS, [dataCount, dataName, err]);
-            }
-            else if (retries === maxRetries) {
-                retries = 0;
-                sourceCache.clear(); // we clear the queue if request fails after retries.
-                log.warn(constants_1.SUBMITTERS_PUSH_FAILS, [dataCount, dataName, err]);
-            }
-            else {
-                retries++;
-                log.warn(constants_1.SUBMITTERS_PUSH_RETRY, [dataCount, dataName, err]);
-            }
-        });
-        // if latencyTracker provided, attach stop callback to postEventsPromise
-        return latencyTrackerStop ? postPromise.then(latencyTrackerStop).catch(latencyTrackerStop) : postPromise;
-    }
-    return (0, syncTask_1.syncTaskFactory)(log, postData, postRate, dataName + ' submitter');
-}
-exports.submitterSyncTaskFactory = submitterSyncTaskFactory;

package/esm/storages/inMemory/CountsCacheInMemory.js

@@ -1,35 +0,0 @@
-var CountsCacheInMemory = /** @class */ (function () {
-    function CountsCacheInMemory() {
-        this.counters = {};
-    }
-    /**
-     * Add counts.
-     */
-    CountsCacheInMemory.prototype.track = function (metricName) {
-        if (this.counters[metricName] === undefined)
-            this.counters[metricName] = 1;
-        else
-            this.counters[metricName]++;
-        return true;
-    };
-    /**
-     * Clear the collector
-     */
-    CountsCacheInMemory.prototype.clear = function () {
-        this.counters = {};
-    };
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    CountsCacheInMemory.prototype.state = function () {
-        return this.counters;
-    };
-    /**
-     * Check if the cache is empty.
-     */
-    CountsCacheInMemory.prototype.isEmpty = function () {
-        return Object.keys(this.counters).length === 0;
-    };
-    return CountsCacheInMemory;
-}());
-export { CountsCacheInMemory };

package/esm/storages/inMemory/LatenciesCacheInMemory.js

@@ -1,40 +0,0 @@
-import { findLatencyIndex } from '../findLatencyIndex';
-var LatenciesCacheInMemory = /** @class */ (function () {
-    function LatenciesCacheInMemory() {
-        this.counters = {};
-    }
-    /**
-     * Add latencies.
-     */
-    LatenciesCacheInMemory.prototype.track = function (metricName, latency) {
-        // Initialize if needed
-        if (this.counters[metricName] === undefined) {
-            this.counters[metricName] = [
-                0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
-            ];
-        }
-        // +1 based on the latency number
-        this.counters[metricName][findLatencyIndex(latency)]++;
-        return true;
-    };
-    /**
-     * Clear the collector
-     */
-    LatenciesCacheInMemory.prototype.clear = function () {
-        this.counters = {};
-    };
-    /**
-     * Get the collected data, used as payload for posting.
-     */
-    LatenciesCacheInMemory.prototype.state = function () {
-        return this.counters;
-    };
-    /**
-     * Check if the cache is empty.
-     */
-    LatenciesCacheInMemory.prototype.isEmpty = function () {
-        return Object.keys(this.counters).length === 0;
-    };
-    return LatenciesCacheInMemory;
-}());
-export { LatenciesCacheInMemory };

package/esm/storages/inRedis/CountsCacheInRedis.js

@@ -1,13 +0,0 @@
-var CountsCacheInRedis = /** @class */ (function () {
-    function CountsCacheInRedis(keys, redis) {
-        this.keys = keys;
-        this.redis = redis;
-    }
-    CountsCacheInRedis.prototype.track = function (metricName) {
-        return this.redis.incr(this.keys.buildCountKey(metricName)).catch(function () {
-            // noop, for telemetry metrics there's no need to throw.
-        }).then(function () { return true; });
-    };
-    return CountsCacheInRedis;
-}());
-export { CountsCacheInRedis };

package/esm/storages/inRedis/LatenciesCacheInRedis.js

@@ -1,15 +0,0 @@
-import { findLatencyIndex } from '../findLatencyIndex';
-var LatenciesCacheInRedis = /** @class */ (function () {
-    function LatenciesCacheInRedis(keys, redis) {
-        this.keys = keys;
-        this.redis = redis;
-    }
-    LatenciesCacheInRedis.prototype.track = function (metricName, latency) {
-        var bucketNumber = findLatencyIndex(latency);
-        return this.redis.incr(this.keys.buildLatencyKey(metricName, bucketNumber)).catch(function () {
-            // noop, for telemetry metrics there's no need to throw.
-        }).then(function () { return true; });
-    };
-    return LatenciesCacheInRedis;
-}());
-export { LatenciesCacheInRedis };

package/esm/sync/submitters/eventsSyncTask.js

@@ -1,40 +0,0 @@
-import { submitterSyncTaskFactory } from './submitterSyncTask';
-import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-var DATA_NAME = 'events';
-/**
- * Sync task that periodically posts tracked events
- */
-export function eventsSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, eventsFirstPushWindow, latencyTracker) {
-    // don't retry events.
-    var syncTask = submitterSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, DATA_NAME, latencyTracker);
-    // Set a timer for the first push window of events.
-    // Not implemented in the base submitter or sync task, since this feature is only used by the events submitter.
-    if (eventsFirstPushWindow > 0) {
-        var running_1 = false;
-        var stopEventPublisherTimeout_1;
-        var originalStart_1 = syncTask.start;
-        syncTask.start = function () {
-            running_1 = true;
-            stopEventPublisherTimeout_1 = setTimeout(originalStart_1, eventsFirstPushWindow);
-        };
-        var originalStop_1 = syncTask.stop;
-        syncTask.stop = function () {
-            running_1 = false;
-            clearTimeout(stopEventPublisherTimeout_1);
-            originalStop_1();
-        };
-        syncTask.isRunning = function () {
-            return running_1;
-        };
-    }
-    // register events submitter to be executed when events cache is full
-    eventsCache.setOnFullQueueCb(function () {
-        if (syncTask.isRunning()) {
-            log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-            syncTask.execute();
-        }
-        // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
-        // Data will be sent when submitter is resumed.
-    });
-    return syncTask;
-}

package/esm/sync/submitters/metricsSyncTask.js

@@ -1,26 +0,0 @@
-import { forOwn } from '../../utils/lang';
-import { submitterSyncTaskFactory } from './submitterSyncTask';
-// extract POST payload object from cache
-function fromCache(propertyName) {
-    return function (data) {
-        var result = [];
-        forOwn(data, function (value, key) {
-            var _a;
-            result.push((_a = { name: key }, _a[propertyName] = value, _a));
-        });
-        return result;
-    };
-}
-/**
- * Sync task that periodically posts telemetry counts
- */
-export function countsSyncTaskFactory(log, postMetricsCounters, countsCache, metricsRefreshRate, latencyTracker) {
-    return submitterSyncTaskFactory(log, postMetricsCounters, countsCache, metricsRefreshRate, 'count metrics', latencyTracker, fromCache('delta'));
-}
-/**
- * Sync task that periodically posts telemetry latencies
- */
-export function latenciesSyncTaskFactory(log, postMetricsLatencies, latenciesCache, metricsRefreshRate, latencyTracker) {
-    // don't retry metrics.
-    return submitterSyncTaskFactory(log, postMetricsLatencies, latenciesCache, metricsRefreshRate, 'latency metrics', latencyTracker, fromCache('latencies'), 0, true);
-}

package/esm/sync/submitters/submitterSyncTask.js

@@ -1,40 +0,0 @@
-import { syncTaskFactory } from '../syncTask';
-import { SUBMITTERS_PUSH, SUBMITTERS_PUSH_FAILS, SUBMITTERS_PUSH_RETRY } from '../../logger/constants';
-/**
- * Base function to create submitter sync tasks, such as ImpressionsSyncTask and EventsSyncTask
- */
-export function submitterSyncTaskFactory(log, postClient, sourceCache, postRate, dataName, latencyTracker, fromCacheToPayload, maxRetries, debugLogs) {
-    if (maxRetries === void 0) { maxRetries = 0; }
-    var retries = 0;
-    function postData() {
-        if (sourceCache.isEmpty())
-            return Promise.resolve();
-        var data = sourceCache.state();
-        var dataCount = typeof data.length === 'number' ? data.length : '';
-        log[debugLogs ? 'debug' : 'info'](SUBMITTERS_PUSH, [dataCount, dataName]);
-        var latencyTrackerStop = latencyTracker && latencyTracker.start();
-        var jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
-        if (!maxRetries)
-            sourceCache.clear();
-        var postPromise = postClient(jsonPayload).then(function () {
-            retries = 0;
-            sourceCache.clear(); // we clear the queue if request successes.
-        }).catch(function (err) {
-            if (!maxRetries) {
-                log.warn(SUBMITTERS_PUSH_FAILS, [dataCount, dataName, err]);
-            }
-            else if (retries === maxRetries) {
-                retries = 0;
-                sourceCache.clear(); // we clear the queue if request fails after retries.
-                log.warn(SUBMITTERS_PUSH_FAILS, [dataCount, dataName, err]);
-            }
-            else {
-                retries++;
-                log.warn(SUBMITTERS_PUSH_RETRY, [dataCount, dataName, err]);
-            }
-        });
-        // if latencyTracker provided, attach stop callback to postEventsPromise
-        return latencyTrackerStop ? postPromise.then(latencyTrackerStop).catch(latencyTrackerStop) : postPromise;
-    }
-    return syncTaskFactory(log, postData, postRate, dataName + ' submitter');
-}

package/src/storages/inMemory/CountsCacheInMemory.ts

@@ -1,37 +0,0 @@
-import { ICountsCacheSync } from '../types';
-
-export class CountsCacheInMemory implements ICountsCacheSync {
-
-  private counters: Record<string, number> = {};
-
-  /**
-   * Add counts.
-   */
-  track(metricName: string) {
-    if (this.counters[metricName] === undefined) this.counters[metricName] = 1;
-    else this.counters[metricName]++;
-
-    return true;
-  }
-
-  /**
-   * Clear the collector
-   */
-  clear() {
-    this.counters = {};
-  }
-
-  /**
-   * Get the collected data, used as payload for posting.
-   */
-  state() {
-    return this.counters;
-  }
-
-  /**
-   * Check if the cache is empty.
-   */
-  isEmpty() {
-    return Object.keys(this.counters).length === 0;
-  }
-}

package/src/storages/inMemory/LatenciesCacheInMemory.ts

@@ -1,45 +0,0 @@
-import { ILatenciesCacheSync } from '../types';
-import { findLatencyIndex } from '../findLatencyIndex';
-
-export class LatenciesCacheInMemory implements ILatenciesCacheSync {
-
-  private counters: Record<string, number[]> = {};
-
-  /**
-   * Add latencies.
-   */
-  track(metricName: string, latency: number) {
-    // Initialize if needed
-    if (this.counters[metricName] === undefined) {
-      this.counters[metricName] = [
-        0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
-      ];
-    }
-
-    // +1 based on the latency number
-    this.counters[metricName][findLatencyIndex(latency)]++;
-
-    return true;
-  }
-
-  /**
-   * Clear the collector
-   */
-  clear() {
-    this.counters = {};
-  }
-
-  /**
-   * Get the collected data, used as payload for posting.
-   */
-  state() {
-    return this.counters;
-  }
-
-  /**
-   * Check if the cache is empty.
-   */
-  isEmpty() {
-    return Object.keys(this.counters).length === 0;
-  }
-}

package/src/storages/inRedis/CountsCacheInRedis.ts

@@ -1,20 +0,0 @@
-import { ICountsCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { Redis } from 'ioredis';
-
-export class CountsCacheInRedis implements ICountsCacheAsync {
-
-  private readonly redis: Redis;
-  private readonly keys: KeyBuilderSS;
-
-  constructor(keys: KeyBuilderSS, redis: Redis) {
-    this.keys = keys;
-    this.redis = redis;
-  }
-
-  track(metricName: string): Promise<boolean> {
-    return this.redis.incr(this.keys.buildCountKey(metricName)).catch(() => {
-      // noop, for telemetry metrics there's no need to throw.
-    }).then(() => true);
-  }
-}

package/src/storages/inRedis/LatenciesCacheInRedis.ts

@@ -1,23 +0,0 @@
-import { ILatenciesCacheAsync } from '../types';
-import { KeyBuilderSS } from '../KeyBuilderSS';
-import { findLatencyIndex } from '../findLatencyIndex';
-import { Redis } from 'ioredis';
-
-export class LatenciesCacheInRedis implements ILatenciesCacheAsync {
-
-  private readonly redis: Redis;
-  private readonly keys: KeyBuilderSS;
-
-  constructor(keys: KeyBuilderSS, redis: Redis) {
-    this.keys = keys;
-    this.redis = redis;
-  }
-
-  track(metricName: string, latency: number): Promise<boolean> {
-    const bucketNumber = findLatencyIndex(latency);
-
-    return this.redis.incr(this.keys.buildLatencyKey(metricName, bucketNumber)).catch(() => {
-      // noop, for telemetry metrics there's no need to throw.
-    }).then(() => true);
-  }
-}

package/src/sync/submitters/eventsSyncTask.ts

@@ -1,57 +0,0 @@
-import { IEventsCacheSync } from '../../storages/types';
-import { IPostEventsBulk } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { submitterSyncTaskFactory } from './submitterSyncTask';
-import { ILogger } from '../../logger/types';
-import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
-
-const DATA_NAME = 'events';
-
-/**
- * Sync task that periodically posts tracked events
- */
-export function eventsSyncTaskFactory(
-  log: ILogger,
-  postEventsBulk: IPostEventsBulk,
-  eventsCache: IEventsCacheSync,
-  eventsPushRate: number,
-  eventsFirstPushWindow: number,
-  latencyTracker?: ITimeTracker
-): ISyncTask {
-
-  // don't retry events.
-  const syncTask = submitterSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, DATA_NAME, latencyTracker);
-
-  // Set a timer for the first push window of events.
-  // Not implemented in the base submitter or sync task, since this feature is only used by the events submitter.
-  if (eventsFirstPushWindow > 0) {
-    let running = false;
-    let stopEventPublisherTimeout: ReturnType<typeof setTimeout>;
-    const originalStart = syncTask.start;
-    syncTask.start = () => {
-      running = true;
-      stopEventPublisherTimeout = setTimeout(originalStart, eventsFirstPushWindow);
-    };
-    const originalStop = syncTask.stop;
-    syncTask.stop = () => {
-      running = false;
-      clearTimeout(stopEventPublisherTimeout);
-      originalStop();
-    };
-    syncTask.isRunning = () => {
-      return running;
-    };
-  }
-
-  // register events submitter to be executed when events cache is full
-  eventsCache.setOnFullQueueCb(() => {
-    if (syncTask.isRunning()) {
-      log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
-      syncTask.execute();
-    }
-    // If submitter is stopped (e.g., user consent declined or unknown, or app state offline), we don't send the data.
-    // Data will be sent when submitter is resumed.
-  });
-
-  return syncTask;
-}

package/src/sync/submitters/metricsSyncTask.ts

@@ -1,49 +0,0 @@
-
-import { forOwn } from '../../utils/lang';
-import { ICountsCacheSync, ILatenciesCacheSync } from '../../storages/types';
-import { IPostMetricsCounters, IPostMetricsTimes } from '../../services/types';
-import { ISyncTask, ITimeTracker } from '../types';
-import { submitterSyncTaskFactory } from './submitterSyncTask';
-import { ILogger } from '../../logger/types';
-
-// extract POST payload object from cache
-function fromCache<V>(propertyName: 'latencies' | 'delta') {
-  return (data: Record<string, V>): any[] => {
-    const result: any[] = [];
-
-    forOwn(data, (value, key) => {
-      result.push({ name: key, [propertyName]: value });
-    });
-
-    return result;
-  };
-}
-
-/**
- * Sync task that periodically posts telemetry counts
- */
-export function countsSyncTaskFactory(
-  log: ILogger,
-  postMetricsCounters: IPostMetricsCounters,
-  countsCache: ICountsCacheSync,
-  metricsRefreshRate: number,
-  latencyTracker?: ITimeTracker
-): ISyncTask {
-
-  return submitterSyncTaskFactory(log, postMetricsCounters, countsCache, metricsRefreshRate, 'count metrics', latencyTracker, fromCache<number>('delta'));
-}
-
-/**
- * Sync task that periodically posts telemetry latencies
- */
-export function latenciesSyncTaskFactory(
-  log: ILogger,
-  postMetricsLatencies: IPostMetricsTimes,
-  latenciesCache: ILatenciesCacheSync,
-  metricsRefreshRate: number,
-  latencyTracker?: ITimeTracker
-): ISyncTask {
-
-  // don't retry metrics.
-  return submitterSyncTaskFactory(log, postMetricsLatencies, latenciesCache, metricsRefreshRate, 'latency metrics', latencyTracker, fromCache<number[]>('latencies'), 0, true);
-}