Don’t crash sourcekit-lsp if a known message is missing a field #1154
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
|
@swift-ci Please test |
bnbarham
reviewed
Mar 29, 2024
| case .unknown: | ||
| // We don't know what has gone wrong. This could be any level of badness. Inform the user about it. | ||
| logger.fault("ignoring unknown message") | ||
| sendMessageDecodingErrorNotificationToClient(message: "sourcekit-lsp failed to decode a message") |
There was a problem hiding this comment.
Are you purposefully making this slightly different to the catch case so that we know the difference from eg. a screenshot?
| // We failed to parse the message header. There isn't really much we can do to recover because we lost our | ||
| // anchor in the stream where new messages start. Crashing and letting ourselves be restarted by the client is | ||
| // probably the best option. | ||
| sendMessageDecodingErrorNotificationToClient(message: "Failed to find next message in connection to editor.") |
There was a problem hiding this comment.
The . will cause a .. as sendMessageDecodingErrorNotificationToClient adds a . itself
ahoppen
force-pushed
the
ahoppen/dont-crash-if-message-has-missing-field
branch
from
5527188 to
eb28054
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
bnbarham
approved these changes
Mar 29, 2024
| } catch { | ||
| // We don't know what has gone wrong. This could be any level of badness. Inform the user about it and ignore the | ||
| // message. | ||
| logger.fault("ignoring unknown message") |
Previously, we `fatalError`ing when `JSONDecoder` failed to decode a message from the client. Instead of crashing, try recovering from such invalid messages as best as possible. If we know that the state might have gotten out of sync with the client, show a notification message to the user, asking them to file an issue. rdar://112991102
ahoppen
force-pushed
the
ahoppen/dont-crash-if-message-has-missing-field
branch
from
eb28054 to
be42621
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
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.
Previously, we
fatalErroring whenJSONDecoderfailed to decode a message from the client. Instead of crashing, try recovering from such invalid messages as best as possible. If we know that the state might have gotten out of sync with the client, show a notification message to the user, asking them to file an issue.rdar://112991102