Skip to content

Use synchronous writes when detecting keyboard modes#13478

Merged
scidomino merged 1 commit intomainfrom
tomm_fix
Nov 20, 2025
Merged

Use synchronous writes when detecting keyboard modes#13478
scidomino merged 1 commit intomainfrom
tomm_fix

Conversation

@scidomino
Copy link
Copy Markdown
Collaborator

@scidomino scidomino commented Nov 20, 2025

Summary

Use synchronous writes when detecting/enabling/disabling keyboard modes

Details

There's a slight chance this will fix the "9;5u" problem.

@scidomino scidomino requested a review from a team as a code owner November 20, 2025 05:22
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @scidomino, I'm Gemini Code Assist1! 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 refactors the terminal protocol detection and enabling logic by switching from process.stdout.write to fs.writeSync for sending terminal escape sequences. This change ensures synchronous output to the terminal, which is crucial for reliable interaction with protocols like Kitty and SGR Mouse, and introduces robust error handling to gracefully manage scenarios where these write operations might not be supported.

Highlights

  • Synchronous Terminal Output: Replaced asynchronous process.stdout.write calls with synchronous fs.writeSync(1, ...) for sending terminal escape sequences, ensuring immediate and reliable communication with the terminal.
  • Consolidated Write Operations: Combined multiple sequential process.stdout.write calls into single fs.writeSync calls to streamline output and potentially improve efficiency.
  • Robust Error Handling: Implemented try...catch blocks around all terminal write operations to gracefully handle potential errors, preventing crashes in environments where these operations might not be fully supported or might fail.
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.

@scidomino scidomino changed the title Use writeSync Use synchronous writes when detecting keyboard modes Nov 20, 2025
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly replaces asynchronous process.stdout.write calls with synchronous fs.writeSync calls. This is an important improvement, particularly for the disableAllProtocols function which is registered as an exit handler, as only synchronous operations are guaranteed to complete before a process exits. My review includes suggestions to improve the readability and maintainability of the new code by avoiding the use of a magic number for the stdout file descriptor.

Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts Outdated
Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts
Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Nov 20, 2025

Size Change: +146 B (0%)

Total Size: 21.1 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 21.1 MB +146 B (0%)
./bundle/sandbox-macos-permissive-closed.sb 1.03 kB 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-closed.sb 3.29 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B

compressed-size-action

@scidomino
Copy link
Copy Markdown
Collaborator Author

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request changes terminal writes from asynchronous process.stdout.write to synchronous fs.writeSync to prevent potential race conditions when detecting keyboard protocol support. This is a good approach to ensure control sequences are sent before the application attempts to read a response. My review includes suggestions to improve the robustness of error handling in disableAllProtocols and enableSupportedProtocol, where a single try...catch block could leave the terminal in an inconsistent state if one of the write operations fails.

Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts
Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts
@scidomino scidomino enabled auto-merge November 20, 2025 05:35
Comment thread packages/cli/src/ui/utils/kittyProtocolDetector.ts
process.stdout.write('\x1b[?1006l'); // Disable SGR Mouse
sgrMouseEnabled = false;
try {
if (kittyEnabled) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a comment why we use the nonstandard writeSync which would generally be against project guidelines if it wasn't for the reasons mentioned in the pr description. You could even just mention the bug this is believed to fix.

Copy link
Copy Markdown
Contributor

@jacob314 jacob314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@scidomino scidomino added this pull request to the merge queue Nov 20, 2025
Merged via the queue into main with commit 9ebf321 Nov 20, 2025
22 checks passed
@scidomino scidomino deleted the tomm_fix branch November 20, 2025 05:59
@scidomino scidomino mentioned this pull request Nov 20, 2025
18 tasks
thacio added a commit to thacio/auditaria that referenced this pull request Nov 23, 2025
thacio added a commit to thacio/auditaria that referenced this pull request Nov 23, 2025
danpalmer pushed a commit to danpalmer/gemini-cli that referenced this pull request Nov 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants