refactor: simplify getting initializationState

Author: joker23

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

@@ -2,7 +2,6 @@ import {
   createClient as createBaseClient,
   LDContextStrict,
   LDStartOptions,
-  LDWaitForInitializationResult,
 } from '@launchdarkly/js-client-sdk';
 
 import { createClient } from '../../src/client/LDReactClient';
@@ -76,37 +75,43 @@ jest.mock('@launchdarkly/js-client-sdk', () => {
   };
 });
 
-it('returns getInitializationState() === "unknown" initially', () => {
-  const { mock } = 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' });
-  expect(client.getInitializationState()).toBe('unknown');
-});
-
-it('returns "initializing" while start() is in-flight', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
+  const received: LDContextStrict[] = [];
+  client.onContextChange((c) => received.push(c));
 
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
   const startPromise = client.start();
-  expect(client.getInitializationState()).toBe('initializing');
-
+  setContext(ctx);
   resolveStart('complete');
   await startPromise;
-  expect(client.getInitializationState()).toBe('complete');
+
+  expect(received).toHaveLength(1);
+  expect(received[0]).toEqual(ctx);
 });
 
-it('sets initializedState to "complete" after start() resolves', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
+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 startPromise = client.start();
+  const received: LDContextStrict[] = [];
+  client.onContextChange((c) => received.push(c));
+
+  setContext(ctx);
+  const startPromise1 = client.start();
   resolveStart('complete');
-  await startPromise;
+  await startPromise1;
+
+  // Second call should not notify again
+  const startPromise2 = client.start();
+  await startPromise2;
 
-  expect(client.getInitializationState()).toBe('complete');
+  expect(received).toHaveLength(1);
 });
 
 it('invokes onContextChange callback after identify() resolves with the new context', async () => {
@@ -196,128 +201,3 @@ it('noop client onContextChange returns a no-op unsubscribe', () => {
   // @ts-ignore
   global.window = originalWindow;
 });
-
-it('invokes onInitializationStatusChange callback after start() resolves', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const received: LDWaitForInitializationResult[] = [];
-  client.onInitializationStatusChange((result) => received.push(result));
-
-  const startPromise = client.start();
-  resolveStart('complete');
-  await startPromise;
-
-  expect(received).toHaveLength(1);
-  expect(received[0].status).toBe('complete');
-});
-
-it('notifies multiple subscribers on start()', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const calls1: LDWaitForInitializationResult[] = [];
-  const calls2: LDWaitForInitializationResult[] = [];
-  client.onInitializationStatusChange((r) => calls1.push(r));
-  client.onInitializationStatusChange((r) => calls2.push(r));
-
-  const startPromise = client.start();
-  resolveStart('complete');
-  await startPromise;
-
-  expect(calls1).toHaveLength(1);
-  expect(calls2).toHaveLength(1);
-});
-
-it('stops notifying after the unsubscribe function is called (onInitializationStatusChange)', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const received: LDWaitForInitializationResult[] = [];
-  const unsubscribe = client.onInitializationStatusChange((r) => received.push(r));
-
-  unsubscribe();
-
-  const startPromise = client.start();
-  resolveStart('complete');
-  await startPromise;
-
-  expect(received).toHaveLength(0);
-});
-
-it('calls callback immediately if start() already resolved (late subscriber)', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const startPromise = client.start();
-  resolveStart('complete');
-  await startPromise;
-
-  const received: LDWaitForInitializationResult[] = [];
-  client.onInitializationStatusChange((r) => received.push(r));
-
-  expect(received).toHaveLength(1);
-  expect(received[0].status).toBe('complete');
-});
-
-it('getInitializationError() returns undefined before start()', () => {
-  const { mock } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  expect(client.getInitializationError()).toBeUndefined();
-});
-
-it('getInitializationError() returns undefined after successful start()', async () => {
-  const { mock, resolveStart } = makeMockBaseClient();
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const startPromise = client.start();
-  resolveStart('complete');
-  await startPromise;
-
-  expect(client.getInitializationError()).toBeUndefined();
-});
-
-it('getInitializationError() returns the error after a failed start()', async () => {
-  const { mock } = makeMockBaseClient();
-  const failError = new Error('network failure');
-  (mock.start as jest.Mock).mockResolvedValueOnce({ status: 'failed', error: failError });
-  (createBaseClient as jest.Mock).mockReturnValue(mock);
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  await client.start();
-
-  expect(client.getInitializationError()).toBe(failError);
-});
-
-it('noop client getInitializationError() returns undefined', () => {
-  const originalWindow = global.window;
-  // @ts-ignore
-  delete global.window;
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  expect(client.getInitializationError()).toBeUndefined();
-
-  // @ts-ignore
-  global.window = originalWindow;
-});
-
-it('noop client onInitializationStatusChange returns a no-op unsubscribe', () => {
-  const originalWindow = global.window;
-  // @ts-ignore
-  delete global.window;
-
-  const client = createClient('test-id', { kind: 'user', key: 'u1' });
-  const unsubscribe = client.onInitializationStatusChange(() => {});
-  expect(typeof unsubscribe).toBe('function');
-  expect(() => unsubscribe()).not.toThrow();
-
-  // @ts-ignore
-  global.window = originalWindow;
-});

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

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

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

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