svelte 5.40.2 → 5.41.1

package/src/internal/client/dom/blocks/branches.js

@@ -0,0 +1,185 @@
+/** @import { Effect, TemplateNode } from '#client' */
+import { is_runes } from '../../context.js';
+import { Batch, current_batch } from '../../reactivity/batch.js';
+import {
+	branch,
+	destroy_effect,
+	move_effect,
+	pause_effect,
+	resume_effect
+} from '../../reactivity/effects.js';
+import { set_should_intro, should_intro } from '../../render.js';
+import { hydrate_node, hydrating } from '../hydration.js';
+import { create_text, should_defer_append } from '../operations.js';
+
+/**
+ * @typedef {{ effect: Effect, fragment: DocumentFragment }} Branch
+ */
+
+/**
+ * @template Key
+ */
+export class BranchManager {
+	/** @type {TemplateNode} */
+	anchor;
+
+	/** @type {Map<Batch, Key>} */
+	#batches = new Map();
+
+	/** @type {Map<Key, Effect>} */
+	#onscreen = new Map();
+
+	/** @type {Map<Key, Branch>} */
+	#offscreen = new Map();
+
+	/**
+	 * Whether to pause (i.e. outro) on change, or destroy immediately.
+	 * This is necessary for `<svelte:element>`
+	 */
+	#transition = true;
+
+	/**
+	 * @param {TemplateNode} anchor
+	 * @param {boolean} transition
+	 */
+	constructor(anchor, transition = true) {
+		this.anchor = anchor;
+		this.#transition = transition;
+	}
+
+	#commit = () => {
+		var batch = /** @type {Batch} */ (current_batch);
+
+		// if this batch was made obsolete, bail
+		if (!this.#batches.has(batch)) return;
+
+		var key = /** @type {Key} */ (this.#batches.get(batch));
+
+		var onscreen = this.#onscreen.get(key);
+
+		if (onscreen) {
+			// effect is already in the DOM — abort any current outro
+			resume_effect(onscreen);
+		} else {
+			// effect is currently offscreen. put it in the DOM
+			var offscreen = this.#offscreen.get(key);
+
+			if (offscreen) {
+				this.#onscreen.set(key, offscreen.effect);
+				this.#offscreen.delete(key);
+
+				// remove the anchor...
+				/** @type {TemplateNode} */ (offscreen.fragment.lastChild).remove();
+
+				// ...and append the fragment
+				this.anchor.before(offscreen.fragment);
+				onscreen = offscreen.effect;
+			}
+		}
+
+		for (const [b, k] of this.#batches) {
+			this.#batches.delete(b);
+
+			if (b === batch) {
+				// keep values for newer batches
+				break;
+			}
+
+			const offscreen = this.#offscreen.get(k);
+
+			if (offscreen) {
+				// for older batches, destroy offscreen effects
+				// as they will never be committed
+				destroy_effect(offscreen.effect);
+				this.#offscreen.delete(k);
+			}
+		}
+
+		// outro/destroy all onscreen effects...
+		for (const [k, effect] of this.#onscreen) {
+			// ...except the one that was just committed
+			if (k === key) continue;
+
+			const on_destroy = () => {
+				const keys = Array.from(this.#batches.values());
+
+				if (keys.includes(k)) {
+					// keep the effect offscreen, as another batch will need it
+					var fragment = document.createDocumentFragment();
+					move_effect(effect, fragment);
+
+					fragment.append(create_text()); // TODO can we avoid this?
+
+					this.#offscreen.set(k, { effect, fragment });
+				} else {
+					destroy_effect(effect);
+				}
+
+				this.#onscreen.delete(k);
+			};
+
+			if (this.#transition || !onscreen) {
+				pause_effect(effect, on_destroy, false);
+			} else {
+				on_destroy();
+			}
+		}
+	};
+
+	/**
+	 *
+	 * @param {any} key
+	 * @param {null | ((target: TemplateNode) => void)} fn
+	 */
+	ensure(key, fn) {
+		var batch = /** @type {Batch} */ (current_batch);
+		var defer = should_defer_append();
+
+		if (fn && !this.#onscreen.has(key) && !this.#offscreen.has(key)) {
+			if (defer) {
+				var fragment = document.createDocumentFragment();
+				var target = create_text();
+
+				fragment.append(target);
+
+				this.#offscreen.set(key, {
+					effect: branch(() => fn(target)),
+					fragment
+				});
+			} else {
+				this.#onscreen.set(
+					key,
+					branch(() => fn(this.anchor))
+				);
+			}
+		}
+
+		this.#batches.set(batch, key);
+
+		if (defer) {
+			for (const [k, effect] of this.#onscreen) {
+				if (k === key) {
+					batch.skipped_effects.delete(effect);
+				} else {
+					batch.skipped_effects.add(effect);
+				}
+			}
+
+			for (const [k, branch] of this.#offscreen) {
+				if (k === key) {
+					batch.skipped_effects.delete(branch.effect);
+				} else {
+					batch.skipped_effects.add(branch.effect);
+				}
+			}
+
+			batch.add_callback(this.#commit);
+		} else {
+			if (hydrating) {
+				this.anchor = hydrate_node;
+			}
+
+			this.#commit();
+		}
+	}
+}

package/src/internal/client/dom/blocks/if.js

@@ -1,19 +1,16 @@
-/** @import { Effect, TemplateNode } from '#client' */
-/** @import { Batch } from '../../reactivity/batch.js'; */
+/** @import { TemplateNode } from '#client' */
 import { EFFECT_TRANSPARENT } from '#client/constants';
 import {
 	hydrate_next,
-	hydrate_node,
 	hydrating,
 	read_hydration_instruction,
 	skip_nodes,
 	set_hydrate_node,
 	set_hydrating
 } from '../hydration.js';
-import { block, branch, pause_effect, resume_effect } from '../../reactivity/effects.js';
-import { HYDRATION_START_ELSE, UNINITIALIZED } from '../../../../constants.js';
-import { create_text, should_defer_append } from '../operations.js';
-import { current_batch } from '../../reactivity/batch.js';
+import { block } from '../../reactivity/effects.js';
+import { HYDRATION_START_ELSE } from '../../../../constants.js';
+import { BranchManager } from './branches.js';
 
 // TODO reinstate https://github.com/sveltejs/svelte/pull/15250
 
@@ -28,122 +25,46 @@ export function if_block(node, fn, elseif = false) {
 		hydrate_next();
 	}
 
-	var anchor = node;
-
-	/** @type {Effect | null} */
-	var consequent_effect = null;
-
-	/** @type {Effect | null} */
-	var alternate_effect = null;
-
-	/** @type {typeof UNINITIALIZED | boolean | null} */
-	var condition = UNINITIALIZED;
-
+	var branches = new BranchManager(node);
 	var flags = elseif ? EFFECT_TRANSPARENT : 0;
 
-	var has_branch = false;
-
-	const set_branch = (/** @type {(anchor: Node) => void} */ fn, flag = true) => {
-		has_branch = true;
-		update_branch(flag, fn);
-	};
-
-	/** @type {DocumentFragment | null} */
-	var offscreen_fragment = null;
-
-	function commit() {
-		if (offscreen_fragment !== null) {
-			// remove the anchor
-			/** @type {Text} */ (offscreen_fragment.lastChild).remove();
-
-			anchor.before(offscreen_fragment);
-			offscreen_fragment = null;
-		}
-
-		var active = condition ? consequent_effect : alternate_effect;
-		var inactive = condition ? alternate_effect : consequent_effect;
-
-		if (active) {
-			resume_effect(active);
-		}
-
-		if (inactive) {
-			pause_effect(inactive, () => {
-				if (condition) {
-					alternate_effect = null;
-				} else {
-					consequent_effect = null;
-				}
-			});
-		}
-	}
-
-	const update_branch = (
-		/** @type {boolean | null} */ new_condition,
-		/** @type {null | ((anchor: Node) => void)} */ fn
-	) => {
-		if (condition === (condition = new_condition)) return;
-
-		/** Whether or not there was a hydration mismatch. Needs to be a `let` or else it isn't treeshaken out */
-		let mismatch = false;
-
+	/**
+	 * @param {boolean} condition,
+	 * @param {null | ((anchor: Node) => void)} fn
+	 */
+	function update_branch(condition, fn) {
 		if (hydrating) {
-			const is_else = read_hydration_instruction(anchor) === HYDRATION_START_ELSE;
+			const is_else = read_hydration_instruction(node) === HYDRATION_START_ELSE;
 
-			if (!!condition === is_else) {
+			if (condition === is_else) {
 				// Hydration mismatch: remove everything inside the anchor and start fresh.
 				// This could happen with `{#if browser}...{/if}`, for example
-				anchor = skip_nodes();
+				var anchor = skip_nodes();
 
 				set_hydrate_node(anchor);
-				set_hydrating(false);
-				mismatch = true;
-			}
-		}
+				branches.anchor = anchor;
 
-		var defer = should_defer_append();
-		var target = anchor;
-
-		if (defer) {
-			offscreen_fragment = document.createDocumentFragment();
-			offscreen_fragment.append((target = create_text()));
-		}
+				set_hydrating(false);
+				branches.ensure(condition, fn);
+				set_hydrating(true);
 
-		if (condition) {
-			consequent_effect ??= fn && branch(() => fn(target));
-		} else {
-			alternate_effect ??= fn && branch(() => fn(target));
+				return;
+			}
 		}
 
-		if (defer) {
-			var batch = /** @type {Batch} */ (current_batch);
-
-			var active = condition ? consequent_effect : alternate_effect;
-			var inactive = condition ? alternate_effect : consequent_effect;
-
-			if (active) batch.skipped_effects.delete(active);
-			if (inactive) batch.skipped_effects.add(inactive);
+		branches.ensure(condition, fn);
+	}
 
-			batch.add_callback(commit);
-		} else {
-			commit();
-		}
+	block(() => {
+		var has_branch = false;
 
-		if (mismatch) {
-			// continue in hydration mode
-			set_hydrating(true);
-		}
-	};
+		fn((fn, flag = true) => {
+			has_branch = true;
+			update_branch(flag, fn);
+		});
 
-	block(() => {
-		has_branch = false;
-		fn(set_branch);
 		if (!has_branch) {
-			update_branch(null, null);
+			update_branch(false, null);
 		}
 	}, flags);
-
-	if (hydrating) {
-		anchor = hydrate_node;
-	}
 }

package/src/internal/client/dom/blocks/key.js

@@ -1,12 +1,8 @@
-/** @import { Effect, TemplateNode } from '#client' */
-/** @import { Batch } from '../../reactivity/batch.js'; */
-import { UNINITIALIZED } from '../../../../constants.js';
-import { block, branch, pause_effect } from '../../reactivity/effects.js';
-import { not_equal, safe_not_equal } from '../../reactivity/equality.js';
+/** @import { TemplateNode } from '#client' */
 import { is_runes } from '../../context.js';
-import { hydrate_next, hydrate_node, hydrating } from '../hydration.js';
-import { create_text, should_defer_append } from '../operations.js';
-import { current_batch } from '../../reactivity/batch.js';
+import { block } from '../../reactivity/effects.js';
+import { hydrate_next, hydrating } from '../hydration.js';
+import { BranchManager } from './branches.js';
 
 /**
  * @template V
@@ -20,60 +16,18 @@ export function key(node, get_key, render_fn) {
 		hydrate_next();
 	}
 
-	var anchor = node;
+	var branches = new BranchManager(node);
 
-	/** @type {V | typeof UNINITIALIZED} */
-	var key = UNINITIALIZED;
-
-	/** @type {Effect} */
-	var effect;
-
-	/** @type {Effect} */
-	var pending_effect;
-
-	/** @type {DocumentFragment | null} */
-	var offscreen_fragment = null;
-
-	var changed = is_runes() ? not_equal : safe_not_equal;
-
-	function commit() {
-		if (effect) {
-			pause_effect(effect);
-		}
-
-		if (offscreen_fragment !== null) {
-			// remove the anchor
-			/** @type {Text} */ (offscreen_fragment.lastChild).remove();
-
-			anchor.before(offscreen_fragment);
-			offscreen_fragment = null;
-		}
-
-		effect = pending_effect;
-	}
+	var legacy = !is_runes();
 
 	block(() => {
-		if (changed(key, (key = get_key()))) {
-			var target = anchor;
-
-			var defer = should_defer_append();
-
-			if (defer) {
-				offscreen_fragment = document.createDocumentFragment();
-				offscreen_fragment.append((target = create_text()));
-			}
-
-			pending_effect = branch(() => render_fn(target));
+		var key = get_key();
 
-			if (defer) {
-				/** @type {Batch} */ (current_batch).add_callback(commit);
-			} else {
-				commit();
-			}
+		// key blocks in Svelte <5 had stupid semantics
+		if (legacy && key !== null && typeof key === 'object') {
+			key = /** @type {V} */ ({});
 		}
-	});
 
-	if (hydrating) {
-		anchor = hydrate_node;
-	}
+		branches.ensure(key, render_fn);
+	});
 }

package/src/internal/client/dom/blocks/snippet.js

@@ -1,8 +1,8 @@
 /** @import { Snippet } from 'svelte' */
-/** @import { Effect, TemplateNode } from '#client' */
+/** @import { TemplateNode } from '#client' */
 /** @import { Getters } from '#shared' */
 import { EFFECT_TRANSPARENT, ELEMENT_NODE } from '#client/constants';
-import { branch, block, destroy_effect, teardown } from '../../reactivity/effects.js';
+import { block, teardown } from '../../reactivity/effects.js';
 import {
 	dev_current_component_function,
 	set_dev_current_component_function
@@ -14,8 +14,8 @@ import * as w from '../../warnings.js';
 import * as e from '../../errors.js';
 import { DEV } from 'esm-env';
 import { get_first_child, get_next_sibling } from '../operations.js';
-import { noop } from '../../../shared/utils.js';
 import { prevent_snippet_stringification } from '../../../shared/validate.js';
+import { BranchManager } from './branches.js';
 
 /**
  * @template {(node: TemplateNode, ...args: any[]) => void} SnippetFn
@@ -25,33 +25,17 @@ import { prevent_snippet_stringification } from '../../../shared/validate.js';
  * @returns {void}
  */
 export function snippet(node, get_snippet, ...args) {
-	var anchor = node;
-
-	/** @type {SnippetFn | null | undefined} */
-	// @ts-ignore
-	var snippet = noop;
-
-	/** @type {Effect | null} */
-	var snippet_effect;
+	var branches = new BranchManager(node);
 
 	block(() => {
-		if (snippet === (snippet = get_snippet())) return;
-
-		if (snippet_effect) {
-			destroy_effect(snippet_effect);
-			snippet_effect = null;
-		}
+		const snippet = get_snippet() ?? null;
 
 		if (DEV && snippet == null) {
 			e.invalid_snippet();
 		}
 
-		snippet_effect = branch(() => /** @type {SnippetFn} */ (snippet)(anchor, ...args));
+		branches.ensure(snippet, snippet && ((anchor) => snippet(anchor, ...args)));
 	}, EFFECT_TRANSPARENT);
-
-	if (hydrating) {
-		anchor = hydrate_node;
-	}
 }
 
 /**

package/src/internal/client/dom/blocks/svelte-component.js

@@ -1,10 +1,8 @@
-/** @import { TemplateNode, Dom, Effect } from '#client' */
-/** @import { Batch } from '../../reactivity/batch.js'; */
+/** @import { TemplateNode, Dom } from '#client' */
 import { EFFECT_TRANSPARENT } from '#client/constants';
-import { block, branch, pause_effect } from '../../reactivity/effects.js';
-import { current_batch } from '../../reactivity/batch.js';
-import { hydrate_next, hydrate_node, hydrating } from '../hydration.js';
-import { create_text, should_defer_append } from '../operations.js';
+import { block } from '../../reactivity/effects.js';
+import { hydrate_next, hydrating } from '../hydration.js';
+import { BranchManager } from './branches.js';
 
 /**
  * @template P
@@ -19,64 +17,10 @@ export function component(node, get_component, render_fn) {
 		hydrate_next();
 	}
 
-	var anchor = node;
-
-	/** @type {C} */
-	var component;
-
-	/** @type {Effect | null} */
-	var effect;
-
-	/** @type {DocumentFragment | null} */
-	var offscreen_fragment = null;
-
-	/** @type {Effect | null} */
-	var pending_effect = null;
-
-	function commit() {
-		if (effect) {
-			pause_effect(effect);
-			effect = null;
-		}
-
-		if (offscreen_fragment) {
-			// remove the anchor
-			/** @type {Text} */ (offscreen_fragment.lastChild).remove();
-
-			anchor.before(offscreen_fragment);
-			offscreen_fragment = null;
-		}
-
-		effect = pending_effect;
-		pending_effect = null;
-	}
+	var branches = new BranchManager(node);
 
 	block(() => {
-		if (component === (component = get_component())) return;
-
-		var defer = should_defer_append();
-
-		if (component) {
-			var target = anchor;
-
-			if (defer) {
-				offscreen_fragment = document.createDocumentFragment();
-				offscreen_fragment.append((target = create_text()));
-				if (effect) {
-					/** @type {Batch} */ (current_batch).skipped_effects.add(effect);
-				}
-			}
-			pending_effect = branch(() => render_fn(target, component));
-		}
-
-		if (defer) {
-			/** @type {Batch} */ (current_batch).add_callback(commit);
-		} else {
-			commit();
-		}
+		var component = get_component() ?? null;
+		branches.ensure(component, component && ((target) => render_fn(target, component)));
 	}, EFFECT_TRANSPARENT);
-
-	if (hydrating) {
-		anchor = hydrate_node;
-	}
 }