/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import React from 'react'; import { renderHook, act, waitFor } from '@testing-library/react'; import { vi, Mock } from 'vitest'; import { KeypressProvider, useKeypressContext, Key, } from './KeypressContext.js'; import { useStdin } from 'ink'; import { EventEmitter } from 'events'; import { KITTY_KEYCODE_ENTER, KITTY_KEYCODE_NUMPAD_ENTER, CHAR_CODE_ESC, CHAR_CODE_LEFT_BRACKET, CHAR_CODE_1, CHAR_CODE_2, } from '../utils/platformConstants.js'; // Mock the 'ink' module to control stdin vi.mock('ink', async (importOriginal) => { const original = await importOriginal(); return { ...original, useStdin: vi.fn(), }; }); class MockStdin extends EventEmitter { isTTY = true; setRawMode = vi.fn(); override on = this.addListener; override removeListener = super.removeListener; write = vi.fn(); resume = vi.fn(); pause = vi.fn(); // Helper to simulate a keypress event pressKey(key: Partial) { this.emit('keypress', null, key); } // Helper to simulate a kitty protocol sequence sendKittySequence(sequence: string) { this.emit('data', Buffer.from(sequence)); } // Helper to simulate a paste event sendPaste(text: string) { const PASTE_MODE_PREFIX = `\x1b[200~`; const PASTE_MODE_SUFFIX = `\x1b[201~`; this.emit('data', Buffer.from(PASTE_MODE_PREFIX)); this.emit('data', Buffer.from(text)); this.emit('data', Buffer.from(PASTE_MODE_SUFFIX)); } } describe('KeypressContext - Kitty Protocol', () => { let stdin: MockStdin; const mockSetRawMode = vi.fn(); const wrapper = ({ children, kittyProtocolEnabled = true, }: { children: React.ReactNode; kittyProtocolEnabled?: boolean; }) => ( {children} ); beforeEach(() => { vi.clearAllMocks(); stdin = new MockStdin(); (useStdin as Mock).mockReturnValue({ stdin, setRawMode: mockSetRawMode, }); }); describe('Enter key handling', () => { it('should recognize regular enter key (keycode 13) in kitty protocol', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for regular enter: ESC[13u act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_ENTER}u`); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, ctrl: false, meta: false, shift: false, }), ); }); it('should recognize numpad enter key (keycode 57414) in kitty protocol', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for numpad enter: ESC[57414u act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_NUMPAD_ENTER}u`); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, ctrl: false, meta: false, shift: false, }), ); }); it('should handle numpad enter with modifiers', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for numpad enter with Shift (modifier 2): ESC[57414;2u act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_NUMPAD_ENTER};2u`); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, ctrl: false, meta: false, shift: true, }), ); }); it('should handle numpad enter with Ctrl modifier', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for numpad enter with Ctrl (modifier 5): ESC[57414;5u act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_NUMPAD_ENTER};5u`); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, ctrl: true, meta: false, shift: false, }), ); }); it('should handle numpad enter with Alt modifier', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for numpad enter with Alt (modifier 3): ESC[57414;3u act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_NUMPAD_ENTER};3u`); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, ctrl: false, meta: true, shift: false, }), ); }); it('should not process kitty sequences when kitty protocol is disabled', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: false }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for numpad enter act(() => { stdin.sendKittySequence(`\x1b[${KITTY_KEYCODE_NUMPAD_ENTER}u`); }); // When kitty protocol is disabled, the sequence should be passed through // as individual keypresses, not recognized as a single enter key expect(keyHandler).not.toHaveBeenCalledWith( expect.objectContaining({ name: 'return', kittyProtocol: true, }), ); }); }); describe('Escape key handling', () => { it('should recognize escape key (keycode 27) in kitty protocol', async () => { const keyHandler = vi.fn(); const { result } = renderHook(() => useKeypressContext(), { wrapper: ({ children }) => wrapper({ children, kittyProtocolEnabled: true }), }); act(() => { result.current.subscribe(keyHandler); }); // Send kitty protocol sequence for escape: ESC[27u act(() => { stdin.sendKittySequence('\x1b[27u'); }); expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'escape', kittyProtocol: true, }), ); }); }); describe('paste mode', () => { it('should handle multiline paste as a single event', async () => { const keyHandler = vi.fn(); const pastedText = 'This \nis \na \nmultiline \npaste.'; const { result } = renderHook(() => useKeypressContext(), { wrapper, }); act(() => { result.current.subscribe(keyHandler); }); // Simulate a bracketed paste event act(() => { stdin.sendPaste(pastedText); }); await waitFor(() => { // Expect the handler to be called exactly once for the entire paste expect(keyHandler).toHaveBeenCalledTimes(1); }); // Verify the single event contains the full pasted text expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ paste: true, sequence: pastedText, }), ); }); }); describe('debug keystroke logging', () => { let consoleLogSpy: ReturnType; let consoleWarnSpy: ReturnType; beforeEach(() => { consoleLogSpy = vi.spyOn(console, 'log').mockImplementation(() => {}); consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {}); }); afterEach(() => { consoleLogSpy.mockRestore(); consoleWarnSpy.mockRestore(); }); it('should not log keystrokes when debugKeystrokeLogging is false', async () => { const keyHandler = vi.fn(); const wrapper = ({ children }: { children: React.ReactNode }) => ( {children} ); const { result } = renderHook(() => useKeypressContext(), { wrapper }); act(() => { result.current.subscribe(keyHandler); }); // Send a kitty sequence act(() => { stdin.sendKittySequence('\x1b[27u'); }); expect(keyHandler).toHaveBeenCalled(); expect(consoleLogSpy).not.toHaveBeenCalledWith( expect.stringContaining('[DEBUG] Kitty'), ); }); it('should log kitty buffer accumulation when debugKeystrokeLogging is true', async () => { const keyHandler = vi.fn(); const wrapper = ({ children }: { children: React.ReactNode }) => ( {children} ); const { result } = renderHook(() => useKeypressContext(), { wrapper }); act(() => { result.current.subscribe(keyHandler); }); // Send a complete kitty sequence for escape act(() => { stdin.sendKittySequence('\x1b[27u'); }); expect(consoleLogSpy).toHaveBeenCalledWith( '[DEBUG] Kitty buffer accumulating:', expect.stringContaining('\x1b[27u'), ); expect(consoleLogSpy).toHaveBeenCalledWith( '[DEBUG] Kitty sequence parsed successfully:', expect.stringContaining('\x1b[27u'), ); }); it('should log kitty buffer overflow when debugKeystrokeLogging is true', async () => { const keyHandler = vi.fn(); const wrapper = ({ children }: { children: React.ReactNode }) => ( {children} ); const { result } = renderHook(() => useKeypressContext(), { wrapper }); act(() => { result.current.subscribe(keyHandler); }); // Send an invalid long sequence to trigger overflow const longInvalidSequence = '\x1b[' + 'x'.repeat(100); act(() => { stdin.sendKittySequence(longInvalidSequence); }); expect(consoleLogSpy).toHaveBeenCalledWith( '[DEBUG] Kitty buffer overflow, clearing:', expect.any(String), ); }); it('should log kitty buffer clear on Ctrl+C when debugKeystrokeLogging is true', async () => { const keyHandler = vi.fn(); const wrapper = ({ children }: { children: React.ReactNode }) => ( {children} ); const { result } = renderHook(() => useKeypressContext(), { wrapper }); act(() => { result.current.subscribe(keyHandler); }); // Send incomplete kitty sequence act(() => { stdin.pressKey({ name: undefined, ctrl: false, meta: false, shift: false, sequence: '\x1b[1', }); }); // Send Ctrl+C act(() => { stdin.pressKey({ name: 'c', ctrl: true, meta: false, shift: false, sequence: '\x03', }); }); expect(consoleLogSpy).toHaveBeenCalledWith( '[DEBUG] Kitty buffer cleared on Ctrl+C:', '\x1b[1', ); // Verify Ctrl+C was handled expect(keyHandler).toHaveBeenCalledWith( expect.objectContaining({ name: 'c', ctrl: true, }), ); }); it('should show char codes when debugKeystrokeLogging is true even without debug mode', async () => { const keyHandler = vi.fn(); const wrapper = ({ children }: { children: React.ReactNode }) => ( {children} ); const { result } = renderHook(() => useKeypressContext(), { wrapper }); act(() => { result.current.subscribe(keyHandler); }); // Send incomplete kitty sequence const sequence = '\x1b[12'; act(() => { stdin.pressKey({ name: undefined, ctrl: false, meta: false, shift: false, sequence, }); }); // Verify debug logging for accumulation expect(consoleLogSpy).toHaveBeenCalledWith( '[DEBUG] Kitty buffer accumulating:', sequence, ); // Verify warning for char codes expect(consoleWarnSpy).toHaveBeenCalledWith( 'Kitty sequence buffer has char codes:', [CHAR_CODE_ESC, CHAR_CODE_LEFT_BRACKET, CHAR_CODE_1, CHAR_CODE_2], ); }); }); });