@splitsoftware/splitio-commons 1.17.0-rc.1 → 1.17.0-rc.3

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 lastUpdate property to ReadinessManager 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);
@@ -121,7 +132,8 @@ function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         hasTimedout: function () { return hasTimedout; },
         isReadyFromCache: function () { return isReadyFromCache; },
         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

@@ -115,6 +115,7 @@ function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, readinessMa
                     isOperational: readinessManager.isOperational(),
                     hasTimedout: readinessManager.hasTimedout(),
                     isDestroyed: readinessManager.isDestroyed(),
+                    lastUpdate: readinessManager.lastUpdate(),
                 };
             },
         })

package/cjs/services/decorateHeaders.js

@@ -18,20 +18,13 @@ var FORBIDDEN_HEADERS = new sets_1._Set([
     'keep-alive',
     'x-fastly-debug'
 ]);
-function copyToLowerCase(obj) {
-    return Object.keys(obj).reduce(function (acc, key) {
-        acc[key.toLowerCase()] = obj[key];
-        return acc;
-    }, {});
-}
 function decorateHeaders(settings, headers) {
     var _a;
     if ((_a = settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) {
-        headers = copyToLowerCase(headers);
         try {
-            var headerOverrides_1 = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: (0, objectAssign_1.objectAssign)({}, headers) }));
+            var headerOverrides_1 = settings.sync.requestOptions.getHeaderOverrides({ headers: (0, objectAssign_1.objectAssign)({}, headers) });
             Object.keys(headerOverrides_1)
-                .filter(function (key) { return !FORBIDDEN_HEADERS.has(key); })
+                .filter(function (key) { return !FORBIDDEN_HEADERS.has(key.toLowerCase()); })
                 .forEach(function (key) { return headers[key] = headerOverrides_1[key]; });
         }
         catch (e) {

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);
@@ -118,6 +129,7 @@ export function readinessManagerFactory(EventEmitter, readyTimeout, splits) {
         hasTimedout: function () { return hasTimedout; },
         isReadyFromCache: function () { return isReadyFromCache; },
         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

@@ -112,6 +112,7 @@ export function sdkReadinessManagerFactory(log, EventEmitter, readyTimeout, read
                     isOperational: readinessManager.isOperational(),
                     hasTimedout: readinessManager.hasTimedout(),
                     isDestroyed: readinessManager.isDestroyed(),
+                    lastUpdate: readinessManager.lastUpdate(),
                 };
             },
         })

package/esm/services/decorateHeaders.js

@@ -15,20 +15,13 @@ var FORBIDDEN_HEADERS = new _Set([
     'keep-alive',
     'x-fastly-debug'
 ]);
-function copyToLowerCase(obj) {
-    return Object.keys(obj).reduce(function (acc, key) {
-        acc[key.toLowerCase()] = obj[key];
-        return acc;
-    }, {});
-}
 export function decorateHeaders(settings, headers) {
     var _a;
     if ((_a = settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) {
-        headers = copyToLowerCase(headers);
         try {
-            var headerOverrides_1 = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
+            var headerOverrides_1 = settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) });
             Object.keys(headerOverrides_1)
-                .filter(function (key) { return !FORBIDDEN_HEADERS.has(key); })
+                .filter(function (key) { return !FORBIDDEN_HEADERS.has(key.toLowerCase()); })
                 .forEach(function (key) { return headers[key] = headerOverrides_1[key]; });
         }
         catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-commons",
-  "version": "1.17.0-rc.1",
+  "version": "1.17.0-rc.3",
   "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();
@@ -134,7 +146,8 @@ export function readinessManagerFactory(
     hasTimedout() { return hasTimedout; },
     isReadyFromCache() { return isReadyFromCache; },
     isDestroyed() { return isDestroyed; },
-    isOperational() { return (isReady || isReadyFromCache) && !isDestroyed; }
+    isOperational() { return (isReady || isReadyFromCache) && !isDestroyed; },
+    lastUpdate() { return lastUpdate; }
   };
 
 }

package/src/readiness/sdkReadinessManager.ts

@@ -129,6 +129,7 @@ export function sdkReadinessManagerFactory(
             isOperational: readinessManager.isOperational(),
             hasTimedout: readinessManager.hasTimedout(),
             isDestroyed: readinessManager.isDestroyed(),
+            lastUpdate: readinessManager.lastUpdate(),
           };
         },
       }

package/src/readiness/types.ts

@@ -53,6 +53,7 @@ export interface IReadinessManager {
   hasTimedout(): boolean,
   isDestroyed(): boolean,
   isOperational(): boolean,
+  lastUpdate(): number,
 
   timeout(): void,
   setDestroyed(): void,

package/src/services/decorateHeaders.ts

@@ -18,20 +18,12 @@ const FORBIDDEN_HEADERS = new _Set([
   'x-fastly-debug'
 ]);
 
-function copyToLowerCase(obj: Record<string, string>) {
-  return Object.keys(obj).reduce<Record<string, string>>((acc, key) => {
-    acc[key.toLowerCase()] = obj[key];
-    return acc;
-  }, {});
-}
-
 export function decorateHeaders(settings: ISettings, headers: Record<string, string>) {
   if (settings.sync.requestOptions?.getHeaderOverrides) {
-    headers = copyToLowerCase(headers);
     try {
-      const headerOverrides = copyToLowerCase(settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) }));
+      const headerOverrides = settings.sync.requestOptions.getHeaderOverrides({ headers: objectAssign({}, headers) });
       Object.keys(headerOverrides)
-        .filter(key => !FORBIDDEN_HEADERS.has(key))
+        .filter(key => !FORBIDDEN_HEADERS.has(key.toLowerCase()))
         .forEach(key => headers[key] = headerOverrides[key]);
     } catch (e) {
       settings.log.error('Problem adding custom headers to request decorator: ' + e);

package/types/readiness/types.d.ts

@@ -41,6 +41,7 @@ export interface IReadinessManager {
     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;