Skip to content

fix: ensure effects destroy owned deriveds upon teardown #13563

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

Merged
merged 6 commits into from
Oct 14, 2024

Conversation

trueadm
Copy link
Contributor

@trueadm trueadm commented Oct 10, 2024

Deriveds now cleanup accordingly when the effect that they were created in gets destroyed. This should resolve a memory leak with deriveds that created in branch/root effects – and thus were previously never cleaned up as these effects don't know of the deriveds in the first place. This essentially aims to solve this memory leak:

<!-- main.svelte -->
<script>
    import Foo from './Foo.svelte';

    let count = $state(0);
    let toggle = $state(0);
</script>

{#if toggle}
  {@const double = count * 2}
  <Foo double={double} />
{/if}

<button onclick={() => toggle = !toggle}>toggle</button>
<button onclick={() => count++}>increment</button>

<!-- Foo.svelte -->
<script>
    const { double } = $props();
    // read the prop, now it leaks when we toggle and hide this component
    double;
</script>

Above the double derived leaks, with this PR we now destroy that derived when the {if} block toggles. Previously, we didn't destroy it, meaning it was permanently retained forever – taking a lot of DOM and effects with it. This is because we read the double inside the component body of Foo.svelte which is a branch effect – not a tracking effect. The read causes a connection to be made with count and this connection is never disconnected upon the effects being destroyed as the effects have no knowledge of the derived.

Copy link

changeset-bot bot commented Oct 10, 2024

🦋 Changeset detected

Latest commit: cd632e5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@trueadm
Copy link
Contributor Author

trueadm commented Oct 14, 2024

Looking at the benchmarks, this doesn't seem to have any real impact on perf:

This branch:

Screenshot 2024-10-14 at 14 14 14

Main:

Screenshot 2024-10-14 at 14 15 45

@paoloricciuti
Copy link
Member

Mmm this could also in some way be related to #13586 ...could you take a look at that too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants