api/v0: reject Metadata.ProtocolID == 0 #95
Merged
Conversation
This file contains 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
mvdan
commented
Oct 13, 2021
willscott
approved these changes
Oct 13, 2021
|
Why is Circle running and just erroring immediately? |
Because nobody has pushed #87 over the finish line |
Integers in Go default to the zero value, meaning that if the user
forgets to set the protocol ID, it could transparently default to a
confusing value. For instance:
metadata := v0.Metadata{Data: someData}
This could lead to confusing decode errors later on, or to metadata
being mistaken for the wrong kind.
Instead, reject this zero value. The protocol ID is a multihash anyway,
and we want users to either select registered indexer metadata
multihashes, or a multihash in the reserved range for testing.
The check happens at both encode and decode, for extra safety.
This required adding an error return on the encode side.
While we're there, make Metadata implement encoding's Binary interfaces.
Updates #94.
mvdan
force-pushed
the
metadata-encoding-error
branch
from
dfd2784
to
5df6652
Compare
gammazero
reviewed
Oct 13, 2021
| // EncodeMetadata serializes Metadata to []byte. | ||
| func (m Metadata) Encode() []byte { | ||
| // MarshalBinary implements encoding.BinaryMarshaler. | ||
| func (m Metadata) MarshalBinary() ([]byte, error) { |
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.
(see commit message)