@splitsoftware/splitio-commons 1.9.1-rc.0 → 1.9.1

package/CHANGES.txt

@@ -1,10 +1,13 @@
+1.9.1 (September 21, 2023)
+ - Updated browser listener to avoid registering a handler for 'unload' DOM events, that can prevent browsers from being able to put pages in the back/forward cache for faster back and forward loads (Related to issue https://github.com/splitio/javascript-client/issues/759).
+
 1.9.0 (July 18, 2023)
  - Updated streaming architecture implementation to apply feature flag updates from the notification received which is now enhanced, improving efficiency and reliability of the whole update system.
 
 1.8.3 (June 29, 2023)
  - Updated some transitive dependencies for vulnerability fixes.
  - Updated SDK_READY_TIMED_OUT event to be emitted immediately when a connection error occurs using pluggable storage (i.e., when the wrapper `connect` promise is rejected) in consumer and partial consumer modes.
- - Bugfix - The `destroy` method has been updated to immediately flag the SDK client as destroyed, to prevent unexpected behaviours when `getTreatment` and `track` methods are called synchronously after `destroy` method is called.
+ - Bugfixing - The `destroy` method has been updated to immediately flag the SDK client as destroyed, to prevent unexpected behaviours when `getTreatment` and `track` methods are called synchronously after `destroy` method is called.
 
 1.8.2 (May 15, 2023)
  - Updated terminology on the SDKs codebase to be more aligned with current standard without causing a breaking change. The core change is the term split for feature flag on things like logs and IntelliSense comments.
@@ -90,7 +93,7 @@
    - Integration with Auth service V2, connecting to the new channels and applying the received connection delay.
    - Implemented handling of the new MySegmentsV2 notification types (SegmentRemoval, KeyList, Bounded and Unbounded)
    - New control notification for environment scoped streaming reset.
- - Updated localhost mode to emit SDK_READY_FROM_CACHE event in Browser when using localStorage (Related to issue https://github.com/splitio/react-client/issues/34).
+ - Updated localhost mode to emit SDK_READY_FROM_CACHE event in browser when using localStorage (Related to issue https://github.com/splitio/react-client/issues/34).
  - Updated dependencies for vulnerability fixes.
 
 0.1.0 (March 30, 2021)

package/cjs/integrations/ga/GaToSplit.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GaToSplit = exports.fixEventTypeId = exports.validateEventData = exports.validateIdentities = exports.defaultPrefix = exports.defaultMapper = void 0;
-/* eslint-disable no-undef */
 var objectAssign_1 = require("../../utils/lang/objectAssign");
 var lang_1 = require("../../utils/lang");
 var inputValidation_1 = require("../../utils/inputValidation");
@@ -252,6 +251,7 @@ function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
+    // eslint-disable-next-line no-undef
     providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true, telemetryTracker);
 }
 exports.GaToSplit = GaToSplit;

package/cjs/listeners/browser.js

@@ -9,8 +9,7 @@ var constants_2 = require("../logger/constants");
 var consent_1 = require("../consent");
 var VISIBILITYCHANGE_EVENT = 'visibilitychange';
 var PAGEHIDE_EVENT = 'pagehide';
-var UNLOAD_EVENT = 'unload';
-var EVENT_NAME = 'for unload page event.';
+var EVENT_NAME = 'for visibilitychange and pagehide events.';
 /**
  * We'll listen for events over the window object.
  */
@@ -22,7 +21,6 @@ var BrowserSignalListener = /** @class */ (function () {
         this.serviceApi = serviceApi;
         this.flushData = this.flushData.bind(this);
         this.flushDataIfHidden = this.flushDataIfHidden.bind(this);
-        this.stopSync = this.stopSync.bind(this);
         this.fromImpressionsCollector = impressionsSubmitter_1.fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
     }
     /**
@@ -36,11 +34,9 @@ var BrowserSignalListener = /** @class */ (function () {
             document.addEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
         }
         if (typeof window !== 'undefined' && window.addEventListener) {
-            // Some browsers like Safari does not fire the `visibilitychange` event when the page is being unloaded. So we also flush data in the `pagehide` event.
-            // If both events are triggered, the last one will find the storage empty, so no duplicated data will be submitted.
+            // Some browsers, like Safari, does not fire the `visibilitychange` event when the page is being unloaded. Therefore, we also flush data in the `pagehide` event.
+            // If both events are triggered, the latter will find the storage empty, so no duplicate data will be submitted.
             window.addEventListener(PAGEHIDE_EVENT, this.flushData);
-            // Stop streaming on 'unload' event. Used instead of 'beforeunload', because 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
-            window.addEventListener(UNLOAD_EVENT, this.stopSync);
         }
     };
     /**
@@ -54,14 +50,8 @@ var BrowserSignalListener = /** @class */ (function () {
         }
         if (typeof window !== 'undefined' && window.removeEventListener) {
             window.removeEventListener(PAGEHIDE_EVENT, this.flushData);
-            window.removeEventListener(UNLOAD_EVENT, this.stopSync);
         }
     };
-    BrowserSignalListener.prototype.stopSync = function () {
-        // Close streaming connection
-        if (this.syncManager && this.syncManager.pushManager)
-            this.syncManager.pushManager.stop();
-    };
     /**
      * flushData method.
      * Called when pagehide event is triggered. It flushed remaining impressions and events to the backend,

package/cjs/sdkClient/clientCS.js

@@ -20,10 +20,7 @@ function clientCSDecorator(log, client, key, trafficType) {
         getTreatmentsWithConfig: clientCS.getTreatmentsWithConfig.bind(clientCS, key),
         // Key is bound to the `track` method. Same thing happens with trafficType but only if provided
         track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
-        // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
-        isClientSide: true,
-        key: key,
-        trafficType: trafficType
+        isClientSide: true
     });
 }
 exports.clientCSDecorator = clientCSDecorator;

package/cjs/sync/streaming/parseUtils.js

@@ -10,6 +10,7 @@ function Uint8ArrayToString(myUint8Arr) {
 }
 function StringToUint8Array(myString) {
     var charCodes = myString.split('').map(function (e) { return e.charCodeAt(0); });
+    // eslint-disable-next-line compat/compat
     return new Uint8Array(charCodes);
 }
 /**

package/esm/integrations/ga/GaToSplit.js

@@ -1,4 +1,3 @@
-/* eslint-disable no-undef */
 import { objectAssign } from '../../utils/lang/objectAssign';
 import { isString, isFiniteNumber, uniqAsStrings } from '../../utils/lang';
 import { validateEvent, validateEventValue, validateEventProperties, validateKey, validateTrafficType } from '../../utils/inputValidation';
@@ -246,5 +245,6 @@ export function GaToSplit(sdkOptions, params) {
         return SplitTracker;
     }());
     // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
+    // eslint-disable-next-line no-undef
     providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true, telemetryTracker);
 }

package/esm/listeners/browser.js

@@ -6,8 +6,7 @@ import { CLEANUP_REGISTERING, CLEANUP_DEREGISTERING } from '../logger/constants'
 import { isConsentGranted } from '../consent';
 var VISIBILITYCHANGE_EVENT = 'visibilitychange';
 var PAGEHIDE_EVENT = 'pagehide';
-var UNLOAD_EVENT = 'unload';
-var EVENT_NAME = 'for unload page event.';
+var EVENT_NAME = 'for visibilitychange and pagehide events.';
 /**
  * We'll listen for events over the window object.
  */
@@ -19,7 +18,6 @@ var BrowserSignalListener = /** @class */ (function () {
         this.serviceApi = serviceApi;
         this.flushData = this.flushData.bind(this);
         this.flushDataIfHidden = this.flushDataIfHidden.bind(this);
-        this.stopSync = this.stopSync.bind(this);
         this.fromImpressionsCollector = fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
     }
     /**
@@ -33,11 +31,9 @@ var BrowserSignalListener = /** @class */ (function () {
             document.addEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
         }
         if (typeof window !== 'undefined' && window.addEventListener) {
-            // Some browsers like Safari does not fire the `visibilitychange` event when the page is being unloaded. So we also flush data in the `pagehide` event.
-            // If both events are triggered, the last one will find the storage empty, so no duplicated data will be submitted.
+            // Some browsers, like Safari, does not fire the `visibilitychange` event when the page is being unloaded. Therefore, we also flush data in the `pagehide` event.
+            // If both events are triggered, the latter will find the storage empty, so no duplicate data will be submitted.
             window.addEventListener(PAGEHIDE_EVENT, this.flushData);
-            // Stop streaming on 'unload' event. Used instead of 'beforeunload', because 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
-            window.addEventListener(UNLOAD_EVENT, this.stopSync);
         }
     };
     /**
@@ -51,14 +47,8 @@ var BrowserSignalListener = /** @class */ (function () {
         }
         if (typeof window !== 'undefined' && window.removeEventListener) {
             window.removeEventListener(PAGEHIDE_EVENT, this.flushData);
-            window.removeEventListener(UNLOAD_EVENT, this.stopSync);
         }
     };
-    BrowserSignalListener.prototype.stopSync = function () {
-        // Close streaming connection
-        if (this.syncManager && this.syncManager.pushManager)
-            this.syncManager.pushManager.stop();
-    };
     /**
      * flushData method.
      * Called when pagehide event is triggered. It flushed remaining impressions and events to the backend,

package/esm/sdkClient/clientCS.js

@@ -17,9 +17,6 @@ export function clientCSDecorator(log, client, key, trafficType) {
         getTreatmentsWithConfig: clientCS.getTreatmentsWithConfig.bind(clientCS, key),
         // Key is bound to the `track` method. Same thing happens with trafficType but only if provided
         track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
-        // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
-        isClientSide: true,
-        key: key,
-        trafficType: trafficType
+        isClientSide: true
     });
 }

package/esm/sync/streaming/parseUtils.js

@@ -7,6 +7,7 @@ function Uint8ArrayToString(myUint8Arr) {
 }
 function StringToUint8Array(myString) {
     var charCodes = myString.split('').map(function (e) { return e.charCodeAt(0); });
+    // eslint-disable-next-line compat/compat
     return new Uint8Array(charCodes);
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.9.1-rc.0",
+  "version": "1.9.1",
   "description": "Split Javascript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",
@@ -60,12 +60,12 @@
     "@types/ioredis": "^4.28.0",
     "@types/jest": "^27.0.0",
     "@types/lodash": "^4.14.162",
-    "@typescript-eslint/eslint-plugin": "^4.2.0",
-    "@typescript-eslint/parser": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.6.0",
+    "@typescript-eslint/parser": "^6.6.0",
     "cross-env": "^7.0.2",
     "csv-streamify": "^4.0.0",
-    "eslint": "^7.32.0",
-    "eslint-plugin-compat": "3.7.0",
+    "eslint": "^8.48.0",
+    "eslint-plugin-compat": "^4.2.0",
     "eslint-plugin-import": "^2.25.3",
     "fetch-mock": "^9.11.0",
     "ioredis": "^4.28.0",

package/src/integrations/ga/GaToSplit.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-undef */
 import { objectAssign } from '../../utils/lang/objectAssign';
 import { isString, isFiniteNumber, uniqAsStrings } from '../../utils/lang';
 import {
@@ -295,5 +294,6 @@ export function GaToSplit(sdkOptions: GoogleAnalyticsToSplitOptions, params: IIn
   }
 
   // Register the plugin, even if config is invalid, since, if not provided, it will block `ga` command queue.
+  // eslint-disable-next-line no-undef
   providePlugin(window, 'splitTracker', SplitTracker, log, sdkOptions.autoRequire === true, telemetryTracker);
 }

package/src/listeners/browser.ts

@@ -15,8 +15,7 @@ import { isConsentGranted } from '../consent';
 
 const VISIBILITYCHANGE_EVENT = 'visibilitychange';
 const PAGEHIDE_EVENT = 'pagehide';
-const UNLOAD_EVENT = 'unload';
-const EVENT_NAME = 'for unload page event.';
+const EVENT_NAME = 'for visibilitychange and pagehide events.';
 
 /**
  * We'll listen for events over the window object.
@@ -33,7 +32,6 @@ export class BrowserSignalListener implements ISignalListener {
   ) {
     this.flushData = this.flushData.bind(this);
     this.flushDataIfHidden = this.flushDataIfHidden.bind(this);
-    this.stopSync = this.stopSync.bind(this);
     this.fromImpressionsCollector = fromImpressionsCollector.bind(undefined, settings.core.labelsEnabled);
   }
 
@@ -48,11 +46,9 @@ export class BrowserSignalListener implements ISignalListener {
       document.addEventListener(VISIBILITYCHANGE_EVENT, this.flushDataIfHidden);
     }
     if (typeof window !== 'undefined' && window.addEventListener) {
-      // Some browsers like Safari does not fire the `visibilitychange` event when the page is being unloaded. So we also flush data in the `pagehide` event.
-      // If both events are triggered, the last one will find the storage empty, so no duplicated data will be submitted.
+      // Some browsers, like Safari, does not fire the `visibilitychange` event when the page is being unloaded. Therefore, we also flush data in the `pagehide` event.
+      // If both events are triggered, the latter will find the storage empty, so no duplicate data will be submitted.
       window.addEventListener(PAGEHIDE_EVENT, this.flushData);
-      // Stop streaming on 'unload' event. Used instead of 'beforeunload', because 'unload' is not a cancelable event, so no other listeners can stop the event from occurring.
-      window.addEventListener(UNLOAD_EVENT, this.stopSync);
     }
   }
 
@@ -67,15 +63,9 @@ export class BrowserSignalListener implements ISignalListener {
     }
     if (typeof window !== 'undefined' && window.removeEventListener) {
       window.removeEventListener(PAGEHIDE_EVENT, this.flushData);
-      window.removeEventListener(UNLOAD_EVENT, this.stopSync);
     }
   }
 
-  stopSync() {
-    // Close streaming connection
-    if (this.syncManager && this.syncManager.pushManager) this.syncManager.pushManager.stop();
-  }
-
   /**
    * flushData method.
    * Called when pagehide event is triggered. It flushed remaining impressions and events to the backend,

package/src/sdkClient/clientCS.ts

@@ -25,9 +25,6 @@ export function clientCSDecorator(log: ILogger, client: SplitIO.IClient, key: Sp
     // Key is bound to the `track` method. Same thing happens with trafficType but only if provided
     track: trafficType ? clientCS.track.bind(clientCS, key, trafficType) : clientCS.track.bind(clientCS, key),
 
-    // Not part of the public API. These properties are used to support other modules (e.g., Split Suite)
-    isClientSide: true,
-    key,
-    trafficType
+    isClientSide: true
   }) as SplitIO.ICsClient;
 }

package/src/storages/inMemory/TelemetryCacheInMemory.ts

@@ -181,7 +181,7 @@ export class TelemetryCacheInMemory implements ITelemetryCacheSync {
     this.e = false;
   }
 
-  private streamingEvents: StreamingEvent[] = []
+  private streamingEvents: StreamingEvent[] = [];
 
   popStreamingEvents() {
     return this.streamingEvents.splice(0);

package/src/storages/inRedis/RedisAdapter.ts

@@ -33,7 +33,7 @@ interface IRedisCommand {
  * Redis adapter on top of the library of choice (written with ioredis) for some extra control.
  */
 export class RedisAdapter extends ioredis {
-  private readonly log: ILogger
+  private readonly log: ILogger;
   private _options: object;
   private _notReadyCommandsQueue?: IRedisCommand[];
   private _runningCommands: ISet<Promise<any>>;

package/src/sync/streaming/parseUtils.ts

@@ -11,6 +11,7 @@ function Uint8ArrayToString(myUint8Arr: Uint8Array) { // @ts-ignore
 
 function StringToUint8Array(myString: string) {
   const charCodes = myString.split('').map((e) => e.charCodeAt(0));
+  // eslint-disable-next-line compat/compat
   return new Uint8Array(charCodes);
 }
 

package/src/utils/redis/RedisMock.ts

@@ -13,7 +13,7 @@ const PIPELINE_METHODS = ['rpush', 'hincrby'];
 
 export class RedisMock {
 
-  private pipelineMethods: any = { exec: jest.fn(asyncFunction) }
+  private pipelineMethods: any = { exec: jest.fn(asyncFunction) };
 
   constructor() {
     IDENTITY_METHODS.forEach(method => {

package/types/listeners/browser.d.ts

@@ -23,7 +23,6 @@ export declare class BrowserSignalListener implements ISignalListener {
      * Called when client is destroyed, it removes event listeners.
      */
     stop(): void;
-    stopSync(): void;
     /**
      * flushData method.
      * Called when pagehide event is triggered. It flushed remaining impressions and events to the backend,