Skip to content

Prevent effect_update_depth_exceeded when using bind:value on a select with deriveds state in legacy components #16165

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/wild-queens-promise.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

Improve compiler output on legacy components to prevent infinite loops from <select> bind:value on $: derived variables
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,23 @@ function setup_select_synchronization(value_binding, context) {
bound = /** @type {Identifier | MemberExpression} */ (bound.object);
}

// Skip synchronisation if the bound identifier is *already* updated by a
// reactive statement (declared directly in `$:` or assigned inside one).
// In those cases the extra invalidate-helper would re-write its own
// source signal and create a circular update loop.
if (bound.type === 'Identifier') {
const binding = context.state.scope.get(bound.name);
if (binding) {
// 1) declared directly inside a `$:`
if (binding.kind === 'legacy_reactive') return;

// 2) declared elsewhere but *assigned* inside a `$:` block
for (const [, rs] of context.state.analysis.reactive_statements) {
if (rs.assignments.has(binding)) return;
}
}
}

/** @type {string[]} */
const names = [];

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { test } from '../../test';
import { tick } from 'svelte';

export default test({
html: `
<select>
<option value="1">1</option>
<option value="US">US</option>
<option value="FR">FR</option>
</select>
<button id="btn-us">US</button>
<button id="btn-reset">Reset</button>
<button id="btn-fr">FR</button>
`,

async test({ assert, component, window, logs }) {
// Primary assertion: No infinite loop error
assert.notInclude(logs, 'Infinite loop detected');

// Verify component state
const select = window.document.querySelector('select');
if (!select) {
assert.fail('Select element not found');
return;
}

// With default_details fallback nothing is selected
assert.equal(select.value, '');
assert.equal(select.disabled, false);

window.document.getElementById('btn-us')?.click();
await tick();
assert.equal(select.disabled, true);
assert.equal(select.value, 'US');

window.document.getElementById('btn-reset')?.click();
await tick();
assert.equal(select.value, '');
assert.equal(select.disabled, false);

window.document.getElementById('btn-fr')?.click();
await tick();
assert.equal(select.value, 'FR');
assert.equal(select.disabled, true);
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<script>
const default_details = { country: '' };

$: data = { locked: false, details: null };

let details;
$: {
details = guard_infinite_loop() ?? data.details ?? default_details;
}

// Guard: if this reactive block runs too often we assume an infinite loop
let guard_infinite_loop_counter = 0;
function guard_infinite_loop() {
guard_infinite_loop_counter++;
if (guard_infinite_loop_counter > 20) {
throw new Error('Infinite loop detected');
}
}

function setUS() {
data = { locked: true, details: { country: 'US' } };
}

function resetData() {
data = { locked: false, details: null };
}

function setFR() {
data = { locked: true, details: { country: 'FR' } };
}
</script>

<select bind:value={details.country} disabled={data.locked}>
<option value="1">1</option>
<option value="US">US</option>
<option value="FR">FR</option>
</select>

<button id="btn-us" on:click={setUS}>US</button>
<button id="btn-reset" on:click={resetData}>Reset</button>
<button id="btn-fr" on:click={setFR}>FR</button>
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { tick } from 'svelte';
import { test } from '../../test';

export default test({
html: `
<select>
<option value="1">1</option>
<option value="US">US</option>
<option value="FR">FR</option>
</select>
<button id="btn-us">US</button>
<button id="btn-reset">Reset</button>
<button id="btn-fr">FR</button>
`,

async test({ assert, component, window, logs }) {
// Primary assertion: No infinite loop error
assert.notInclude(logs, 'Infinite loop detected');

// Verify component state
const select = window.document.querySelector('select');
if (!select) {
assert.fail('Select element not found');
return;
}

// With default_details fallback nothing is selected
assert.equal(select.value, '');
assert.equal(select.disabled, false);

window.document.getElementById('btn-us')?.click();
await tick();
assert.equal(select.disabled, true);
assert.equal(select.value, 'US');

window.document.getElementById('btn-reset')?.click();
await tick();
assert.equal(select.value, '');
assert.equal(select.disabled, false);

window.document.getElementById('btn-fr')?.click();
await tick();
assert.equal(select.value, 'FR');
assert.equal(select.disabled, true);
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<script>
const default_details = { country: '' };

$: data = { locked: false, details: null };

$: details = guard_infinite_loop() ?? data.details ?? default_details;

// Guard: if this reactive block runs too often we assume an infinite loop
let guard_infinite_loop_counter = 0;
function guard_infinite_loop() {
guard_infinite_loop_counter++;
if (guard_infinite_loop_counter > 20) {
throw new Error('Infinite loop detected');
}
}

function setUS() {
data = { locked: true, details: { country: 'US' } };
}

function resetData() {
data = { locked: false, details: null };
}

function setFR() {
data = { locked: true, details: { country: 'FR' } };
}
</script>

<select bind:value={details.country} disabled={data.locked}>
<option value="1">1</option>
<option value="US">US</option>
<option value="FR">FR</option>
</select>

<button id="btn-us" on:click={setUS}>US</button>
<button id="btn-reset" on:click={resetData}>Reset</button>
<button id="btn-fr" on:click={setFR}>FR</button>