refactor(assets-controllers): Simplify TokenDetectionController tests
#3744
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 comment was marked as resolved.
This comment was marked as resolved.
Gudahtt
force-pushed
the
refactor-token-detection-controller-tests
branch
from
6d24b1a
to
07da387
Compare
Gudahtt
force-pushed
the
refactor-token-balances-controller-tests
branch
from
262b25e
to
000b301
Compare
Base automatically changed from
refactor-token-balances-controller-tests
to
main
January 8, 2024 18:20
Gudahtt
force-pushed
the
refactor-token-detection-controller-tests
branch
from
946694b
to
665f73c
Compare
mcmire
reviewed
Jan 8, 2024
| @@ -157,58 +145,6 @@ function buildTokenDetectionControllerMessenger( | |||
| } | |||
|
|
|||
| describe('TokenDetectionController', () => { | |||
| let tokenDetection: TokenDetectionController; | |||
There was a problem hiding this comment.
Look at all this code go! 👋🏻
| [sampleTokenA.address]: new BN(1), | ||
| }); | ||
| await tokenDetection.detectTokens(); | ||
| describe('enabled', () => { |
There was a problem hiding this comment.
What do you think about using:
Suggested change
| describe('enabled', () => { | |
| describe('when the "disabled" option is false', () => { |
or something like that?
There was a problem hiding this comment.
Good point, done in e80e936
The `TokenDetectionController` tests have been refactored to use mocks instead of real controller instances, and to use the `withController` pattern to simplify controller setup and ensure that polling has stopped after each test. A `getDefaultTokenListState` function has been added to the `TokenListController` to enable us to use that default state in tests. Relates to #3708
Gudahtt
force-pushed
the
refactor-token-detection-controller-tests
branch
from
665f73c
to
0b9bede
Compare
Merged
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
The
TokenDetectionControllertests have been refactored to use mocks instead of real controller instances, and to use thewithControllerpattern to simplify controller setup and ensure that polling has stopped after each test.A
getDefaultTokenListStatefunction has been added to theTokenListControllerto enable us to use that default state in tests.One test was added to the
TokensControllertests to prevent a coverage drop (it was previously being tested indirectly via theTokenDetectionControllertests).References
Relates to #3708
Changelog
@metamask/assets-controllersAdded
getDefaultTokenListStatefunction to `TokenListControllerChecklist