Skip to content
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

Merged
merged 24 commits into from
Jan 30, 2024
Merged

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Jan 12, 2024

Description

Closes: #18522

This pr does:

  • Creates an environment struct that is passed to circuit module as an example.
  • Cleans up gas meter to be simpler and more direct
  • Creates a gas service in runtime
  • Removes event listeners, was added but unclear if its needed
  • Remove ctx from event manager functions as its duplicated with the service context

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...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

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...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

runtime/environment.go Fixed Show fixed Hide fixed
runtime/environment.go Fixed Show fixed Hide fixed
runtime/environment.go Fixed Show fixed Hide fixed
@alexanderbez
Copy link
Contributor

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.

@tac0turtle tac0turtle changed the title refactor: add in environment bundler of service refactor!(core): add in environment bundler of service Jan 12, 2024
@tac0turtle
Copy link
Member Author

tac0turtle commented Jan 12, 2024

opening this for review, but i still need to add replace tags to make things work

@tac0turtle tac0turtle marked this pull request as ready for review January 12, 2024 18:57
@tac0turtle tac0turtle requested a review from a team as a code owner January 12, 2024 18:57
Copy link
Contributor

coderabbitai bot commented Jan 12, 2024

Walkthrough

The suite of changes introduces the appmodule.Environment interface to centralize and simplify access to various services within the application, such as event handling, gas metering, and key-value stores. This modification aims to enhance modularity and reduce direct dependencies on the Cosmos SDK, facilitating a more streamlined, service-oriented architecture. The removal of unused elements like HasEventListeners and adjustments in gas meter handling reflect a broader effort to refine and optimize the framework's efficiency and developer experience.

Changes

File Path Change Summary
core/appmodule/environment.go
runtime/environment.go
runtime/module.go
x/circuit/depinject.go
x/circuit/keeper/keeper.go
x/circuit/keeper/genesis_test.go
x/circuit/keeper/keeper_test.go
Introduced appmodule.Environment for streamlined service access and modified related functions and structs to utilize this new interface.
x/accounts/testing/counter/counter.go Updated gas meter handling from ConsumeGas to Consume method calls, adjusting gas consumption logic.
x/circuit/CHANGELOG.md
core/CHANGELOG.md
Documented breaking changes and additions, specifically the introduction of appmodule.Environment and the removal of HasEventListeners.
runtime/gas.go Added new gas management functionality, including interfaces and implementations for gas meter operations.
simapp/app.go Modified NewSimApp function to adapt to changes in CircuitKeeper and AuthzKeeper initialization.

Assessment against linked issues

Objective Addressed Explanation
Introduce a new type Environment as a struct to embed service interfaces. (#18522)
Simplify the module instantiation process by using the Environment struct. (#18522)
Enable passing a single Environment variable to modules. (#18522)
Allow the Environment struct to be generic and customizable. (#18522)

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

runtime/module.go Outdated Show resolved Hide resolved
Copy link
Member

@aaronc aaronc left a 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

@tac0turtle
Copy link
Member Author

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

core/appmodule/environment.go Outdated Show resolved Hide resolved
runtime/module.go Outdated Show resolved Hide resolved
// Gas Meter Wrappers
// ______________________________________________________________________________________________

type SDKGasMeter struct {
Copy link
Contributor

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?

Copy link
Member Author

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

core/appmodule/event.go Outdated Show resolved Hide resolved
core/event/service.go Outdated Show resolved Hide resolved
runtime/environment.go Outdated Show resolved Hide resolved
@tac0turtle tac0turtle requested a review from julienrbrt January 23, 2024 13:38
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@tac0turtle tac0turtle enabled auto-merge January 29, 2024 14:47
Comment on lines +45 to +47

env := runtime.NewEnvironment(runtime.NewKVStoreService(mockStoreKey))
k := keeper.NewKeeper(env, encCfg.Codec, authtypes.NewModuleAddress("gov").String(), ac)
Copy link
Contributor

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.

Copy link
Member

@facundomedica facundomedica left a 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

@tac0turtle tac0turtle added this pull request to the merge queue Jan 30, 2024
Merged via the queue into main with commit ca04e11 Jan 30, 2024
59 of 61 checks passed
@tac0turtle tac0turtle deleted the marko/18522 branch January 30, 2024 12:24
@coderabbitai coderabbitai bot mentioned this pull request Feb 8, 2024
12 tasks
@coderabbitai coderabbitai bot mentioned this pull request May 3, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Environment Variable
5 participants