Gracefully handle invalid configs during LSP addon startup #14508
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
Earlopain
commented
Sep 5, 2025
|
|
||
| raise(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash) | ||
| unless hash.is_a?(Hash) | ||
| raise(ValidationError, "Malformed configuration in #{absolute_path}") |
There was a problem hiding this comment.
in ConfigLoader, ValidationError is raised when some values don't have the expected shape. This makes it consistent and allows it to be rescued more specifically in reload_config
| "- #{e.message}" | ||
| end | ||
| raise Requests::Formatting::Error, <<~MSG | ||
| An internal error occurred #{message}. |
There was a problem hiding this comment.
I talked with @vinistock recently, and the reason for inlining this is that they eventually want to deprecate/remove the formatter on the ruby-lsp side. So we should not rely on RubyLsp::Requests::Support::InternalRuboCopError being around.
I also want to completly stop loading the ruby-lsp buildin addon in the future, in which case it would also not be defined.
If the config is invalid for any reason during startup, the addon will be left in a state which it cannot recover from. This fixes this by instead showing a notification to the user. After the config is fixed, it will be properly reloaded. While it is invalid, no diagnostics will be shown. I have also: * Removed reliance on `RubyLsp::Requests::Support::InternalRuboCopError` * Moved lsp specific error handling into the addon itself * Logged the full error The main goal was to gracefully handle editing the config, where it may be invalid shortly, however due to a ruby-lsp bug no feedback is given in that case yet.
Earlopain
force-pushed
the
ruby-lsp-errors
branch
from
522f6fc to
96c7f49
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
If the config is invalid for any reason during startup, the addon will be left in a state which it cannot recover from.
This fixes this by instead showing a notification to the user. After the config is fixed, it will be properly reloaded. While it is invalid, no diagnostics will be shown.
I have also:
RubyLsp::Requests::Support::InternalRuboCopErrorThe main goal was to gracefully handle editing the config, where it may be invalid shortly, however due to a ruby-lsp bug no feedback is given in that case yet.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.