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: invoke $state.link callback at the correct time #12938

Closed
wants to merge 2 commits into from
Closed
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/proud-dots-swim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

fix: invoke `$state.link` callback at the correct time
44 changes: 12 additions & 32 deletions packages/svelte/src/internal/client/reactivity/sources.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import {
} from '../constants.js';
import * as e from '../errors.js';
import { derived } from './deriveds.js';
import { render_effect } from './effects.js';

let inspect_effects = new Set();

Expand All @@ -53,44 +54,23 @@ export function source(v) {
* @returns {(value?: V) => V}
*/
export function source_link(get_value, callback) {
var was_local = false;
var init = false;
var local_source = source(/** @type {V} */ (undefined));
var s = source(/** @type {V} */ (undefined));
var ran = false;

var linked_derived = derived(() => {
var local_value = /** @type {V} */ (get(local_source));
var linked_value = get_value();
callback ??= (value) => set(s, value);

if (was_local) {
was_local = false;
return local_value;
}

return linked_value;
});

return function (/** @type {any} */ value) {
if (arguments.length > 0) {
was_local = true;
set(local_source, value);
get(linked_derived);
return value;
}

var linked_value = get(linked_derived);

if (init) {
if (callback !== undefined) {
untrack(() => callback(linked_value));
return local_source.v;
}
render_effect(() => {
if (ran) {
callback(get_value());
Copy link
Member

Choose a reason for hiding this comment

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

This will only invoke the callback the first time around rather then whenever the linked value changes right?

Copy link
Member Author

Choose a reason for hiding this comment

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

No? It will run whenever get_value() changes

Copy link
Member

Choose a reason for hiding this comment

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

Duh, mobile phone wrap around made me dirty...sprry

} else {
init = true;
s.v = get_value();
}
});

local_source.v = linked_value;
ran = true;

return linked_value;
return function (/** @type {any} */ value) {
return arguments.length === 1 ? set(s, /** @type {V} */ (value)) : get(s);
};
}

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

export default test({
html: `<button>0</button><button>0</button><button>false</button>`,

test({ assert, target }) {
const [btn1, btn2, btn3] = target.querySelectorAll('button');

flushSync(() => btn1.click());
assert.htmlEqual(
target.innerHTML,
`<button>1</button><button>1</button><button>false</button>`
);

flushSync(() => btn2.click());
assert.htmlEqual(
target.innerHTML,
`<button>1</button><button>2</button><button>false</button>`
);

flushSync(() => btn3.click());
assert.htmlEqual(target.innerHTML, `<button>1</button><button>2</button><button>true</button>`);

flushSync(() => btn1.click());
assert.htmlEqual(target.innerHTML, `<button>2</button><button>2</button><button>true</button>`);

flushSync(() => btn1.click());
assert.htmlEqual(target.innerHTML, `<button>3</button><button>2</button><button>true</button>`);

flushSync(() => btn1.click());
flushSync(() => btn3.click());
assert.htmlEqual(
target.innerHTML,
`<button>4</button><button>4</button><button>false</button>`
);
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<script>
let a = $state(0);
let b = $state.link(a, (value) => {
if (c) return;
b = value;
});
let c = $state(false);
</script>

<button onclick={() => a++}>{a}</button>
<button onclick={() => b++}>{b}</button>
<button onclick={() => c = !c}>{c}</button>
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,21 @@ import { flushSync } from 'svelte';
import { test } from '../../test';

export default test({
html: `<button>0</button><button>0</button><button>false</button>`,
html: `<button>0</button><button>0</button>`,

test({ assert, target }) {
const [btn1, btn2, btn3] = target.querySelectorAll('button');
test({ assert, target, logs }) {
const [btn1, btn2] = target.querySelectorAll('button');

flushSync(() => btn1.click());
assert.htmlEqual(
target.innerHTML,
`<button>1</button><button>1</button><button>false</button>`
);
assert.deepEqual(logs, ['in callback 1']);
assert.htmlEqual(target.innerHTML, `<button>1</button><button>1</button>`);

flushSync(() => btn2.click());
assert.htmlEqual(
target.innerHTML,
`<button>1</button><button>2</button><button>false</button>`
);

flushSync(() => btn3.click());
assert.htmlEqual(target.innerHTML, `<button>1</button><button>2</button><button>true</button>`);

flushSync(() => btn1.click());
assert.htmlEqual(target.innerHTML, `<button>2</button><button>2</button><button>true</button>`);

flushSync(() => btn1.click());
assert.htmlEqual(target.innerHTML, `<button>3</button><button>2</button><button>true</button>`);
assert.deepEqual(logs, ['in callback 1']);
assert.htmlEqual(target.innerHTML, `<button>1</button><button>2</button>`);

flushSync(() => btn1.click());
flushSync(() => btn3.click());
assert.htmlEqual(
target.innerHTML,
`<button>4</button><button>4</button><button>false</button>`
);
assert.deepEqual(logs, ['in callback 1', 'in callback 2']);
assert.htmlEqual(target.innerHTML, `<button>2</button><button>2</button>`);
}
});
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
<script>
let a = $state(0);
let b = $state.link(a, (value) => {
if (c) return;
console.log(`in callback ${value}`);
b = value;
});
let c = $state(false);
</script>

<button onclick={() => a++}>{a}</button>
<button onclick={() => b++}>{b}</button>
<button onclick={() => c = !c}>{c}</button>
Loading