grpc/proto changes for GetByIndex #355
Conversation
|
There doesn't seem to be. Ill open a PR to fix that now. |
UnitylChaos
force-pushed
the
grpc-getbyindex
branch
from
4eafe82
to
26c4225
Compare
CHANGELOG.md
Outdated
| ## Unreleased | ||
|
|
||
| ### Breaking Changes | ||
| - [\#355](https://github.com/cosmos/iavl/pull/355) `Get` in `iavlServer` no longer returns an error if the requested key does not exist. `GetResponse` now contains a `missing` boolean to indicate that a key does not exist, and the returned index will be that of the next occupied key. |
There was a problem hiding this comment.
Why do we need that breaking change?
There was a problem hiding this comment.
I don't believe there is a supported way of returning structured error information in gRPC, so in order to return the index of the nearest key when accessing a missing key we have to change from an error response to a regular response. See original issue #354.
server/server.go
Outdated
| } | ||
|
|
||
| return &pb.GetResponse{Index: idx, Value: value}, nil | ||
| return &pb.GetResponse{Index: idx, Value: value, Missing: false}, nil |
There was a problem hiding this comment.
you could merge the lines above to one line;
return &pb.GetResponse{Index: idx, Value: value, Missing: value==nil}, nil
proto/iavl/iavl_api.proto
Outdated
| @@ -283,6 +296,12 @@ message HasResponse { | |||
| message GetResponse { | |||
| int64 index = 1; | |||
| bytes value = 2; | |||
| bool missing = 3; | |||
There was a problem hiding this comment.
how about changing to more standard not_found (like in HTTP) or exists (like in SQL)?
There was a problem hiding this comment.
Sure, not_found sounds good. I think it makes sense for the zero value to default to the typical case where the key exists.
#354
Is there any documentation on how to do the setup for the gogoproto generation stuff? I see the
proto-genmake action, but when I tried to set things up manually to do that I ended up with a different version ofprotoc-gen-grpc-gatewaywhich caused a bunch of extra changes on the generated go files.