Merge pull request #175 from splitio/development

Release v1.10.2

Author: EmilianoSanchez

CHANGES.txt

@@ -1,5 +1,8 @@
+1.10.2 (December 12, 2023)
+ - Updated @splitsoftware/splitio package to version 10.24.1 that updates localStorage usage to clear cached feature flag definitions before initiating the synchronization process, if the cache was previously synchronized with a different SDK key (i.e., a different environment) or different Split Filter criteria, to avoid using invalid cached data when the SDK is ready from cache.
+
 1.10.1 (November 21, 2023)
- - Bugfixing - Resolved an issue with `useSplitClient` hook, which was not re-rendering when an SDK client event was emitted between the hook's call (render phase) and the execution of its internal effect (commit phase).
+ - Bugfixing - Resolved an issue with `useSplitClient` hook and `SplitClient` component, that were not re-rendering when an SDK client event was emitted between the render and the commit phases of component lifecycle.
 
 1.10.0 (November 16, 2023)
  - Added support for Flag Sets on the SDK, which enables grouping feature flags and interacting with the group rather than individually (more details in our documentation):

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@splitsoftware/splitio-react",
-  "version": "1.10.1",
+  "version": "1.10.2",
   "description": "A React library to easily integrate and use Split JS SDK",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -62,7 +62,7 @@
   },
   "homepage": "https://github.com/splitio/react-client#readme",
   "dependencies": {
-    "@splitsoftware/splitio": "10.24.0-beta",
+    "@splitsoftware/splitio": "10.24.1",
     "memoize-one": "^5.1.1",
     "shallowequal": "^1.1.0"
   },

package.json

@@ -47,6 +47,7 @@ describe('SplitClient', () => {
 
     render(
       <SplitFactory factory={outerFactory} >
+        {/* Equivalent to <SplitClient splitKey={undefined} > */}
         <SplitClient splitKey={sdkBrowser.core.key} >
           {({ client, isReady, isReadyFromCache, hasTimedout, isTimedout, isDestroyed, lastUpdate }: ISplitClientChildProps) => {
             expect(client).toBe(outerFactory.client());
@@ -201,6 +202,31 @@ describe('SplitClient', () => {
     expect(renderTimes).toBe(2);
   });
 
+  test('must update on SDK events between the render and commit phases', () => {
+    const outerFactory = SplitSdk(sdkBrowser);
+    let count = 0;
+
+    render(
+      <SplitFactory factory={outerFactory} >
+        <SplitClient splitKey='some_user' >
+          {({ client }) => {
+            count++;
+
+            // side effect in the render phase
+            if (!(client as any).__getStatus().isReady) {
+              console.log('emit');
+              (client as any).__emitter__.emit(Event.SDK_READY);
+            }
+
+            return null;
+          }}
+        </SplitClient>
+      </SplitFactory>
+    );
+
+    expect(count).toEqual(2);
+  });
+
   test('renders a passed JSX.Element with a new SplitContext value.', (done) => {
     const outerFactory = SplitSdk(sdkBrowser);
 

src/__tests__/SplitClient.test.tsx

@@ -36,5 +36,5 @@ export type {
   ISplitTreatmentsProps,
   IUpdateProps,
   IUseSplitClientOptions,
-  IUseSplitTreatmentsOptions,
+  IUseSplitTreatmentsOptions
 } from './types';