refactor: simplify getting initializationState

Author: joker23

packages/sdk/react/__tests__/client/LDReactClient.test.ts

@@ -76,37 +76,63 @@ jest.mock('@launchdarkly/js-client-sdk', () => {
   };
 });
 
-it('returns getInitializationState() === "unknown" initially', () => {
+it('returns getInitializationState() === "initializing" initially', () => {
   const { mock } = makeMockBaseClient();
   (createBaseClient as jest.Mock).mockReturnValue(mock);
 
   const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  expect(client.getInitializationState()).toBe('unknown');
+  expect(client.getInitializationState()).toBe('initializing');
 });
 
-it('returns "initializing" while start() is in-flight', async () => {
+it('sets initializedState to "complete" after start() resolves', async () => {
   const { mock, resolveStart } = makeMockBaseClient();
   (createBaseClient as jest.Mock).mockReturnValue(mock);
 
   const client = createClient('test-id', { kind: 'user', key: 'u1' });
   const startPromise = client.start();
-  expect(client.getInitializationState()).toBe('initializing');
-
   resolveStart('complete');
   await startPromise;
+
   expect(client.getInitializationState()).toBe('complete');
 });
 
-it('sets initializedState to "complete" after start() resolves', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
+it('start() fires onContextChange subscribers with the new context', async () => {
+  const ctx: LDContextStrict = { kind: 'user', key: 'u1' };
+  const { mock, resolveStart, setContext } = makeMockBaseClient();
   (createBaseClient as jest.Mock).mockReturnValue(mock);
 
   const client = createClient('test-id', { kind: 'user', key: 'u1' });
+  const received: LDContextStrict[] = [];
+  client.onContextChange((c) => received.push(c));
+
   const startPromise = client.start();
+  setContext(ctx);
   resolveStart('complete');
   await startPromise;
 
-  expect(client.getInitializationState()).toBe('complete');
+  expect(received).toHaveLength(1);
+  expect(received[0]).toEqual(ctx);
+});
+
+it('start() only notifies context subscribers once even if called multiple times', async () => {
+  const ctx: LDContextStrict = { kind: 'user', key: 'u1' };
+  const { mock, resolveStart, setContext } = makeMockBaseClient();
+  (createBaseClient as jest.Mock).mockReturnValue(mock);
+
+  const client = createClient('test-id', { kind: 'user', key: 'u1' });
+  const received: LDContextStrict[] = [];
+  client.onContextChange((c) => received.push(c));
+
+  setContext(ctx);
+  const startPromise1 = client.start();
+  resolveStart('complete');
+  await startPromise1;
+
+  // Second call should not notify again
+  const startPromise2 = client.start();
+  await startPromise2;
+
+  expect(received).toHaveLength(1);
 });
 
 it('invokes onContextChange callback after identify() resolves with the new context', async () => {

packages/sdk/react/__tests__/client/deprecated-hooks/renderHelpers.tsx

@@ -10,7 +10,7 @@ export function makeWrapper(
 ) {
   const contextValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'unknown',
+    initializedState: 'initializing',
     ...contextOverrides,
   };
 
@@ -31,7 +31,7 @@ export function makeStatefulWrapper(mockClient: ReturnType<typeof makeMockClient
   function Wrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setterRef.current = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;

packages/sdk/react/__tests__/client/deprecated-hooks/useFlags.test.tsx

@@ -378,7 +378,7 @@ it('clears the variation cache when the context changes after identify', () => {
     setterRef.current!({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -429,7 +429,7 @@ it('reads flags from a custom react context', () => {
 
   const ctxValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'complete',
+    initializedState: 'initializing',
   };
 
   render(

packages/sdk/react/__tests__/client/hooks/useInitializationStatus.test.tsx

@@ -23,18 +23,6 @@ function StatusConsumer({ onStatus }: { onStatus: (s: InitializationStatus) => v
   return null;
 }
 
-it('returns { status: "unknown" } when initializedState is "unknown"', () => {
-  const captured: InitializationStatus[] = [];
-
-  render(
-    <LDReactContext.Provider value={makeContextValue('unknown')}>
-      <StatusConsumer onStatus={(s) => captured.push(s)} />
-    </LDReactContext.Provider>,
-  );
-
-  expect(captured[0]).toEqual({ status: 'unknown' });
-});
-
 it('returns { status: "initializing" } when initializedState is "initializing"', () => {
   const captured: InitializationStatus[] = [];
 

packages/sdk/react/__tests__/client/hooks/useLDClient.test.tsx

@@ -19,7 +19,7 @@ it('returns the client from the nearest provider context', () => {
   const mockClient = makeMockClient();
   const contextValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'unknown',
+    initializedState: 'initializing',
   };
 
   let capturedClient: any;
@@ -43,7 +43,7 @@ it('returns the client from a custom react context', () => {
   const customContext = React.createContext<LDReactClientContextValue>(null as any);
   const contextValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'unknown',
+    initializedState: 'initializing',
   };
 
   let capturedClient: any;

packages/sdk/react/__tests__/client/hooks/useVariation.test.tsx

@@ -20,7 +20,7 @@ function makeWrapper(
 ) {
   const contextValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'unknown',
+    initializedState: 'initializing',
     ...contextOverrides,
   };
 
@@ -148,7 +148,7 @@ it('useBoolVariation calls variation again when context changes after identify',
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -171,7 +171,7 @@ it('useBoolVariation calls variation again when context changes after identify',
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -312,7 +312,7 @@ it('useStringVariation calls variation again when context changes', () => {
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -335,7 +335,7 @@ it('useStringVariation calls variation again when context changes', () => {
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -404,7 +404,7 @@ it('useNumberVariation calls variation again when context changes', () => {
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -427,7 +427,7 @@ it('useNumberVariation calls variation again when context changes', () => {
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -534,7 +534,7 @@ it('useJsonVariation calls variation again when context changes', () => {
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -557,7 +557,7 @@ it('useJsonVariation calls variation again when context changes', () => {
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 

packages/sdk/react/__tests__/client/hooks/useVariationDetail.test.tsx

@@ -19,7 +19,7 @@ import { makeMockClient } from '../mockClient';
 function makeWrapper(mockClient: ReturnType<typeof makeMockClient>) {
   const contextValue: LDReactClientContextValue = {
     client: mockClient,
-    initializedState: 'unknown',
+    initializedState: 'initializing',
   };
 
   return function Wrapper({ children }: { children: React.ReactNode }) {
@@ -142,7 +142,7 @@ it('useBoolVariationDetail calls variation detail again when context changes', (
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -165,7 +165,7 @@ it('useBoolVariationDetail calls variation detail again when context changes', (
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -300,7 +300,7 @@ it('useStringVariationDetail calls variation detail again when context changes',
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -323,7 +323,7 @@ it('useStringVariationDetail calls variation detail again when context changes',
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -413,7 +413,7 @@ it('useNumberVariationDetail calls variation detail again when context changes',
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -436,7 +436,7 @@ it('useNumberVariationDetail calls variation detail again when context changes',
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 
@@ -526,7 +526,7 @@ it('useJsonVariationDetail calls variation detail again when context changes', (
   function StatefulWrapper({ children }: { children: React.ReactNode }) {
     const [ctxValue, setCtx] = React.useState<LDReactClientContextValue>({
       client: mockClient,
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
     setContextValue = setCtx;
     return <LDReactContext.Provider value={ctxValue}>{children}</LDReactContext.Provider>;
@@ -549,7 +549,7 @@ it('useJsonVariationDetail calls variation detail again when context changes', (
     setContextValue({
       client: mockClient,
       context: { kind: 'user', key: 'new-user' },
-      initializedState: 'complete',
+      initializedState: 'initializing',
     });
   });
 

packages/sdk/react/__tests__/client/mockClient.ts

@@ -36,7 +36,7 @@ export function makeMockClient(options: MockClientOptions = {}): MockClient {
 
   const initStatusSubscribers = new Set<(result: LDWaitForInitializationResult) => void>();
   const contextChangeSubscribers = new Set<(ctx: LDContextStrict) => void>();
-  let initState: InitializedState = initialState ?? (preFailedError ? 'failed' : 'unknown');
+  let initState: InitializedState = initialState ?? (preFailedError ? 'failed' : 'initializing');
   let initError: Error | undefined = preFailedError;
   let currentContext: LDContextStrict | undefined;
   const eventHandlers = new Map<string, Set<EventHandler>>();

packages/sdk/react/__tests__/client/provider/LDReactProvider.test.tsx

@@ -81,7 +81,7 @@ it('updates initializedState and context when onInitializationStatusChange fires
     </Provider>,
   );
 
-  expect(contextValues[contextValues.length - 1]?.initializedState).toBe('unknown');
+  expect(contextValues[contextValues.length - 1]?.initializedState).toBe('initializing');
 
   await act(async () => {
     client.fireInitStatusChange('complete');

packages/sdk/react/__tests__/client/provider/multipleEnvironments.test.tsx

@@ -147,8 +147,8 @@ it('initialization state is tracked independently per context', async () => {
     </ProviderA>,
   );
 
-  expect(screen.getByTestId('status-a').textContent).toBe('unknown');
-  expect(screen.getByTestId('status-b').textContent).toBe('unknown');
+  expect(screen.getByTestId('status-a').textContent).toBe('initializing');
+  expect(screen.getByTestId('status-b').textContent).toBe('initializing');
 
   await act(async () => {
     clientA.fireInitStatusChange('complete');
@@ -157,8 +157,8 @@ it('initialization state is tracked independently per context', async () => {
   await waitFor(() => {
     expect(screen.getByTestId('status-a').textContent).toBe('complete');
   });
-  // clientB still unknown
-  expect(screen.getByTestId('status-b').textContent).toBe('unknown');
+  // clientB still initializing
+  expect(screen.getByTestId('status-b').textContent).toBe('initializing');
 
   await act(async () => {
     clientB.fireInitStatusChange('complete');