Repository navigation
fix(canonical): prevent non-deterministic field name qualification when field name collides with record type name - #314
Open
reginaldalfret wants to merge 1 commit into
Conversation
…en field name collides with record type name Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
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.
Summary
Fixes non-deterministic canonical schema generation in
CanonicalSchema()when a field name and a record type name share the same local name within the same namespace.Problem
In
canonical.go,pcfObjectprocesses JSON objects and namespace-qualifies any"name"property while populatingtypeLookup. When a field object (e.g.{"name": "items", ...}) was processed, its declared field name was incorrectly registered intypeLookupas a named type (com.example.items). Due to non-deterministic Go map iteration order, ifitemswas registered beforepcfStringevaluated the field's"name"attribute, the field name"items"was replaced with"com.example.items".Solution
"name"property qualification andtypeLookupregistration inpcfObjectso it only applies to actual named types (record,enum,fixed)."name"attribute key-value pairs directly without looking up declared name values intypeLookup.canonical_test.gocovering same-named field and record type schemas.Testing
go test ./...andgo test -v -run TestCanonicalSchema -count=100 .. All tests passed cleanly.Related Issue
Closes #307