diff options
| author | Jacob Richman <[email protected]> | 2025-05-24 00:44:17 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-05-24 00:44:17 -0700 |
| commit | b4c16d1f56f4e19fffd3d7608b410570f35045f9 (patch) | |
| tree | dfda3634f4d266f5472bd37b78362abebe6a9c9e /packages/cli/src/ui/hooks/usePhraseCycler.test.ts | |
| parent | 1c3d9d7623ecff0437db0627cace0cbb421b458a (diff) | |
Code review comment fixes and some refactors. (#525)
No intentional different behavior aside for tweaks suggested from the code review of #506 Refactor: Extract console message logic to custom hook
This commit refactors the console message handling from App.tsx into a new custom hook useConsoleMessages.
This change improves the testability of the console message logic and declutters the main App component.
Created useConsoleMessages.ts to encapsulate console message state and update logic.
Updated App.tsx to utilize the new useConsoleMessages hook.
Added unit tests for useConsoleMessages.ts to ensure its functionality.
I deleted and started over on LoadingIndicator.test.tsx as I spent way too much time trying to fix it before just regenerating the tests as the code was easier to write tests for from scratch and the existing tests were not that good (I added them in the previous pull request).
Diffstat (limited to 'packages/cli/src/ui/hooks/usePhraseCycler.test.ts')
| -rw-r--r-- | packages/cli/src/ui/hooks/usePhraseCycler.test.ts | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/packages/cli/src/ui/hooks/usePhraseCycler.test.ts b/packages/cli/src/ui/hooks/usePhraseCycler.test.ts new file mode 100644 index 00000000..f5be12e9 --- /dev/null +++ b/packages/cli/src/ui/hooks/usePhraseCycler.test.ts @@ -0,0 +1,111 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; +import { renderHook, act } from '@testing-library/react'; +import { + usePhraseCycler, + WITTY_LOADING_PHRASES, + PHRASE_CHANGE_INTERVAL_MS, +} from './usePhraseCycler.js'; + +describe('usePhraseCycler', () => { + beforeEach(() => { + vi.useFakeTimers(); + }); + + afterEach(() => { + vi.restoreAllMocks(); + }); + + it('should initialize with the first witty phrase when not active and not waiting', () => { + const { result } = renderHook(() => usePhraseCycler(false, false)); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); + }); + + it('should show "Waiting for user confirmation..." when isWaiting is true', () => { + const { result, rerender } = renderHook( + ({ isActive, isWaiting }) => usePhraseCycler(isActive, isWaiting), + { initialProps: { isActive: true, isWaiting: false } }, + ); + rerender({ isActive: true, isWaiting: true }); + expect(result.current).toBe('Waiting for user confirmation...'); + }); + + it('should not cycle phrases if isActive is false and not waiting', () => { + const { result } = renderHook(() => usePhraseCycler(false, false)); + act(() => { + vi.advanceTimersByTime(PHRASE_CHANGE_INTERVAL_MS * 2); + }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); + }); + + it('should cycle through witty phrases when isActive is true and not waiting', () => { + const { result } = renderHook(() => usePhraseCycler(true, false)); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); + + act(() => { + vi.advanceTimersByTime(PHRASE_CHANGE_INTERVAL_MS); + }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[1]); + + act(() => { + vi.advanceTimersByTime(PHRASE_CHANGE_INTERVAL_MS); + }); + expect(result.current).toBe( + WITTY_LOADING_PHRASES[2 % WITTY_LOADING_PHRASES.length], + ); + }); + + it('should reset to the first phrase when isActive becomes true after being false (and not waiting)', () => { + const { result, rerender } = renderHook( + ({ isActive, isWaiting }) => usePhraseCycler(isActive, isWaiting), + { initialProps: { isActive: false, isWaiting: false } }, + ); + // Cycle to a different phrase + rerender({ isActive: true, isWaiting: false }); + act(() => { + vi.advanceTimersByTime(PHRASE_CHANGE_INTERVAL_MS); + }); + expect(result.current).not.toBe(WITTY_LOADING_PHRASES[0]); + + // Set to inactive + rerender({ isActive: false, isWaiting: false }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); // Should reset to first phrase + + // Set back to active + rerender({ isActive: true, isWaiting: false }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); // Should start with the first phrase + }); + + it('should clear phrase interval on unmount when active', () => { + const { unmount } = renderHook(() => usePhraseCycler(true, false)); + const clearIntervalSpy = vi.spyOn(global, 'clearInterval'); + unmount(); + expect(clearIntervalSpy).toHaveBeenCalledOnce(); + }); + + it('should reset to the first witty phrase when transitioning from waiting to active', () => { + const { result, rerender } = renderHook( + ({ isActive, isWaiting }) => usePhraseCycler(isActive, isWaiting), + { initialProps: { isActive: true, isWaiting: false } }, + ); + + // Cycle to a different phrase + act(() => { + vi.advanceTimersByTime(PHRASE_CHANGE_INTERVAL_MS); + }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[1]); + + // Go to waiting state + rerender({ isActive: false, isWaiting: true }); + expect(result.current).toBe('Waiting for user confirmation...'); + + // Go back to active cycling + rerender({ isActive: true, isWaiting: false }); + expect(result.current).toBe(WITTY_LOADING_PHRASES[0]); + }); +}); |
