Fix pressing any key to exit select mode.

[jacob314]

Summary

Fix bug where only ctrl-S would exit copy mode

Details

This was broken by adding key press bubbling behavior but that same behavior also enables making this support more robust if used correctly.

• Refactored Keypress Handling: Implemented a new priority-based system for keypress event dispatch, allowing for more granular control over which handlers respond to input.
• Introduced KeypressPriority Enum: Defined explicit priority levels (Low, Normal, High, Critical) for keypress handlers, ensuring critical actions like exiting copy mode reliably take precedence.
• Dedicated Copy Mode Exit Handler: Created a specific useKeypress instance with Critical priority to ensure that any keypress exits copy mode when it is active, fixing a previous bug.
• Improved Test Reliability: Updated tests to simulate keypresses directly via stdin.write using ANSI escape sequences, providing more accurate and robust validation of the new keypress system.

Related Issues

Fixes #18422

[gemini-code-assist]

Summary of Changes

Hello @jacob314, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors the application's keyboard input handling mechanism by introducing a robust priority-based system for dispatching keypress events. The core objective is to ensure that specific, critical actions, such as exiting copy mode, reliably take precedence over other input handlers. This change enhances the predictability and correctness of keyboard interactions within the application, particularly for state-dependent behaviors like copy mode, leading to a more stable and intuitive user experience.

Highlights

• Refactored Keypress Handling: Implemented a new priority-based system for keypress event dispatch, allowing for more granular control over which handlers respond to input.
• Introduced KeypressPriority Enum: Defined explicit priority levels (Low, Normal, High, Critical) for keypress handlers, ensuring critical actions like exiting copy mode reliably take precedence.
• Dedicated Copy Mode Exit Handler: Created a specific useKeypress instance with Critical priority to ensure that any keypress exits copy mode when it is active, fixing a previous bug.
• Improved Test Reliability: Updated tests to simulate keypresses directly via stdin.write using ANSI escape sequences, providing more accurate and robust validation of the new keypress system.

Changelog

• packages/cli/src/ui/AppContainer.test.tsx
  • Refactored keypress simulation in tests to use stdin.write for more accurate event triggering.
  • Introduced KeypressProvider wrapper for AppContainer in tests.
  • Added a new test case to verify that the copy mode exit handler correctly overrides other priority listeners.
  • Removed direct mocking of useKeypress callback in tests.
• packages/cli/src/ui/AppContainer.tsx
  • Moved the logic for exiting copy mode on any keypress into a dedicated useKeypress hook with Critical priority.
  • Removed the copyModeEnabled check from the general handleGlobalKeypress callback.
  • Imported KeypressPriority enum.
• packages/cli/src/ui/contexts/KeypressContext.tsx
  • Implemented a priority-based keypress dispatch system using MultiMap.
  • Defined KeypressPriority enum (Low, Normal, High, Critical) for granular control over handler precedence.
  • Updated subscribe and unsubscribe methods to manage handlers based on their priority.
  • Optimized keypress broadcasting by caching sorted priority levels.
• packages/cli/src/ui/hooks/useKeypress.ts
  • Updated the useKeypress hook to accept KeypressPriority as an option, allowing developers to specify the priority of their keypress handlers.
  • Maintained backward compatibility for boolean priority values.

Activity

• The pull request introduces a significant refactoring of the keypress handling system, moving from a simpler, less flexible keypress management to a more robust, priority-based system.
• This involves architectural changes across multiple files, including the main application container, the keypress context, and the useKeypress hook.
• Comprehensive updates to the related test file were made to reflect and validate these architectural changes, ensuring the new system behaves as expected.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Size Change: +7.2 kB (+0.03%)

Total Size: 24.3 MB

Filename	Size	Change
./bundle/gemini.js	24.3 MB	+7.2 kB (+0.03%)

ℹ️ View Unchanged

Filename	Size
./bundle/sandbox-macos-permissive-closed.sb	1.03 kB
./bundle/sandbox-macos-permissive-open.sb	890 B
./bundle/sandbox-macos-permissive-proxied.sb	1.31 kB
./bundle/sandbox-macos-restrictive-closed.sb	3.29 kB
./bundle/sandbox-macos-restrictive-open.sb	3.36 kB
./bundle/sandbox-macos-restrictive-proxied.sb	3.56 kB

_{compressed-size-action}

[gemini-code-assist]

Code Review

This pull request introduces a significant and well-executed refactoring of the keypress handling logic. By replacing the previous hook-based approach with a KeypressProvider and a priority-based subscription model, it elegantly solves the issue of keypresses being intercepted before they can exit select/copy mode. The new system, featuring multiple priority levels (Low, Normal, High, Critical), is more robust, maintainable, and extensible. The accompanying test refactoring is also a major improvement, moving from mocking hooks to more realistic integration tests that write directly to stdin. The new test case for handler priority provides strong confidence in the correctness of the fix. Overall, this is an excellent change that improves both functionality and code quality.

[sehoon38]

LGTM, thanks!