release(runway): cherry-pick fix: cp-13.12.0 Resolve race condition in useMultiPolling effect cleanup
#38411
+6
−9
Conversation
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
…n `useMultiPolling` effect cleanup (#38405) <!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** <!-- Write a short description of the changes included in this pull request, also include relevant motivation and context. Have in mind the following questions: 1. What is the reason for the change? 2. What is the improvement/solution? --> Reverts the following change made to `useMultiPolling` hook in f167e26 (#37480), where a cleanup function that should only run on unmount was moved into an effect with dependencies. ```diff diff --git a/ui/hooks/useMultiPolling.ts b/ui/hooks/useMultiPolling.ts index c28967e..ce61598753 100644 --- a/ui/hooks/useMultiPolling.ts +++ b/ui/hooks/useMultiPolling.ts @@ -44,10 +44,7 @@ const useMultiPolling = <PollingInput>( pollingTokens.current.delete(inputKey); } } - }, [ - completedOnboarding, - usePollingOptions.input && JSON.stringify(usePollingOptions.input), - ]); + } // stop all polling on dismount useEffect(() => { @@ -56,7 +53,10 @@ const useMultiPolling = <PollingInput>( usePollingOptions.stopPollingByPollingToken(token); } }; - }, []); + }, [[ + completedOnboarding, + usePollingOptions.input && JSON.stringify(usePollingOptions.input), + ]]); }; export default useMultiPolling; ``` This change causes cleanup to run on every dependency change as well as on unmount, triggering the following race conditions: 1. Premature token cleanup When inputs change, cleanup stops all tokens before the effect body runs. This could stop tokens for inputs that didn't change, causing unnecessary stop/restarts. 2. Stale tokens Dependency changes can potentially trigger cleanup while `startPolling().then()` calls are still pending. This could cause pending `.then()` to store stale tokens that were already cleaned up. This commit resolves these issues by moving the cleanup function back into an effect with an empty dependency array so that it only runs on unmount. The following behavior is restored: - Only polling calls for removed inputs are stopped on cleanup. - Pending starts are not interrupted by cleanup during the hook lifecycle. Note that `usePolling` has its cleanup run on dependency changes, because it's only managing a single poll at a time. Moving `usePolling` cleanup to unmount-only would cause multiple simultaneous polls and orphaned tokens. [](https://codespaces.new/MetaMask/metamask-extension/pull/38405?quickstart=1) ## **Changelog** <!-- If this PR is not End-User-Facing and should not show up in the CHANGELOG, you can choose to either: 1. Write `CHANGELOG entry: null` 2. Label with `no-changelog` If this PR is End-User-Facing, please write a short User-Facing description in the past tense like: `CHANGELOG entry: Added a new tab for users to see their NFTs` `CHANGELOG entry: Fixed a bug that was causing some NFTs to flicker` (This helps the Release Engineer do their job more quickly and accurately) --> CHANGELOG entry: null ## **Related issues** - Fixes issue introduced by: #37480 - Followed by: #38339 ## **Manual testing steps** 1. Go to this page... 2. 3. ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** <!-- [screenshots/recordings] --> ### **After** <!-- [screenshots/recordings] --> ## **Pre-merge author checklist** - [ ] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [ ] I've completed the PR template to the best of my ability - [ ] I’ve included tests if applicable - [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [ ] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **Pre-merge reviewer checklist** - [ ] I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed). - [ ] I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots. <!-- CURSOR_SUMMARY --> --- > [!NOTE] > Moves polling cleanup to an unmount-only effect, ensuring all tokens are stopped on dismount and removing cleanup from the dependency-based effect. > > - **Hooks/Lifecycle (useMultiPolling)**: > - Add unmount-only cleanup: stop all polling tokens and reset `prevPollingInputStringified`; manage `isMounted` flags. > - Remove cleanup from dependency-driven effect; early-return becomes a simple no-op. > - **Polling management**: > - Maintain logic to start polls for new inputs and stop polls for removed inputs, guarding token storage with `isMounted`. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 0928d40. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY -->
Contributor
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
Collaborator
Builds ready [129fa16]
UI Startup Metrics (1247 ± 97 ms)
📊 Page Load Benchmark ResultsCurrent Commit: 📄 Localhost MetaMask Test DappSamples: 100 Summary
📈 Detailed Results
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
](https://codespaces.new/MetaMask/metamask-extension/pull/38405?quickstart=1){kind=link}
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.
useMultiPollingeffect cleanup (fix: cp-13.12.0 Resolve race condition inuseMultiPollingeffect cleanup #38405)Description
Reverts the following change made to
useMultiPollinghook inf167e26
(#37480), where a
cleanup function that should only run on unmount was moved into an
effect with dependencies.
This change causes cleanup to run on every dependency change as well as
on unmount, triggering the following race conditions:
Premature token cleanup
When inputs change, cleanup stops all tokens before the effect body
runs. This could stop tokens for inputs that didn't change, causing
unnecessary stop/restarts.
Stale tokens
Dependency changes can potentially trigger cleanup while
startPolling().then()calls are still pending. This could causepending
.then()to store stale tokens that were already cleaned up.This commit resolves these issues by moving the cleanup function back
into an effect with an empty dependency array so that it only runs on
unmount.
The following behavior is restored:
lifecycle.
Note that
usePollinghas its cleanup run on dependency changes,because it's only managing a single poll at a time. Moving
usePollingcleanup to unmount-only would cause multiple simultaneous polls and
orphaned tokens.
Changelog
CHANGELOG entry: null
Related issues
build: Enable React Compiler for Browserify builds, fix
react-compiler/react-compilerESLint rule violations #37480use{,Multi}Pollingby addinguseSyncEqualityCheck#38339Manual testing steps
Screenshots/Recordings
Before
After
Pre-merge author checklist
Docs and MetaMask
Extension Coding
Standards.
if applicable
guidelines).
Not required for external contributors.
Pre-merge reviewer checklist
app, test code being changed).
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.
Note
Moves polling cleanup to an unmount-only effect and removes dependency-based cleanup to avoid premature/stale token issues.
ui/hooks/useMultiPolling.ts:[]deps) and resetprevPollingInputStringified/isMountedon unmount.Written by Cursor Bugbot for commit 129fa16. This will update automatically on new commits. Configure here.
5957159