-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Set port dynamically in VSCode extension and read from it in gemini-cli and send initial notification #4255
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @chrstnb, 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 significantly enhances the robustness and flexibility of the communication between the VSCode extension and the gemini-cli
. It transitions from a static, hardcoded port to a dynamic port allocation system for the IDE companion server, which is then communicated to the CLI via an environment variable. This change addresses potential port conflicts and streamlines the setup for users.
Highlights
- Dynamic Port Allocation: The VSCode extension's companion server now dynamically allocates an available port using the
get-port
library, replacing the previously hardcoded port3000
to prevent potential conflicts. - Environment Variable Integration: The dynamically chosen port is now exposed to integrated VSCode terminals via the
GEMINI_CLI_IDE_SERVER_PORT
environment variable, allowing other processes to discover it. - CLI Port Configuration: The
gemini-cli
has been updated to read the companion server's port from theGEMINI_CLI_IDE_SERVER_PORT
environment variable when running in IDE mode, ensuring it connects to the correct, dynamically assigned port. - IDE Notification Refinement: The logic for sending
ide/activeFileChanged
notifications within the VSCode extension has been refactored to ensure reliable and single-time delivery per session initialization, improving communication robustness.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this 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 introduces dynamic port allocation for the VSCode extension's MCP server and corresponding logic in the CLI to read this port from an environment variable. The changes look good and correctly implement the intended feature. I've added a couple of suggestions to improve robustness and error handling: one to validate the port number in the CLI, and another to add more comprehensive error handling and fix a misleading log message in the VSCode extension.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: can you also update the commit message to include the notification changes
Code Coverage Summary
CLI Package - Full Text Report
Core Package - Full Text Report
For detailed HTML reports, please see the 'coverage-reports-22.x' artifact from the main CI run. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
…li and send initial notification (google-gemini#4255)
…li and send initial notification (#4255)
…li and send initial notification (google-gemini#4255)
…li and send initial notification (#4255)
…li and send initial notification (google-gemini#4255)
TLDR
Dynamically generates a port and writes it to IDE terminals. Note that when/if we first install the extension, the user will need to re-start the terminal or create a new one or reload vscode to pick up the changes.
Also sends a notification after spinning up.
Reviewer Test Plan
Run extension locally and verify that when you spin up gemini CLI in IDE mode, it is able to connect to the MCP server.
Testing Matrix
Linked issues / bugs
Resolves #3918