gRPC: fix server reflection #8945
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| // Package gogoreflection implements gRPC reflection for gogoproto consumers | ||
| // the normal reflection library does not work as it points to a different | ||
| // singleton registry. The API and codebase is taken from the official gRPC | ||
| // reflection repository. | ||
| package gogoreflection |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| package gogoreflection | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "compress/gzip" | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| _ "github.com/gogo/protobuf/gogoproto" // required so it does register the gogoproto file descriptor | ||
| gogoproto "github.com/gogo/protobuf/proto" | ||
|
|
||
| // nolint: staticcheck | ||
| "github.com/golang/protobuf/proto" | ||
| dpb "github.com/golang/protobuf/protoc-gen-go/descriptor" | ||
| _ "github.com/regen-network/cosmos-proto" // look above | ||
| ) | ||
|
|
||
| var importsToFix = map[string]string{ | ||
| "gogo.proto": "gogoproto/gogo.proto", | ||
| "cosmos.proto": "cosmos_proto/cosmos.proto", | ||
| } | ||
|
|
||
| // fixRegistration is required because certain files register themselves in a way | ||
| // but are imported by other files in a different way. | ||
fdymylja marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // NOTE(fdymylja): This fix should not be needed and should be addressed in some CI. | ||
| // Currently every cosmos-sdk proto file is importing gogo.proto as gogoproto/gogo.proto, | ||
| // but gogo.proto registers itself as gogo.proto, same goes for cosmos.proto. | ||
|
Contributor
There was a problem hiding this comment. Do you know why this happens? Maybe we should fix it in
Contributor
There was a problem hiding this comment. I mean - let's create an issue if there is a bug we can easily fix in cosmos-proto
Contributor
Author
There was a problem hiding this comment. it's not a bug per se, it's a shortcoming when it comes to combo together reflection and proto imports. protofiles register themselve in the registry with a path, but then are imported with another path. this makes reflection fail, because it cannot find certain files. this would mean either forking gogoproto and changing how we feed the file to protoc, or changing the third_party structure in the sdk, edit how every file imports gogoproto. and im not sure if this is a breaking change, descriptor wise it is. probably this should be a blob of work which should be reorganized during the transition to protov2 |
||
| func fixRegistration(registeredAs, importedAs string) error { | ||
| raw := gogoproto.FileDescriptor(registeredAs) | ||
| if len(raw) == 0 { | ||
| return fmt.Errorf("file descriptor not found for %s", registeredAs) | ||
| } | ||
|
|
||
| fd, err := decodeFileDesc(raw) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // fix name | ||
| *fd.Name = importedAs | ||
| fixedRaw, err := compress(fd) | ||
| if err != nil { | ||
| return fmt.Errorf("unable to compress: %w", err) | ||
| } | ||
| gogoproto.RegisterFile(importedAs, fixedRaw) | ||
| return nil | ||
| } | ||
|
|
||
| func init() { | ||
| // we need to fix the gogoproto filedesc to match the import path | ||
| // in theory this shouldn't be required, generally speaking | ||
| // proto files should be imported as their registration path | ||
|
|
||
| for registeredAs, importedAs := range importsToFix { | ||
| err := fixRegistration(registeredAs, importedAs) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // compress compresses the given file descriptor | ||
| // nolint: interfacer | ||
| func compress(fd *dpb.FileDescriptorProto) ([]byte, error) { | ||
| fdBytes, err := proto.Marshal(fd) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| buf := new(bytes.Buffer) | ||
| cw := gzip.NewWriter(buf) | ||
| _, err = cw.Write(fdBytes) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| err = cw.Close() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return buf.Bytes(), nil | ||
| } | ||
|
|
||
| func getFileDescriptor(filePath string) []byte { | ||
| // since we got well known descriptors which are not registered into gogoproto registry | ||
| // but are instead registered into the proto one, we need to check both | ||
| fd := gogoproto.FileDescriptor(filePath) | ||
| if len(fd) != 0 { | ||
| return fd | ||
| } | ||
| // nolint: staticcheck | ||
fdymylja marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return proto.FileDescriptor(filePath) | ||
| } | ||
|
|
||
| func getMessageType(name string) reflect.Type { | ||
| typ := gogoproto.MessageType(name) | ||
| if typ != nil { | ||
| return typ | ||
| } | ||
| // nolint: staticcheck | ||
| return proto.MessageType(name) | ||
| } | ||
|
|
||
| func getExtension(extID int32, m proto.Message) *gogoproto.ExtensionDesc { | ||
| // check first in gogoproto registry | ||
| for id, desc := range gogoproto.RegisteredExtensions(m) { | ||
| if id == extID { | ||
| return desc | ||
| } | ||
| } | ||
| // check into proto registry | ||
| // nolint: staticcheck | ||
| for id, desc := range proto.RegisteredExtensions(m) { | ||
| if id == extID { | ||
| return &gogoproto.ExtensionDesc{ | ||
| ExtendedType: desc.ExtendedType, | ||
| ExtensionType: desc.ExtensionType, | ||
| Field: desc.Field, | ||
| Name: desc.Name, | ||
| Tag: desc.Tag, | ||
| Filename: desc.Filename, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func getExtensionsNumbers(m proto.Message) []int32 { | ||
| gogoProtoExts := gogoproto.RegisteredExtensions(m) | ||
| out := make([]int32, 0, len(gogoProtoExts)) | ||
| for id := range gogoProtoExts { | ||
| out = append(out, id) | ||
| } | ||
| if len(out) != 0 { | ||
| return out | ||
| } | ||
| // nolint: staticcheck | ||
| protoExts := proto.RegisteredExtensions(m) | ||
| out = make([]int32, 0, len(protoExts)) | ||
| for id := range protoExts { | ||
| out = append(out, id) | ||
| } | ||
| return out | ||
| } | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package gogoreflection | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "google.golang.org/protobuf/runtime/protoimpl" | ||
| ) | ||
|
|
||
| func TestRegistrationFix(t *testing.T) { | ||
| res := getFileDescriptor("gogoproto/gogo.proto") | ||
| rawDesc, err := decompress(res) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| fd := protoimpl.DescBuilder{ | ||
| RawDescriptor: rawDesc, | ||
| }.Build() | ||
|
|
||
| if fd.File.Extensions().Len() == 0 { | ||
| t.Fatal("unexpected parsing") | ||
| } | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.