-
Notifications
You must be signed in to change notification settings - Fork 27.4k
fix(core): prevent dangling prevConsumer reference from leaking destroyed views #68137
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.
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
Open
stewartmcgown
wants to merge
2
commits into
angular:main
Choose a base branch
from
stewartmcgown:fix/signal-prevConsumer-leak
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /** | ||
| * @license | ||
| * Copyright Google LLC All Rights Reserved. | ||
| * | ||
| * Use of this source code is governed by an MIT-style license that can be | ||
| * found in the LICENSE file at https://angular.dev/license | ||
| */ | ||
|
|
||
| import {computed, signal, WritableSignal} from '../../src/core'; | ||
| import {ReactiveNode, SIGNAL} from '../../primitives/signals'; | ||
| import {isBrowser, timeout} from '@angular/private/testing'; | ||
|
|
||
| import {flushEffects, resetEffects, testingEffect} from './effect_util'; | ||
|
|
||
| describe('signal graph: destroyed consumers should be GC-eligible', () => { | ||
| if (isBrowser) { | ||
| it('should pass', () => {}); | ||
| return; | ||
| } | ||
|
|
||
| afterEach(() => { | ||
| resetEffects(); | ||
| }); | ||
|
|
||
| function setupAndReturnRef(source: WritableSignal<number>): WeakRef<object> { | ||
| const destroyEffect = testingEffect(() => source()); | ||
| flushEffects(); | ||
|
|
||
| const sourceNode = source[SIGNAL] as ReactiveNode; | ||
| let watchNode; | ||
| let link = (sourceNode as any).consumers; | ||
| while (link !== undefined) { | ||
| watchNode = link.consumer; | ||
| link = link.nextConsumer; | ||
| } | ||
| const ref = new WeakRef(watchNode!); | ||
|
|
||
| // Non-live computed that also reads source. | ||
| const derived = computed(() => source() + 1); | ||
| derived(); | ||
|
|
||
| // Clearing the graph edges. | ||
| destroyEffect(); | ||
|
|
||
| return ref; | ||
| } | ||
|
|
||
| it('should GC a destroyed effect when a non-live computed reads the same producer', async () => { | ||
| const source = signal(0); | ||
| const ref = setupAndReturnRef(source); | ||
|
|
||
| (globalThis as any).gc(); | ||
| await timeout(); | ||
| (globalThis as any).gc(); | ||
|
|
||
| expect(ref.deref()).toBeUndefined(); | ||
| }); | ||
|
|
||
| it('should GC destroyed effects across repeated create/destroy cycles', async () => { | ||
| const source = signal(0); | ||
| const derived = computed(() => source() + 1); | ||
| derived(); | ||
|
|
||
| const refs: WeakRef<object>[] = []; | ||
| for (let i = 0; i < 5; i++) { | ||
| refs.push(setupAndReturnRef(source)); | ||
| } | ||
|
|
||
| (globalThis as any).gc(); | ||
| await timeout(); | ||
| (globalThis as any).gc(); | ||
|
|
||
| for (let i = 0; i < refs.length; i++) { | ||
| expect(refs[i].deref()).withContext(`cycle ${i}`).toBeUndefined(); | ||
| } | ||
| }); | ||
| }); | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the spirit of making this depend less on the datastructure of links, I wonder if it would make sense to use createWatch directly so we can avoid doing source[SIGNAL]?
(I'm a fan of this new GC direction, I think it's cleaner than before and this behavior of V8 should be reasonably dependable)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here is my proposed change: 2257e64