fix: make introspection JSON output deterministic#6076
Merged
Conversation
The introspection proc macros (used by the `experimental-inspect`
feature) accumulated each JSON object's fields in a `HashMap` before
serializing them in iteration order. Because `std`'s default hasher is
seeded randomly per process, the emitted JSON key order varied between
otherwise identical builds, leaving the embedded introspection chunks
non-reproducible.
Switch to `BTreeMap` so the keys come out in a stable (alphabetical)
order. JSON objects are unordered by spec, so downstream parsers are
unaffected.
Caught via Debian's reproducible-builds rebuild of pysequoia 0.1.34-2,
which fails with diffs like:
{"name","parent","type","annotation"}
vs
{"annotation","parent","type","name"}
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
2 participants
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.
The introspection proc macros (used by the
experimental-inspectfeature) accumulated each JSON object's fields in aHashMapbefore serializing them in iteration order. Becausestd's default hasher is seeded randomly per process, the emitted JSON key order varied between otherwise identical builds, leaving the embedded introspection chunks non-reproducible.Switch to
BTreeMapso the keys come out in a stable (alphabetical) order. JSON objects are unordered by spec, so downstream parsers are unaffected.Caught via Debian's reproducible-builds rebuild of pysequoia 0.1.34-2, which fails with diffs like:
{"name","parent","type","annotation"}
vs
{"annotation","parent","type","name"}