fix: internal listeners infinite retry loop by mikesposito · Pull Request #284 · MetaMask/eth-block-tracker

mikesposito · 2024-11-13T13:15:23Z

Our block tracker implementation relies on the presence of listeners to establish whether the polling should be continued or stopped.

However, an internal listener is being added in the getLatestBlock method, which will count as the other external listeners and will prevent the instance from stopping fetching new blocks. This creates an infinite loop in case the network is unreachable, because of the retry mechanism.

This PR aims to fix this behavior by keeping track of internal listeners' references in order to exclude them from the listener's count

Fixes #163

mikesposito · 2024-11-13T13:22:19Z

It would be good to cover this with tests

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

This reverts commit eb5514d.

* Suggestion to simplify prevention of dangling Promise on destroy The `fix/internal-listeners` branch has a number of changes intended to ensure we don't have a dangling unresolved Promise when the block tracker is destroyed. This solution involved adding an additional listener to capture errors, and it involved not removing internal listeners when `destroy` is called. This required changes to some logging in `_updateAndQueue` as well. This commit is an alternative solution that avoids the use of internal listeners, thus avoiding much of the complexity in the previous solution. Instead an internal deferred Promise is used. This also might be slightly more efficient when `getLatestBlock` is called repeatedly, as we can reuse the same listener rather than creating a new one each time. * Unset pending latest block after it has resolved

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

mikesposito · 2024-12-02T10:24:50Z

        this._newPotentialLatest(blockNumber);
      } catch (e) {
        this.emit('error', e);
+        this.#rejectPendingLatestBlock(e);


If the request fails at this point, the pending promise must be rejected as there will be no retry

mikesposito · 2024-12-02T10:24:56Z

        this._subscriptionId = null;
      } catch (e) {
        this.emit('error', e);
+        this.#rejectPendingLatestBlock(e);


If the request fails at this point, the pending promise must be rejected as there will be no retry

mcmire

Aside from the tests which we've been discussing, this looks good!

Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>

mcmire

LGTM.

## Explanation This PR bumps `@metamask/eth-block-tracker` to `^11.0.3` across core packages. The only change that is being pulled is: ``` - Avoid risk of infinite retry loops when fetching new blocks ([#284](MetaMask/eth-block-tracker#284)) - When the provider returns an error and `PollingBlockTracker` or `SubscribeBlockTracker` is destroyed, the promise returned by the `getLatestBlock` method will be rejected. ``` Related to: MetaMask/metamask-extension#17040 ## References  ## Changelog  ### `@metamask/network-controller` - **CHANGED**: Bump `@metamask/eth-block-tracker` from `^11.0.2` to `^11.0.3` ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate - [ ] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

fix: internal listeners infinite retry loop

db4725b

mikesposito requested a review from a team as a code owner November 13, 2024 13:15

edit CHANGELOG

4fbcd76

mikesposito added the team-wallet-framework label Nov 13, 2024

mikesposito mentioned this pull request Nov 13, 2024

[Bug]: MM is sending RPC requests to another custom network, aside from the one that's currently selected MetaMask/metamask-extension#17040

Closed

mikesposito commented Nov 13, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

refactor: rename to #internalEventListeners

ec76fae

Gudahtt reviewed Nov 13, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts

mikesposito and others added 3 commits November 13, 2024 16:43

refactor: simplify listener equality check

eb5514d

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

Revert "refactor: simplify listener equality check"

a6c6e3c

This reverts commit eb5514d.

apply fix to SubscribeBlockTracker

b724fc9

mikesposito commented Nov 20, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

fix: reject getLatestBlock promise when block tracker stops

3f39061

mikesposito requested a review from Gudahtt November 20, 2024 14:23

mikesposito commented Nov 20, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

fix: remove on error internal listener

16f88ff

mikesposito commented Nov 20, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

mikesposito commented Nov 20, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

mikesposito commented Nov 20, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

Gudahtt reviewed Nov 20, 2024

View reviewed changes

Comment thread CHANGELOG.md Outdated

mcmire reviewed Nov 21, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

Comment thread src/PollingBlockTracker.ts Outdated

Comment thread src/PollingBlockTracker.ts Outdated

Comment thread src/PollingBlockTracker.ts Outdated

Comment thread src/PollingBlockTracker.test.ts Outdated

mikesposito commented Nov 26, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.ts Outdated

mikesposito and others added 6 commits November 26, 2024 16:31

fix: operand of a delete operator cannot be a private identifier

e89e058

test: change error message

cbcb2c6

refactor: add helper methods

a568006

refactor: simplify SubscribeBlockTracker

416f51a

Update CHANGELOG.md

c9e2df2

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

fix: SubscribeBlockTracker throws when subscription fails

f88b53d

mikesposito added 2 commits December 2, 2024 11:13

test: remove broken case

b3f10ec

test: add case for returning the same promise

adde387

mikesposito commented Dec 2, 2024

View reviewed changes

mikesposito added 2 commits December 2, 2024 14:05

test: add coverage for PollingBlockTracker

532ee3d

test: add coverage for SubscribeBlockTracker

1de9112

mcmire reviewed Dec 3, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.test.ts Outdated

Comment thread src/SubscribeBlockTracker.test.ts Outdated

mikesposito and others added 5 commits December 3, 2024 15:19

test: remove redundant tests

eaba6e8

test: check promises return for SubscribeBlockTracker

b9da4b8

rename test case

33db227

Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>

test: spy on provider.request

efceaf7

edit changelog entry

bc6e7d6

mikesposito commented Dec 3, 2024

View reviewed changes

Comment thread src/PollingBlockTracker.test.ts Outdated

test: set automatic timer calls to 2

821bae5

mcmire approved these changes Dec 3, 2024

View reviewed changes

mikesposito merged commit b41e033 into main Dec 3, 2024

mikesposito deleted the fix/internal-listeners branch December 3, 2024 18:26

Gudahtt mentioned this pull request Jan 14, 2025

PollingBlockTracker runs endlessly when started by an internal event #301

Closed

Uh oh!

Conversation

mikesposito commented Nov 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mikesposito commented Nov 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mikesposito Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

mikesposito Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mikesposito commented Nov 13, 2024 •

edited

Loading