fix: Fix StaticIntervalPollingController not properly stopping polling if _executePoll was still pending#4230
Merged
Merged
Conversation
jiexi
commented
Apr 29, 2024
jiexi
changed the title
StaticIntervalPollingController not properly stopping polling if _executePoll was still pending
Member
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Member
Author
adonesky1
reviewed
May 1, 2024
…imeout' into jl/fix-static-interval-polling-timeout
Contributor
|
Details |
adonesky1
reviewed
May 1, 2024
| }); | ||
|
|
||
| it('should start and stop polling sessions for different networkClientIds with the same options', async () => { | ||
| controller.setIntervalLength(TICK_TIME); |
Contributor
There was a problem hiding this comment.
pretty minor but was this always extraneous?
Member
Author
There was a problem hiding this comment.
yeah, this is set in the beforeEach already
adonesky1
reviewed
May 1, 2024
Comment on lines
+277
to
+288
| it('should stop polling session after current iteration if stop is requested while current iteration is still executing', async () => { | ||
| const pollingToken = controller.startPollingByNetworkClientId('mainnet'); | ||
| await advanceTime({ clock, duration: 0 }); | ||
| expect(controller._executePoll).toHaveBeenCalledTimes(1); | ||
| controller.stopPollingByPollingToken(pollingToken); | ||
| controller.executePollPromises[0].resolve(); | ||
| await advanceTime({ clock, duration: TICK_TIME }); | ||
| expect(controller._executePoll).toHaveBeenCalledTimes(1); | ||
| await advanceTime({ clock, duration: TICK_TIME }); | ||
| expect(controller._executePoll).toHaveBeenCalledTimes(1); | ||
| controller.stopAllPolling(); | ||
| }); |
Contributor
There was a problem hiding this comment.
Not blocking but should we do a version of this test where we have multiple polling keys running?
Member
Author
There was a problem hiding this comment.
not sure if necessary since we have other tests that specifically test that stopping polling for one key does not stop polling for other keys
Contributor
There was a problem hiding this comment.
Fair yeah I guess I'm wondering about a test like starting polling sessions for a few keys and then calling stopAllPolling before execution resolves for both.
adonesky1
previously approved these changes
May 1, 2024
Contributor
adonesky1
left a comment
adonesky1
left a comment
There was a problem hiding this comment.
LGTM! Just one non-blocking request for an additional test
…imeout' into jl/fix-static-interval-polling-timeout
matthewwalsh0
approved these changes
May 7, 2024
7 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Currently, there is a bug in the StaticIntervalPollingController that causes polling to not be properly stopped if a stop is requested while
_executePollhas not yet resolved for the current loop. This PR adds a guard to check if the id returned by setTimeout still matches what is in state, indicating that polling is still active.References
Changelog
@metamask/polling-controllerStaticIntervalPollingControllerOnly,StaticIntervalPollingController, andStaticIntervalPollingControllerV1now properly stops polling when a stop is requested while_executePollhas not yet resolved for the current loopChecklist