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

feat: turn reactive_declaration_non_reactive_property into a runtime warning #14192

Merged
merged 13 commits into from
Dec 3, 2024

Conversation

Rich-Harris
Copy link
Member

Alternative to #14111. Instead of a compiler warning, we can have a runtime warning for cases where 'invisible' reactive state is read inside a $: statement. The message could probably be improved and it might be nice to have a detailed example for the docs, but putting this up just as a suggestion for now

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.

Tests and linting

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

Sorry, something went wrong.

Copy link

changeset-bot bot commented Nov 6, 2024

🦋 Changeset detected

Latest commit: 2207b7d

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

@Rich-Harris
Copy link
Member Author

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

this is an automated message

Copy link
Contributor

github-actions bot commented Nov 6, 2024

Playground

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

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

As I commented on that other PR I think this approach makes more sense, so 👍

Rich-Harris and others added 5 commits November 6, 2024 16:34

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>
fix
@benmccann
Copy link
Member

I agree this approach makes sense

Rich-Harris and others added 6 commits November 20, 2024 15:09

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>
@Rich-Harris Rich-Harris merged commit a5de086 into main Dec 3, 2024
11 checks passed
@Rich-Harris Rich-Harris deleted the gh-14111-alternative branch December 3, 2024 18:45
@github-actions github-actions bot mentioned this pull request Dec 3, 2024
dummdidumm added a commit that referenced this pull request Dec 10, 2024
…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.
dummdidumm added a commit that referenced this pull request Dec 11, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
…warning (#14663)

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.
wackbyte added a commit to wackbyte/anki that referenced this pull request Jan 12, 2025

Verified

This commit was signed with the committer’s verified signature.
Warnings from enums were fixed in sveltejs/svelte#14192
wackbyte added a commit to wackbyte/anki that referenced this pull request Jan 12, 2025

Verified

This commit was signed with the committer’s verified signature.
Warnings from enums were fixed in sveltejs/svelte#14192
dae pushed a commit to ankitects/anki that referenced this pull request Jan 12, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Warnings from enums were fixed in sveltejs/svelte#14192
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants