feat: validate namespace in share constructor #87
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
cmwaters
requested review from
ramin,
staheri14 and
vgonkivs
and removed request for
a team
rootulp
approved these changes
Jun 24, 2024
Wondertan
reviewed
Jun 24, 2024
| @@ -110,6 +94,14 @@ func (n Namespace) ID() []byte { | |||
| return n.data[NamespaceVersionSize:] | |||
| } | |||
|
|
|||
| func Validate(version uint8, id []byte) error { | |||
|
|
||
| err = validateID(bytes[VersionIndex], bytes[NamespaceVersionSize:]) | ||
| if err != nil { | ||
| if err := Validate(bytes[VersionIndex], bytes[NamespaceVersionSize:]); err != nil { |
There was a problem hiding this comment.
nit: to avoid confusing byte slicing you could do:
ns := Namespace{data: bytes}
err := Validate(ns.Version(), ns.ID())
if err != nil {
return Namespace{}, err
}
return nsThere was a problem hiding this comment.
Still, I'm not sure why we wouldn't add Validate as a method. (I know it's guaranteed to be valid after the construction but still)
There was a problem hiding this comment.
It gets used by the share package (which keeps the namespace in bytes form). Maybe we could consider either caching the namespace in the share struct or merging the namespace package with the share package (and thus we can return the namespace without needing to validate it)
| panic(err) | ||
| } | ||
| return blob | ||
| func NewV0Blob(ns ns.Namespace, data []byte) (*Blob, error) { |
|
I plan to merge the namespace package into the shares package. This will mean that |
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.
Closes: #86
This PR also addresses the nits from @Rootul's review here