mirror of https://github.com/sveltejs/svelte
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
743 lines
16 KiB
743 lines
16 KiB
import { describe, assert, it } from 'vitest';
|
|
import { flushSync } from '../../src/index-client';
|
|
import * as $ from '../../src/internal/client/runtime';
|
|
import {
|
|
effect,
|
|
effect_root,
|
|
render_effect,
|
|
user_effect
|
|
} from '../../src/internal/client/reactivity/effects';
|
|
import { state, set } from '../../src/internal/client/reactivity/sources';
|
|
import type { Derived, Value } from '../../src/internal/client/types';
|
|
import { proxy } from '../../src/internal/client/proxy';
|
|
import { derived } from '../../src/internal/client/reactivity/deriveds';
|
|
import { snapshot } from '../../src/internal/shared/clone.js';
|
|
import { SvelteSet } from '../../src/reactivity/set';
|
|
|
|
/**
|
|
* @param runes runes mode
|
|
* @param fn A function that returns a function because we first need to setup all the signals
|
|
* and then execute the test in order to simulate a real component
|
|
*/
|
|
function run_test(runes: boolean, fn: (runes: boolean) => () => void) {
|
|
return () => {
|
|
// Create a component context to test runes vs legacy mode
|
|
$.push({}, runes);
|
|
// Create a render context so that effect validations etc don't fail
|
|
let execute: any;
|
|
const destroy = effect_root(() => {
|
|
execute = fn(runes);
|
|
});
|
|
$.pop();
|
|
execute();
|
|
destroy();
|
|
};
|
|
}
|
|
|
|
function test(text: string, fn: (runes: boolean) => any) {
|
|
it(`${text} (legacy mode)`, run_test(false, fn));
|
|
it(`${text} (runes mode)`, run_test(true, fn));
|
|
}
|
|
|
|
test.only = (text: string, fn: (runes: boolean) => any) => {
|
|
it.only(`${text} (legacy mode)`, run_test(false, fn));
|
|
it.only(`${text} (runes mode)`, run_test(true, fn));
|
|
};
|
|
|
|
test.skip = (text: string, fn: (runes: boolean) => any) => {
|
|
it.skip(`${text} (legacy mode)`, run_test(false, fn));
|
|
it.skip(`${text} (runes mode)`, run_test(true, fn));
|
|
};
|
|
|
|
describe('signals', () => {
|
|
test('effect with state and derived in it', () => {
|
|
const log: string[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
effect(() => {
|
|
log.push(`${$.get(count)}:${$.get(double)}`);
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
|
|
assert.deepEqual(log, ['0:0', '1:2', '2:4']);
|
|
};
|
|
});
|
|
|
|
test('multiple effects with state and derived in it#1', () => {
|
|
const log: string[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
|
|
effect(() => {
|
|
log.push(`A:${$.get(count)}:${$.get(double)}`);
|
|
});
|
|
effect(() => {
|
|
log.push(`B:${$.get(double)}`);
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
|
|
assert.deepEqual(log, ['A:0:0', 'B:0', 'A:1:2', 'B:2', 'A:2:4', 'B:4']);
|
|
};
|
|
});
|
|
|
|
test('multiple effects with state and derived in it#2', () => {
|
|
const log: string[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
|
|
effect(() => {
|
|
log.push(`A:${$.get(double)}`);
|
|
});
|
|
effect(() => {
|
|
log.push(`B:${$.get(count)}:${$.get(double)}`);
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
|
|
assert.deepEqual(log, ['A:0', 'B:0:0', 'A:2', 'B:1:2', 'A:4', 'B:2:4']);
|
|
};
|
|
});
|
|
|
|
test('derived from state', () => {
|
|
const log: number[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
|
|
effect(() => {
|
|
log.push($.get(double));
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
|
|
assert.deepEqual(log, [0, 2, 4]);
|
|
};
|
|
});
|
|
|
|
test('derived from derived', () => {
|
|
const log: number[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
let quadruple = derived(() => $.get(double) * 2);
|
|
|
|
effect(() => {
|
|
log.push($.get(quadruple));
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
|
|
assert.deepEqual(log, [0, 4, 8]);
|
|
};
|
|
});
|
|
|
|
test('state reset', () => {
|
|
const log: number[] = [];
|
|
|
|
let count = state(0);
|
|
let double = derived(() => $.get(count) * 2);
|
|
|
|
effect(() => {
|
|
log.push($.get(double));
|
|
});
|
|
|
|
return () => {
|
|
flushSync();
|
|
log.length = 0;
|
|
|
|
set(count, 1);
|
|
set(count, 0);
|
|
|
|
flushSync();
|
|
|
|
assert.deepEqual(log, []);
|
|
|
|
set(count, 1);
|
|
$.get(double);
|
|
set(count, 0);
|
|
|
|
flushSync();
|
|
|
|
// TODO: in an ideal world, the effect wouldn't fire here
|
|
assert.deepEqual(log, [0]);
|
|
};
|
|
});
|
|
|
|
test('https://perf.js.hyoo.ru/#!bench=9h2as6_u0mfnn', () => {
|
|
let res: number[] = [];
|
|
|
|
const numbers = Array.from({ length: 2 }, (_, i) => i);
|
|
const fib = (n: number): number => (n < 2 ? 1 : fib(n - 1) + fib(n - 2));
|
|
const hard = (n: number, l: string) => n + fib(16);
|
|
|
|
const A = state(0);
|
|
const B = state(0);
|
|
const C = derived(() => ($.get(A) % 2) + ($.get(B) % 2));
|
|
const D = derived(() => numbers.map((i) => i + ($.get(A) % 2) - ($.get(B) % 2)));
|
|
const E = derived(() => hard($.get(C) + $.get(A) + $.get(D)[0]!, 'E'));
|
|
const F = derived(() => hard($.get(D)[0]! && $.get(B), 'F'));
|
|
const G = derived(() => $.get(C) + ($.get(C) || $.get(E) % 2) + $.get(D)[0]! + $.get(F));
|
|
effect(() => {
|
|
res.push(hard($.get(G), 'H'));
|
|
});
|
|
effect(() => {
|
|
res.push($.get(G));
|
|
});
|
|
effect(() => {
|
|
res.push(hard($.get(F), 'J'));
|
|
});
|
|
|
|
return () => {
|
|
flushSync();
|
|
|
|
let i = 2;
|
|
while (--i) {
|
|
res.length = 0;
|
|
set(B, 1);
|
|
set(A, 1 + i * 2);
|
|
flushSync();
|
|
|
|
set(A, 2 + i * 2);
|
|
set(B, 2);
|
|
flushSync();
|
|
|
|
assert.equal(res.length, 4);
|
|
assert.deepEqual(res, [3198, 1601, 3195, 1598]);
|
|
}
|
|
};
|
|
});
|
|
|
|
test('effects correctly handle unowned derived values that do not change', () => {
|
|
const log: number[] = [];
|
|
|
|
let count = state(0);
|
|
const read = () => {
|
|
const x = derived(() => ({ count: $.get(count) }));
|
|
return $.get(x);
|
|
};
|
|
const derivedCount = derived(() => read().count);
|
|
user_effect(() => {
|
|
log.push($.get(derivedCount));
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
// Ensure we're not leaking consumers
|
|
assert.deepEqual(count.reactions?.length, 1);
|
|
flushSync(() => set(count, 2));
|
|
// Ensure we're not leaking consumers
|
|
assert.deepEqual(count.reactions?.length, 1);
|
|
flushSync(() => set(count, 3));
|
|
// Ensure we're not leaking consumers
|
|
assert.deepEqual(count.reactions?.length, 1);
|
|
assert.deepEqual(log, [0, 1, 2, 3]);
|
|
};
|
|
});
|
|
|
|
test('correctly cleanup unowned nested derived values', () => {
|
|
return () => {
|
|
const nested: Derived<string>[] = [];
|
|
|
|
const a = state(0);
|
|
const b = state(0);
|
|
const c = derived(() => {
|
|
const a_2 = derived(() => $.get(a) + '!');
|
|
const b_2 = derived(() => $.get(b) + '?');
|
|
nested.push(a_2, b_2);
|
|
|
|
return { a: $.get(a_2), b: $.get(b_2) };
|
|
});
|
|
|
|
$.get(c);
|
|
|
|
flushSync(() => set(a, 1));
|
|
|
|
$.get(c);
|
|
|
|
flushSync(() => set(b, 1));
|
|
|
|
$.get(c);
|
|
|
|
// Ensure we're not leaking dependencies
|
|
assert.deepEqual(
|
|
nested.slice(0, -2).map((s) => s.deps),
|
|
[null, null, null, null]
|
|
);
|
|
};
|
|
});
|
|
|
|
// outside of test function so that they are unowned signals
|
|
let count = state(0);
|
|
let calc = derived(() => {
|
|
if ($.get(count) >= 2) {
|
|
return 'limit';
|
|
}
|
|
return $.get(count) * 2;
|
|
});
|
|
|
|
test('effect with derived using unowned derived every time', () => {
|
|
const log: Array<number | string> = [];
|
|
|
|
const destroy = effect_root(() => {
|
|
user_effect(() => {
|
|
log.push($.get(calc));
|
|
});
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
flushSync(() => set(count, 3));
|
|
flushSync(() => set(count, 4));
|
|
flushSync(() => set(count, 0));
|
|
// Ensure we're not leaking consumers
|
|
assert.deepEqual(count.reactions?.length, 2);
|
|
assert.deepEqual(calc.reactions?.length, 1);
|
|
assert.deepEqual(log, [0, 2, 'limit', 0]);
|
|
destroy();
|
|
// Ensure we're not leaking consumers
|
|
assert.deepEqual(count.reactions, null);
|
|
assert.deepEqual(calc.reactions, null);
|
|
};
|
|
});
|
|
|
|
let no_deps = derived(() => {
|
|
return [];
|
|
});
|
|
|
|
test('two effects with an unowned derived that has no dependencies', () => {
|
|
const log: Array<Array<any>> = [];
|
|
|
|
render_effect(() => {
|
|
log.push($.get(no_deps));
|
|
});
|
|
|
|
render_effect(() => {
|
|
log.push($.get(no_deps));
|
|
});
|
|
|
|
return () => {
|
|
flushSync();
|
|
assert.deepEqual(log, [[], []]);
|
|
};
|
|
});
|
|
|
|
let some_state = state({});
|
|
let some_deps = derived(() => {
|
|
return [$.get(some_state)];
|
|
});
|
|
|
|
test('two effects with an unowned derived that has some dependencies', () => {
|
|
const log: Array<Array<any>> = [];
|
|
|
|
render_effect(() => {
|
|
log.push($.get(some_deps));
|
|
});
|
|
|
|
render_effect(() => {
|
|
log.push($.get(some_deps));
|
|
});
|
|
|
|
return () => {
|
|
flushSync();
|
|
assert.deepEqual(log, [[{}], [{}]]);
|
|
};
|
|
});
|
|
|
|
test('schedules rerun when writing to signal before reading it', (runes) => {
|
|
if (!runes) return () => {};
|
|
|
|
const value = state({ count: 0 });
|
|
user_effect(() => {
|
|
set(value, { count: 0 });
|
|
$.get(value);
|
|
});
|
|
|
|
return () => {
|
|
let errored = false;
|
|
try {
|
|
flushSync();
|
|
} catch (e: any) {
|
|
assert.include(e.message, 'effect_update_depth_exceeded');
|
|
errored = true;
|
|
}
|
|
assert.equal(errored, true);
|
|
};
|
|
});
|
|
|
|
test('schedules rerun when writing to signal before reading it', (runes) => {
|
|
if (!runes) return () => {};
|
|
|
|
const value = proxy({ arr: [] });
|
|
user_effect(() => {
|
|
value.arr = [];
|
|
value.arr;
|
|
});
|
|
|
|
return () => {
|
|
let errored = false;
|
|
try {
|
|
flushSync();
|
|
} catch (e: any) {
|
|
assert.include(e.message, 'effect_update_depth_exceeded');
|
|
errored = true;
|
|
}
|
|
assert.equal(errored, true);
|
|
};
|
|
});
|
|
|
|
test('effect teardown is removed on re-run', () => {
|
|
const count = state(0);
|
|
let first = true;
|
|
let teardown = 0;
|
|
|
|
user_effect(() => {
|
|
$.get(count);
|
|
if (first) {
|
|
first = false;
|
|
return () => {
|
|
teardown += 1;
|
|
};
|
|
}
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => set(count, 1));
|
|
flushSync(() => set(count, 2));
|
|
assert.equal(teardown, 1);
|
|
};
|
|
});
|
|
|
|
test('creating effects within a derived correctly handles ownership', () => {
|
|
const log: Array<number | string> = [];
|
|
let a: Value<unknown>;
|
|
let inner: Value<string | number>;
|
|
let outer: Value<string | number>;
|
|
|
|
const destroy = effect_root(() => {
|
|
inner = state(0);
|
|
outer = state(0);
|
|
|
|
render_effect(() => {
|
|
a = derived(() => {
|
|
log.push('outer', $.get(outer));
|
|
effect(() => {
|
|
log.push('inner', $.get(inner));
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
return () => {
|
|
flushSync(() => {
|
|
$.get(a);
|
|
});
|
|
assert.deepEqual(log, ['outer', 0, 'inner', 0]);
|
|
log.length = 0;
|
|
flushSync(() => {
|
|
set(inner, 1);
|
|
$.get(a);
|
|
});
|
|
assert.deepEqual(log, ['inner', 1]);
|
|
log.length = 0;
|
|
flushSync(() => {
|
|
set(outer, 1);
|
|
$.get(a);
|
|
});
|
|
assert.deepEqual(log, ['outer', 1, 'inner', 1]);
|
|
log.length = 0;
|
|
flushSync(() => {
|
|
set(inner, 2);
|
|
$.get(a);
|
|
});
|
|
assert.deepEqual(log, ['inner', 2]);
|
|
destroy();
|
|
};
|
|
});
|
|
|
|
test('owned deriveds correctly cleanup when no longer connected to graph', () => {
|
|
let a: Derived<unknown>;
|
|
let s = state(0);
|
|
|
|
const destroy = effect_root(() => {
|
|
render_effect(() => {
|
|
a = derived(() => {
|
|
$.get(s);
|
|
});
|
|
$.get(a);
|
|
});
|
|
});
|
|
|
|
return () => {
|
|
flushSync();
|
|
assert.equal(a?.deps?.length, 1);
|
|
assert.equal(s?.reactions?.length, 1);
|
|
destroy();
|
|
assert.equal(s?.reactions, null);
|
|
};
|
|
});
|
|
|
|
test('deriveds update upon reconnection #1', () => {
|
|
let a = state(false);
|
|
let b = state(false);
|
|
|
|
let c = derived(() => $.get(a));
|
|
let d = derived(() => $.get(c));
|
|
|
|
let last: Record<string, boolean | null> = {};
|
|
|
|
render_effect(() => {
|
|
last = {
|
|
a: $.get(a),
|
|
b: $.get(b),
|
|
c: $.get(c),
|
|
d: $.get(a) || $.get(b) ? $.get(d) : null
|
|
};
|
|
});
|
|
|
|
return () => {
|
|
assert.deepEqual(last, { a: false, b: false, c: false, d: null });
|
|
|
|
flushSync(() => set(a, true));
|
|
flushSync(() => set(b, true));
|
|
assert.deepEqual(last, { a: true, b: true, c: true, d: true });
|
|
|
|
flushSync(() => set(a, false));
|
|
flushSync(() => set(b, false));
|
|
assert.deepEqual(last, { a: false, b: false, c: false, d: null });
|
|
|
|
flushSync(() => set(a, true));
|
|
flushSync(() => set(b, true));
|
|
assert.deepEqual(last, { a: true, b: true, c: true, d: true });
|
|
|
|
flushSync(() => set(a, false));
|
|
flushSync(() => set(b, false));
|
|
assert.deepEqual(last, { a: false, b: false, c: false, d: null });
|
|
|
|
flushSync(() => set(b, true));
|
|
assert.deepEqual(last, { a: false, b: true, c: false, d: false });
|
|
};
|
|
});
|
|
|
|
test('deriveds update upon reconnection #2', () => {
|
|
let a = state(false);
|
|
let b = state(false);
|
|
let c = state(false);
|
|
|
|
let d = derived(() => $.get(a) || $.get(b));
|
|
|
|
let branch = '';
|
|
|
|
render_effect(() => {
|
|
if ($.get(c) && !$.get(d)) {
|
|
branch = 'if';
|
|
} else {
|
|
branch = 'else';
|
|
}
|
|
});
|
|
|
|
return () => {
|
|
assert.deepEqual(branch, 'else');
|
|
|
|
flushSync(() => set(c, true));
|
|
assert.deepEqual(branch, 'if');
|
|
|
|
flushSync(() => set(a, true));
|
|
assert.deepEqual(branch, 'else');
|
|
|
|
set(a, false);
|
|
set(b, false);
|
|
set(c, false);
|
|
flushSync();
|
|
assert.deepEqual(branch, 'else');
|
|
|
|
flushSync(() => set(c, true));
|
|
assert.deepEqual(branch, 'if');
|
|
|
|
flushSync(() => set(b, true));
|
|
assert.deepEqual(branch, 'else');
|
|
|
|
set(a, false);
|
|
set(b, false);
|
|
set(c, false);
|
|
flushSync();
|
|
assert.deepEqual(branch, 'else');
|
|
|
|
flushSync(() => set(c, true));
|
|
assert.deepEqual(branch, 'if');
|
|
};
|
|
});
|
|
|
|
test('deriveds update upon reconnection #3', () => {
|
|
let a = state(false);
|
|
let b = state(false);
|
|
|
|
let c = derived(() => $.get(a) || $.get(b));
|
|
let d = derived(() => $.get(c));
|
|
let e = derived(() => $.get(d));
|
|
|
|
return () => {
|
|
const log: string[] = [];
|
|
let destroy = effect_root(() => {
|
|
render_effect(() => {
|
|
$.get(e);
|
|
log.push('init');
|
|
});
|
|
});
|
|
destroy();
|
|
|
|
destroy = effect_root(() => {
|
|
render_effect(() => {
|
|
$.get(e);
|
|
log.push('update');
|
|
});
|
|
});
|
|
|
|
assert.deepEqual(log, ['init', 'update']);
|
|
|
|
set(a, true);
|
|
flushSync();
|
|
|
|
assert.deepEqual(log, ['init', 'update', 'update']);
|
|
};
|
|
});
|
|
|
|
test('unowned deriveds are not added as reactions', () => {
|
|
var count = state(0);
|
|
|
|
function create_derived() {
|
|
return derived(() => $.get(count) * 2);
|
|
}
|
|
|
|
return () => {
|
|
let d = create_derived();
|
|
assert.equal($.get(d), 0);
|
|
assert.equal(count.reactions, null);
|
|
assert.equal(d.deps?.length, 1);
|
|
|
|
set(count, 1);
|
|
assert.equal($.get(d), 2);
|
|
assert.equal(count.reactions, null);
|
|
assert.equal(d.deps?.length, 1);
|
|
|
|
d = create_derived();
|
|
assert.equal($.get(d), 2);
|
|
assert.equal(count.reactions, null);
|
|
assert.equal(d.deps?.length, 1);
|
|
};
|
|
});
|
|
|
|
test('unowned deriveds are correctly connected and disconnected from the graph', () => {
|
|
var count = state(0);
|
|
|
|
function create_derived() {
|
|
return derived(() => $.get(count) * 2);
|
|
}
|
|
|
|
return () => {
|
|
let d = create_derived();
|
|
|
|
const destroy = effect_root(() => {
|
|
render_effect(() => {
|
|
assert.equal($.get(d), 0);
|
|
});
|
|
});
|
|
|
|
assert.equal($.get(d), 0);
|
|
assert.equal(count.reactions?.length, 1);
|
|
assert.equal(d.deps?.length, 1);
|
|
|
|
set(count, 1);
|
|
assert.equal($.get(d), 2);
|
|
assert.equal(count.reactions?.length, 1);
|
|
assert.equal(d.deps?.length, 1);
|
|
|
|
destroy();
|
|
|
|
assert.equal(count.reactions, null);
|
|
|
|
set(count, 2);
|
|
assert.equal($.get(d), 4);
|
|
assert.equal(count.reactions, null);
|
|
assert.equal(d.deps?.length, 1);
|
|
};
|
|
});
|
|
|
|
test('unowned deriveds correctly update', () => {
|
|
return () => {
|
|
const arr1 = proxy<{ a: number }[]>([]);
|
|
const arr2 = proxy([]);
|
|
const combined = derived(() => [...arr1, ...arr2]);
|
|
const derived_length = derived(() => $.get(combined).length);
|
|
|
|
assert.deepEqual($.get(combined), []);
|
|
assert.equal($.get(derived_length), 0);
|
|
|
|
arr1.push({ a: 1 });
|
|
|
|
assert.deepEqual($.get(combined), [{ a: 1 }]);
|
|
assert.equal($.get(derived_length), 1);
|
|
};
|
|
});
|
|
|
|
test('deriveds cannot depend on state they own', () => {
|
|
return () => {
|
|
const d = derived(() => {
|
|
const s = state(0);
|
|
return $.get(s);
|
|
});
|
|
|
|
assert.throws(() => $.get(d), 'state_unsafe_local_read');
|
|
};
|
|
});
|
|
|
|
test('proxy version state does not trigger self-dependency guard', () => {
|
|
return () => {
|
|
const s = proxy({ a: { b: 1 } });
|
|
const d = derived(() => snapshot(s));
|
|
|
|
assert.deepEqual($.get(d), s);
|
|
};
|
|
});
|
|
|
|
test('set version state does not trigger self-dependency guard', () => {
|
|
return () => {
|
|
const set = new SvelteSet();
|
|
const d = derived(() => set.has('test'));
|
|
|
|
set.add('test');
|
|
assert.equal($.get(d), true);
|
|
};
|
|
});
|
|
|
|
test('deriveds read inside the root/branches are cleaned up', () => {
|
|
return () => {
|
|
const a = state(0);
|
|
|
|
const destroy = effect_root(() => {
|
|
const b = derived(() => $.get(a));
|
|
$.get(b);
|
|
});
|
|
|
|
destroy();
|
|
|
|
assert.deepEqual(a.reactions, null);
|
|
};
|
|
});
|
|
});
|