@splitsoftware/splitio-commons 1.17.0-rc.2 → 1.17.0-rc.4

package/CHANGES.txt

@@ -1,5 +1,6 @@
-1.17.0 (August XXX, 2024)
+1.17.0 (September 6, 2024)
  - Added `sync.requestOptions.getHeaderOverrides` configuration option to enhance SDK HTTP request Headers for Authorization Frameworks.
+ - Added `isTimedout` and `lastUpdate` properties to IStatusInterface to keep track of the timestamp of the last SDK event, used on React and Redux SDKs.
  - Updated some transitive dependencies for vulnerability fixes.
 
 1.16.0 (June 13, 2024)

package/cjs/readiness/readinessManager.js

@@ -31,6 +31,12 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
     if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
     var segments = segmentsEventEmitterFactory(EventEmitter);
     var gate = new EventEmitter();
+    var lastUpdate = 0;
+    function syncLastUpdate() {
+        var dateNow = Date.now();
+        // ensure lastUpdate is always increasing per event, is case Date.now() is mocked or its value is the same
+        lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
+    }
     // emit SDK_READY_FROM_CACHE
     var isReadyFromCache = false;
     if (splits.splitsCacheLoaded)
@@ -43,6 +49,7 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         if (hasTimedout)
             return;
         hasTimedout = true;
+        syncLastUpdate();
         gate.emit(constants_1.SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
     }
     var readyTimeoutId;
@@ -59,6 +66,7 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
         if (!isReady) {
             try {
+                syncLastUpdate();
                 gate.emit(constants_1.SDK_READY_FROM_CACHE);
             }
             catch (e) {
@@ -70,6 +78,7 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
     function checkIsReadyOrUpdate(diff) {
         if (isReady) {
             try {
+                syncLastUpdate();
                 gate.emit(constants_1.SDK_UPDATE, diff);
             }
             catch (e) {
@@ -82,6 +91,7 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
                 clearTimeout(readyTimeoutId);
                 isReady = true;
                 try {
+                    syncLastUpdate();
                     gate.emit(constants_1.SDK_READY);
                 }
                 catch (e) {
@@ -109,6 +119,7 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         setDestroyed: function () { isDestroyed = true; },
         destroy: function () {
             isDestroyed = true;
+            syncLastUpdate();
             segments.removeAllListeners();
             gate.removeAllListeners();
             clearTimeout(readyTimeoutId);
@@ -118,10 +129,12 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
                 splits.removeAllListeners();
         },
         isReady: function () { return isReady; },
-        hasTimedout: function () { return hasTimedout; },
         isReadyFromCache: function () { return isReadyFromCache; },
+        isTimedout: function () { return hasTimedout && !isReady; },
+        hasTimedout: function () { return hasTimedout; },
         isDestroyed: function () { return isDestroyed; },
-        isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; }
+        isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; },
+        lastUpdate: function () { return lastUpdate; }
     };
 }
 exports.readinessManagerFactory = readinessManagerFactory;

package/cjs/readiness/sdkReadinessManager.js

@@ -107,14 +107,15 @@ function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessMa
                 }
                 return readyPromise;
             },
-            // Expose status for internal purposes only. Not considered part of the public API, and might be updated eventually.
             __getStatus: function () {
                 return {
                     isReady: readinessManager.isReady(),
                     isReadyFromCache: readinessManager.isReadyFromCache(),
-                    isOperational: readinessManager.isOperational(),
+                    isTimedout: readinessManager.isTimedout(),
                     hasTimedout: readinessManager.hasTimedout(),
                     isDestroyed: readinessManager.isDestroyed(),
+                    isOperational: readinessManager.isOperational(),
+                    lastUpdate: readinessManager.lastUpdate(),
                 };
             },
         })

package/esm/readiness/readinessManager.js

@@ -28,6 +28,12 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
     if (splits === void 0) { splits = splitsEventEmitterFactory(EventEmitter); }
     var segments = segmentsEventEmitterFactory(EventEmitter);
     var gate = new EventEmitter();
+    var lastUpdate = 0;
+    function syncLastUpdate() {
+        var dateNow = Date.now();
+        // ensure lastUpdate is always increasing per event, is case Date.now() is mocked or its value is the same
+        lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
+    }
     // emit SDK_READY_FROM_CACHE
     var isReadyFromCache = false;
     if (splits.splitsCacheLoaded)
@@ -40,6 +46,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         if (hasTimedout)
             return;
         hasTimedout = true;
+        syncLastUpdate();
         gate.emit(SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
     }
     var readyTimeoutId;
@@ -56,6 +63,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
         if (!isReady) {
             try {
+                syncLastUpdate();
                 gate.emit(SDK_READY_FROM_CACHE);
             }
             catch (e) {
@@ -67,6 +75,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
     function checkIsReadyOrUpdate(diff) {
         if (isReady) {
             try {
+                syncLastUpdate();
                 gate.emit(SDK_UPDATE, diff);
             }
             catch (e) {
@@ -79,6 +88,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
                 clearTimeout(readyTimeoutId);
                 isReady = true;
                 try {
+                    syncLastUpdate();
                     gate.emit(SDK_READY);
                 }
                 catch (e) {
@@ -106,6 +116,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         setDestroyed: function () { isDestroyed = true; },
         destroy: function () {
             isDestroyed = true;
+            syncLastUpdate();
             segments.removeAllListeners();
             gate.removeAllListeners();
             clearTimeout(readyTimeoutId);
@@ -115,9 +126,11 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
                 splits.removeAllListeners();
         },
         isReady: function () { return isReady; },
-        hasTimedout: function () { return hasTimedout; },
         isReadyFromCache: function () { return isReadyFromCache; },
+        isTimedout: function () { return hasTimedout && !isReady; },
+        hasTimedout: function () { return hasTimedout; },
         isDestroyed: function () { return isDestroyed; },
-        isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; }
+        isOperational: function () { return (isReady || isReadyFromCache) && !isDestroyed; },
+        lastUpdate: function () { return lastUpdate; }
     };
 }

package/esm/readiness/sdkReadinessManager.js

@@ -104,14 +104,15 @@ export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, read
                 }
                 return readyPromise;
             },
-            // Expose status for internal purposes only. Not considered part of the public API, and might be updated eventually.
             __getStatus: function () {
                 return {
                     isReady: readinessManager.isReady(),
                     isReadyFromCache: readinessManager.isReadyFromCache(),
-                    isOperational: readinessManager.isOperational(),
+                    isTimedout: readinessManager.isTimedout(),
                     hasTimedout: readinessManager.hasTimedout(),
                     isDestroyed: readinessManager.isDestroyed(),
+                    isOperational: readinessManager.isOperational(),
+                    lastUpdate: readinessManager.lastUpdate(),
                 };
             },
         })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.17.0-rc.2",
+  "version": "1.17.0-rc.4",
   "description": "Split JavaScript SDK common components",
   "main": "cjs/index.js",
   "module": "esm/index.js",

package/src/readiness/readinessManager.ts

@@ -39,6 +39,13 @@ export function readinessManagerFactory(
   const segments: ISegmentsEventEmitter = segmentsEventEmitterFactory(EventEmitter);
   const gate: IReadinessEventEmitter = new EventEmitter();
 
+  let lastUpdate = 0;
+  function syncLastUpdate() {
+    const dateNow = Date.now();
+    // ensure lastUpdate is always increasing per event, is case Date.now() is mocked or its value is the same
+    lastUpdate = dateNow > lastUpdate ? dateNow : lastUpdate + 1;
+  }
+
   // emit SDK_READY_FROM_CACHE
   let isReadyFromCache = false;
   if (splits.splitsCacheLoaded) isReadyFromCache = true; // ready from cache, but doesn't emit SDK_READY_FROM_CACHE
@@ -50,6 +57,7 @@ export function readinessManagerFactory(
   function timeout() {
     if (hasTimedout) return;
     hasTimedout = true;
+    syncLastUpdate();
     gate.emit(SDK_READY_TIMED_OUT, 'Split SDK emitted SDK_READY_TIMED_OUT event.');
   }
 
@@ -70,6 +78,7 @@ export function readinessManagerFactory(
     // Don't emit SDK_READY_FROM_CACHE if SDK_READY has been emitted
     if (!isReady) {
       try {
+        syncLastUpdate();
         gate.emit(SDK_READY_FROM_CACHE);
       } catch (e) {
         // throws user callback exceptions in next tick
@@ -81,6 +90,7 @@ export function readinessManagerFactory(
   function checkIsReadyOrUpdate(diff: any) {
     if (isReady) {
       try {
+        syncLastUpdate();
         gate.emit(SDK_UPDATE, diff);
       } catch (e) {
         // throws user callback exceptions in next tick
@@ -91,6 +101,7 @@ export function readinessManagerFactory(
         clearTimeout(readyTimeoutId);
         isReady = true;
         try {
+          syncLastUpdate();
           gate.emit(SDK_READY);
         } catch (e) {
           // throws user callback exceptions in next tick
@@ -121,6 +132,7 @@ export function readinessManagerFactory(
 
     destroy() {
       isDestroyed = true;
+      syncLastUpdate();
 
       segments.removeAllListeners();
       gate.removeAllListeners();
@@ -131,10 +143,12 @@ export function readinessManagerFactory(
     },
 
     isReady() { return isReady; },
-    hasTimedout() { return hasTimedout; },
     isReadyFromCache() { return isReadyFromCache; },
+    isTimedout() { return hasTimedout && !isReady; },
+    hasTimedout() { return hasTimedout; },
     isDestroyed() { return isDestroyed; },
-    isOperational() { return (isReady || isReadyFromCache) && !isDestroyed; }
+    isOperational() { return (isReady || isReadyFromCache) && !isDestroyed; },
+    lastUpdate() { return lastUpdate; }
   };
 
 }

package/src/readiness/sdkReadinessManager.ts

@@ -121,14 +121,15 @@ export function sdkReadinessManagerFactory(
           return readyPromise;
         },
 
-        // Expose status for internal purposes only. Not considered part of the public API, and might be updated eventually.
         __getStatus() {
           return {
             isReady: readinessManager.isReady(),
             isReadyFromCache: readinessManager.isReadyFromCache(),
-            isOperational: readinessManager.isOperational(),
+            isTimedout: readinessManager.isTimedout(),
             hasTimedout: readinessManager.hasTimedout(),
             isDestroyed: readinessManager.isDestroyed(),
+            isOperational: readinessManager.isOperational(),
+            lastUpdate: readinessManager.lastUpdate(),
           };
         },
       }

package/src/readiness/types.ts

@@ -50,9 +50,11 @@ export interface IReadinessManager {
   /** Readiness status */
   isReady(): boolean,
   isReadyFromCache(): boolean,
+  isTimedout(): boolean,
   hasTimedout(): boolean,
   isDestroyed(): boolean,
   isOperational(): boolean,
+  lastUpdate(): number,
 
   timeout(): void,
   setDestroyed(): void,

package/src/types.ts

@@ -409,6 +409,17 @@ export interface IStatusInterface extends IEventEmitter {
    * @returns {Promise<void>}
    */
   ready(): Promise<void>
+
+  // Expose status for internal purposes only. Not considered part of the public API, and might be updated eventually.
+  __getStatus(): {
+    isReady: boolean;
+    isReadyFromCache: boolean;
+    isTimedout: boolean;
+    hasTimedout: boolean;
+    isDestroyed: boolean;
+    isOperational: boolean;
+    lastUpdate: number;
+  }
 }
 /**
  * Common definitions between clients for different environments interface.

package/types/readiness/types.d.ts

@@ -38,9 +38,11 @@ export interface IReadinessManager {
     /** Readiness status */
     isReady(): boolean;
     isReadyFromCache(): boolean;
+    isTimedout(): boolean;
     hasTimedout(): boolean;
     isDestroyed(): boolean;
     isOperational(): boolean;
+    lastUpdate(): number;
     timeout(): void;
     setDestroyed(): void;
     destroy(): void;

package/types/sync/streaming/pushManagerCS_Spec1_3.d.ts

@@ -0,0 +1,9 @@
+import { IPushManager } from './types';
+import { IPollingManager } from '../polling/types';
+import { ISdkFactoryContextSync } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - 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 declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

package/types/sync/streaming/pushManager_Spec1_3.d.ts

@@ -0,0 +1,9 @@
+import { IPushManager } from './types';
+import { IPollingManager } from '../polling/types';
+import { ISdkFactoryContextSync } from '../../sdkFactory/types';
+/**
+ * PushManager factory:
+ * - 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 declare function pushManagerFactory(params: ISdkFactoryContextSync, pollingManager: IPollingManager): IPushManager | undefined;

package/types/types.d.ts

@@ -407,6 +407,15 @@ export interface IStatusInterface extends IEventEmitter {
      * @returns {Promise<void>}
      */
     ready(): Promise<void>;
+    __getStatus(): {
+        isReady: boolean;
+        isReadyFromCache: boolean;
+        isTimedout: boolean;
+        hasTimedout: boolean;
+        isDestroyed: boolean;
+        isOperational: boolean;
+        lastUpdate: number;
+    };
 }
 /**
  * Common definitions between clients for different environments interface.