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

package/CHANGES.txt

@@ -1,6 +1,6 @@
 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.
+ - 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

@@ -129,8 +129,9 @@ 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; },
         lastUpdate: function () { return lastUpdate; }

package/cjs/readiness/sdkReadinessManager.js

@@ -107,14 +107,14 @@ 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/cjs/sync/streaming/SSEClient/index.js

@@ -63,14 +63,16 @@ var SSEClient = /** @class */ (function () {
             return encodeURIComponent(params + channel);
         }).join(',');
         var url = this.settings.urls.streaming + "/sse?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
-        // use headers in server-side or if getHeaderOverrides is defined
-        var useHeaders = !this.settings.core.key || ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides);
+        var isServerSide = !this.settings.core.key;
         this.connection = new this.eventSource(
-        // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
-        // because native EventSource implementations for browser doesn't support headers.
-        useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
-        // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        (0, objectAssign_1.objectAssign)(useHeaders ? { headers: (0, decorateHeaders_1.decorateHeaders)(this.settings, this.headers) } : {}, this.options));
+        // For client-side SDKs, metadata is passed as query param to avoid CORS issues and because native EventSource implementations in browsers do not support headers
+        isServerSide ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
+        // For server-side SDKs, metadata is passed via headers. For NodeJS, the SDK uses an EventSource that support headers
+        (0, objectAssign_1.objectAssign)(isServerSide ?
+            { headers: (0, decorateHeaders_1.decorateHeaders)(this.settings, this.headers) } :
+            ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) ?
+                { headers: (0, decorateHeaders_1.decorateHeaders)(this.settings, {}) } : // Assuming the user is providing a window.EventSource polyfill that supports headers
+                {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/esm/readiness/readinessManager.js

@@ -126,8 +126,9 @@ 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; },
         lastUpdate: function () { return lastUpdate; }

package/esm/readiness/sdkReadinessManager.js

@@ -104,14 +104,14 @@ 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/esm/sync/streaming/SSEClient/index.js

@@ -60,14 +60,16 @@ var SSEClient = /** @class */ (function () {
             return encodeURIComponent(params + channel);
         }).join(',');
         var url = this.settings.urls.streaming + "/sse?channels=" + channelsQueryParam + "&accessToken=" + authToken.token + "&v=" + ABLY_API_VERSION + "&heartbeats=true"; // same results using `&heartbeats=false`
-        // use headers in server-side or if getHeaderOverrides is defined
-        var useHeaders = !this.settings.core.key || ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides);
+        var isServerSide = !this.settings.core.key;
         this.connection = new this.eventSource(
-        // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
-        // because native EventSource implementations for browser doesn't support headers.
-        useHeaders ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
-        // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-        objectAssign(useHeaders ? { headers: decorateHeaders(this.settings, this.headers) } : {}, this.options));
+        // For client-side SDKs, metadata is passed as query param to avoid CORS issues and because native EventSource implementations in browsers do not support headers
+        isServerSide ? url : url + ("&SplitSDKVersion=" + this.headers.SplitSDKVersion + "&SplitSDKClientKey=" + this.headers.SplitSDKClientKey), 
+        // For server-side SDKs, metadata is passed via headers. For NodeJS, the SDK uses an EventSource that support headers
+        objectAssign(isServerSide ?
+            { headers: decorateHeaders(this.settings, this.headers) } :
+            ((_a = this.settings.sync.requestOptions) === null || _a === void 0 ? void 0 : _a.getHeaderOverrides) ?
+                { headers: decorateHeaders(this.settings, {}) } : // Assuming the user is providing a window.EventSource polyfill that supports headers
+                {}, this.options));
         if (this.handler) { // no need to check if SSEClient is used only by PushManager
             this.connection.addEventListener('open', this.handler.handleOpen);
             this.connection.addEventListener('message', this.handler.handleMessage);

package/package.json

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

package/src/readiness/readinessManager.ts

@@ -143,8 +143,9 @@ 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; },
     lastUpdate() { return lastUpdate; }

package/src/readiness/sdkReadinessManager.ts

@@ -121,14 +121,14 @@ 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,6 +50,7 @@ export interface IReadinessManager {
   /** Readiness status */
   isReady(): boolean,
   isReadyFromCache(): boolean,
+  isTimedout(): boolean,
   hasTimedout(): boolean,
   isDestroyed(): boolean,
   isOperational(): boolean,

package/src/sync/streaming/SSEClient/index.ts

@@ -78,15 +78,20 @@ export class SSEClient implements ISSEClient {
       }
     ).join(',');
     const url = `${this.settings.urls.streaming}/sse?channels=${channelsQueryParam}&accessToken=${authToken.token}&v=${ABLY_API_VERSION}&heartbeats=true`; // same results using `&heartbeats=false`
-    // use headers in server-side or if getHeaderOverrides is defined
-    const useHeaders = !this.settings.core.key || this.settings.sync.requestOptions?.getHeaderOverrides;
+    const isServerSide = !this.settings.core.key;
 
     this.connection = new this.eventSource!(
-      // For client-side SDKs, SplitSDKClientKey and SplitSDKClientKey metadata is passed as query params,
-      // because native EventSource implementations for browser doesn't support headers.
-      useHeaders ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,
-      // For server-side SDKs, metadata is passed via headers. EventSource must support headers, like 'eventsource' package for Node.
-      objectAssign(useHeaders ? { headers: decorateHeaders(this.settings, this.headers) } : {}, this.options)
+      // For client-side SDKs, metadata is passed as query param to avoid CORS issues and because native EventSource implementations in browsers do not support headers
+      isServerSide ? url : url + `&SplitSDKVersion=${this.headers.SplitSDKVersion}&SplitSDKClientKey=${this.headers.SplitSDKClientKey}`,
+      // For server-side SDKs, metadata is passed via headers. For NodeJS, the SDK uses an EventSource that support headers
+      objectAssign(
+        isServerSide ?
+          { headers: decorateHeaders(this.settings, this.headers) } :
+          this.settings.sync.requestOptions?.getHeaderOverrides ?
+            { headers: decorateHeaders(this.settings, {}) } : // Assuming the user is providing a window.EventSource polyfill that supports headers
+            {},
+        this.options
+      )
     );
 
     if (this.handler) { // no need to check if SSEClient is used only by PushManager

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,6 +38,7 @@ export interface IReadinessManager {
     /** Readiness status */
     isReady(): boolean;
     isReadyFromCache(): boolean;
+    isTimedout(): boolean;
     hasTimedout(): boolean;
     isDestroyed(): boolean;
     isOperational(): boolean;

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.