msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

chore: simplify create effect (#17813)

Browse Source 
follow-up to #17808. This makes it a bit more explicit _why_ we do
certain things in `create_effect`, and gets rid of a redundant parameter

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

- [x] 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
- [x] Prefix your PR title with `feat:`, `fix:`, `chore:`, or `docs:`.
- [x] 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

- [x] Run the tests with `pnpm test` and lint the project with `pnpm
lint`
pull/17815/head
Rich Harris 6 months ago committed by GitHub
parent 5bd4699539
commit 5e28508377
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 41 additions and 39 deletions
Show Stats Download Patch File Download Diff File

80
packages/svelte/src/internal/client/reactivity/effects.js vendored
Unescape View File

@ -80,10 +80,9 @@ function push_effect(effect, parent_effect) {
/** /**
* @param {number} type * @param {number} type
* @param {null | (() => void | (() => void))} fn * @param {null | (() => void | (() => void))} fn
* @param {boolean} sync
* @returns {Effect} * @returns {Effect}
*/ */
function create_effect(type, fn, sync) { function create_effect(type, fn) {
var parent = active_effect; var parent = active_effect;
if (DEV) { if (DEV) {
@ -119,36 +118,39 @@ function create_effect(type, fn, sync) {
effect.component_function = dev_current_component_function; effect.component_function = dev_current_component_function;
} }
if (sync) { /** @type {Effect | null} */
var e = effect;
if ((type & EFFECT) !== 0) {
if (collected_effects !== null) {
// created during traversal — collect and run afterwards
collected_effects.push(effect);
} else {
// schedule for later
schedule_effect(effect);
}
} else if (fn !== null) {
try { try {
update_effect(effect); update_effect(effect);
} catch (e) { } catch (e) {
destroy_effect(effect); destroy_effect(effect);
throw e; throw e;
} }
} else if ((type & EFFECT) !== 0 && collected_effects !== null) {
collected_effects.push(effect);
} else if (fn !== null) {
schedule_effect(effect);
}
/** @type {Effect | null} */ // if an effect doesn't need to be kept in the tree (because it
var e = effect; // won't re-run, has no DOM, and has no teardown etc)
// then we skip it and go to its child (if any)
// if an effect has already ran and doesn't need to be kept in the tree if (
// (because it won't re-run, has no DOM, and has no teardown etc) e.deps === null &&
// then we skip it and go to its child (if any) e.teardown === null &&
if ( e.nodes === null &&
sync && e.first === e.last && // either `null`, or a singular child
e.deps === null && (e.f & EFFECT_PRESERVED) === 0
e.teardown === null && ) {
e.nodes === null && e = e.first;
e.first === e.last && // either `null`, or a singular child if ((type & BLOCK_EFFECT) !== 0 && (type & EFFECT_TRANSPARENT) !== 0 && e !== null) {
(e.f & EFFECT_PRESERVED) === 0 e.f |= EFFECT_TRANSPARENT;
) { }
e = e.first;
if ((type & BLOCK_EFFECT) !== 0 && (type & EFFECT_TRANSPARENT) !== 0 && e !== null) {
e.f |= EFFECT_TRANSPARENT;
} }
} }
@ -185,7 +187,7 @@ export function effect_tracking() {
* @param {() => void} fn * @param {() => void} fn
*/ */
export function teardown(fn) { export function teardown(fn) {
const effect = create_effect(RENDER_EFFECT, null, false); const effect = create_effect(RENDER_EFFECT, null);
set_signal_status(effect, CLEAN); set_signal_status(effect, CLEAN);
effect.teardown = fn; effect.teardown = fn;
return effect; return effect;
@ -223,7 +225,7 @@ export function user_effect(fn) {
* @param {() => void | (() => void)} fn * @param {() => void | (() => void)} fn
*/ */
export function create_user_effect(fn) { export function create_user_effect(fn) {
return create_effect(EFFECT | USER_EFFECT, fn, false); return create_effect(EFFECT | USER_EFFECT, fn);
} }
/** /**
@ -238,12 +240,12 @@ export function user_pre_effect(fn) {
value: '$effect.pre' value: '$effect.pre'
}); });
} }
return create_effect(RENDER_EFFECT | USER_EFFECT, fn, true); return create_effect(RENDER_EFFECT | USER_EFFECT, fn);
} }
/** @param {() => void | (() => void)} fn */ /** @param {() => void | (() => void)} fn */
export function eager_effect(fn) { export function eager_effect(fn) {
return create_effect(EAGER_EFFECT, fn, true); return create_effect(EAGER_EFFECT, fn);
} }
/** /**
@ -253,7 +255,7 @@ export function eager_effect(fn) {
*/ */
export function effect_root(fn) { export function effect_root(fn) {
Batch.ensure(); Batch.ensure();
const effect = create_effect(ROOT_EFFECT | EFFECT_PRESERVED, fn, true); const effect = create_effect(ROOT_EFFECT | EFFECT_PRESERVED, fn);
return () => { return () => {
destroy_effect(effect); destroy_effect(effect);
@ -267,7 +269,7 @@ export function effect_root(fn) {
*/ */
export function component_root(fn) { export function component_root(fn) {
Batch.ensure(); Batch.ensure();
const effect = create_effect(ROOT_EFFECT | EFFECT_PRESERVED, fn, true); const effect = create_effect(ROOT_EFFECT | EFFECT_PRESERVED, fn);
return (options = {}) => { return (options = {}) => {
return new Promise((fulfil) => { return new Promise((fulfil) => {
@ -289,7 +291,7 @@ export function component_root(fn) {
* @returns {Effect} * @returns {Effect}
*/ */
export function effect(fn) { export function effect(fn) {
return create_effect(EFFECT, fn, false); return create_effect(EFFECT, fn);
} }
/** /**
@ -347,7 +349,7 @@ export function legacy_pre_effect_reset() {
* @returns {Effect} * @returns {Effect}
*/ */
export function async_effect(fn) { export function async_effect(fn) {
return create_effect(ASYNC | EFFECT_PRESERVED, fn, true); return create_effect(ASYNC | EFFECT_PRESERVED, fn);
} }
/** /**
@ -355,7 +357,7 @@ export function async_effect(fn) {
* @returns {Effect} * @returns {Effect}
*/ */
export function render_effect(fn, flags = 0) { export function render_effect(fn, flags = 0) {
return create_effect(RENDER_EFFECT | flags, fn, true); return create_effect(RENDER_EFFECT | flags, fn);
} }
/** /**
@ -366,7 +368,7 @@ export function render_effect(fn, flags = 0) {
*/ */
export function template_effect(fn, sync = [], async = [], blockers = []) { export function template_effect(fn, sync = [], async = [], blockers = []) {
flatten(blockers, sync, async, (values) => { flatten(blockers, sync, async, (values) => {
create_effect(RENDER_EFFECT, () => fn(...values.map(get)), true); create_effect(RENDER_EFFECT, () => fn(...values.map(get)));
}); });
} }
@ -383,7 +385,7 @@ export function deferred_template_effect(fn, sync = [], async = [], blockers = [
} }
flatten(blockers, sync, async, (values) => { flatten(blockers, sync, async, (values) => {
create_effect(EFFECT, () => fn(...values.map(get)), false); create_effect(EFFECT, () => fn(...values.map(get)));
if (decrement_pending) { if (decrement_pending) {
decrement_pending(); decrement_pending();
@ -396,7 +398,7 @@ export function deferred_template_effect(fn, sync = [], async = [], blockers = [
* @param {number} flags * @param {number} flags
*/ */
export function block(fn, flags = 0) { export function block(fn, flags = 0) {
var effect = create_effect(BLOCK_EFFECT | flags, fn, true); var effect = create_effect(BLOCK_EFFECT | flags, fn);
if (DEV) { if (DEV) {
effect.dev_stack = dev_stack; effect.dev_stack = dev_stack;
} }
@ -408,7 +410,7 @@ export function block(fn, flags = 0) {
* @param {number} flags * @param {number} flags
*/ */
export function managed(fn, flags = 0) { export function managed(fn, flags = 0) {
var effect = create_effect(MANAGED_EFFECT | flags, fn, true); var effect = create_effect(MANAGED_EFFECT | flags, fn);
if (DEV) { if (DEV) {
effect.dev_stack = dev_stack; effect.dev_stack = dev_stack;
} }
@ -419,7 +421,7 @@ export function managed(fn, flags = 0) {
* @param {(() => void)} fn * @param {(() => void)} fn
*/ */
export function branch(fn) { export function branch(fn) {
return create_effect(BRANCH_EFFECT | EFFECT_PRESERVED, fn, true); return create_effect(BRANCH_EFFECT | EFFECT_PRESERVED, fn);
} }
/** /**

Write Preview
Loading…
Cancel
Save