fix: useTracker should only render once on mount (closes #439)#482
Open
nicolv wants to merge 2 commits into
Open
fix: useTracker should only render once on mount (closes #439)#482nicolv wants to merge 2 commits into
nicolv wants to merge 2 commits into
Conversation
Collaborator
|
Looks elegant using new hooks. I'll try to find some time to test this out. |
There was a problem hiding this comment.
Pull request overview
This PR aims to prevent extra initial renders (especially under React 18 StrictMode) by stabilizing the Tracker computation lifecycle in useTracker, introducing a shared useSyncEffect helper and simplifying the no-deps path.
Changes:
- Added a new
useSyncEffecthook to run an effect during render while deferring cleanup. - Refactored
useTrackerWithDepsto useuseSyncEffectfor creating/stopping the Tracker computation. - Simplified
useTrackerNoDepsto delegate touseTrackerWithDeps.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/react-meteor-data/useTracker.ts | Refactors Tracker computation lifecycle to use useSyncEffect, and simplifies the no-deps path. |
| packages/react-meteor-data/useSyncEffect.ts | Introduces a render-phase effect helper with deferred cleanup intended to mitigate StrictMode behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+81
to
+83
| const useTrackerNoDeps = <T = any>(reactiveFn: IReactiveFn<T>, skipUpdate: ISkipUpdate<T> = null) => ( | ||
| useTrackerWithDeps(reactiveFn, undefined, skipUpdate) | ||
| ) |
| @@ -2,6 +2,7 @@ declare var Package: any | |||
| import { Meteor } from 'meteor/meteor'; | |||
| import { Tracker } from 'meteor/tracker'; | |||
| import { useReducer, useEffect, useRef, useMemo, DependencyList } from 'react'; | |||
Comment on lines
+9
to
+22
| const useSyncEffect = (effect: () => any, deps: DependencyList) => { | ||
| const [cleanup, timeoutId] = useMemo( | ||
| () => { | ||
| const cleanup = effect(); | ||
| const timeoutId = setTimeout(cleanup, 1000); | ||
| return [cleanup, timeoutId]; | ||
| }, | ||
| deps | ||
| ); | ||
|
|
||
| useEffect(() => { | ||
| clearTimeout(timeoutId); | ||
| return cleanup; | ||
| }, [cleanup, timeoutId]); |
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
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.
Summary
Closes #439 -
useTrackerrenders two times at mountProblem
The previous implementation of
useTrackerNoDepswould:Solution
Added
useSyncEffecthook - A custom hook that runs effects synchronously during render but defers cleanup by 1 second to avoid StrictMode double-rendering issuesSimplified
useTrackerNoDeps- Now delegates touseTrackerWithDepsinstead of having its own complex render-phase logicUpdated
useTrackerWithDeps- UsesuseSyncEffectto manage the Tracker computation lifecycle, avoiding the stop/recreate on every renderChanges
packages/react-meteor-data/useSyncEffect.ts- New file: theuseSyncEffecthookpackages/react-meteor-data/useTracker.ts- Simplified to useuseSyncEffectKey Technical Points
Meteor.defer()and render-phase computation creation, which caused issues with StrictModeuseSyncEffectruns the effect inuseMemo(during render) but delays cleanup by 1 second, avoiding StrictMode double-render issuesTesting
The existing
noDepsTestertest inuseTracker.tests.jsalready covers StrictMode behavior.Related to #439