chore: update JS SDK dependency and adapt to new getStatus API

EmilianoSanchez · EmilianoSanchez · commit 6c44714bf985 · 2025-10-29T14:03:08.000-03:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -63,7 +63,7 @@
   },
   "homepage": "https://github.com/splitio/react-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio": "11.7.1",
+    "@splitsoftware/splitio": "11.7.2-rc.4",
     "memoize-one": "^5.1.1",
     "shallowequal": "^1.1.0",
     "tslib": "^2.3.1"
diff --git a/src/__tests__/SplitClient.test.tsx b/src/__tests__/SplitClient.test.tsx
@@ -56,6 +56,7 @@ describe('SplitClient', () => {
               client: outerFactory.client(),
               isReady: true,
               isReadyFromCache: true,
+              isOperational: true,
               lastUpdate: getStatus(outerFactory.client()).lastUpdate
             });
 
@@ -141,7 +142,7 @@ describe('SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, true, true]);
                 break;
               case 2: // Updated. Although `updateOnSdkReady` is false, status props must reflect the current status of the client.
-                expect(statusProps).toStrictEqual([true, false, true, false]);
+                expect(statusProps).toStrictEqual([true, true, true, false]);
                 break;
               default:
                 fail('Child must not be rerendered');
@@ -182,7 +183,7 @@ describe('SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, false, false]);
                 break;
               case 1: // Ready
-                expect(statusProps).toStrictEqual([true, false, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
+                expect(statusProps).toStrictEqual([true, true, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
                 break;
               default:
                 fail('Child must not be rerendered');
@@ -214,7 +215,7 @@ describe('SplitClient', () => {
             count++;
 
             // side effect in the render phase
-            if (!(client as any).__getStatus().isReady) {
+            if (!client!.getStatus().isReady) {
               (client as any).__emitter__.emit(Event.SDK_READY);
             }
 
@@ -318,11 +319,11 @@ describe('SplitClient', () => {
                   break;
                 case 4:
                   expect(client).toBe(outerFactory.client('user3'));
-                  expect(statusProps).toStrictEqual([true, false, false, false]);
+                  expect(statusProps).toStrictEqual([true, true, false, false]);
                   break;
                 case 5:
                   expect(client).toBe(outerFactory.client('user3'));
-                  expect(statusProps).toStrictEqual([true, false, false, false]);
+                  expect(statusProps).toStrictEqual([true, true, false, false]);
                   break;
                 default:
                   fail('Child must not be rerendered');
@@ -501,7 +502,7 @@ describe('SplitFactoryProvider + SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, true, true]);
                 break;
               case 2: // Updated. Although `updateOnSdkReady` is false, status props must reflect the current status of the client.
-                expect(statusProps).toStrictEqual([true, false, true, false]);
+                expect(statusProps).toStrictEqual([true, true, true, false]);
                 break;
               default:
                 fail('Child must not be rerendered');
@@ -542,7 +543,7 @@ describe('SplitFactoryProvider + SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, true, true]);
                 break;
               case 2: // Updated. Although `updateOnSdkReady` is false, status props must reflect the current status of the client.
-                expect(statusProps).toStrictEqual([true, false, true, false]);
+                expect(statusProps).toStrictEqual([true, true, true, false]);
                 break;
               default:
                 fail('Child must not be rerendered');
@@ -578,7 +579,7 @@ describe('SplitFactoryProvider + SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, false, false]);
                 break;
               case 1: // Ready
-                expect(statusProps).toStrictEqual([true, false, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
+                expect(statusProps).toStrictEqual([true, true, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
                 break;
               default:
                 fail('Child must not be rerendered');
@@ -615,7 +616,7 @@ describe('SplitFactoryProvider + SplitClient', () => {
                 expect(statusProps).toStrictEqual([false, false, false, false]);
                 break;
               case 1: // Ready
-                expect(statusProps).toStrictEqual([true, false, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
+                expect(statusProps).toStrictEqual([true, true, true, false]); // not rerendering on SDK_TIMEOUT, but hasTimedout reflects the current state
                 break;
               default:
                 fail('Child must not be rerendered');
diff --git a/src/__tests__/SplitFactoryProvider.test.tsx b/src/__tests__/SplitFactoryProvider.test.tsx
@@ -70,6 +70,7 @@ describe('SplitFactoryProvider', () => {
             client: outerFactory.client(),
             isReady: true,
             isReadyFromCache: true,
+            isOperational: true,
             lastUpdate: getStatus(outerFactory.client()).lastUpdate
           });
           return null;
diff --git a/src/__tests__/SplitTreatments.test.tsx b/src/__tests__/SplitTreatments.test.tsx
@@ -69,7 +69,7 @@ describe('SplitTreatments', () => {
                     expect(clientMock.getTreatmentsWithConfig.mock.calls.length).toBe(1);
                     expect(treatments).toBe(clientMock.getTreatmentsWithConfig.mock.results[0].value);
                     expect(featureFlagNames).toBe(clientMock.getTreatmentsWithConfig.mock.calls[0][0]);
-                    expect([isReady2, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, false, false, false, false, getStatus(outerFactory.client()).lastUpdate]);
+                    expect([isReady2, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, true, false, false, false, getStatus(outerFactory.client()).lastUpdate]);
                     return null;
                   }}
                 </SplitTreatments>
diff --git a/src/__tests__/testUtils/mockSplitFactory.ts b/src/__tests__/testUtils/mockSplitFactory.ts
@@ -54,7 +54,7 @@ export function mockSdk() {
       }
 
       const __emitter__ = new EventEmitter();
-      __emitter__.on(Event.SDK_READY, () => { isReady = true; syncLastUpdate(); });
+      __emitter__.on(Event.SDK_READY, () => { isReady = true; isReadyFromCache = true; syncLastUpdate(); });
       __emitter__.on(Event.SDK_READY_FROM_CACHE, () => { isReadyFromCache = true; syncLastUpdate(); });
       __emitter__.on(Event.SDK_READY_TIMED_OUT, () => { hasTimedout = true; syncLastUpdate(); });
       __emitter__.on(Event.SDK_UPDATE, () => { syncLastUpdate(); });
@@ -96,13 +96,13 @@ export function mockSdk() {
           else { __emitter__.on(Event.SDK_READY_TIMED_OUT, rej); }
         });
       });
-      const __getStatus = () => ({
+      const getStatus = () => ({
         isReady,
         isReadyFromCache,
         isTimedout: hasTimedout && !isReady,
         hasTimedout,
         isDestroyed,
-        isOperational: (isReady || isReadyFromCache) && !isDestroyed,
+        isOperational: isReadyFromCache && !isDestroyed,
         lastUpdate,
       });
       const destroy: jest.Mock = jest.fn(() => {
@@ -122,10 +122,9 @@ export function mockSdk() {
         setAttributes,
         clearAttributes,
         getAttributes,
+        getStatus,
         // EventEmitter exposed to trigger events manually
         __emitter__,
-        // Clients expose a `__getStatus` method, that is not considered part of the public API, to get client readiness status (isReady, isReadyFromCache, isOperational, hasTimedout, isDestroyed)
-        __getStatus,
         // Restore the mock client to its initial NO-READY status.
         // Useful when you want to reuse the same mock between tests after emitting events or destroying the instance.
         __restore() {
diff --git a/src/__tests__/testUtils/utils.tsx b/src/__tests__/testUtils/utils.tsx
@@ -123,6 +123,7 @@ export const INITIAL_STATUS: ISplitStatus & IUpdateProps = {
   hasTimedout: false,
   lastUpdate: 0,
   isDestroyed: false,
+  isOperational: false,
   updateOnSdkReady: true,
   updateOnSdkReadyFromCache: true,
   updateOnSdkTimedout: true,
diff --git a/src/__tests__/useSplitClient.test.tsx b/src/__tests__/useSplitClient.test.tsx
@@ -207,7 +207,7 @@ describe('useSplitClient', () => {
 
           // side effect in the render phase
           const client = outerFactory.client('some_user') as any;
-          if (!client.__getStatus().isReady) client.__emitter__.emit(Event.SDK_READY);
+          if (!client.getStatus().isReady) client.__emitter__.emit(Event.SDK_READY);
 
           return null;
         })}
@@ -256,7 +256,7 @@ describe('useSplitClient', () => {
 
     act(() => mainClient.__emitter__.emit(Event.SDK_READY)); // trigger re-render
     expect(rendersCount).toBe(5);
-    expect(currentStatus).toMatchObject({ isReady: true, isReadyFromCache: false, hasTimedout: true });
+    expect(currentStatus).toMatchObject({ isReady: true, isReadyFromCache: true, hasTimedout: true });
 
     act(() => mainClient.__emitter__.emit(Event.SDK_UPDATE)); // do not trigger re-render because updateOnSdkUpdate is false
     expect(rendersCount).toBe(5);
diff --git a/src/__tests__/useSplitManager.test.tsx b/src/__tests__/useSplitManager.test.tsx
@@ -48,8 +48,9 @@ describe('useSplitManager', () => {
       hasTimedout: false,
       isDestroyed: false,
       isReady: true,
-      isReadyFromCache: false,
+      isReadyFromCache: true,
       isTimedout: false,
+      isOperational: true,
       lastUpdate: getStatus(outerFactory.client()).lastUpdate,
     });
   });
@@ -98,8 +99,9 @@ describe('useSplitManager', () => {
       hasTimedout: false,
       isDestroyed: false,
       isReady: true,
-      isReadyFromCache: false,
+      isReadyFromCache: true,
       isTimedout: false,
+      isOperational: true,
       lastUpdate: getStatus(outerFactory.client()).lastUpdate,
     });
   });
diff --git a/src/__tests__/withSplitFactory.test.tsx b/src/__tests__/withSplitFactory.test.tsx
@@ -40,7 +40,7 @@ describe('withSplitFactory', () => {
       const Component = withSplitFactory(undefined, outerFactory)(
         ({ factory, isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate }: ISplitFactoryChildProps) => {
           expect(factory).toBe(outerFactory);
-          expect([isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, false, false, false, false, 0]);
+          expect([isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, true, false, false, false, 0]);
           return null;
         }
       );
diff --git a/src/types.ts b/src/types.ts
@@ -1,45 +1,10 @@
 import type { ReactNode } from 'react';
 
+// @TODO: remove in next major release (it duplicates SplitIO.ReadinessStatus)
 /**
- * Split Status interface. It represents the readiness state of an SDK client.
+ * Readiness Status interface. It represents the readiness state of an SDK client.
  */
-export interface ISplitStatus {
-
-  /**
-   * `isReady` indicates if the Split SDK client has triggered an `SDK_READY` event and thus is ready to be consumed.
-   */
-  isReady: boolean;
-
-  /**
-   * `isReadyFromCache` indicates if the Split SDK client has triggered an `SDK_READY_FROM_CACHE` event and thus is ready to be consumed,
-   * although the data in cache might be stale.
-   */
-  isReadyFromCache: boolean;
-
-  /**
-   * `isTimedout` indicates if the Split SDK client has triggered an `SDK_READY_TIMED_OUT` event and is not ready to be consumed.
-   * In other words, `isTimedout` is equivalent to `hasTimedout && !isReady`.
-   */
-  isTimedout: boolean;
-
-  /**
-   * `hasTimedout` indicates if the Split SDK client has ever triggered an `SDK_READY_TIMED_OUT` event.
-   * It's meant to keep a reference that the SDK emitted a timeout at some point, not the current state.
-   */
-  hasTimedout: boolean;
-
-  /**
-   * `isDestroyed` indicates if the Split SDK client has been destroyed.
-   */
-  isDestroyed: boolean;
-
-  /**
-   * `lastUpdate` indicates the timestamp of the most recent status event. This timestamp is only updated for events that are being listened to,
-   * configured via the `updateOnSdkReady` option for `SDK_READY` event, `updateOnSdkReadyFromCache` for `SDK_READY_FROM_CACHE` event,
-   * `updateOnSdkTimedout` for `SDK_READY_TIMED_OUT` event, and `updateOnSdkUpdate` for `SDK_UPDATE` event.
-   */
-  lastUpdate: number;
-}
+export interface ISplitStatus extends SplitIO.ReadinessStatus {}
 
 /**
  * Update Props interface. It defines the props used to configure what SDK events are listened to update the component.
diff --git a/src/utils.ts b/src/utils.ts
@@ -3,32 +3,17 @@ import shallowEqual from 'shallowequal';
 import { CONTROL_WITH_CONFIG } from './constants';
 import { ISplitStatus } from './types';
 
-// Utils used to access singleton instances of Split factories and clients, and to gracefully shutdown all clients together.
-
-/**
- * ClientWithContext interface.
- */
-interface IClientWithContext extends SplitIO.IBrowserClient {
-  __getStatus(): {
-    isReady: boolean;
-    isReadyFromCache: boolean;
-    isTimedout: boolean;
-    hasTimedout: boolean;
-    isDestroyed: boolean;
-    isOperational: boolean;
-    lastUpdate: number;
-  };
-}
+// Utils used to access singleton instances of Split factories and clients
 
 export interface IFactoryWithLazyInit extends SplitIO.IBrowserSDK {
   config: SplitIO.IBrowserSettings;
   init(): void;
 }
 
 // idempotent operation
-export function getSplitClient(factory: SplitIO.IBrowserSDK, key?: SplitIO.SplitKey): IClientWithContext {
+export function getSplitClient(factory: SplitIO.IBrowserSDK, key?: SplitIO.SplitKey): SplitIO.IBrowserClient {
   // factory.client is an idempotent operation
-  const client = (key !== undefined ? factory.client(key) : factory.client()) as IClientWithContext;
+  const client = key !== undefined ? factory.client(key) : factory.client();
 
   // Remove EventEmitter warning emitted when using multiple SDK hooks or components.
   // Unlike JS SDK, users don't need to access the client directly, making the warning irrelevant.
@@ -38,18 +23,18 @@ export function getSplitClient(factory: SplitIO.IBrowserSDK, key?: SplitIO.Split
 }
 
 // Util used to get client status.
-// It might be removed in the future, if the JS SDK extends its public API with a `getStatus` method
 export function getStatus(client?: SplitIO.IBrowserClient): ISplitStatus {
-  const status = client && (client as IClientWithContext).__getStatus();
-
-  return {
-    isReady: status ? status.isReady : false,
-    isReadyFromCache: status ? status.isReadyFromCache : false,
-    isTimedout: status ? status.isTimedout : false,
-    hasTimedout: status ? status.hasTimedout : false,
-    isDestroyed: status ? status.isDestroyed : false,
-    lastUpdate: status ? status.lastUpdate : 0,
-  };
+  return client ?
+    client.getStatus() :
+    {
+      isReady: false,
+      isReadyFromCache: false,
+      isTimedout: false,
+      hasTimedout: false,
+      isDestroyed: false,
+      isOperational: false,
+      lastUpdate: 0,
+    };
 }
 
 /**
@@ -100,7 +85,7 @@ function argsAreEqual(newArgs: any[], lastArgs: any[]): boolean {
 }
 
 function evaluateFeatureFlags(client: SplitIO.IBrowserClient | undefined, _lastUpdate: number, names?: SplitIO.SplitNames, attributes?: SplitIO.Attributes, _clientAttributes?: SplitIO.Attributes, flagSets?: string[], options?: SplitIO.EvaluationOptions) {
-  return client && (client as IClientWithContext).__getStatus().isOperational && (names || flagSets) ?
+  return client && client.getStatus().isOperational && (names || flagSets) ?
     names ?
       client.getTreatmentsWithConfig(names, attributes, options) :
       client.getTreatmentsWithConfigByFlagSets(flagSets!, attributes, options) :

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ describe('withSplitFactory', () => {`
`40`	`40`	`const Component = withSplitFactory(undefined, outerFactory)(`
`41`	`41`	`({ factory, isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate }: ISplitFactoryChildProps) => {`
`42`	`42`	`expect(factory).toBe(outerFactory);`
`43`		`- expect([isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, false, false, false, false, 0]);`
	`43`	`+ expect([isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate]).toStrictEqual([true, true, false, false, false, 0]);`
`44`	`44`	`return null;`
`45`	`45`	`}`
`46`	`46`	`);`