chore: convert boundary implementation to a class (#16284)

* WIP class boundaries

* WIP

* WIP

* WIP

* unused

* unused

* unused

packages/svelte/src/internal/client/dom/blocks/boundary.js

@@ -1,6 +1,5 @@
 /** @import { Effect, TemplateNode, } from '#client' */
-
+import { BOUNDARY_EFFECT, EFFECT_PRESERVED, EFFECT_TRANSPARENT } from '#client/constants';
-import { BOUNDARY_EFFECT, EFFECT_TRANSPARENT } from '#client/constants';
 import { component_context, set_component_context } from '../../context.js';
 import { invoke_error_boundary } from '../../error-handling.js';
 import { block, branch, destroy_effect, pause_effect } from '../../reactivity/effects.js';
@@ -21,20 +20,93 @@ import {
 import { queue_micro_task } from '../task.js';
 
 /**
- * @param {Effect} boundary
+ * @typedef {{
- * @param {() => void} fn
+ * 	 onerror?: (error: unknown, reset: () => void) => void;
+ *   failed?: (anchor: Node, error: () => unknown, reset: () => () => void) => void;
+ * }} BoundaryProps
+ */
+
+var flags = EFFECT_TRANSPARENT | EFFECT_PRESERVED | BOUNDARY_EFFECT;
+
+/**
+ * @param {TemplateNode} node
+ * @param {BoundaryProps} props
+ * @param {((anchor: Node) => void)} children
+ * @returns {void}
+ */
+export function boundary(node, props, children) {
+	new Boundary(node, props, children);
+}
+
+export class Boundary {
+	/** @type {TemplateNode} */
+	#anchor;
+
+	/** @type {TemplateNode} */
+	#hydrate_open;
+
+	/** @type {BoundaryProps} */
+	#props;
+
+	/** @type {((anchor: Node) => void)} */
+	#children;
+
+	/** @type {Effect} */
+	#effect;
+
+	/** @type {Effect | null} */
+	#main_effect = null;
+
+	/** @type {Effect | null} */
+	#failed_effect = null;
+
+	#is_creating_fallback = false;
+
+	/**
+	 * @param {TemplateNode} node
+	 * @param {BoundaryProps} props
+	 * @param {((anchor: Node) => void)} children
 	 */
-function with_boundary(boundary, fn) {
+	constructor(node, props, children) {
+		this.#anchor = node;
+		this.#props = props;
+		this.#children = children;
+
+		this.#hydrate_open = hydrate_node;
+
+		this.#effect = block(() => {
+			/** @type {Effect} */ (active_effect).b = this;
+
+			if (hydrating) {
+				hydrate_next();
+			}
+
+			try {
+				this.#main_effect = branch(() => children(this.#anchor));
+			} catch (error) {
+				this.error(error);
+			}
+		}, flags);
+
+		if (hydrating) {
+			this.#anchor = hydrate_node;
+		}
+	}
+
+	/**
+	 * @param {() => Effect | null} fn
+	 */
+	#run(fn) {
 		var previous_effect = active_effect;
 		var previous_reaction = active_reaction;
 		var previous_ctx = component_context;
 
-	set_active_effect(boundary);
+		set_active_effect(this.#effect);
-	set_active_reaction(boundary);
+		set_active_reaction(this.#effect);
-	set_component_context(boundary.ctx);
+		set_component_context(this.#effect.ctx);
 
 		try {
-		fn();
+			return fn();
 		} finally {
 			set_active_effect(previous_effect);
 			set_active_reaction(previous_reaction);
@@ -42,46 +114,30 @@ function with_boundary(boundary, fn) {
 		}
 	}
 
-/**
+	/** @param {unknown} error */
- * @param {TemplateNode} node
+	error(error) {
- * @param {{
+		var onerror = this.#props.onerror;
- * 	 onerror?: (error: unknown, reset: () => void) => void,
+		let failed = this.#props.failed;
- *   failed?: (anchor: Node, error: () => unknown, reset: () => () => void) => void
- * }} props
- * @param {((anchor: Node) => void)} boundary_fn
- * @returns {void}
- */
-export function boundary(node, props, boundary_fn) {
-	var anchor = node;
 
-	/** @type {Effect} */
+		const reset = () => {
-	var boundary_effect;
+			if (this.#failed_effect !== null) {
-
+				pause_effect(this.#failed_effect, () => {
-	block(() => {
+					this.#failed_effect = null;
-		var boundary = /** @type {Effect} */ (active_effect);
+				});
-		var hydrate_open = hydrate_node;
+			}
-		var is_creating_fallback = false;
 
-		// We re-use the effect's fn property to avoid allocation of an additional field
+			this.#main_effect = this.#run(() => {
-		boundary.fn = (/** @type {unknown}} */ error) => {
+				this.#is_creating_fallback = false;
-			var onerror = props.onerror;
+				return branch(() => this.#children(this.#anchor));
-			let failed = props.failed;
+			});
+		};
 
 		// If we have nothing to capture the error, or if we hit an error while
 		// rendering the fallback, re-throw for another boundary to handle
-			if ((!onerror && !failed) || is_creating_fallback) {
+		if (this.#is_creating_fallback || (!onerror && !failed)) {
 			throw error;
 		}
 
-			var reset = () => {
-				pause_effect(boundary_effect);
-
-				with_boundary(boundary, () => {
-					is_creating_fallback = false;
-					boundary_effect = branch(() => boundary_fn(anchor));
-				});
-			};
-
 		var previous_reaction = active_reaction;
 
 		try {
@@ -91,46 +147,43 @@ export function boundary(node, props, boundary_fn) {
 			set_active_reaction(previous_reaction);
 		}
 
-			if (boundary_effect) {
+		if (this.#main_effect) {
-				destroy_effect(boundary_effect);
+			destroy_effect(this.#main_effect);
-			} else if (hydrating) {
+			this.#main_effect = null;
-				set_hydrate_node(hydrate_open);
+		}
+
+		if (this.#failed_effect) {
+			destroy_effect(this.#failed_effect);
+			this.#failed_effect = null;
+		}
+
+		if (hydrating) {
+			set_hydrate_node(this.#hydrate_open);
 			next();
 			set_hydrate_node(remove_nodes());
 		}
 
 		if (failed) {
-				// Render the `failed` snippet in a microtask
 			queue_micro_task(() => {
-					with_boundary(boundary, () => {
+				this.#failed_effect = this.#run(() => {
-						is_creating_fallback = true;
+					this.#is_creating_fallback = true;
 
 					try {
-							boundary_effect = branch(() => {
+						return branch(() => {
 							failed(
-									anchor,
+								this.#anchor,
 								() => error,
 								() => reset
 							);
 						});
 					} catch (error) {
-							invoke_error_boundary(error, /** @type {Effect} */ (boundary.parent));
+						invoke_error_boundary(error, /** @type {Effect} */ (this.#effect.parent));
+						return null;
+					} finally {
+						this.#is_creating_fallback = false;
 					}
-
-						is_creating_fallback = false;
 				});
 			});
 		}
-		};
-
-		if (hydrating) {
-			hydrate_next();
-		}
-
-		boundary_effect = branch(() => boundary_fn(anchor));
-	}, EFFECT_TRANSPARENT | BOUNDARY_EFFECT);
-
-	if (hydrating) {
-		anchor = hydrate_node;
 	}
 }

packages/svelte/src/internal/client/error-handling.js

@@ -1,4 +1,5 @@
 /** @import { Effect } from '#client' */
+/** @import { Boundary } from './dom/blocks/boundary.js' */
 import { DEV } from 'esm-env';
 import { FILENAME } from '../../constants.js';
 import { is_firefox } from './dom/operations.js';
@@ -39,8 +40,7 @@ export function invoke_error_boundary(error, effect) {
 	while (effect !== null) {
 		if ((effect.f & BOUNDARY_EFFECT) !== 0) {
 			try {
-				// @ts-expect-error
+				/** @type {Boundary} */ (effect.b).error(error);
-				effect.fn(error);
 				return;
 			} catch {}
 		}

packages/svelte/src/internal/client/reactivity/effects.js

@@ -104,6 +104,7 @@ function create_effect(type, fn, sync, push = true) {
 		last: null,
 		next: null,
 		parent,
+		b: parent && parent.b,
 		prev: null,
 		teardown: null,
 		transitions: null,

packages/svelte/src/internal/client/reactivity/types.d.ts

@@ -5,6 +5,7 @@ import type {
 	TemplateNode,
 	TransitionManager
 } from '#client';
+import type { Boundary } from '../dom/blocks/boundary';
 
 export interface Signal {
 	/** Flags bitmask */
@@ -84,6 +85,8 @@ export interface Effect extends Reaction {
 	last: null | Effect;
 	/** Parent effect */
 	parent: Effect | null;
+	/** The boundary this effect belongs to */
+	b: Boundary | null;
 	/** Dev only */
 	component_function?: any;
 	/** Dev only. Only set for certain block effects. Contains a reference to the stack that represents the render tree */