refactor: introduces NamespaceVersionMaxValue const #1893
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
staheri14
added
enhancement
Codecov Report
@@ Coverage Diff @@
## main #1893 +/- ##
=======================================
Coverage 21.85% 21.85%
=======================================
Files 117 117
Lines 13304 13304
=======================================
Hits 2907 2907
Misses 10107 10107
Partials 290 290
|
rootulp
reviewed
Jun 8, 2023
pkg/appconsts/global_consts.go
Outdated
| @@ -11,7 +13,8 @@ import ( | |||
| // They can not change throughout the lifetime of a network. | |||
| const ( | |||
| // NamespaveVersionSize is the size of a namespace version in bytes. | |||
| NamespaceVersionSize = 1 | |||
| NamespaceVersionSize = 1 | |||
| NamespaceVersionMaxValue = math.MaxUint8 // this value should be set according to NamespaceVersionSize, i.e., 2^NamespaceVersionSize - 1 | |||
There was a problem hiding this comment.
I think there's a slight typo in 2^NamespaceVersionSize - 1 b/c it doesn't evaluate to math.MaxUint8. When NamespaceVersionSize is interpolated, this evaluates to 2 ^ 1 - 1. Maybe this meant to say something like ... i.e., // math.Pow(2, 8 * NamespaceVersionSize) - 1 but proposal to do this instead:
// NamespaceVersionMaxValue is the maximum value a namespace version can be.
// This const must be updated if NamespaceVersionSize is changed.
NamespaceVersionMaxValue = math.MaxUint8There was a problem hiding this comment.
You are right, when writing that formula, I was thinking of NamespaceVersionSize in bits, instead of bytes. The correction is as you suggested 2^(8* NamespaceVersionSize)-1). Going to fix it.
rootulp
approved these changes
Jun 8, 2023
|
[nit] you may change the conventional commit prefix of this PR to |
staheri14
changed the title
cmwaters
approved these changes
Jun 9, 2023
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.
Overview
Although we already have a constant
NamespaceVersionSize, the comparison of the max value of the namespace version of the incoming Blobs is currently hardcoded tomath.uint8. While this aligns with the current value ofNamespaceVersionSizewhich is 1 byte, it would be safer (and also easier to debug and maintain the code) to derive the maximum value from the original constant instead of manually hardcoding it. This PR incorporates this modification.cc: @rootulp @evan-forbes please let me know if this change also makes sense to you.
Checklist