(GH-118) Fail gracefully when critical gems cannot load #134
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
Previously the language server would crash/terminate early if a critical gem like puppet was unavailable. This can happen when the ruby environment is not from the Puppet Agent or PDK. This commit changes the behaviour of the Language Server to still execute but it a completely disable fashion: * Detects a failed gem load for critical gems and sets PuppetLanguageServer.active? is to false * When the Language Server is not active, a different Message Router is used which effectively warns the user that the server failed to start and that all functions are disabled. The server responds to the client with no capabilities and the custom getVersion request, is responded to with unknown data No automated tests were added as this is an edge case. Manual testing was performed by changing the call `require 'puppet'` to `require 'puppetxxxxx'` which is enough to trigger a failure.
jpogran
approved these changes
May 28, 2019
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.
Fixes #118
Previously the language server would crash/terminate early if a critical gem
like puppet was unavailable. This can happen when the ruby environment is not
from the Puppet Agent or PDK. This commit changes the behaviour of the
Language Server to still execute but it a completely disable fashion:
PuppetLanguageServer.active? is to false
which effectively warns the user that the server failed to start and that
all functions are disabled. The server responds to the client with no
capabilities and the custom getVersion request, is responded to with
unknown data
No automated tests were added as this is an edge case. Manual testing was
performed by changing the call
require 'puppet'torequire 'puppetxxxxx'which is enough to trigger a failure.