Support waiting for a VM Service in AutoLaunch #5615
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @DanTup, 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 introduces a significant enhancement to the auto-launch feature, enabling it to intelligently wait for a specified VM Service to become accessible before initiating a debug session. This improvement aims to increase the reliability of automated debug launches by preventing attempts to connect to unavailable or stale VM Services, directly addressing a reported issue.
Highlights
- Enhanced Auto-Launch Configuration: Users can now specify
vmServiceUriandwaitForVmServiceMsfields in theirautolaunch.jsonfiles to control the debug session startup behavior. - VM Service Availability Check: A new internal mechanism has been implemented to actively poll the provided
vmServiceUriusing WebSockets, waiting for it to become connectable before proceeding with the debug session. - Conditional Debug Session Start: Debug sessions will only commence if the VM Service becomes available within the configured timeout. If the timeout is reached without a successful connection, the auto-launch process will abort, preventing attempts to debug against an unavailable service.
- Comprehensive Test Coverage: New unit tests have been added to validate the VM Service waiting logic, covering scenarios such as immediate availability, delayed availability, and timeout failures, as well as cases where the new configuration fields are partially or fully omitted.
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 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 or fill out our survey 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.
Pull Request Overview
This PR adds support for waiting for a VM Service to become available before starting debug sessions in AutoLaunch. It introduces two new configuration fields (vmServiceUri and waitForVmServiceMs) that allow AutoLaunch to probe a VM Service endpoint and wait for it to become accessible before proceeding with the debug session.
Key changes:
- Added VM Service connectivity probing with configurable timeout
- Enhanced AutoLaunch to handle VM Service waiting logic
- Comprehensive test coverage for various VM Service scenarios
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/shared/vscode/autolaunch.ts | Implements VM Service probing logic with WebSocket connectivity checks and timeout handling |
| src/test/dart/debug/autolaunch.test.ts | Adds comprehensive test suite for VM Service waiting functionality and refactors existing tests |
There was a problem hiding this comment.
Code Review
This pull request introduces a useful feature to wait for the VM Service to be available before auto-launching a debug session. The implementation is solid and the new functionality is well-tested. I have one suggestion to simplify the WebSocket connection logic by using the built-in handshakeTimeout option, which also addresses an incorrect comment in the code.
Overall, the changes are well-implemented and the tests are comprehensive.
If you include these fields in your
autolaunch.json:Then we will wait up to
waitForVmServiceMsforvmServiceUrito be connectable (as a WebSocket) before we start the debug session. If it never becomes available within this time, we will do nothing (we can add another flag later if we think we should have functionality to start the debug session anyway, but I suspect this won't be wanted, because stale files would result in failed debug sessions).Fixes #5614