feat: include error as description for parse errors closes #1556
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.
Note: the
socket.io.js
file is the generated output ofmake socket.io.js
, and should not be manually modified.The kind of change this PR does introduce
Current behaviour
When the client has an error decoding incoming data, it will currently close current connection, which will retrigger a reconnect. However, there's no good way to know what might have caused the
parse error
and makes debugging them much harder.New behaviour
Now, the error that was raised during parsing is attached as the optional
description
field on theonclose
and so the user can get at it as described in the 4.5.0 release notes.The error includes the data for ease of debugging, but that could probably be removed as that info should be accessible via the network inspection.
Other information (e.g. related issues)
Closes #1554