Skip to content

chore: use template_effect for html tags #15779

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 17, 2025
Merged

chore: use template_effect for html tags #15779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
113 changes: 53 additions & 60 deletions packages/svelte/src/internal/client/dom/blocks/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** @import { Effect, TemplateNode } from '#client' */
import { FILENAME, HYDRATION_ERROR } from '../../../../constants.js';
import { block, branch, destroy_effect } from '../../reactivity/effects.js';
import { remove_effect_dom, template_effect } from '../../reactivity/effects.js';
import { hydrate_next, hydrate_node, hydrating, set_hydrate_node } from '../hydration.js';
import { create_fragment_from_html } from '../reconciler.js';
import { assign_nodes } from '../template.js';
Expand All @@ -9,6 +9,7 @@ import { hash, sanitize_location } from '../../../../utils.js';
import { DEV } from 'esm-env';
import { dev_current_component_function } from '../../context.js';
import { get_first_child, get_next_sibling } from '../operations.js';
import { active_effect } from '../../runtime.js';

/**
* @param {Element} element
Expand Down Expand Up @@ -44,79 +45,71 @@ export function html(node, get_value, svg = false, mathml = false, skip_warning

var value = '';

/** @type {Effect | undefined} */
var effect;
template_effect(() => {
var effect = /** @type {Effect} */ (active_effect);

block(() => {
if (value === (value = get_value() ?? '')) {
if (hydrating) {
hydrate_next();
}
if (hydrating) hydrate_next();
return;
}

if (effect !== undefined) {
destroy_effect(effect);
effect = undefined;
if (effect.nodes_start !== null) {
remove_effect_dom(effect.nodes_start, /** @type {TemplateNode} */ (effect.nodes_end));
effect.nodes_start = effect.nodes_end = null;
}

if (value === '') return;

effect = branch(() => {
if (hydrating) {
// We're deliberately not trying to repair mismatches between server and client,
// as it's costly and error-prone (and it's an edge case to have a mismatch anyway)
var hash = /** @type {Comment} */ (hydrate_node).data;
var next = hydrate_next();
var last = next;

while (
next !== null &&
(next.nodeType !== 8 || /** @type {Comment} */ (next).data !== '')
) {
last = next;
next = /** @type {TemplateNode} */ (get_next_sibling(next));
}

if (next === null) {
w.hydration_mismatch();
throw HYDRATION_ERROR;
}

if (DEV && !skip_warning) {
check_hash(/** @type {Element} */ (next.parentNode), hash, value);
}

assign_nodes(hydrate_node, last);
anchor = set_hydrate_node(next);
return;
}
if (hydrating) {
// We're deliberately not trying to repair mismatches between server and client,
// as it's costly and error-prone (and it's an edge case to have a mismatch anyway)
var hash = /** @type {Comment} */ (hydrate_node).data;
var next = hydrate_next();
var last = next;

var html = value + '';
if (svg) html = `<svg>${html}</svg>`;
else if (mathml) html = `<math>${html}</math>`;
while (next !== null && (next.nodeType !== 8 || /** @type {Comment} */ (next).data !== '')) {
last = next;
next = /** @type {TemplateNode} */ (get_next_sibling(next));
}

// Don't use create_fragment_with_script_from_html here because that would mean script tags are executed.
// @html is basically `.innerHTML = ...` and that doesn't execute scripts either due to security reasons.
/** @type {DocumentFragment | Element} */
var node = create_fragment_from_html(html);
if (next === null) {
w.hydration_mismatch();
throw HYDRATION_ERROR;
}

if (svg || mathml) {
node = /** @type {Element} */ (get_first_child(node));
if (DEV && !skip_warning) {
check_hash(/** @type {Element} */ (next.parentNode), hash, value);
}

assign_nodes(
/** @type {TemplateNode} */ (get_first_child(node)),
/** @type {TemplateNode} */ (node.lastChild)
);

if (svg || mathml) {
while (get_first_child(node)) {
anchor.before(/** @type {Node} */ (get_first_child(node)));
}
} else {
anchor.before(node);
assign_nodes(hydrate_node, last);
anchor = set_hydrate_node(next);
return;
}

var html = value + '';
if (svg) html = `<svg>${html}</svg>`;
else if (mathml) html = `<math>${html}</math>`;

// Don't use create_fragment_with_script_from_html here because that would mean script tags are executed.
// @html is basically `.innerHTML = ...` and that doesn't execute scripts either due to security reasons.
/** @type {DocumentFragment | Element} */
var node = create_fragment_from_html(html);

if (svg || mathml) {
node = /** @type {Element} */ (get_first_child(node));
}

assign_nodes(
/** @type {TemplateNode} */ (get_first_child(node)),
/** @type {TemplateNode} */ (node.lastChild)
);

if (svg || mathml) {
while (get_first_child(node)) {
anchor.before(/** @type {Node} */ (get_first_child(node)));
}
});
} else {
anchor.before(node);
}
});
}
28 changes: 16 additions & 12 deletions packages/svelte/src/internal/client/reactivity/effects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -427,18 +427,7 @@ export function destroy_effect(effect, remove_dom = true) {
var removed = false;

if ((remove_dom || (effect.f & HEAD_EFFECT) !== 0) && effect.nodes_start !== null) {
/** @type {TemplateNode | null} */
var node = effect.nodes_start;
var end = effect.nodes_end;

while (node !== null) {
/** @type {TemplateNode | null} */
var next = node === end ? null : /** @type {TemplateNode} */ (get_next_sibling(node));

node.remove();
node = next;
}

remove_effect_dom(effect.nodes_start, /** @type {TemplateNode} */ (effect.nodes_end));
removed = true;
}

Expand Down Expand Up @@ -480,6 +469,21 @@ export function destroy_effect(effect, remove_dom = true) {
null;
}

/**
*
* @param {TemplateNode | null} node
* @param {TemplateNode} end
*/
export function remove_effect_dom(node, end) {
while (node !== null) {
/** @type {TemplateNode | null} */
var next = node === end ? null : /** @type {TemplateNode} */ (get_next_sibling(node));

node.remove();
node = next;
}
}

/**
* Detach an effect from the effect tree, freeing up memory and
* reducing the amount of work that happens on subsequent traversals
Expand Down