fix: In Keybase GetByAddress, change generic error to NewErrKeyNotFound #1316
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
Signed-off-by: Jeff Thompson <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1316 +/- ##
==========================================
+ Coverage 47.87% 47.88% +0.01%
==========================================
Files 372 372
Lines 63019 63019
==========================================
+ Hits 30168 30179 +11
+ Misses 30384 30373 -11
Partials 2467 2467
☔ View full report in Codecov by Sentry. |
moul
approved these changes
Oct 29, 2023
This was referenced Oct 30, 2023
thehowl
approved these changes
Nov 9, 2023
moul
pushed a commit
to moul/gno
that referenced
this pull request
Nov 14, 2023
…nd (gnolang#1316) The Keybase method `GetByName` [returns the specific error](https://github.com/gnolang/gno/blob/199cd29584d44812a0aec3606bbff37a320c609a/tm2/pkg/crypto/keys/keybase.go#L184) `ErrKeyNotFound` if the key is not found. This is very nice because the GnoMobile API wraps this with a gRPC function and we use `keyerror.IsErrKeyNotFound` to check the error type and convert it to the gRPC equivalent. But the Keybase method `GetByAddress` just [returns a generic error](https://github.com/gnolang/gno/blob/199cd29584d44812a0aec3606bbff37a320c609a/tm2/pkg/crypto/keys/keybase.go#L192) if the key isn't found. (I assume that it is not intentional to restrict this to a generic error.) This means that the gRPC interface must search the error string for "not found", which is unreliable. We would prefer to use `keyerror.IsErrKeyNotFound`. Furthermore, `GetByNameOrAddress` [can return an error from either](https://github.com/gnolang/gno/blob/199cd29584d44812a0aec3606bbff37a320c609a/tm2/pkg/crypto/keys/keybase.go#L175-L177) `GetByName` or `GetByAddress`. It is preferable to return just one error type for key not found. This pull request updates `GetByAddress` to use `keyerror.NewErrKeyNotFound` with the same error message. <details><summary>Contributors' checklist...</summary> - [x] Added new tests, or not needed, or not feasible - [x] Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory - [x] Updated the official documentation or not needed - [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message was included in the description - [ ] Added references to related issues and PRs - [ ] Provided any useful hints for running manual tests - [ ] Added new benchmarks to [generated graphs](https://gnoland.github.io/benchmarks), if any. More info [here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md). </details> Signed-off-by: Jeff Thompson <[email protected]>
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.
The Keybase method
GetByNamereturns the specific errorErrKeyNotFoundif the key is not found. This is very nice because the GnoMobile API wraps this with a gRPC function and we usekeyerror.IsErrKeyNotFoundto check the error type and convert it to the gRPC equivalent. But the Keybase methodGetByAddressjust returns a generic error if the key isn't found. (I assume that it is not intentional to restrict this to a generic error.) This means that the gRPC interface must search the error string for "not found", which is unreliable. We would prefer to usekeyerror.IsErrKeyNotFound. Furthermore,GetByNameOrAddresscan return an error from eitherGetByNameorGetByAddress. It is preferable to return just one error type for key not found.This pull request updates
GetByAddressto usekeyerror.NewErrKeyNotFoundwith the same error message.Contributors' checklist...
BREAKING CHANGE: xxxmessage was included in the description