update unit tests for useSplitTreatments

Author: EmilianoSanchez

src/SplitClient.tsx

@@ -83,7 +83,7 @@ export class SplitComponent extends React.Component<IUpdateProps & { factory: Sp
     }
   }
 
-  // NOTE: assuming that SDK events are scatered enough in time, so that Date.now() result is unique per event and triggers an update
+  // NOTE: assuming that SDK events are scattered in time so that Date.now() timestamps are unique per event and trigger an update
   setReady = () => {
     if (this.props.updateOnSdkReady) this.setState({ lastUpdate: Date.now() });
   }

src/__tests__/useSplitTreatments.test.tsx

@@ -16,7 +16,7 @@ import { SplitTreatments } from '../SplitTreatments';
 import { SplitContext } from '../SplitContext';
 import { ISplitTreatmentsChildProps } from '../types';
 
-function validateTreatments({ treatments, isReady, isReadyFromCache}: ISplitTreatmentsChildProps) {
+function validateTreatments({ treatments, isReady, isReadyFromCache }: ISplitTreatmentsChildProps) {
   if (isReady || isReadyFromCache) {
     expect(treatments).toEqual({
       split_test: {
@@ -34,12 +34,12 @@ function validateTreatments({ treatments, isReady, isReadyFromCache}: ISplitTrea
   }
 }
 
-test('useSplitTreatments', () => {
+test('useSplitTreatments', async () => {
   const outerFactory = SplitSdk(sdkBrowser);
   const mainClient = outerFactory.client() as any;
   const user2Client = outerFactory.client('user_2') as any;
 
-  let countSplitContext = 0, countSplitTreatments = 0, countUseSplitTreatments = 0, countUseSplitTreatmentsUser2 = 0;
+  let countSplitContext = 0, countSplitTreatments = 0, countUseSplitTreatments = 0, countUseSplitTreatmentsUser2 = 0, countUseSplitTreatmentsUser2WithUpdate = 0;
 
   render(
     <SplitFactory factory={outerFactory} >
@@ -51,7 +51,7 @@ test('useSplitTreatments', () => {
           {() => { countSplitTreatments++; return null }}
         </SplitTreatments>
         {React.createElement(() => {
-          const context = useSplitTreatments(['split_test'], { att1: 'att1' } );
+          const context = useSplitTreatments(['split_test'], { att1: 'att1' });
           expect(context.client).toBe(mainClient); // Assert that the main client was retrieved.
           validateTreatments(context);
           countUseSplitTreatments++;
@@ -64,16 +64,24 @@ test('useSplitTreatments', () => {
           countUseSplitTreatmentsUser2++;
           return null;
         })}
+        {React.createElement(() => {
+          const context = useSplitTreatments(['split_test'], undefined, 'user_2', { updateOnSdkUpdate: true });
+          expect(context.client).toBe(user2Client);
+          validateTreatments(context);
+          countUseSplitTreatmentsUser2WithUpdate++;
+          return null;
+        })}
       </>
     </SplitFactory>
   );
 
-  act(() => mainClient.__emitter__.emit(Event.SDK_READY_FROM_CACHE));
-  act(() => mainClient.__emitter__.emit(Event.SDK_READY));
-  act(() => mainClient.__emitter__.emit(Event.SDK_UPDATE));
-  act(() => user2Client.__emitter__.emit(Event.SDK_READY_FROM_CACHE));
-  act(() => user2Client.__emitter__.emit(Event.SDK_READY));
-  act(() => user2Client.__emitter__.emit(Event.SDK_UPDATE));
+  // Awaiting to make sure each event is processed with a different lastUpdate timestamp.
+  await act(() => mainClient.__emitter__.emit(Event.SDK_READY_FROM_CACHE));
+  await act(() => mainClient.__emitter__.emit(Event.SDK_READY));
+  await act(() => mainClient.__emitter__.emit(Event.SDK_UPDATE));
+  await act(() => user2Client.__emitter__.emit(Event.SDK_READY_FROM_CACHE));
+  await act(() => user2Client.__emitter__.emit(Event.SDK_READY));
+  await act(() => user2Client.__emitter__.emit(Event.SDK_UPDATE));
 
   // SplitContext renders 3 times: initially, when ready from cache, and when ready.
   expect(countSplitContext).toEqual(3);
@@ -86,6 +94,8 @@ test('useSplitTreatments', () => {
 
   // If useSplitTreatments uses a different client than the context one, it renders when the context renders and when the new client is ready and ready from cache.
   expect(countUseSplitTreatmentsUser2).toEqual(countSplitContext + 2);
-  expect(user2Client.getTreatmentsWithConfig).toHaveBeenCalledTimes(2);
+  // If it is used with `updateOnSdkUpdate: true`, it also renders when the client emits an SDK_UPDATE event.
+  expect(countUseSplitTreatmentsUser2WithUpdate).toEqual(countSplitContext + 3);
+  expect(user2Client.getTreatmentsWithConfig).toHaveBeenCalledTimes(5);
   expect(user2Client.getTreatmentsWithConfig).toHaveBeenLastCalledWith(['split_test'], undefined);
 });

src/useSplitClient.ts

@@ -37,6 +37,7 @@ export function useSplitClient(key?: SplitIO.SplitKey, trafficType?: string, att
   const [lastUpdate, setLastUpdate] = React.useState(client === contextClient ? context.lastUpdate : 0);
 
   // Handle client events
+  // NOTE: assuming that SDK events are scattered in time so that Date.now() timestamps are unique per event and trigger an update
   React.useEffect(() => {
     const setReady = () => {
       if (options.updateOnSdkReady) setLastUpdate(Date.now());