/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ const { mockProcessExit } = vi.hoisted(() => ({ mockProcessExit: vi.fn((_code?: number): never => undefined as never), })); vi.mock('node:process', () => ({ default: { exit: mockProcessExit, }, })); const mockBuiltinLoadCommands = vi.fn(); vi.mock('../../services/BuiltinCommandLoader.js', () => ({ BuiltinCommandLoader: vi.fn().mockImplementation(() => ({ loadCommands: mockBuiltinLoadCommands, })), })); const mockFileLoadCommands = vi.fn(); vi.mock('../../services/FileCommandLoader.js', () => ({ FileCommandLoader: vi.fn().mockImplementation(() => ({ loadCommands: mockFileLoadCommands, })), })); vi.mock('../contexts/SessionContext.js', () => ({ useSessionStats: vi.fn(() => ({ stats: {} })), })); import { act, renderHook, waitFor } from '@testing-library/react'; import { vi, describe, it, expect, beforeEach, type Mock } from 'vitest'; import { useSlashCommandProcessor } from './slashCommandProcessor.js'; import { CommandKind, SlashCommand } from '../commands/types.js'; import { Config } from '@google/gemini-cli-core'; import { LoadedSettings } from '../../config/settings.js'; import { MessageType } from '../types.js'; import { BuiltinCommandLoader } from '../../services/BuiltinCommandLoader.js'; import { FileCommandLoader } from '../../services/FileCommandLoader.js'; const createTestCommand = ( overrides: Partial, kind: CommandKind = CommandKind.BUILT_IN, ): SlashCommand => ({ name: 'test', description: 'a test command', kind, ...overrides, }); describe('useSlashCommandProcessor', () => { const mockAddItem = vi.fn(); const mockClearItems = vi.fn(); const mockLoadHistory = vi.fn(); const mockSetShowHelp = vi.fn(); const mockOpenAuthDialog = vi.fn(); const mockSetQuittingMessages = vi.fn(); const mockConfig = { getProjectRoot: () => '/mock/cwd', getSessionId: () => 'test-session', getGeminiClient: () => ({ setHistory: vi.fn().mockResolvedValue(undefined), }), } as unknown as Config; const mockSettings = {} as LoadedSettings; beforeEach(() => { vi.clearAllMocks(); (vi.mocked(BuiltinCommandLoader) as Mock).mockClear(); mockBuiltinLoadCommands.mockResolvedValue([]); mockFileLoadCommands.mockResolvedValue([]); }); const setupProcessorHook = ( builtinCommands: SlashCommand[] = [], fileCommands: SlashCommand[] = [], ) => { mockBuiltinLoadCommands.mockResolvedValue(Object.freeze(builtinCommands)); mockFileLoadCommands.mockResolvedValue(Object.freeze(fileCommands)); const { result } = renderHook(() => useSlashCommandProcessor( mockConfig, mockSettings, mockAddItem, mockClearItems, mockLoadHistory, vi.fn(), // refreshStatic mockSetShowHelp, vi.fn(), // onDebugMessage vi.fn(), // openThemeDialog mockOpenAuthDialog, vi.fn(), // openEditorDialog vi.fn(), // toggleCorgiMode mockSetQuittingMessages, vi.fn(), // openPrivacyNotice ), ); return result; }; describe('Initialization and Command Loading', () => { it('should initialize CommandService with all required loaders', () => { setupProcessorHook(); expect(BuiltinCommandLoader).toHaveBeenCalledWith(mockConfig); expect(FileCommandLoader).toHaveBeenCalledWith(mockConfig); }); it('should call loadCommands and populate state after mounting', async () => { const testCommand = createTestCommand({ name: 'test' }); const result = setupProcessorHook([testCommand]); await waitFor(() => { expect(result.current.slashCommands).toHaveLength(1); }); expect(result.current.slashCommands[0]?.name).toBe('test'); expect(mockBuiltinLoadCommands).toHaveBeenCalledTimes(1); expect(mockFileLoadCommands).toHaveBeenCalledTimes(1); }); it('should provide an immutable array of commands to consumers', async () => { const testCommand = createTestCommand({ name: 'test' }); const result = setupProcessorHook([testCommand]); await waitFor(() => { expect(result.current.slashCommands).toHaveLength(1); }); const commands = result.current.slashCommands; expect(() => { // @ts-expect-error - We are intentionally testing a violation of the readonly type. commands.push(createTestCommand({ name: 'rogue' })); }).toThrow(TypeError); }); it('should override built-in commands with file-based commands of the same name', async () => { const builtinAction = vi.fn(); const fileAction = vi.fn(); const builtinCommand = createTestCommand({ name: 'override', description: 'builtin', action: builtinAction, }); const fileCommand = createTestCommand( { name: 'override', description: 'file', action: fileAction }, CommandKind.FILE, ); const result = setupProcessorHook([builtinCommand], [fileCommand]); await waitFor(() => { // The service should only return one command with the name 'override' expect(result.current.slashCommands).toHaveLength(1); }); await act(async () => { await result.current.handleSlashCommand('/override'); }); // Only the file-based command's action should be called. expect(fileAction).toHaveBeenCalledTimes(1); expect(builtinAction).not.toHaveBeenCalled(); }); }); describe('Command Execution Logic', () => { it('should display an error for an unknown command', async () => { const result = setupProcessorHook(); await waitFor(() => expect(result.current.slashCommands).toBeDefined()); await act(async () => { await result.current.handleSlashCommand('/nonexistent'); }); // Expect 2 calls: one for the user's input, one for the error message. expect(mockAddItem).toHaveBeenCalledTimes(2); expect(mockAddItem).toHaveBeenLastCalledWith( { type: MessageType.ERROR, text: 'Unknown command: /nonexistent', }, expect.any(Number), ); }); it('should display help for a parent command invoked without a subcommand', async () => { const parentCommand: SlashCommand = { name: 'parent', description: 'a parent command', kind: CommandKind.BUILT_IN, subCommands: [ { name: 'child1', description: 'First child.', kind: CommandKind.BUILT_IN, }, ], }; const result = setupProcessorHook([parentCommand]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('/parent'); }); expect(mockAddItem).toHaveBeenCalledTimes(2); expect(mockAddItem).toHaveBeenLastCalledWith( { type: MessageType.INFO, text: expect.stringContaining( "Command '/parent' requires a subcommand.", ), }, expect.any(Number), ); }); it('should correctly find and execute a nested subcommand', async () => { const childAction = vi.fn(); const parentCommand: SlashCommand = { name: 'parent', description: 'a parent command', kind: CommandKind.BUILT_IN, subCommands: [ { name: 'child', description: 'a child command', kind: CommandKind.BUILT_IN, action: childAction, }, ], }; const result = setupProcessorHook([parentCommand]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('/parent child with args'); }); expect(childAction).toHaveBeenCalledTimes(1); expect(childAction).toHaveBeenCalledWith( expect.objectContaining({ services: expect.objectContaining({ config: mockConfig, }), ui: expect.objectContaining({ addItem: mockAddItem, }), }), 'with args', ); }); }); describe('Action Result Handling', () => { it('should handle "dialog: help" action', async () => { const command = createTestCommand({ name: 'helpcmd', action: vi.fn().mockResolvedValue({ type: 'dialog', dialog: 'help' }), }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('/helpcmd'); }); expect(mockSetShowHelp).toHaveBeenCalledWith(true); }); it('should handle "load_history" action', async () => { const command = createTestCommand({ name: 'load', action: vi.fn().mockResolvedValue({ type: 'load_history', history: [{ type: MessageType.USER, text: 'old prompt' }], clientHistory: [{ role: 'user', parts: [{ text: 'old prompt' }] }], }), }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('/load'); }); expect(mockClearItems).toHaveBeenCalledTimes(1); expect(mockAddItem).toHaveBeenCalledWith( { type: 'user', text: 'old prompt' }, expect.any(Number), ); }); describe('with fake timers', () => { // This test needs to let the async `waitFor` complete with REAL timers // before switching to FAKE timers to test setTimeout. it('should handle a "quit" action', async () => { const quitAction = vi .fn() .mockResolvedValue({ type: 'quit', messages: [] }); const command = createTestCommand({ name: 'exit', action: quitAction, }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1), ); vi.useFakeTimers(); try { await act(async () => { await result.current.handleSlashCommand('/exit'); }); await act(async () => { await vi.advanceTimersByTimeAsync(200); }); expect(mockSetQuittingMessages).toHaveBeenCalledWith([]); expect(mockProcessExit).toHaveBeenCalledWith(0); } finally { vi.useRealTimers(); } }); }); it('should handle "submit_prompt" action returned from a file-based command', async () => { const fileCommand = createTestCommand( { name: 'filecmd', description: 'A command from a file', action: async () => ({ type: 'submit_prompt', content: 'The actual prompt from the TOML file.', }), }, CommandKind.FILE, ); const result = setupProcessorHook([], [fileCommand]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); let actionResult; await act(async () => { actionResult = await result.current.handleSlashCommand('/filecmd'); }); expect(actionResult).toEqual({ type: 'submit_prompt', content: 'The actual prompt from the TOML file.', }); expect(mockAddItem).toHaveBeenCalledWith( { type: MessageType.USER, text: '/filecmd' }, expect.any(Number), ); }); }); describe('Command Parsing and Matching', () => { it('should be case-sensitive', async () => { const command = createTestCommand({ name: 'test' }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { // Use uppercase when command is lowercase await result.current.handleSlashCommand('/Test'); }); // It should fail and call addItem with an error expect(mockAddItem).toHaveBeenCalledWith( { type: MessageType.ERROR, text: 'Unknown command: /Test', }, expect.any(Number), ); }); it('should correctly match an altName', async () => { const action = vi.fn(); const command = createTestCommand({ name: 'main', altNames: ['alias'], description: 'a command with an alias', action, }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('/alias'); }); expect(action).toHaveBeenCalledTimes(1); expect(mockAddItem).not.toHaveBeenCalledWith( expect.objectContaining({ type: MessageType.ERROR }), ); }); it('should handle extra whitespace around the command', async () => { const action = vi.fn(); const command = createTestCommand({ name: 'test', action }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand(' /test with-args '); }); expect(action).toHaveBeenCalledWith(expect.anything(), 'with-args'); }); it('should handle `?` as a command prefix', async () => { const action = vi.fn(); const command = createTestCommand({ name: 'help', action }); const result = setupProcessorHook([command]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(1)); await act(async () => { await result.current.handleSlashCommand('?help'); }); expect(action).toHaveBeenCalledTimes(1); }); }); describe('Command Precedence', () => { it('should prioritize a command with a primary name over a command with a matching alias', async () => { const quitAction = vi.fn(); const exitAction = vi.fn(); const quitCommand = createTestCommand({ name: 'quit', altNames: ['exit'], action: quitAction, }); const exitCommand = createTestCommand( { name: 'exit', action: exitAction, }, CommandKind.FILE, ); // The order of commands in the final loaded array is not guaranteed, // so the test must work regardless of which comes first. const result = setupProcessorHook([quitCommand], [exitCommand]); await waitFor(() => { expect(result.current.slashCommands).toHaveLength(2); }); await act(async () => { await result.current.handleSlashCommand('/exit'); }); // The action for the command whose primary name is 'exit' should be called. expect(exitAction).toHaveBeenCalledTimes(1); // The action for the command that has 'exit' as an alias should NOT be called. expect(quitAction).not.toHaveBeenCalled(); }); it('should add an overridden command to the history', async () => { const quitCommand = createTestCommand({ name: 'quit', altNames: ['exit'], action: vi.fn(), }); const exitCommand = createTestCommand( { name: 'exit', action: vi.fn() }, CommandKind.FILE, ); const result = setupProcessorHook([quitCommand], [exitCommand]); await waitFor(() => expect(result.current.slashCommands).toHaveLength(2)); await act(async () => { await result.current.handleSlashCommand('/exit'); }); // It should be added to the history. expect(mockAddItem).toHaveBeenCalledWith( { type: MessageType.USER, text: '/exit' }, expect.any(Number), ); }); }); describe('Lifecycle', () => { it('should abort command loading when the hook unmounts', async () => { const abortSpy = vi.spyOn(AbortController.prototype, 'abort'); const { unmount } = renderHook(() => useSlashCommandProcessor( mockConfig, mockSettings, mockAddItem, mockClearItems, mockLoadHistory, vi.fn(), // refreshStatic mockSetShowHelp, vi.fn(), // onDebugMessage vi.fn(), // openThemeDialog mockOpenAuthDialog, vi.fn(), // openEditorDialog vi.fn(), // toggleCorgiMode mockSetQuittingMessages, vi.fn(), // openPrivacyNotice ), ); unmount(); expect(abortSpy).toHaveBeenCalledTimes(1); }); }); });