feat(depinject/appconfig): support gogo proto module configs #20540
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,80 @@ | ||
| package appconfig | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "google.golang.org/protobuf/reflect/protodesc" | ||
| "google.golang.org/protobuf/reflect/protoreflect" | ||
| "google.golang.org/protobuf/reflect/protoregistry" | ||
| "google.golang.org/protobuf/types/dynamicpb" | ||
| ) | ||
|
|
||
| // dynamic resolver allows marshaling gogo proto messages from the gogoproto.HybridResolver as long as those | ||
| // files have been imported before calling LoadJSON. There is similar code in autocli, this should probably | ||
| // eventually be moved into a library. | ||
|
Member
Author
There was a problem hiding this comment. Do we want to refactor this code and the almost identical implementation in autocli to cosmos-proto possibly?
Member
Author
There was a problem hiding this comment. We could also move it to gogoproto because it uses the hybrid resolver and then call it here: https://github.com/cosmos/gogoproto/blob/6eec9731781bf8ec4feb0e4098ffb19ee74afb50/jsonpb/jsonpb.go#L792. So that gogoproto jsonpb.Unmarshal can be used to unmarshal v2 messages from json that contain some gogo proto messages in Any's. |
||
| type dynamicTypeResolver struct { | ||
| resolver protodesc.Resolver | ||
| } | ||
|
|
||
| func (r dynamicTypeResolver) FindExtensionByName(field protoreflect.FullName) (protoreflect.ExtensionType, error) { | ||
| ext, err := protoregistry.GlobalTypes.FindExtensionByName(field) | ||
| if err == nil { | ||
| return ext, nil | ||
| } | ||
|
|
||
| desc, err := r.resolver.FindDescriptorByName(field) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return dynamicpb.NewExtensionType(desc.(protoreflect.ExtensionTypeDescriptor)), nil | ||
| } | ||
|
|
||
| func (r dynamicTypeResolver) FindExtensionByNumber(message protoreflect.FullName, field protoreflect.FieldNumber) (protoreflect.ExtensionType, error) { | ||
| ext, err := protoregistry.GlobalTypes.FindExtensionByNumber(message, field) | ||
| if err == nil { | ||
| return ext, nil | ||
| } | ||
|
|
||
| desc, err := r.resolver.FindDescriptorByName(message) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| messageDesc := desc.(protoreflect.MessageDescriptor) | ||
| exts := messageDesc.Extensions() | ||
| n := exts.Len() | ||
| for i := 0; i < n; i++ { | ||
| ext := exts.Get(i) | ||
| if ext.Number() == field { | ||
| return dynamicpb.NewExtensionType(ext), nil | ||
| } | ||
| } | ||
|
|
||
| return nil, protoregistry.NotFound | ||
| } | ||
|
|
||
| func (r dynamicTypeResolver) FindMessageByName(message protoreflect.FullName) (protoreflect.MessageType, error) { | ||
| typ, err := protoregistry.GlobalTypes.FindMessageByName(message) | ||
| if err == nil { | ||
| return typ, nil | ||
| } | ||
|
|
||
| desc, err := r.resolver.FindDescriptorByName(message) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return dynamicpb.NewMessageType(desc.(protoreflect.MessageDescriptor)), nil | ||
| } | ||
|
|
||
| func (r dynamicTypeResolver) FindMessageByURL(url string) (protoreflect.MessageType, error) { | ||
| if i := strings.LastIndexByte(url, '/'); i >= 0 { | ||
| url = url[i+1:] | ||
| } | ||
|
|
||
| return r.FindMessageByName(protoreflect.FullName(url)) | ||
| } | ||
|
|
||
| var _ protoregistry.MessageTypeResolver = dynamicTypeResolver{} | ||
| var _ protoregistry.ExtensionTypeResolver = dynamicTypeResolver{} | ||
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 |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| package appconfig | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| "github.com/cosmos/gogoproto/proto" | ||
|
|
||
| internal "cosmossdk.io/depinject/internal/appconfig" | ||
|
Contributor
There was a problem hiding this comment. Usage of internal package not allowed. The use of Toolsgolangci-lint
|
||
| ) | ||
|
|
@@ -19,10 +20,15 @@ var Register = RegisterModule | |
| // Protobuf message types used for module configuration should define the | ||
| // cosmos.app.v1alpha.module option and must explicitly specify go_package | ||
| // to make debugging easier for users. | ||
|
Contributor
There was a problem hiding this comment. Why using any of we do a type check/cast just below. Cannot we just use the gogoproto.Message interface?
Member
Author
There was a problem hiding this comment. The logic I had was that we may want to support plan old go structs (not protobuf) eventually so one breaking change is better than two. When we discussed in architecture @tac0turtle said gogo is enough, although personally if people are annoyed with too much proto we should lower the barrier
Member
Author
There was a problem hiding this comment. We okay to leave as is and merge this? |
||
| func RegisterModule(config any, options ...Option) { | ||
| protoConfig, ok := config.(proto.Message) | ||
| if !ok { | ||
| panic(fmt.Errorf("expected config to be a proto.Message, got %T", config)) | ||
| } | ||
|
|
||
| ty := reflect.TypeOf(config) | ||
| init := &internal.ModuleInitializer{ | ||
| ConfigProtoMessage: protoConfig, | ||
| ConfigGoType: ty, | ||
| } | ||
| internal.ModuleRegistry[ty] = init | ||
|
|
||
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
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.
Check notice
Code scanning / CodeQL
Sensitive package import