fix(reactive/concurrency): give composables a disposal path - #193
Merged
Conversation
Three composables created long-lived reactive primitives that leaked when not created inside an active effectScope: - deferred() created an internal effect (plus its scheduled timer) and returned only readonly(mirror), with no disposer. It now returns a handle with a dispose() that stops the effect (cancelling any pending timer) and disposes the mirror. - persistedSignal() ran its persistence effect in the ambient scope, so scope.stop() silently stopped persistence while the signal kept living, and there was no way to stop it otherwise. Persistence now runs in a detached scope tied to the signal's own dispose(): stopping an ambient scope no longer affects it, and disposing the signal stops persistence. - effectScope() gained an optional parameter (Vue-style) so a scope's lifetime can be made independent of any enclosing scope. Fixes #173 Co-Authored-By: Claude Fable 5 <[email protected]>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
reactive
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
1 participant
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
Fixes #173 (Medium; memory leaks).
Three composables created long-lived reactive primitives with no disposal path, leaking whenever created outside an active
effectScope.Fixes
deferred()— created an internaleffect(and its scheduled timer/idle callback) but returned onlyreadonly(mirror), no disposer. Now returnsReadonlySignalHandle<T> & { dispose() };dispose()stops the effect (its cleanup cancels any pending timer) and disposes the mirror. Scope-managed behavior when inside a scope is unchanged.persistedSignal()— the persistenceeffectauto-registered with the ambient scope, soscope.stop()silently stopped persistence while the returned signal kept living, and there was no other way to stop it. Persistence now runs in a detached scope tied to the signal's owndispose(): an ambientscope.stop()no longer affects it, andsignal.dispose()stops persistence.effectScope(detached?)— new optional param (mirrors Vue'seffectScope(true)): whentruethe scope isn't auto-collected by an enclosing scope. Additive, backward-compatible.(The third sub-point in the issue — module-scope
computed()retention — is a documented must-dispose contract;computedalready exposesdispose(). This PR addresses the two composables that had no disposal path at all.)Verification
deferred: new test asserts source changes stop flowing afterdispose().persistedSignal: new tests assert persistence survives an ambientscope.stop()and stops aftersignal.dispose(). Both new persist tests + the deferred test fail on the pre-fix code.tsc --noEmit+ eslint clean.🤖 Generated with Claude Code