Fix debug restart to recompile code before restarting #21081
+201
−31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When users press the restart button while debugging Rust tests, the debugger now automatically recompiles the code to ensure the latest changes are used. Previously, onDidTerminateDebugSession was used to detect restarts, but this event no longer fires on restart in recent VS Code versions. The solution now uses DebugAdapterTracker.onWillReceiveMessage to intercept the DAP 'restart' command. Key implementation details: - Intercepts 'restart' command via Debug Adapter Protocol tracker - Stops the debug session to clear cached binaries/symbols - Runs 'cargo build --all-targets' with progress notification - Starts a fresh debug session with the new binary - Includes error handling and timeout protection (2 minutes) The stop + recompile + fresh start approach is required because debug adapters cache binaries and symbols, so a simple restart would use stale data. Changes: - Updated debug.ts with DebugAdapterTracker implementation - Added user documentation in README.md - Added unit tests in debug_restart.test.ts - Added integration test documentation in debug_restart_integration.md - Removed unused activeDebugSessionIds variable - Added comprehensive code comments explaining DAP behavior
rustbot
added
the
S-waiting-on-review
Contributor
|
Is this PR AI-generated? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
When debugging Rust tests and pressing the restart button (⟳), the debugger would use stale binaries instead of recompiling with the latest code changes.
Previously, this worked using
onDidTerminateDebugSession, but this event no longer fires on restaart in recent VS Code versions.Solution
Uses
DebugAdapterTracker.onWillReceiveMessageto intercept the Debug Adapter Protocol (DAP)restartcommand and trigger recompilation.Implementation
restartcommand viaDebugAdapterTrackercargo build --all-targetswith 2-minute timeoutThe stop + recompile + fresh start approach is necessary because debug adapters cache binaries and symbols. A simple restart would continue using stale data.
Changes
debug.tswithDebugAdapterTrackerimplementationREADME.mddebug_restart.test.tsdebug_restart_integration.mdactiveDebugSessionIdsvariableTesting
User Experience
When users modify code during a debug session and press restart: