Skip to content
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

fix: remove overzealous reactive_declaration_non_reactive_property warning #14663

Merged
merged 1 commit into from
Dec 11, 2024

Conversation

dummdidumm
Copy link
Member

fixes #14532

This removes the reactive_declaration_non_reactive_property warning altogether. The first version caused many false positives at compile time. The refined runtime version (introduced in #14192) was hoped to fix this, but it turns out we now get loads of false positives at runtime. The ones I've seen essentially revolve around a signal being created while reading or writing (to) something in a reactive statement, but in a matter which is harmless.

For example writing to $$props or $$restProps (like $: { if ($$restProps.foo) $$restProps.bar = 'x' }) creates a new signal under the hood, as the props now temporarily can get out of sync, and we need a backing signal for that. For this we call the prop function, which in turn creates several deriveds and may also read from user-land signals that were not read previously - in other words, it's not possible to fix the problem by marking all internal signals (which would be a very very tedious undertaking).

The potential benefits of this warning are vastly outnumbered by the false positives it causes, so we should just remove it.

Before submitting the PR, please make sure you do the following

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

…warning

fixes #14532

This removes the `reactive_declaration_non_reactive_property` warning altogether. The first version caused many false positives at compile time. The refined runtime version (introduced in #14192) was hoped to fix this, but it turns out we now get loads of false positives at runtime. The ones I've seen essentially revolve around a signal being created while reading or writing (to) something in a reactive statement, but in a matter which is harmless.

For example writing to `$$props` or `$$restProps` (like `$: { if ($$restProps.foo) $$restProps.bar = 'x' }`) creates a new signal under the hood, as the props now temporarily can get out of sync, and we need a backing signal for that. For this we call the `prop` function, which in turn creates several deriveds and may also read from user-land signals that were not read previously - in other words, it's not possible to fix the problem by marking all internal signals (which would be a very very tedious undertaking).

The potential benefits of this warning are vastly outnumbered by the false positives it causes, so we should just remove it.
Copy link

changeset-bot bot commented Dec 10, 2024

🦋 Changeset detected

Latest commit: 196c68a

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

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@14663

@dummdidumm dummdidumm marked this pull request as ready for review December 10, 2024 22:37
@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14663-svelte.vercel.app/

this is an automated message

@regexident
Copy link

regexident commented Dec 11, 2024

🙏 🙇

This warning has been the source of a massive performance regression for Layerchart's <ForceSimulation> component, spawning hundreds of warnings per second (all of which seem to be false positives afaict), dropping frame rates down to mere 2-5fps, rendering it effectively unusable and a definite road-blocker.

Copy link
Contributor

@trueadm trueadm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100% agreed, it's driving people up the wall.

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.

From svelte@5.5.2 a lot of reactive_declaration_non_reactive_property warnings
4 participants