-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor!(core): add in environment bundler of service #19041
Conversation
Looks pretty straightforward thus far. The advantage of this over a service locator, is that you get compile time safety here, but at the cost of a type that needs to be constantly updated and contain all the services. But this is minor IMO. |
opening this for review, but i still need to add replace tags to make things work |
WalkthroughThe suite of changes introduces the Changes
Assessment against linked issues
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The risk of a struct is you could end up in scenarios where modules need to nil check fields in the environment. An interface would be safer. To add stuff to an environment interface in future versions, you just create EnvironmentV2, etc
i want to do this, but i think we are not 100% sure if this is all we want there. I think when we cut core 1.0 then we should have an interface, till then we may need to add things |
// Gas Meter Wrappers | ||
// ______________________________________________________________________________________________ | ||
|
||
type SDKGasMeter struct { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Why not just call this GasMeter
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the idea was to easily recoginize the difference, since there is a new api for gas metering
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm!
|
||
env := runtime.NewEnvironment(runtime.NewKVStoreService(mockStoreKey)) | ||
k := keeper.NewKeeper(env, encCfg.Codec, authtypes.NewModuleAddress("gov").String(), ac) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The refactor to use the Environment
struct in test setup is a significant improvement, promoting consistency with the main codebase. It's recommended to review and possibly extend the test suite to cover any new behavior or edge cases introduced by the Environment
struct, especially focusing on error handling and service initialization.
Consider adding tests that specifically validate the behavior of the Environment
struct, including scenarios where services might not be initialized correctly, to ensure robust error handling and system stability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are missing:
ProvideEnvironment,
in runtime/module.go's init function.
I'll push it here, feel free to revert
EDIT: I broke everything
Description
Closes: #18522
This pr does:
Author 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.md
Reviewers 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.
I have...