Print debugger output to the Ruby LSP output channel as well as the debug console #2957
Conversation
This file contains 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
…ebug console Because the debug console is only available when the debugger is actually spawned and attached to, users often miss crucial debugging messages about the reason the debugger exits unexpectedly. This commit prints all output to the Ruby LSP output channel as well as the debug console. So when the debugger exits unexpectedly, users can still see the output in the Ruby LSP output channel.
st0012
added
enhancement
andyw8
approved these changes
Dec 4, 2024
| this.logDebuggerMessage(`Spawning debugger in directory ${cwd}`); | ||
| this.logDebuggerMessage(` Command bundle ${args.join(" ")}`); | ||
| this.logDebuggerMessage( | ||
| ` Environment ${JSON.stringify(configuration.env)}`, |
There was a problem hiding this comment.
Is the trailing comma accidental?
There was a problem hiding this comment.
I think it's required by linting rules:
When I save the file, it's automatically added back.
There was a problem hiding this comment.
Oh, it seems the linter is defaulting to an 80 character line limit.
| @@ -341,4 +344,12 @@ export class Debugger | |||
| }); | |||
| }); | |||
| } | |||
|
|
|||
| private logDebuggerMessage(message: string) { | |||
| const trimmedMessage = message.trimEnd(); | |||
There was a problem hiding this comment.
If the debugger prints messages containing a \n in the end, it'd create an empty line in the log, which takes up space and doesn't help understanding the message. So IMO it's better to remove them.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
Because the debug console is only available when the debugger is actually spawned and attached to, users often miss crucial debugging messages about the reason the debugger exits unexpectedly.
This commit prints all output to the Ruby LSP output channel as well as the debug console. So when the debugger exits unexpectedly, users can still see the output in the Ruby LSP output channel.
Example
Launching Rails server is a project where
bin/railsis removed. In this case, because the debugger does not successfully start,DEBUG CONSOLEwill have no output.Before
After
Implementation
Automated Tests
Manual Tests