diff options
Diffstat (limited to 'packages/cli/src/ui/hooks')
| -rw-r--r-- | packages/cli/src/ui/hooks/useShellHistory.test.ts | 198 | ||||
| -rw-r--r-- | packages/cli/src/ui/hooks/useShellHistory.ts | 104 |
2 files changed, 302 insertions, 0 deletions
diff --git a/packages/cli/src/ui/hooks/useShellHistory.test.ts b/packages/cli/src/ui/hooks/useShellHistory.test.ts new file mode 100644 index 00000000..47fc5c62 --- /dev/null +++ b/packages/cli/src/ui/hooks/useShellHistory.test.ts @@ -0,0 +1,198 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { renderHook, act, waitFor } from '@testing-library/react'; +import { useShellHistory } from './useShellHistory.js'; +import * as fs from 'fs/promises'; +import path from 'path'; + +vi.mock('fs/promises'); + +const MOCKED_PROJECT_ROOT = '/test/project'; +const MOCKED_HISTORY_DIR = path.join(MOCKED_PROJECT_ROOT, '.gemini'); +const MOCKED_HISTORY_FILE = path.join(MOCKED_HISTORY_DIR, 'shell_history'); + +describe('useShellHistory', () => { + const mockedFs = vi.mocked(fs); + + beforeEach(() => { + vi.resetAllMocks(); + + mockedFs.readFile.mockResolvedValue(''); + mockedFs.writeFile.mockResolvedValue(undefined); + mockedFs.mkdir.mockResolvedValue(undefined); + }); + + it('should initialize and read the history file from the correct path', async () => { + mockedFs.readFile.mockResolvedValue('cmd1\ncmd2'); + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + + await waitFor(() => { + expect(mockedFs.readFile).toHaveBeenCalledWith( + MOCKED_HISTORY_FILE, + 'utf-8', + ); + }); + + let command: string | null = null; + act(() => { + command = result.current.getPreviousCommand(); + }); + + // History is loaded newest-first: ['cmd2', 'cmd1'] + expect(command).toBe('cmd2'); + }); + + it('should handle a non-existent history file gracefully', async () => { + const error = new Error('File not found') as NodeJS.ErrnoException; + error.code = 'ENOENT'; + mockedFs.readFile.mockRejectedValue(error); + + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + + await waitFor(() => { + expect(mockedFs.readFile).toHaveBeenCalled(); + }); + + let command: string | null = null; + act(() => { + command = result.current.getPreviousCommand(); + }); + + expect(command).toBe(null); + }); + + it('should add a command and write to the history file', async () => { + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + + await waitFor(() => expect(mockedFs.readFile).toHaveBeenCalled()); + + act(() => { + result.current.addCommandToHistory('new_command'); + }); + + await waitFor(() => { + expect(mockedFs.mkdir).toHaveBeenCalledWith(MOCKED_HISTORY_DIR, { + recursive: true, + }); + expect(mockedFs.writeFile).toHaveBeenCalledWith( + MOCKED_HISTORY_FILE, + 'new_command', // Written to file oldest-first. + ); + }); + + let command: string | null = null; + act(() => { + command = result.current.getPreviousCommand(); + }); + expect(command).toBe('new_command'); + }); + + it('should navigate history correctly with previous/next commands', async () => { + mockedFs.readFile.mockResolvedValue('cmd1\ncmd2\ncmd3'); + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + + // Wait for history to be loaded: ['cmd3', 'cmd2', 'cmd1'] + await waitFor(() => expect(mockedFs.readFile).toHaveBeenCalled()); + + let command: string | null = null; + + act(() => { + command = result.current.getPreviousCommand(); + }); + expect(command).toBe('cmd3'); + + act(() => { + command = result.current.getPreviousCommand(); + }); + expect(command).toBe('cmd2'); + + act(() => { + command = result.current.getPreviousCommand(); + }); + expect(command).toBe('cmd1'); + + // Should stay at the oldest command + act(() => { + command = result.current.getPreviousCommand(); + }); + expect(command).toBe('cmd1'); + + act(() => { + command = result.current.getNextCommand(); + }); + expect(command).toBe('cmd2'); + + act(() => { + command = result.current.getNextCommand(); + }); + expect(command).toBe('cmd3'); + + // Should return to the "new command" line (represented as empty string) + act(() => { + command = result.current.getNextCommand(); + }); + expect(command).toBe(''); + }); + + it('should not add empty or whitespace-only commands to history', async () => { + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + await waitFor(() => expect(mockedFs.readFile).toHaveBeenCalled()); + + act(() => { + result.current.addCommandToHistory(' '); + }); + + expect(mockedFs.writeFile).not.toHaveBeenCalled(); + }); + + it('should truncate history to MAX_HISTORY_LENGTH (100)', async () => { + const oldCommands = Array.from({ length: 120 }, (_, i) => `old_cmd_${i}`); + mockedFs.readFile.mockResolvedValue(oldCommands.join('\n')); + + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + await waitFor(() => expect(mockedFs.readFile).toHaveBeenCalled()); + + act(() => { + result.current.addCommandToHistory('new_cmd'); + }); + + // Wait for the async write to happen and then inspect the arguments. + await waitFor(() => expect(mockedFs.writeFile).toHaveBeenCalled()); + + // The hook stores history newest-first. + // Initial state: ['old_cmd_119', ..., 'old_cmd_0'] + // After adding 'new_cmd': ['new_cmd', 'old_cmd_119', ..., 'old_cmd_21'] (100 items) + // Written to file (reversed): ['old_cmd_21', ..., 'old_cmd_119', 'new_cmd'] + const writtenContent = mockedFs.writeFile.mock.calls[0][1] as string; + const writtenLines = writtenContent.split('\n'); + + expect(writtenLines.length).toBe(100); + expect(writtenLines[0]).toBe('old_cmd_21'); // New oldest command + expect(writtenLines[99]).toBe('new_cmd'); // Newest command + }); + + it('should move an existing command to the top when re-added', async () => { + mockedFs.readFile.mockResolvedValue('cmd1\ncmd2\ncmd3'); + const { result } = renderHook(() => useShellHistory(MOCKED_PROJECT_ROOT)); + + // Initial state: ['cmd3', 'cmd2', 'cmd1'] + await waitFor(() => expect(mockedFs.readFile).toHaveBeenCalled()); + + act(() => { + result.current.addCommandToHistory('cmd1'); + }); + + // After re-adding 'cmd1': ['cmd1', 'cmd3', 'cmd2'] + // Written to file (reversed): ['cmd2', 'cmd3', 'cmd1'] + await waitFor(() => expect(mockedFs.writeFile).toHaveBeenCalled()); + + const writtenContent = mockedFs.writeFile.mock.calls[0][1] as string; + const writtenLines = writtenContent.split('\n'); + + expect(writtenLines).toEqual(['cmd2', 'cmd3', 'cmd1']); + }); +}); diff --git a/packages/cli/src/ui/hooks/useShellHistory.ts b/packages/cli/src/ui/hooks/useShellHistory.ts new file mode 100644 index 00000000..0b1c8d98 --- /dev/null +++ b/packages/cli/src/ui/hooks/useShellHistory.ts @@ -0,0 +1,104 @@ +/** + * @license + * Copyright 2025 Google LLC + * SPDX-License-Identifier: Apache-2.0 + */ + +import { useState, useEffect, useCallback } from 'react'; +import * as fs from 'fs/promises'; +import * as path from 'path'; +import { isNodeError } from '@gemini-cli/core'; + +const HISTORY_DIR = '.gemini'; +const HISTORY_FILE = 'shell_history'; +const MAX_HISTORY_LENGTH = 100; + +async function getHistoryFilePath(projectRoot: string): Promise<string> { + const historyDir = path.join(projectRoot, HISTORY_DIR); + return path.join(historyDir, HISTORY_FILE); +} + +async function readHistoryFile(filePath: string): Promise<string[]> { + try { + const content = await fs.readFile(filePath, 'utf-8'); + return content.split('\n').filter(Boolean); + } catch (error) { + if (isNodeError(error) && error.code === 'ENOENT') { + return []; + } + console.error('Error reading shell history:', error); + return []; + } +} + +async function writeHistoryFile( + filePath: string, + history: string[], +): Promise<void> { + try { + await fs.mkdir(path.dirname(filePath), { recursive: true }); + await fs.writeFile(filePath, history.join('\n')); + } catch (error) { + console.error('Error writing shell history:', error); + } +} + +export function useShellHistory(projectRoot: string) { + const [history, setHistory] = useState<string[]>([]); + const [historyIndex, setHistoryIndex] = useState(-1); + const [historyFilePath, setHistoryFilePath] = useState<string | null>(null); + + useEffect(() => { + async function loadHistory() { + const filePath = await getHistoryFilePath(projectRoot); + setHistoryFilePath(filePath); + const loadedHistory = await readHistoryFile(filePath); + setHistory(loadedHistory.reverse()); // Newest first + } + loadHistory(); + }, [projectRoot]); + + const addCommandToHistory = useCallback( + (command: string) => { + if (!command.trim() || !historyFilePath) { + return; + } + const newHistory = [command, ...history.filter((c) => c !== command)] + .slice(0, MAX_HISTORY_LENGTH) + .filter(Boolean); + setHistory(newHistory); + // Write to file in reverse order (oldest first) + writeHistoryFile(historyFilePath, [...newHistory].reverse()); + setHistoryIndex(-1); + }, + [history, historyFilePath], + ); + + const getPreviousCommand = useCallback(() => { + if (history.length === 0) { + return null; + } + const newIndex = Math.min(historyIndex + 1, history.length - 1); + setHistoryIndex(newIndex); + return history[newIndex] ?? null; + }, [history, historyIndex]); + + const getNextCommand = useCallback(() => { + if (historyIndex < 0) { + return null; + } + const newIndex = historyIndex - 1; + setHistoryIndex(newIndex); + if (newIndex < 0) { + return ''; + } + return history[newIndex] ?? null; + }, [history, historyIndex]); + + return { + addCommandToHistory, + getPreviousCommand, + getNextCommand, + resetHistoryPosition: () => setHistoryIndex(-1), + }; +} |
