Polishing

Author: EmilianoSanchez

CHANGES.txt

@@ -2,7 +2,7 @@
  - Added support for targeting rules based on large segments for browsers.
  - Updated @splitsoftware/splitio package to version 11.0.0 that includes major updates, and updated some transitive dependencies for vulnerability fixes.
  - Renamed distribution folders from `/lib` to `/cjs` for CommonJS build, and `/es` to `/esm` for EcmaScript Modules build.
- - Bugfixing - When the `config` prop is provided, the `SplitFactoryProvider` now makes the SDK factory and client instances available in the context immediately during the initial render, instead of waiting for the first SDK event. This change fixes a bug in the `useTrack` hook, which was not retrieving the client's `track` method during the initial render but rather a no-op function.
+ - Bugfixing - When the `config` prop is provided, the `SplitFactoryProvider` now makes the SDK factory and client instances available in the context immediately during the initial render, instead of waiting for the first SDK event (Related to https://github.com/splitio/react-client/issues/198). This change fixes a bug in the `useTrack` hook, which was not retrieving the client's `track` method during the initial render.
  - BREAKING CHANGES:
       - Updated error handling: using the library modules without wrapping them in a `SplitFactoryProvider` component will now throw an error instead of logging it, as the modules requires the `SplitContext` to work properly.
       - Removed the `core.trafficType` configuration option and the `trafficType` parameter from the SDK `client()` method, `useSplitClient`, `useTrack`, and `SplitClient` component. This is because traffic types can no longer be bound to SDK clients in JavaScript SDK v11.0.0, and so the traffic type must be provided as first argument in the `track` method calls.

src/__tests__/useTrack.test.tsx

@@ -23,34 +23,7 @@ describe('useTrack', () => {
   const value = 10;
   const properties = { prop1: 'prop1' };
 
-  test('returns the track method of the client at Split context updated by SplitFactoryProvider (config prop).', () => {
-    render(
-      <SplitFactoryProvider config={sdkBrowser} >
-        {React.createElement(() => {
-          const clientTrack = useTrack();
-
-          const { client } = useSplitClient();
-          expect(clientTrack).toBe(client!.track);
-
-          clientTrack(tt, eventType, value, properties);
-
-          useEffect(() => {
-            clientTrack(tt, eventType, value, properties);
-          }, [clientTrack]);
-          return null;
-        })}
-      </SplitFactoryProvider>,
-    );
-
-    act(() => getLastInstance(SplitFactory).client().__emitter__.emit(Event.SDK_READY_FROM_CACHE));
-    act(() => getLastInstance(SplitFactory).client().__emitter__.emit(Event.SDK_READY));
-
-    const track = getLastInstance(SplitFactory).client().track as jest.Mock;
-    expect(track).toBeCalledWith(tt, eventType, value, properties);
-    expect(track).toBeCalledTimes(4); // 3 from render + 1 from useEffect (`clientTrack` dependency doesn't change)
-  });
-
-  test('returns the track method of the client at Split context updated by SplitFactoryProvider (factory prop).', () => {
+  test('returns the track method of the client at Split context updated by SplitFactoryProvider.', () => {
     const outerFactory = SplitFactory(sdkBrowser);
     let clientTrack;
     let trackResult;
@@ -121,4 +94,38 @@ describe('useTrack', () => {
     }).toThrow(EXCEPTION_NO_SFP);
   });
 
+  test('returns the track method of the client at Split context updated by SplitFactoryProvider (config prop).', () => {
+    let splitKey: string | undefined = undefined;
+    render(
+      <SplitFactoryProvider config={sdkBrowser} updateOnSdkUpdate={true} >
+        {React.createElement(() => {
+          const clientTrack = useTrack(splitKey);
+
+          const { client } = useSplitClient({ splitKey });
+          expect(clientTrack).toBe(client!.track);
+
+          clientTrack(tt, eventType, value, properties);
+
+          useEffect(() => {
+            clientTrack(tt, eventType, value, properties);
+          }, [clientTrack]);
+          return null;
+        })}
+      </SplitFactoryProvider>,
+    );
+
+    act(() => getLastInstance(SplitFactory).client().__emitter__.emit(Event.SDK_READY_FROM_CACHE));
+    act(() => getLastInstance(SplitFactory).client().__emitter__.emit(Event.SDK_READY));
+    splitKey = 'user2'; // `clientTrack` dependency changed
+    act(() => getLastInstance(SplitFactory).client().__emitter__.emit(Event.SDK_UPDATE));
+
+    let track = getLastInstance(SplitFactory).client().track as jest.Mock;
+    expect(track).toBeCalledWith(tt, eventType, value, properties);
+    expect(track).toBeCalledTimes(4); // 3 from render + 1 from useEffect
+
+    track = getLastInstance(SplitFactory).client('user2').track as jest.Mock;
+    expect(track).toBeCalledWith(tt, eventType, value, properties);
+    expect(track).toBeCalledTimes(2); // 1 from render + 1 from useEffect (`clientTrack` dependency changed)
+  });
+
 });