Skip to content

fix(react): guard against circular prevCache refs in useAtomSelector #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bowheart merged 1 commit into from
Feb 5, 2025
Merged

fix(react): guard against circular prevCache refs in useAtomSelector #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions packages/react/src/hooks/useAtomInstance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,17 @@ export const useAtomInstance: {
if (edge) {
let prevEdge = edge.prevEdge?.deref()

edge.isMaterialized = true

// clear out any junk edges added by StrictMode
while (prevEdge && !prevEdge.isMaterialized) {
ecosystem._graph.removeEdge(prevEdge.dependentKey!, instance.id)

// mark in case of circular references (shouldn't happen, but just for
// consistency with the prevCache algorithm)
prevEdge.isMaterialized = true
prevEdge = prevEdge.prevEdge?.deref()
}

edge.isMaterialized = true
}

// Try adding the edge again (will be a no-op unless React's StrictMode ran
Expand Down
18 changes: 13 additions & 5 deletions packages/react/src/hooks/useAtomSelector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export const useAtomSelector = <T, Args extends any[]>(
cache._lastEdge = new WeakRef(edge)
}

if (selectors._lastCache && selectors._lastCache.deref() !== cache) {
if (selectors._lastCache) {
cache._prevCache = selectors._lastCache
}

Expand All @@ -115,25 +115,33 @@ export const useAtomSelector = <T, Args extends any[]>(
if (edge) {
let prevEdge = edge.prevEdge?.deref()

edge.isMaterialized = true

// clear out any junk edges added by StrictMode
while (prevEdge && !prevEdge.isMaterialized) {
ecosystem._graph.removeEdge(prevEdge.dependentKey!, cache.id)

// mark in case of circular references (shouldn't happen, but just for
// consistency with the prevCache algorithm)
prevEdge.isMaterialized = true
prevEdge = prevEdge.prevEdge?.deref()
}

edge.isMaterialized = true
}

let prevCache = cache._prevCache?.deref()

cache.isMaterialized = true

// clear out any junk caches created by StrictMode
while (prevCache && !prevCache.isMaterialized) {
selectors.destroyCache(prevCache, [], true)

// mark in case of circular references (can happen in certain React
// rendering sequences)
prevCache.isMaterialized = true
prevCache = prevCache._prevCache?.deref()
}

cache.isMaterialized = true

// Try adding the edge again (will be a no-op unless React's StrictMode ran
// this effect's cleanup unnecessarily)
addEdge()
Expand Down