Do not send the 'body' field for DAP Initialized Event. #1345
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
|
As a meta note: the contributing guide mentions that there should always be an issue for a PR - is it ok to send small fix PRs like this without creating an issue first? |
the-mikedavis
force-pushed
the
md-dap-no-body-on-initialized
branch
from
4e4a864
to
550b495
Compare
The body field is required on most DAP Events and optional on Terminated but is actually not included in Initialized at all. Clients parsing the Events strictly will think an Initialized Event with a body is malformed, so this change drops the field entirely for Initialized. https://microsoft.github.io/debug-adapter-protocol/specification#Events_Initialized
the-mikedavis
force-pushed
the
md-dap-no-body-on-initialized
branch
from
550b495
to
2f0b7d4
Compare
It absolutely is. We should remove that requirement from the guidelines. |
robertoaloi
approved these changes
Jul 4, 2022
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.
Description
The body field is required on most DAP Events and optional on Terminated but
is actually not included in Initialized at all. Clients parsing the Events
strictly will think an Initialized Event with a body is malformed, so this
change drops the field entirely for Initialized.
https://microsoft.github.io/debug-adapter-protocol/specification#Events_Initialized