Add example controllers #4550
Open
Add example controllers #4550
Conversation
This file contains 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 commit adds controllers which are not meant to be published, but instead serve as models to exemplify best practices for writing controllers, fulfilling a long-standing need. The controllers included here are implemented within a complete package which is linted just like other packages, and they ship with working tests which are run just like other tests. This lessens the chance that they will fall out of date in the future. The two controllers included in this commit are called `GasPricesController` and `PetNamesController`, which are roughly based on, but intentionally not drawn from, `GasFeeController` and `AddressBookController`. They demonstrate the following best practices: - Setting up a common structure for controllers, including creating complete types for the messenger and for state - Using the messenger to access data from another controller - Using service objects to make HTTP requests - Mocking the messenger in tests - Creating mock service objects - Mocking time in tests Certainly, more best practices can be demonstrated, but this should be a good first start.
mcmire
force-pushed
the
add-example-controllers
branch
from
9a14241
to
7a3475f
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
mcmire
commented
Jul 26, 2024
mikesposito
force-pushed
the
add-example-controllers
branch
from
c7b7365
to
0302bb3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explanation
This commit adds controllers which are not meant to be published, but instead serve as models to exemplify best practices for writing controllers, fulfilling a long-standing need. The controllers included here are implemented within a complete package which is linted just like other packages, and they ship with working tests which are run just like other tests. This lessens the chance that they will fall out of date in the future.
The two controllers included in this commit are called
GasPricesControllerandPetNamesController, which are roughly based on, but intentionally not drawn from,GasFeeControllerandAddressBookController. They demonstrate the following best practices:Certainly, more best practices can be demonstrated, but this should be a good first start.
References
Progresses #4504.
Changelog
(No consumer-facing changes in this commit.)
Checklist