First batch of fixing tests to use best practices. (#11964)

packages/cli/src/ui/hooks/useLoadingIndicator.test.tsx

@@ -0,0 +1,168 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { act } from 'react';
+import { render } from 'ink-testing-library';
+import { useLoadingIndicator } from './useLoadingIndicator.js';
+import { StreamingState } from '../types.js';
+import {
+  WITTY_LOADING_PHRASES,
+  PHRASE_CHANGE_INTERVAL_MS,
+} from './usePhraseCycler.js';
+
+describe('useLoadingIndicator', () => {
+  beforeEach(() => {
+    vi.useFakeTimers();
+  });
+
+  afterEach(() => {
+    vi.useRealTimers(); // Restore real timers after each test
+    act(() => vi.runOnlyPendingTimers);
+    vi.restoreAllMocks();
+  });
+
+  const renderLoadingIndicatorHook = (
+    initialStreamingState: StreamingState,
+  ) => {
+    let hookResult: ReturnType<typeof useLoadingIndicator>;
+    function TestComponent({
+      streamingState,
+    }: {
+      streamingState: StreamingState;
+    }) {
+      hookResult = useLoadingIndicator(streamingState);
+      return null;
+    }
+    const { rerender } = render(
+      <TestComponent streamingState={initialStreamingState} />,
+    );
+    return {
+      result: {
+        get current() {
+          return hookResult;
+        },
+      },
+      rerender: (newProps: { streamingState: StreamingState }) =>
+        rerender(<TestComponent {...newProps} />),
+    };
+  };
+
+  it('should initialize with default values when Idle', () => {
+    vi.spyOn(Math, 'random').mockImplementation(() => 0.5); // Always witty
+    const { result } = renderLoadingIndicatorHook(StreamingState.Idle);
+    expect(result.current.elapsedTime).toBe(0);
+    expect(WITTY_LOADING_PHRASES).toContain(
+      result.current.currentLoadingPhrase,
+    );
+  });
+
+  it('should reflect values when Responding', async () => {
+    vi.spyOn(Math, 'random').mockImplementation(() => 0.5); // Always witty
+    const { result } = renderLoadingIndicatorHook(StreamingState.Responding);
+
+    // Initial state before timers advance
+    expect(result.current.elapsedTime).toBe(0);
+    expect(WITTY_LOADING_PHRASES).toContain(
+      result.current.currentLoadingPhrase,
+    );
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(PHRASE_CHANGE_INTERVAL_MS + 1);
+    });
+
+    // Phrase should cycle if PHRASE_CHANGE_INTERVAL_MS has passed
+    expect(WITTY_LOADING_PHRASES).toContain(
+      result.current.currentLoadingPhrase,
+    );
+  });
+
+  it('should show waiting phrase and retain elapsedTime when WaitingForConfirmation', async () => {
+    const { result, rerender } = renderLoadingIndicatorHook(
+      StreamingState.Responding,
+    );
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(60000);
+    });
+    expect(result.current.elapsedTime).toBe(60);
+
+    act(() => {
+      rerender({ streamingState: StreamingState.WaitingForConfirmation });
+    });
+
+    expect(result.current.currentLoadingPhrase).toBe(
+      'Waiting for user confirmation...',
+    );
+    expect(result.current.elapsedTime).toBe(60); // Elapsed time should be retained
+
+    // Timer should not advance further
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(2000);
+    });
+    expect(result.current.elapsedTime).toBe(60);
+  });
+
+  it('should reset elapsedTime and use a witty phrase when transitioning from WaitingForConfirmation to Responding', async () => {
+    vi.spyOn(Math, 'random').mockImplementation(() => 0.5); // Always witty
+    const { result, rerender } = renderLoadingIndicatorHook(
+      StreamingState.Responding,
+    );
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(5000); // 5s
+    });
+    expect(result.current.elapsedTime).toBe(5);
+
+    act(() => {
+      rerender({ streamingState: StreamingState.WaitingForConfirmation });
+    });
+    expect(result.current.elapsedTime).toBe(5);
+    expect(result.current.currentLoadingPhrase).toBe(
+      'Waiting for user confirmation...',
+    );
+
+    act(() => {
+      rerender({ streamingState: StreamingState.Responding });
+    });
+    expect(result.current.elapsedTime).toBe(0); // Should reset
+    expect(WITTY_LOADING_PHRASES).toContain(
+      result.current.currentLoadingPhrase,
+    );
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(1000);
+    });
+    expect(result.current.elapsedTime).toBe(1);
+  });
+
+  it('should reset timer and phrase when streamingState changes from Responding to Idle', async () => {
+    vi.spyOn(Math, 'random').mockImplementation(() => 0.5); // Always witty
+    const { result, rerender } = renderLoadingIndicatorHook(
+      StreamingState.Responding,
+    );
+
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(10000); // 10s
+    });
+    expect(result.current.elapsedTime).toBe(10);
+
+    act(() => {
+      rerender({ streamingState: StreamingState.Idle });
+    });
+
+    expect(result.current.elapsedTime).toBe(0);
+    expect(WITTY_LOADING_PHRASES).toContain(
+      result.current.currentLoadingPhrase,
+    );
+
+    // Timer should not advance
+    await act(async () => {
+      await vi.advanceTimersByTimeAsync(2000);
+    });
+    expect(result.current.elapsedTime).toBe(0);
+  });
+});