@splitsoftware/splitio-commons 1.2.1-rc.0 → 1.2.1-rc.4

package/esm/sync/streaming/pushManager.js

@@ -19,7 +19,8 @@ import { hash64 } from '../../utils/murmur3/murmur3_64';
  * - for server-side if key is not provided in settings.
  * - for client-side, with support for multiple clients, if key is provided in settings
  */
-export function pushManagerFactory(pollingManager, storage, readiness, fetchAuth, platform, settings) {
+export function pushManagerFactory(params, pollingManager) {
+    var settings = params.settings, storage = params.storage, splitApi = params.splitApi, readiness = params.readiness, platform = params.platform;
     // `userKey` is the matching key of main client in client-side SDK.
     // It can be used to check if running on client-side or server-side SDK.
     var userKey = settings.core.key ? getMatching(settings.core.key) : undefined;
@@ -33,14 +34,14 @@ export function pushManagerFactory(pollingManager, storage, readiness, fetchAuth
         log.warn(STREAMING_FALLBACK, [e]);
         return;
     }
-    var authenticate = authenticateFactory(fetchAuth);
+    var authenticate = authenticateFactory(splitApi.fetchAuth);
     // init feedback loop
     var pushEmitter = new platform.EventEmitter();
     var sseHandler = SSEHandlerFactory(log, pushEmitter);
     sseClient.setEventHandler(sseHandler);
     // init workers
     // MySegmentsUpdateWorker (client-side) are initiated in `add` method
-    var segmentsUpdateWorker = userKey ? undefined : new SegmentsUpdateWorker(storage.segments, pollingManager.segmentsSyncTask);
+    var segmentsUpdateWorker = userKey ? undefined : new SegmentsUpdateWorker(pollingManager.segmentsSyncTask, storage.segments);
     // For server-side we pass the segmentsSyncTask, used by SplitsUpdateWorker to fetch new segments
     var splitsUpdateWorker = new SplitsUpdateWorker(storage.splits, pollingManager.splitsSyncTask, readiness.splits, userKey ? undefined : pollingManager.segmentsSyncTask);
     // [Only for client-side] map of hashes to user keys, to dispatch MY_SEGMENTS_UPDATE events to the corresponding MySegmentsUpdateWorker
@@ -54,6 +55,7 @@ export function pushManagerFactory(pollingManager, storage, readiness, fetchAuth
     // It is used to halt the `connectPush` process if it was in progress.
     var disconnected;
     // flag that indicates a PUSH_NONRETRYABLE_ERROR, condition with which starting pushManager again is ignored.
+    // true if STREAMING_DISABLED control event, or 'pushEnabled: false', or non-recoverable SSE or Auth errors.
     var disabled; // `disabled` implies `disconnected === true`
     /** PushManager functions related to initialization */
     var connectPushRetryBackoff = new Backoff(connectPush, settings.scheduler.pushRetryBackoffBase);
@@ -254,13 +256,15 @@ export function pushManagerFactory(pollingManager, storage, readiness, fetchAuth
     return objectAssign(
     // Expose Event Emitter functionality and Event constants
     Object.create(pushEmitter), {
-        // Stop/pause push mode
+        // Stop/pause push mode.
+        // It doesn't emit events. Neither PUSH_SUBSYSTEM_DOWN to start polling.
         stop: function () {
             disconnectPush(); // `handleNonRetryableError` cannot be used as `stop`, because it emits PUSH_SUBSYSTEM_DOWN event, which starts polling.
             if (userKey)
                 this.remove(userKey); // Necessary to properly resume streaming in client-side (e.g., RN SDK transition to foreground).
         },
-        // Start/resume push mode
+        // Start/resume push mode.
+        // It eventually emits PUSH_SUBSYSTEM_DOWN, that starts polling, or PUSH_SUBSYSTEM_UP, that executes a syncAll
         start: function () {
             // Guard condition to avoid calling `connectPush` again if the `start` method is called multiple times or if push has been disabled.
             if (disabled || disconnected === false)
@@ -271,6 +275,10 @@ export function pushManagerFactory(pollingManager, storage, readiness, fetchAuth
             else
                 setTimeout(connectPush); // server-side runs in next cycle as in client-side, for consistency with client-side
         },
+        // true/false if start or stop was called last respectively
+        isRunning: function () {
+            return disconnected === false;
+        },
         // [Only for client-side]
         add: function (userKey, mySegmentsSyncTask) {
             var hash = hashUserKey(userKey);

package/esm/sync/submitters/eventsSyncTask.js

@@ -1,11 +1,12 @@
 import { submitterSyncTaskFactory } from './submitterSyncTask';
-import { SUBMITTERS_PUSH_FULL_EVENTS_QUEUE } from '../../logger/constants';
+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, 'queued events', latencyTracker);
+    var syncTask = submitterSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPushRate, DATA_NAME, latencyTracker);
     // Set a timer for the first push of events,
     if (eventsFirstPushWindow > 0) {
         var stopEventPublisherTimeout_1;
@@ -19,9 +20,9 @@ export function eventsSyncTaskFactory(log, postEventsBulk, eventsCache, eventsPu
             originalStop_1();
         };
     }
-    // register eventsSubmitter to be executed when events cache is full
+    // register events submitter to be executed when events cache is full
     eventsCache.setOnFullQueueCb(function () {
-        log.info(SUBMITTERS_PUSH_FULL_EVENTS_QUEUE);
+        log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
         syncTask.execute();
     });
     return syncTask;

package/esm/sync/submitters/impressionsSyncTask.js

@@ -1,5 +1,7 @@
 import { groupBy, forOwn } from '../../utils/lang';
 import { submitterSyncTaskFactory } from './submitterSyncTask';
+import { SUBMITTERS_PUSH_FULL_QUEUE } from '../../logger/constants';
+var DATA_NAME = 'impressions';
 /**
  * Converts `impressions` data from cache into request payload.
  */
@@ -32,5 +34,11 @@ export function fromImpressionsCollector(sendLabels, data) {
 export function impressionsSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, sendLabels, latencyTracker) {
     if (sendLabels === void 0) { sendLabels = false; }
     // retry impressions only once.
-    return submitterSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, 'impressions', latencyTracker, fromImpressionsCollector.bind(undefined, sendLabels), 1);
+    var syncTask = submitterSyncTaskFactory(log, postTestImpressionsBulk, impressionsCache, impressionsRefreshRate, DATA_NAME, latencyTracker, fromImpressionsCollector.bind(undefined, sendLabels), 1);
+    // register impressions submitter to be executed when impressions cache is full
+    impressionsCache.setOnFullQueueCb(function () {
+        log.info(SUBMITTERS_PUSH_FULL_QUEUE, [DATA_NAME]);
+        syncTask.execute();
+    });
+    return syncTask;
 }

package/esm/sync/submitters/submitterManager.js

@@ -2,7 +2,8 @@ import { syncTaskComposite } from '../syncTaskComposite';
 import { eventsSyncTaskFactory } from './eventsSyncTask';
 import { impressionsSyncTaskFactory } from './impressionsSyncTask';
 import { impressionCountsSyncTaskFactory } from './impressionCountsSyncTask';
-export function submitterManagerFactory(settings, storage, splitApi) {
+export function submitterManagerFactory(params) {
+    var settings = params.settings, storage = params.storage, splitApi = params.splitApi;
     var log = settings.log;
     var submitters = [
         impressionsSyncTaskFactory(log, splitApi.postTestImpressionsBulk, storage.impressions, settings.scheduler.impressionsRefreshRate, settings.core.labelsEnabled),

package/esm/sync/syncManagerOnline.js

@@ -13,18 +13,17 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
     /**
      * SyncManager factory for modular SDK
      */
-    return function (_a) {
-        var settings = _a.settings, platform = _a.platform, splitApi = _a.splitApi, storage = _a.storage, readiness = _a.readiness;
-        var log = settings.log;
+    return function (params) {
+        var _a = params.settings, log = _a.log, streamingEnabled = _a.streamingEnabled;
         /** Polling Manager */
-        var pollingManager = pollingManagerFactory && pollingManagerFactory(splitApi, storage, readiness, settings);
+        var pollingManager = pollingManagerFactory && pollingManagerFactory(params);
         /** Push Manager */
-        var pushManager = settings.streamingEnabled && pollingManager && pushManagerFactory ?
-            pushManagerFactory(pollingManager, storage, readiness, splitApi.fetchAuth, platform, settings) :
+        var pushManager = streamingEnabled && pollingManager && pushManagerFactory ?
+            pushManagerFactory(params, pollingManager) :
             undefined;
         /** Submitter Manager */
         // It is not inyected as push and polling managers, because at the moment it is required
-        var submitter = submitterManagerFactory(settings, storage, splitApi);
+        var submitter = submitterManagerFactory(params);
         /** Sync Manager logic */
         function startPolling() {
             if (pollingManager.isRunning()) {
@@ -55,9 +54,6 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
              * Method used to start the syncManager for the first time, or resume it after being stopped.
              */
             start: function () {
-                if (running)
-                    return;
-                running = true;
                 // start syncing splits and segments
                 if (pollingManager) {
                     if (pushManager) {
@@ -75,14 +71,12 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 // start periodic data recording (events, impressions, telemetry).
                 if (submitter)
                     submitter.start();
+                running = true;
             },
             /**
              * Method used to stop/pause the syncManager.
              */
             stop: function () {
-                if (!running)
-                    return;
-                running = false;
                 // stop syncing
                 if (pushManager)
                     pushManager.stop();
@@ -91,6 +85,7 @@ export function syncManagerOnlineFactory(pollingManagerFactory, pushManagerFacto
                 // stop periodic data recording (events, impressions, telemetry).
                 if (submitter)
                     submitter.stop();
+                running = false;
             },
             isRunning: function () {
                 return running;

package/esm/utils/inputValidation/eventProperties.js

@@ -1,4 +1,5 @@
-import { isObject, shallowClone, isString, isFiniteNumber, isBoolean } from '../lang';
+import { isObject, isString, isFiniteNumber, isBoolean } from '../lang';
+import { objectAssign } from '../lang/objectAssign';
 import { ERROR_NOT_PLAIN_OBJECT, ERROR_SIZE_EXCEEDED, WARN_SETTING_NULL, WARN_TRIMMING_PROPERTIES } from '../../logger/constants';
 var ECMA_SIZES = {
     NULL: 0,
@@ -17,7 +18,8 @@ export function validateEventProperties(log, maybeProperties, method) {
         return { properties: false, size: BASE_EVENT_SIZE };
     }
     var keys = Object.keys(maybeProperties);
-    var clone = shallowClone(maybeProperties);
+    // Shallow clone
+    var clone = objectAssign({}, maybeProperties);
     // To avoid calculating the size twice we'll return it from here.
     var output = {
         properties: clone,

package/esm/utils/inputValidation/key.js

@@ -35,7 +35,8 @@ export function validateKey(log, maybeKey, method) {
         var bucketingKey = validateKeyValue(log, maybeKey.bucketingKey, method, 'bucketingKey');
         if (matchingKey && bucketingKey)
             return {
-                matchingKey: matchingKey, bucketingKey: bucketingKey
+                matchingKey: matchingKey,
+                bucketingKey: bucketingKey
             };
         log.error(ERROR_INVALID_KEY_OBJECT, [method]);
         return false;

package/esm/utils/lang/index.js

@@ -1,4 +1,4 @@
-import { __spreadArrays } from "tslib";
+import { __spreadArray } from "tslib";
 /**
  * Checks if the target string ends with the sub string.
  */
@@ -179,21 +179,10 @@ export function merge(target, source) {
     });
     if (rest && rest.length) {
         var nextSource = rest.splice(0, 1)[0];
-        res = merge.apply(void 0, __spreadArrays([res, nextSource], rest));
+        res = merge.apply(void 0, __spreadArray([res, nextSource], rest, false));
     }
     return res;
 }
-/**
- * Shallow clone an object
- */
-export function shallowClone(obj) {
-    var keys = Object.keys(obj);
-    var output = {};
-    for (var i = 0; i < keys.length; i++) {
-        output[keys[i]] = obj[keys[i]];
-    }
-    return output;
-}
 /**
  * Checks if the target string starts with the sub string.
  */

package/esm/utils/settingsValidation/index.js

@@ -33,6 +33,8 @@ var base = {
         eventsPushRate: 60,
         // how many events will be queued before flushing
         eventsQueueSize: 500,
+        // how many impressions will be queued before flushing
+        impressionsQueueSize: 30000,
         // backoff base seconds to wait before re attempting to connect to push notifications
         pushRetryBackoffBase: 1,
     },
@@ -64,10 +66,6 @@ var base = {
         impressionsMode: OPTIMIZED,
         localhostMode: undefined
     },
-    runtime: {
-        ip: false,
-        hostname: false
-    },
     // Logger
     log: undefined
 };
@@ -114,8 +112,7 @@ export function settingsValidation(config, validationParams) {
     }
     // Current ip/hostname information
     // @ts-ignore, modify readonly prop
-    if (runtime)
-        withDefaults.runtime = runtime(withDefaults);
+    withDefaults.runtime = runtime(withDefaults);
     // ensure a valid list of integrations.
     // `integrations` returns an array of valid integration items.
     // @ts-ignore, modify readonly prop

package/esm/utils/settingsValidation/runtime.js

@@ -0,0 +1,7 @@
+// For client-side SDKs, machine IP and Hostname are not captured and sent to Split backend.
+export function validateRuntime() {
+    return {
+        ip: false,
+        hostname: false
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.2.1-rc.0",
+  "version": "1.2.1-rc.4",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -20,8 +20,8 @@
     "check:lint": "eslint src --ext .js,.ts",
     "check:types": "tsc --noEmit",
     "build": "npm run build:cjs && npm run build:esm",
-    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types --importHelpers",
-    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs --importHelpers",
+    "build:esm": "rimraf esm && tsc -m es2015 --outDir esm -d true --declarationDir types",
+    "build:cjs": "rimraf cjs && tsc -m CommonJS --outDir cjs",
     "test": "jest",
     "test:coverage": "jest --coverage",
     "publish:rc": "npm run check && npm run test && npm run build && npm publish --tag rc",
@@ -44,7 +44,7 @@
   "bugs": "https://github.com/splitio/javascript-commons/issues",
   "homepage": "https://github.com/splitio/javascript-commons#readme",
   "dependencies": {
-    "tslib": "^2.1.0"
+    "tslib": "^2.3.1"
   },
   "devDependencies": {
     "@types/google.analytics": "0.0.40",
@@ -58,7 +58,7 @@
     "eslint": "^7.32.0",
     "eslint-plugin-compat": "3.7.0",
     "eslint-plugin-import": "^2.25.3",
-    "fetch-mock": "^9.10.7",
+    "fetch-mock": "^9.11.0",
     "ioredis": "^4.28.0",
     "jest": "^27.2.3",
     "jest-localstorage-mock": "^2.4.3",
@@ -68,7 +68,7 @@
     "redis-server": "1.2.2",
     "rimraf": "^3.0.2",
     "ts-jest": "^27.0.5",
-    "typescript": "^4.0.2"
+    "typescript": "4.4.4"
   },
   "sideEffects": false
 }

package/src/evaluator/matchers/ew.ts

@@ -1,13 +1,13 @@
 import { ENGINE_MATCHER_ENDS_WITH } from '../../logger/constants';
 import { ILogger } from '../../logger/types';
-import { endsWith as strEndsWith } from '../../utils/lang';
+import { endsWith } from '../../utils/lang';
 
 export function endsWithMatcherContext(log: ILogger, ruleAttr: string[]) /*: Function */ {
   return function endsWithMatcher(runtimeAttr: string): boolean {
-    let endsWith = ruleAttr.some(e => strEndsWith(runtimeAttr, e));
+    let strEndsWith = ruleAttr.some(e => endsWith(runtimeAttr, e));
 
-    log.debug(ENGINE_MATCHER_ENDS_WITH, [runtimeAttr, ruleAttr, endsWith]);
+    log.debug(ENGINE_MATCHER_ENDS_WITH, [runtimeAttr, ruleAttr, strEndsWith]);
 
-    return endsWith;
+    return strEndsWith;
   };
 }

package/src/integrations/ga/GoogleAnalyticsToSplit.ts

@@ -1,11 +1,14 @@
-import { IIntegrationFactoryParams } from '../types';
+import { IIntegrationFactoryParams, IntegrationFactory } from '../types';
 import { GaToSplit } from './GaToSplit';
 import { GoogleAnalyticsToSplitOptions } from './types';
 
-export function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions) {
+export function GoogleAnalyticsToSplit(options: GoogleAnalyticsToSplitOptions): IntegrationFactory {
 
   // GaToSplit integration factory
-  return (params: IIntegrationFactoryParams) => {
+  function GoogleAnalyticsToSplitFactory(params: IIntegrationFactoryParams) {
     return GaToSplit(options, params);
-  };
+  }
+
+  GoogleAnalyticsToSplitFactory.type = 'GOOGLE_ANALYTICS_TO_SPLIT';
+  return GoogleAnalyticsToSplitFactory;
 }

package/src/integrations/ga/SplitToGoogleAnalytics.ts

@@ -1,11 +1,14 @@
-import { IIntegrationFactoryParams } from '../types';
+import { IIntegrationFactoryParams, IntegrationFactory } from '../types';
 import { SplitToGa } from './SplitToGa';
 import { SplitToGoogleAnalyticsOptions } from './types';
 
-export function SplitToGoogleAnalytics(options: SplitToGoogleAnalyticsOptions = {}) {
+export function SplitToGoogleAnalytics(options: SplitToGoogleAnalyticsOptions = {}): IntegrationFactory {
 
   // SplitToGa integration factory
-  return (params: IIntegrationFactoryParams) => {
+  function SplitToGoogleAnalyticsFactory(params: IIntegrationFactoryParams) {
     return new SplitToGa(params.settings.log, options);
-  };
+  }
+
+  SplitToGoogleAnalyticsFactory.type = 'SPLIT_TO_GOOGLE_ANALYTICS';
+  return SplitToGoogleAnalyticsFactory;
 }

package/src/integrations/types.ts

@@ -12,3 +12,8 @@ export interface IIntegrationFactoryParams {
   storage: { events: IEventsCacheBase }
   settings: ISettings
 }
+
+export type IntegrationFactory = {
+  readonly type: string
+  (params: IIntegrationFactoryParams): IIntegration | void
+}

package/src/logger/constants.ts

@@ -61,7 +61,7 @@ export const STREAMING_RECONNECT = 111;
 export const STREAMING_CONNECTING = 112;
 export const STREAMING_DISABLED = 113;
 export const STREAMING_DISCONNECTING = 114;
-export const SUBMITTERS_PUSH_FULL_EVENTS_QUEUE = 115;
+export const SUBMITTERS_PUSH_FULL_QUEUE = 115;
 export const SUBMITTERS_PUSH = 116;
 export const SYNC_START_POLLING = 117;
 export const SYNC_CONTINUE_POLLING = 118;

package/src/logger/messages/error.ts

@@ -13,7 +13,7 @@ export const codesError: [number, string][] = [
   [c.ERROR_SYNC_OFFLINE_LOADING, c.LOG_PREFIX_SYNC_OFFLINE + 'There was an issue loading the mock Splits data, no changes will be applied to the current cache. %s'],
   [c.ERROR_STREAMING_SSE, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to connect or error on streaming connection, with error message: %s'],
   [c.ERROR_STREAMING_AUTH, c.LOG_PREFIX_SYNC_STREAMING + 'Failed to authenticate for streaming. Error: %s.'],
-  [c.ERROR_HTTP, ' Response status is not OK. Status: %s. URL: %s. Message: %s'],
+  [c.ERROR_HTTP, 'Response status is not OK. Status: %s. URL: %s. Message: %s'],
   // client status
   [c.ERROR_CLIENT_LISTENER, 'A listener was added for %s on the SDK, which has already fired and won\'t be emitted again. The callback won\'t be executed.'],
   [c.ERROR_CLIENT_DESTROYED, '%s: Client has already been destroyed - no calls possible.'],

package/src/logger/messages/info.ts

@@ -20,7 +20,7 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.POLLING_START, c.LOG_PREFIX_SYNC_POLLING + 'Starting polling'],
   [c.POLLING_STOP, c.LOG_PREFIX_SYNC_POLLING + 'Stopping polling'],
   [c.SYNC_SPLITS_FETCH_RETRY, c.LOG_PREFIX_SYNC_SPLITS + 'Retrying download of splits #%s. Reason: %s'],
-  [c.SUBMITTERS_PUSH_FULL_EVENTS_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full events queue and reseting timer.'],
+  [c.SUBMITTERS_PUSH_FULL_QUEUE, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Flushing full %s queue and reseting timer.'],
   [c.SUBMITTERS_PUSH, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Pushing %s %s.'],
   [c.STREAMING_REFRESH_TOKEN, c.LOG_PREFIX_SYNC_STREAMING + 'Refreshing streaming token in %s seconds, and connecting streaming in %s seconds.'],
   [c.STREAMING_RECONNECT, c.LOG_PREFIX_SYNC_STREAMING + 'Attempting to reconnect streaming in %s seconds.'],
@@ -29,5 +29,5 @@ export const codesInfo: [number, string][] = codesWarn.concat([
   [c.STREAMING_DISCONNECTING, c.LOG_PREFIX_SYNC_STREAMING + 'Disconnecting streaming.'],
   [c.SYNC_START_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming not available. Starting polling.'],
   [c.SYNC_CONTINUE_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming couldn\'t connect. Continue polling.'],
-  [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming (re)connected. Syncing and stopping polling.'],
+  [c.SYNC_STOP_POLLING, c.LOG_PREFIX_SYNC_MANAGER + 'Streaming connected. Syncing and stopping polling.'],
 ]);

package/src/logger/types.ts

@@ -9,11 +9,15 @@ export interface ILoggerOptions {
 export interface ILogger {
   setLogLevel(logLevel: LogLevel): void
 
+  debug(msg: any): void
   debug(msg: string | number, args?: any[]): void
 
+  info(msg: any): void
   info(msg: string | number, args?: any[]): void
 
+  warn(msg: any): void
   warn(msg: string | number, args?: any[]): void
 
+  error(msg: any): void
   error(msg: string | number, args?: any[]): void
 }

package/src/sdkFactory/index.ts

@@ -33,6 +33,7 @@ export function sdkFactory(params: ISdkFactoryParams): SplitIO.ICsSDK | SplitIO.
 
   // @TODO consider passing the settings object, so that each storage access only what it needs
   const storageFactoryParams: IStorageFactoryParams = {
+    impressionsQueueSize: settings.scheduler.impressionsQueueSize,
     eventsQueueSize: settings.scheduler.eventsQueueSize,
     optimize: shouldBeOptimized(settings),
 

package/src/storages/inLocalStorage/index.ts

@@ -40,7 +40,7 @@ export function InLocalStorage(options: InLocalStorageOptions = {}): IStorageSyn
     return {
       splits: new SplitsCacheInLocal(log, keys, expirationTimestamp, params.splitFiltersValidation),
       segments: new MySegmentsCacheInLocal(log, keys),
-      impressions: new ImpressionsCacheInMemory(),
+      impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
       impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
       events: new EventsCacheInMemory(params.eventsQueueSize),
 

package/src/storages/inMemory/ImpressionsCacheInMemory.ts

@@ -3,13 +3,34 @@ import { ImpressionDTO } from '../../types';
 
 export class ImpressionsCacheInMemory implements IImpressionsCacheSync {
 
-  private queue: ImpressionDTO[] = [];
+  private onFullQueue?: () => void;
+  private readonly maxQueue: number;
+  private queue: ImpressionDTO[];
+
+  /**
+   *
+   * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
+   * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
+   */
+  constructor(impressionsQueueSize: number = 0) {
+    this.maxQueue = impressionsQueueSize;
+    this.queue = [];
+  }
+
+  setOnFullQueueCb(cb: () => void) {
+    this.onFullQueue = cb;
+  }
 
   /**
    * Store impressions in sequential order
    */
   track(data: ImpressionDTO[]) {
     this.queue.push(...data);
+
+    // Check if the cache queue is full and we need to flush it.
+    if (this.maxQueue > 0 && this.queue.length >= this.maxQueue && this.onFullQueue) {
+      this.onFullQueue();
+    }
   }
 
   /**

package/src/storages/inMemory/InMemoryStorage.ts

@@ -16,7 +16,7 @@ export function InMemoryStorageFactory(params: IStorageFactoryParams): IStorageS
   return {
     splits: new SplitsCacheInMemory(),
     segments: new SegmentsCacheInMemory(),
-    impressions: new ImpressionsCacheInMemory(),
+    impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
     impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
     events: new EventsCacheInMemory(params.eventsQueueSize),
 

package/src/storages/inMemory/InMemoryStorageCS.ts

@@ -16,7 +16,7 @@ export function InMemoryStorageCSFactory(params: IStorageFactoryParams): IStorag
   return {
     splits: new SplitsCacheInMemory(),
     segments: new MySegmentsCacheInMemory(),
-    impressions: new ImpressionsCacheInMemory(),
+    impressions: new ImpressionsCacheInMemory(params.impressionsQueueSize),
     impressionCounts: params.optimize ? new ImpressionCountsCacheInMemory() : undefined,
     events: new EventsCacheInMemory(params.eventsQueueSize),
 

package/src/storages/pluggable/index.ts

@@ -63,7 +63,7 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
 
   const prefix = validatePrefix(options.prefix);
 
-  function PluggableStorageFactory({ log, metadata, onReadyCb, mode, eventsQueueSize, optimize }: IStorageFactoryParams): IStorageAsync {
+  function PluggableStorageFactory({ log, metadata, onReadyCb, mode, eventsQueueSize, impressionsQueueSize, optimize }: IStorageFactoryParams): IStorageAsync {
     const keys = new KeyBuilderSS(prefix, metadata);
     const wrapper = wrapperAdapter(log, options.wrapper);
     const isPartialConsumer = mode === CONSUMER_PARTIAL_MODE;
@@ -74,7 +74,7 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
     return {
       splits: new SplitsCachePluggable(log, keys, wrapper),
       segments: new SegmentsCachePluggable(log, keys, wrapper),
-      impressions: isPartialConsumer ? new ImpressionsCacheInMemory() : new ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
+      impressions: isPartialConsumer ? new ImpressionsCacheInMemory(impressionsQueueSize) : new ImpressionsCachePluggable(log, keys.buildImpressionsKey(), wrapper, metadata),
       impressionCounts: optimize ? new ImpressionCountsCacheInMemory() : undefined,
       events: isPartialConsumer ? promisifyEventsTrack(new EventsCacheInMemory(eventsQueueSize)) : new EventsCachePluggable(log, keys.buildEventsKey(), wrapper, metadata),
       // @TODO add telemetry cache when required

package/src/storages/types.ts

@@ -298,7 +298,7 @@ export interface IRecorderCacheProducerSync<T> {
   // @TODO names are inconsistent with spec
   /* Checks if cache is empty. Returns true if the cache was just created or cleared */
   isEmpty(): boolean
-  /* clears cache data */
+  /* Clears cache data */
   clear(): void
   /* Gets cache data */
   state(): T
@@ -307,10 +307,13 @@ export interface IRecorderCacheProducerSync<T> {
 
 export interface IImpressionsCacheSync extends IImpressionsCacheBase, IRecorderCacheProducerSync<ImpressionDTO[]> {
   track(data: ImpressionDTO[]): void
+  /* Registers callback for full queue */
+  setOnFullQueueCb(cb: () => void): void
 }
 
 export interface IEventsCacheSync extends IEventsCacheBase, IRecorderCacheProducerSync<SplitIO.EventData[]> {
   track(data: SplitIO.EventData, size?: number): boolean
+  /* Registers callback for full queue */
   setOnFullQueueCb(cb: () => void): void
 }
 
@@ -423,6 +426,7 @@ export type DataLoader = (storage: IStorageSync, matchingKey: string) => void
 
 export interface IStorageFactoryParams {
   log: ILogger,
+  impressionsQueueSize?: number,
   eventsQueueSize?: number,
   optimize?: boolean /* whether create the `impressionCounts` cache (OPTIMIZED impression mode) or not (DEBUG impression mode) */,
 
@@ -443,7 +447,7 @@ export interface IStorageFactoryParams {
 export type StorageType = 'MEMORY' | 'LOCALSTORAGE' | 'REDIS' | 'PLUGGABLE';
 
 export type IStorageSyncFactory = {
-  type: StorageType,
+  readonly type: StorageType,
   (params: IStorageFactoryParams): IStorageSync
 }
 

package/src/sync/offline/splitsParser/splitsParserFromFile.ts

@@ -82,7 +82,7 @@ export function splitsParserFromFileFactory(): ISplitsParser {
     try {
       data = fs.readFileSync(filePath, 'utf-8');
     } catch (e) {
-      log.error(e.message);
+      log.error(e && (e as Error).message);
 
       return {};
     }

package/src/sync/polling/fetchers/mySegmentsFetcher.ts

@@ -6,9 +6,10 @@ import { IMySegmentsFetcher } from './types';
  * Factory of MySegments fetcher.
  * MySegments fetcher is a wrapper around `mySegments` API service that parses the response and handle errors.
  */
-export function mySegmentsFetcherFactory(fetchMySegments: IFetchMySegments, userMatchingKey: string): IMySegmentsFetcher {
+export function mySegmentsFetcherFactory(fetchMySegments: IFetchMySegments): IMySegmentsFetcher {
 
   return function mySegmentsFetcher(
+    userMatchingKey: string,
     noCache?: boolean,
     // Optional decorator for `fetchMySegments` promise, such as timeout or time tracker
     decorator?: (promise: Promise<IResponse>) => Promise<IResponse>

package/src/sync/polling/fetchers/types.ts

@@ -15,6 +15,7 @@ export type ISegmentChangesFetcher = (
 ) => Promise<ISegmentChangesResponse[]>
 
 export type IMySegmentsFetcher = (
+  userMatchingKey: string,
   noCache?: boolean,
   decorator?: (promise: Promise<IResponse>) => Promise<IResponse>
 ) => Promise<string[]>