Serializer: name the packet in write errors from a compiled protocol - #180
Open
u9g wants to merge 1 commit into
Open
Serializer: name the packet in write errors from a compiled protocol#180u9g wants to merge 1 commit into
u9g wants to merge 1 commit into
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
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.
Problem
Every packet write goes through
Serializer.createPacketBuffer, but a compiled protocol never setse.field, so the errors coming out say nothing about which packet failed:The interpreter names it through the switch's field path (
params.position.face); the compiler reports no path at all. The error is thrown inside_transformand surfaces asynchronously on the stream, so a caller cannot attribute it after the fact either.Change
Serializer.createPacketBufferprefixes the message within packet <name>:when the value has anameand the error's field path does not already contain it:Interpreted errors and values without a
nameare untouched.Testing
test/misc.js: compiled gets the prefix, interpreted keeps its field path with no duplicate, a value with nonameis left alone.npm test: lint clean, 504 passing.