refactor: Use HybridResolver instead of protoregistry.GlobalFiles in runtime/v2/manager
#22744
Conversation
hieuvubk
requested review from
testinginprod,
sontrinh16,
a team and
julienrbrt
as code owners
📝 WalkthroughWalkthroughThe pull request introduces significant changes to the service registration logic within the Cosmos SDK's module manager. Key modifications include the removal of the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
julienrbrt
added
the
backport/v0.52.x
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
runtime/v2/manager.go (1)
Line range hint
686-689: Prevent potential panic due to unchecked type assertion inRegisterServiceThe type assertion
prefSd.(protoreflect.ServiceDescriptor)may cause a panic ifprefSddoes not implementprotoreflect.ServiceDescriptor. It's safer to use anokcheck to prevent a potential runtime panic.Apply this diff to fix the issue:
func (c *configurator) RegisterService(sd *grpc.ServiceDesc, ss interface{}) { // first we check if it's a msg server prefSd, err := c.registry.FindDescriptorByName(protoreflect.FullName(sd.ServiceName)) if err != nil { c.err = fmt.Errorf("register service: unable to find protov2 service descriptor: please make sure protov2 API counterparty is imported: %s", sd.ServiceName) return } - if !proto.HasExtension(prefSd.(protoreflect.ServiceDescriptor).Options(), cosmosmsg.E_Service) { + sdProto, ok := prefSd.(protoreflect.ServiceDescriptor) + if !ok { + c.err = fmt.Errorf("prefSd does not implement protoreflect.ServiceDescriptor for service %s", sd.ServiceName) + return + } + if !proto.HasExtension(sdProto.Options(), cosmosmsg.E_Service) { err = c.registerQueryHandlers(sd, ss) if err != nil { c.err = err } } else { err = c.registerMsgHandlers(sd, ss) if err != nil { c.err = err } } }
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (2)
runtime/v2/manager.go(3 hunks)x/accounts/module.go(0 hunks)
💤 Files with no reviewable changes (1)
- x/accounts/module.go
🧰 Additional context used
📓 Path-based instructions (1)
runtime/v2/manager.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (3)
runtime/v2/manager.go (3)
487-489: LGTM: Correct usage of gogoproto.HybridResolver in service registration
Switching to gogoproto.HybridResolver for the registry parameter in registerServices aligns with the PR's objective to address the service registration issue.
620-620: LGTM: Updated registerServices function signature
Updating the registry parameter type to gogoproto.Resolver ensures compatibility with the new resolver and reflects the intended design changes.
673-673: LGTM: Changed configurator.registry field type to gogoproto.Resolver
Modifying the registry field to use gogoproto.Resolver aligns with the updated resolver usage and maintains consistency across the codebase.
| if err := registerServices(module, app, gogoproto.HybridResolver); err != nil { | ||
| return err | ||
| } |
There was a problem hiding this comment.
💡 Codebase verification
Several non-test files still use protoregistry.GlobalFiles and need to be updated
The following files need to be updated to use gogoproto.HybridResolver instead of protoregistry.GlobalFiles:
types/msgservice/validate.goserver/mock/app.goruntime/v2/types.goorm/model/ormdb/module.goclient/v2/autocli/flag/builder.go
Test files using protoregistry.GlobalFiles should also be reviewed and updated for consistency, though they don't affect runtime behavior.
🔗 Analysis chain
Verify no remaining usages of protoregistry.GlobalFiles
To ensure consistency across the codebase, please verify that all instances of protoregistry.GlobalFiles have been replaced with gogoproto.HybridResolver.
Run the following script to identify any remaining usages:
Let me verify if these usages are in test files or actual implementation code by categorizing them.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for any usages of protoregistry.GlobalFiles in the codebase.
# Test: Expect no matches for protoregistry.GlobalFiles
rg 'protoregistry\.GlobalFiles'
Length of output: 1351
Script:
#!/bin/bash
# Check for non-test files containing protoregistry.GlobalFiles
echo "=== Non-test files ==="
rg 'protoregistry\.GlobalFiles' --type go | grep -v '_test.go'
echo -e "\n=== Test files ==="
rg 'protoregistry\.GlobalFiles' --type go | grep '_test.go'
Length of output: 1548
Description
Closes: #22688 #22651
x/accountmsg & query after registing failedx/accounts.Msg&x/gov.Queryis missing fromprotoregistry.GlobalFiles=> usegogoproto.HybridResolvercan solve problemAuthor Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit
New Features
Bug Fixes
Refactor