@splitsoftware/splitio-commons 1.3.2-rc.7 → 1.4.1-rc.1

package/CHANGES.txt

@@ -1,3 +1,6 @@
+1.4.1 (June 13, 2022)
+ - Bugfixing - Updated submitters logic, to avoid dropping impressions and events that are being tracked while POST request is pending.
+
 1.4.0 (May 24, 2022)
  - Added `scheduler.telemetryRefreshRate` property to SDK configuration, and deprecated `scheduler.metricsRefreshRate` property.
  - Updated SDK telemetry storage, metrics and updater to be more effective and send less often.

package/cjs/listeners/browser.js

@@ -77,7 +77,7 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype._flushData = function (url, cache, postService, fromCacheToPayload, extraMetadata) {
         // if there is data in cache, send it to backend
         if (!cache.isEmpty()) {
-            var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.state()) : cache.state();
+            var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
                 postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
             }

package/cjs/logger/messages/warn.js

@@ -14,7 +14,7 @@ exports.codesWarn = error_1.codesError.concat([
     [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
     [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
     [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s after retry. Reason: %s.'],
+    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
     [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
     // client status
     [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],

package/cjs/storages/inMemory/EventsCacheInMemory.js

@@ -35,10 +35,12 @@ var EventsCacheInMemory = /** @class */ (function () {
         this.queueByteSize = 0;
     };
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    EventsCacheInMemory.prototype.state = function () {
-        return this.queue;
+    EventsCacheInMemory.prototype.pop = function () {
+        var data = this.queue;
+        this.clear();
+        return data;
     };
     /**
      * Check if the cache is empty.

package/cjs/storages/inMemory/ImpressionCountsCacheInMemory.js

@@ -21,14 +21,22 @@ var ImpressionCountsCacheInMemory = /** @class */ (function () {
         this.cache[key] = currentAmount ? currentAmount + amount : amount;
     };
     /**
-    * Returns all the elements stored in the cache and resets the cache.
-    */
-    ImpressionCountsCacheInMemory.prototype.state = function () {
-        return this.cache;
+     * Pop the collected data, used as payload for posting.
+     */
+    ImpressionCountsCacheInMemory.prototype.pop = function () {
+        var data = this.cache;
+        this.clear();
+        return data;
     };
+    /**
+     * Clear the data stored on the cache.
+     */
     ImpressionCountsCacheInMemory.prototype.clear = function () {
         this.cache = {};
     };
+    /**
+     * Check if the cache is empty.
+     */
     ImpressionCountsCacheInMemory.prototype.isEmpty = function () {
         return Object.keys(this.cache).length === 0;
     };

package/cjs/storages/inMemory/ImpressionsCacheInMemory.js

@@ -33,10 +33,12 @@ var ImpressionsCacheInMemory = /** @class */ (function () {
         this.queue = [];
     };
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    ImpressionsCacheInMemory.prototype.state = function () {
-        return this.queue;
+    ImpressionsCacheInMemory.prototype.pop = function () {
+        var data = this.queue;
+        this.clear();
+        return data;
     };
     /**
      * Check if the cache is empty.

package/cjs/sync/submitters/submitter.js

@@ -10,26 +10,30 @@ function submitterFactory(log, postClient, sourceCache, postRate, dataName, from
 ) {
     if (maxRetries === void 0) { maxRetries = 0; }
     var retries = 0;
+    var data;
     function postData() {
-        if (sourceCache.isEmpty())
-            return Promise.resolve();
-        var data = sourceCache.state();
+        if (!data) {
+            if (sourceCache.isEmpty())
+                return Promise.resolve();
+            // we clear the cache to track new items, while `data` is used for retries
+            data = sourceCache.pop();
+        }
         // @ts-ignore
         var dataCountMessage = typeof data.length === 'number' ? data.length + " " + dataName : dataName;
         log[debugLogs ? 'debug' : 'info'](constants_1.SUBMITTERS_PUSH, [dataCountMessage]);
         var jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
         if (!maxRetries)
-            sourceCache.clear();
+            data = undefined;
         return postClient(jsonPayload).then(function () {
             retries = 0;
-            sourceCache.clear(); // we clear the queue if request successes.
+            data = undefined;
         }).catch(function (err) {
             if (!maxRetries) {
                 log[debugLogs ? 'debug' : 'warn'](constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else if (retries === maxRetries) {
                 retries = 0;
-                sourceCache.clear(); // we clear the queue if request fails after retries.
+                data = undefined;
                 log[debugLogs ? 'debug' : 'warn'](constants_1.SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else {

package/cjs/sync/submitters/telemetrySubmitter.js

@@ -17,7 +17,7 @@ function telemetryCacheStatsAdapter(telemetry, splits, segments) {
         isEmpty: function () { return false; },
         clear: function () { },
         // @TODO consider moving inside telemetry cache for code size reduction
-        state: function () {
+        pop: function () {
             return {
                 lS: telemetry.getLastSynchronization(),
                 mL: telemetry.popLatencies(),
@@ -80,7 +80,7 @@ function telemetryCacheConfigAdapter(telemetry, settings) {
     return {
         isEmpty: function () { return false; },
         clear: function () { },
-        state: function () {
+        pop: function () {
             var urls = settings.urls, scheduler = settings.scheduler;
             var isClientSide = settings.core.key !== undefined;
             return (0, objectAssign_1.objectAssign)(getTelemetryConfigStats(settings.mode, settings.storage.type), {

package/esm/listeners/browser.js

@@ -74,7 +74,7 @@ var BrowserSignalListener = /** @class */ (function () {
     BrowserSignalListener.prototype._flushData = function (url, cache, postService, fromCacheToPayload, extraMetadata) {
         // if there is data in cache, send it to backend
         if (!cache.isEmpty()) {
-            var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.state()) : cache.state();
+            var dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
             if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
                 postService(JSON.stringify(dataPayload)).catch(function () { }); // no-op just to catch a possible exception
             }

package/esm/logger/messages/warn.js

@@ -10,7 +10,7 @@ export var codesWarn = codesError.concat([
     [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
     [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
     [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s after retry. Reason: %s.'],
+    [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
     [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
     // client status
     [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],

package/esm/storages/inMemory/EventsCacheInMemory.js

@@ -32,10 +32,12 @@ var EventsCacheInMemory = /** @class */ (function () {
         this.queueByteSize = 0;
     };
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    EventsCacheInMemory.prototype.state = function () {
-        return this.queue;
+    EventsCacheInMemory.prototype.pop = function () {
+        var data = this.queue;
+        this.clear();
+        return data;
     };
     /**
      * Check if the cache is empty.

package/esm/storages/inMemory/ImpressionCountsCacheInMemory.js

@@ -18,14 +18,22 @@ var ImpressionCountsCacheInMemory = /** @class */ (function () {
         this.cache[key] = currentAmount ? currentAmount + amount : amount;
     };
     /**
-    * Returns all the elements stored in the cache and resets the cache.
-    */
-    ImpressionCountsCacheInMemory.prototype.state = function () {
-        return this.cache;
+     * Pop the collected data, used as payload for posting.
+     */
+    ImpressionCountsCacheInMemory.prototype.pop = function () {
+        var data = this.cache;
+        this.clear();
+        return data;
     };
+    /**
+     * Clear the data stored on the cache.
+     */
     ImpressionCountsCacheInMemory.prototype.clear = function () {
         this.cache = {};
     };
+    /**
+     * Check if the cache is empty.
+     */
     ImpressionCountsCacheInMemory.prototype.isEmpty = function () {
         return Object.keys(this.cache).length === 0;
     };

package/esm/storages/inMemory/ImpressionsCacheInMemory.js

@@ -30,10 +30,12 @@ var ImpressionsCacheInMemory = /** @class */ (function () {
         this.queue = [];
     };
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    ImpressionsCacheInMemory.prototype.state = function () {
-        return this.queue;
+    ImpressionsCacheInMemory.prototype.pop = function () {
+        var data = this.queue;
+        this.clear();
+        return data;
     };
     /**
      * Check if the cache is empty.

package/esm/sync/submitters/submitter.js

@@ -7,26 +7,30 @@ export function submitterFactory(log, postClient, sourceCache, postRate, dataNam
 ) {
     if (maxRetries === void 0) { maxRetries = 0; }
     var retries = 0;
+    var data;
     function postData() {
-        if (sourceCache.isEmpty())
-            return Promise.resolve();
-        var data = sourceCache.state();
+        if (!data) {
+            if (sourceCache.isEmpty())
+                return Promise.resolve();
+            // we clear the cache to track new items, while `data` is used for retries
+            data = sourceCache.pop();
+        }
         // @ts-ignore
         var dataCountMessage = typeof data.length === 'number' ? data.length + " " + dataName : dataName;
         log[debugLogs ? 'debug' : 'info'](SUBMITTERS_PUSH, [dataCountMessage]);
         var jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
         if (!maxRetries)
-            sourceCache.clear();
+            data = undefined;
         return postClient(jsonPayload).then(function () {
             retries = 0;
-            sourceCache.clear(); // we clear the queue if request successes.
+            data = undefined;
         }).catch(function (err) {
             if (!maxRetries) {
                 log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else if (retries === maxRetries) {
                 retries = 0;
-                sourceCache.clear(); // we clear the queue if request fails after retries.
+                data = undefined;
                 log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
             }
             else {

package/esm/sync/submitters/telemetrySubmitter.js

@@ -14,7 +14,7 @@ export function telemetryCacheStatsAdapter(telemetry, splits, segments) {
         isEmpty: function () { return false; },
         clear: function () { },
         // @TODO consider moving inside telemetry cache for code size reduction
-        state: function () {
+        pop: function () {
             return {
                 lS: telemetry.getLastSynchronization(),
                 mL: telemetry.popLatencies(),
@@ -75,7 +75,7 @@ export function telemetryCacheConfigAdapter(telemetry, settings) {
     return {
         isEmpty: function () { return false; },
         clear: function () { },
-        state: function () {
+        pop: function () {
             var urls = settings.urls, scheduler = settings.scheduler;
             var isClientSide = settings.core.key !== undefined;
             return objectAssign(getTelemetryConfigStats(settings.mode, settings.storage.type), {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.3.2-rc.7",
+  "version": "1.4.1-rc.1",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/listeners/browser.ts

@@ -92,7 +92,7 @@ export class BrowserSignalListener implements ISignalListener {
   private _flushData<TState>(url: string, cache: IRecorderCacheProducerSync<TState>, postService: (body: string) => Promise<IResponse>, fromCacheToPayload?: (cacheData: TState) => any, extraMetadata?: {}) {
     // if there is data in cache, send it to backend
     if (!cache.isEmpty()) {
-      const dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.state()) : cache.state();
+      const dataPayload = fromCacheToPayload ? fromCacheToPayload(cache.pop()) : cache.pop();
       if (!this._sendBeacon(url, dataPayload, extraMetadata)) {
         postService(JSON.stringify(dataPayload)).catch(() => { }); // no-op just to catch a possible exception
       }

package/src/logger/messages/warn.ts

@@ -11,7 +11,7 @@ export const codesWarn: [number, string][] = codesError.concat([
   [c.STREAMING_PARSING_ERROR_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE error notification: %s'],
   [c.STREAMING_PARSING_MESSAGE_FAILS, c.LOG_PREFIX_SYNC_STREAMING + 'Error parsing SSE message notification: %s'],
   [c.STREAMING_FALLBACK, c.LOG_PREFIX_SYNC_STREAMING + 'Falling back to polling mode. Reason: %s'],
-  [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Droping %s after retry. Reason: %s.'],
+  [c.SUBMITTERS_PUSH_FAILS, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Dropping %s after retry. Reason: %s.'],
   [c.SUBMITTERS_PUSH_RETRY, c.LOG_PREFIX_SYNC_SUBMITTERS + 'Failed to push %s, keeping data to retry on next iteration. Reason: %s.'],
   // client status
   [c.CLIENT_NOT_READY, '%s: the SDK is not ready, results may be incorrect. Make sure to wait for SDK readiness before using this method.'],

package/src/storages/inMemory/EventsCacheInMemory.ts

@@ -46,10 +46,12 @@ export class EventsCacheInMemory implements IEventsCacheSync {
   }
 
   /**
-   * Get the collected data, used as payload for posting.
+   * Pop the collected data, used as payload for posting.
    */
-  state() {
-    return this.queue;
+  pop() {
+    const data = this.queue;
+    this.clear();
+    return data;
   }
 
   /**

package/src/storages/inMemory/ImpressionCountsCacheInMemory.ts

@@ -20,17 +20,27 @@ export class ImpressionCountsCacheInMemory implements IImpressionCountsCacheSync
     this.cache[key] = currentAmount ? currentAmount + amount : amount;
   }
 
+
+
   /**
-  * Returns all the elements stored in the cache and resets the cache.
-  */
-  state() {
-    return this.cache;
+   * Pop the collected data, used as payload for posting.
+   */
+  pop() {
+    const data = this.cache;
+    this.clear();
+    return data;
   }
 
+  /**
+   * Clear the data stored on the cache.
+   */
   clear() {
     this.cache = {};
   }
 
+  /**
+   * Check if the cache is empty.
+   */
   isEmpty() {
     return Object.keys(this.cache).length === 0;
   }

package/src/storages/inMemory/ImpressionsCacheInMemory.ts

@@ -41,10 +41,12 @@ export class ImpressionsCacheInMemory implements IImpressionsCacheSync {
   }
 
   /**
-   * Get the collected data, used as payload for posting.
+   * Pop the collected data, used as payload for posting.
    */
-  state() {
-    return this.queue;
+  pop() {
+    const data = this.queue;
+    this.clear();
+    return data;
   }
 
   /**

package/src/storages/types.ts

@@ -301,8 +301,8 @@ export interface IRecorderCacheProducerSync<T> {
   isEmpty(): boolean
   /* Clears cache data */
   clear(): void
-  /* Gets cache data */
-  state(): T
+  /* Pops cache data */
+  pop(): T
 }
 
 
@@ -352,8 +352,7 @@ export interface IImpressionCountsCacheSync extends IRecorderCacheProducerSync<R
 
   // Used by impressions count submitter in standalone and producer mode
   isEmpty(): boolean // check if cache is empty. Return true if the cache was just created or cleared.
-  clear(): void // clear cache data
-  state(): Record<string, number> // get cache data
+  pop(): Record<string, number> // pop cache data
 }
 
 

package/src/sync/submitters/submitter.ts

@@ -20,27 +20,31 @@ export function submitterFactory<TState>(
 ): ISyncTask<[], void> {
 
   let retries = 0;
+  let data: TState | undefined;
 
   function postData(): Promise<any> {
-    if (sourceCache.isEmpty()) return Promise.resolve();
+    if (!data) {
+      if (sourceCache.isEmpty()) return Promise.resolve();
+      // we clear the cache to track new items, while `data` is used for retries
+      data = sourceCache.pop();
+    }
 
-    const data = sourceCache.state();
     // @ts-ignore
     const dataCountMessage = typeof data.length === 'number' ? `${data.length} ${dataName}` : dataName;
     log[debugLogs ? 'debug' : 'info'](SUBMITTERS_PUSH, [dataCountMessage]);
 
     const jsonPayload = JSON.stringify(fromCacheToPayload ? fromCacheToPayload(data) : data);
-    if (!maxRetries) sourceCache.clear();
+    if (!maxRetries) data = undefined;
 
     return postClient(jsonPayload).then(() => {
       retries = 0;
-      sourceCache.clear(); // we clear the queue if request successes.
+      data = undefined;
     }).catch(err => {
       if (!maxRetries) {
         log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
       } else if (retries === maxRetries) {
         retries = 0;
-        sourceCache.clear(); // we clear the queue if request fails after retries.
+        data = undefined;
         log[debugLogs ? 'debug' : 'warn'](SUBMITTERS_PUSH_FAILS, [dataCountMessage, err]);
       } else {
         retries++;

package/src/sync/submitters/telemetrySubmitter.ts

@@ -19,7 +19,7 @@ export function telemetryCacheStatsAdapter(telemetry: ITelemetryCacheSync, split
     clear() { }, //  No-op
 
     // @TODO consider moving inside telemetry cache for code size reduction
-    state(): TelemetryUsageStatsPayload {
+    pop(): TelemetryUsageStatsPayload {
       return {
         lS: telemetry.getLastSynchronization(),
         mL: telemetry.popLatencies(),
@@ -88,7 +88,7 @@ export function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, sett
     isEmpty() { return false; },
     clear() { },
 
-    state(): TelemetryConfigStatsPayload {
+    pop(): TelemetryConfigStatsPayload {
       const { urls, scheduler } = settings;
       const isClientSide = settings.core.key !== undefined;
 

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

@@ -21,9 +21,9 @@ export declare class EventsCacheInMemory implements IEventsCacheSync {
      */
     clear(): void;
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    state(): SplitIO.EventData[];
+    pop(): SplitIO.EventData[];
     /**
      * Check if the cache is empty.
      */

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

@@ -10,9 +10,15 @@ export declare class ImpressionCountsCacheInMemory implements IImpressionCountsC
     */
     track(featureName: string, timeFrame: number, amount: number): void;
     /**
-    * Returns all the elements stored in the cache and resets the cache.
-    */
-    state(): Record<string, number>;
+     * Pop the collected data, used as payload for posting.
+     */
+    pop(): Record<string, number>;
+    /**
+     * Clear the data stored on the cache.
+     */
     clear(): void;
+    /**
+     * Check if the cache is empty.
+     */
     isEmpty(): boolean;
 }

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

@@ -20,9 +20,9 @@ export declare class ImpressionsCacheInMemory implements IImpressionsCacheSync {
      */
     clear(): void;
     /**
-     * Get the collected data, used as payload for posting.
+     * Pop the collected data, used as payload for posting.
      */
-    state(): ImpressionDTO[];
+    pop(): ImpressionDTO[];
     /**
      * Check if the cache is empty.
      */

package/types/storages/types.d.ts

@@ -266,7 +266,7 @@ export interface IEventsCacheBase {
 export interface IRecorderCacheProducerSync<T> {
     isEmpty(): boolean;
     clear(): void;
-    state(): T;
+    pop(): T;
 }
 export interface IImpressionsCacheSync extends IImpressionsCacheBase, IRecorderCacheProducerSync<ImpressionDTO[]> {
     track(data: ImpressionDTO[]): void;
@@ -295,8 +295,7 @@ export interface IEventsCacheAsync extends IEventsCacheBase, IRecorderCacheProdu
 export interface IImpressionCountsCacheSync extends IRecorderCacheProducerSync<Record<string, number>> {
     track(featureName: string, timeFrame: number, amount: number): void;
     isEmpty(): boolean;
-    clear(): void;
-    state(): Record<string, number>;
+    pop(): Record<string, number>;
 }
 /**
  * Telemetry storage interface for standalone and partial consumer modes.

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

@@ -8,7 +8,7 @@ import { ISdkFactoryContextSync } from '../../sdkFactory/types';
 export declare function telemetryCacheStatsAdapter(telemetry: ITelemetryCacheSync, splits: ISplitsCacheSync, segments: ISegmentsCacheSync): {
     isEmpty(): boolean;
     clear(): void;
-    state(): TelemetryUsageStatsPayload;
+    pop(): TelemetryUsageStatsPayload;
 };
 export declare function getTelemetryConfigStats(mode: SDKMode, storageType: string): TelemetryConfigStats;
 /**
@@ -17,7 +17,7 @@ export declare function getTelemetryConfigStats(mode: SDKMode, storageType: stri
 export declare function telemetryCacheConfigAdapter(telemetry: ITelemetryCacheSync, settings: ISettings): {
     isEmpty(): boolean;
     clear(): void;
-    state(): TelemetryConfigStatsPayload;
+    pop(): TelemetryConfigStatsPayload;
 };
 /**
  * Submitter that periodically posts telemetry data