Repository navigation
Prevent invalid changes to enums - #4463
Merged
Merged
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Snapshot WarningsEnsure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice. Scanned FilesNone |
Benchstat comparison
Results
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SupunS
approved these changes
Apr 8, 2026
6 tasks done
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.
Description
Several "enum" types in the codebase use
iota-basedconstblocks where the numeric values are part of the on-disk or on-wire format (CBOR encoding of values, storage domains, computation metering, hashing). If a value is accidentally changed (e.g by reordering, inserting a new case in the middle, removing a case, or replacing a_placeholder), it silently breaks backward compatibility.For example, I had accidentally added a new computation kind in e1e6728, which shifted/changed the value of the following existing kinds.
We already had some minimal protection, for some types, which caught e.g. appended cases but missed:
_is replaced with a new named case (count stays the same)StorageDomain,ComputationKind,values.CBORTag,ccf.CBORTag)This PR improves the enums with additional comments and adds more comprehensive tests:
PrimitiveStaticType,StorageDomain,ComputationKind,HashInputType,values.CBORTag,ccf.CBORTag_placeholders are replaces_Countconstants where missing (StorageDomain,ComputationKind)String()functions usingstringerwhere missing (StorageDomain,HashInputType)type CBORTag bytefor bothvalues.CBORTagandccf.CBORTag, which were previously untyped constants, enabling stringer generation and type safetyvalues.CBORTagtest frominterpreter/encoding_test.gotovalues/encode_test.goThis catches the following
require.Equalfails_Countvalue assertion fails_placeholder replaced with named case: Stringer loop detects non-numericString()I verified the prevention of invalid changes, e.g. by adding a new
ComputationKindby replacing an existing_placeholder. This causes a test failure aftergo generate.masterbranchFiles changedin the Github PR explorer