fix(signals): remove signalMethod instance watcher on destroy
#4648
Conversation
This file contains 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
Each `signalMethod` instance uses a watcher assigned to it. The watcher is destroyed when the `signalMethod` itself gets destroyed. However, watchers were removed prematurely due to `onDestroy` behavior in `effect`. • `onDestroy` doesn’t run when an effect is destroyed but after each execution. • This caused watchers to be removed after the first execution unexpectedly. Problematic Code: `watchers.splice(watchers.indexOf(watcher), 1);` The removal mistakenly affected other watchers, keeping instances running, even after the signalMethod was destroyed. Co-authored-by: @davdev82
✅ Deploy Preview for ngrx-io canceled.Built without sensitive environment variables
|
3 tasks
davdev82
reviewed
Jan 2, 2025
timdeschryver
approved these changes
Jan 7, 2025
markostanimirovic
approved these changes
Jan 8, 2025
markostanimirovic
changed the title
onDestroy removing watchers prematurelysignalMethod instance watcher on destroy
|
For the record. The not-working |
rainerhahnekamp
added a commit
to rainerhahnekamp/ngrx
that referenced
this pull request
Jan 20, 2025
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.
Each
signalMethodinstance uses a watcher assigned to it. The watcher is destroyed when thesignalMethoditself gets destroyed. However, watchers were removed prematurely due toonDestroybehavior ineffect. •onDestroydoesn’t run when an effect is destroyed but after each execution. • This caused watchers to be removed after the first execution unexpectedly.Problematic Code:
watchers.splice(watchers.indexOf(watcher), 1);The removal mistakenly affected other watchers, keeping instances running, even after the signalMethod was destroyed.
Co-authored-by: @davdev82
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
effects are not destroyed.
Closes #4644
Does this PR introduce a breaking change?