perf: inline module variables into template

benmccann · benmccann · commit 1d2f6050a41a · 2024-09-03T08:32:31.000-07:00
diff --git a/.changeset/eighty-dragons-search.md b/.changeset/eighty-dragons-search.md
@@ -0,0 +1,5 @@
+---
+'svelte': patch
+---
+
+perf: inline module variables into template
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/types.d.ts b/packages/svelte/src/compiler/phases/3-transform/client/types.d.ts
@@ -54,7 +54,10 @@ export interface ComponentClientTransformState extends ClientTransformState {
 	/** Stuff that happens after the render effect (control blocks, dynamic elements, bindings, actions, etc) */
 	readonly after_update: Statement[];
 	/** The HTML template string */
-	readonly template: string[];
+	readonly template: {
+		quasi: string[];
+		expressions: Expression[];
+	};
 	readonly locations: SourceLocation[];
 	readonly metadata: {
 		namespace: Namespace;
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/utils.js b/packages/svelte/src/compiler/phases/3-transform/client/utils.js
@@ -311,3 +311,38 @@ export function create_derived_block_argument(node, context) {
 export function create_derived(state, arg) {
 	return b.call(state.analysis.runes ? '$.derived' : '$.derived_safe_equal', arg);
 }
+
+/**
+ * @param {import('./types.js').ComponentClientTransformState} state
+ * @param {string} quasi_to_add
+ */
+export function push_template_quasi(state, quasi_to_add) {
+	const { quasi } = state.template;
+	if (quasi.length === 0) {
+		quasi.push(quasi_to_add);
+		return;
+	}
+	quasi[quasi.length - 1] = quasi[quasi.length - 1].concat(quasi_to_add);
+}
+
+/**
+ * @param {import('./types.js').ComponentClientTransformState} state
+ * @param {import('estree').Expression} expression_to_add
+ */
+export function push_template_expression(state, expression_to_add) {
+	const { expressions, quasi } = state.template;
+	if (quasi.length === 0) {
+		quasi.push('');
+	}
+	expressions.push(expression_to_add);
+	quasi.push('');
+}
+
+/**
+ * Whether a variable can be referenced directly from template string.
+ * @param {import('#compiler').Binding | undefined} binding
+ * @returns {boolean}
+ */
+export function can_inline_variable(binding) {
+	return !!binding && !binding.scope.parent;
+}
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/AwaitBlock.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/AwaitBlock.js
@@ -2,14 +2,14 @@
 /** @import { AST } from '#compiler' */
 /** @import { ComponentContext } from '../types' */
 import * as b from '../../../../utils/builders.js';
-import { create_derived_block_argument } from '../utils.js';
+import { create_derived_block_argument, push_template_quasi } from '../utils.js';
 
 /**
  * @param {AST.AwaitBlock} node
  * @param {ComponentContext} context
  */
 export function AwaitBlock(node, context) {
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 
 	// Visit {#await <expression>} first to ensure that scopes are in the correct order
 	const expression = b.thunk(/** @type {Expression} */ (context.visit(node.expression)));
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/Comment.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/Comment.js
@@ -1,11 +1,13 @@
 /** @import { AST } from '#compiler' */
 /** @import { ComponentContext } from '../types' */
 
+import { push_template_quasi } from '../utils.js';
+
 /**
  * @param {AST.Comment} node
  * @param {ComponentContext} context
  */
 export function Comment(node, context) {
 	// We'll only get here if comments are not filtered out, which they are unless preserveComments is true
-	context.state.template.push(`<!--${node.data}-->`);
+	push_template_quasi(context.state, `<!--${node.data}-->`);
 }
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/EachBlock.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/EachBlock.js
@@ -12,7 +12,7 @@ import {
 import { dev } from '../../../../state.js';
 import { extract_paths, object } from '../../../../utils/ast.js';
 import * as b from '../../../../utils/builders.js';
-import { build_getter } from '../utils.js';
+import { build_getter, push_template_quasi } from '../utils.js';
 import { get_value } from './shared/declarations.js';
 
 /**
@@ -32,7 +32,7 @@ export function EachBlock(node, context) {
 	);
 
 	if (!each_node_meta.is_controlled) {
-		context.state.template.push('<!>');
+		push_template_quasi(context.state, '<!>');
 	}
 
 	if (each_node_meta.array_name !== null) {
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/Fragment.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/Fragment.js
@@ -64,7 +64,10 @@ export function Fragment(node, context) {
 		init: [],
 		update: [],
 		after_update: [],
-		template: [],
+		template: {
+			quasi: [],
+			expressions: []
+		},
 		locations: [],
 		transform: { ...context.state.transform },
 		metadata: {
@@ -115,7 +118,12 @@ export function Fragment(node, context) {
 		});
 
 		/** @type {Expression[]} */
-		const args = [b.template([b.quasi(state.template.join(''), true)], [])];
+		const args = [
+			b.template(
+				state.template.quasi.map((q) => b.quasi(q, true)),
+				state.template.expressions
+			)
+		];
 
 		if (state.metadata.context.template_needs_import_node) {
 			args.push(b.literal(TEMPLATE_USE_IMPORT_NODE));
@@ -170,12 +178,15 @@ export function Fragment(node, context) {
 					flags |= TEMPLATE_USE_IMPORT_NODE;
 				}
 
-				if (state.template.length === 1 && state.template[0] === '<!>') {
+				if (state.template.quasi.length === 1 && state.template.quasi[0] === '<!>') {
 					// special case — we can use `$.comment` instead of creating a unique template
 					body.push(b.var(id, b.call('$.comment')));
 				} else {
 					add_template(template_name, [
-						b.template([b.quasi(state.template.join(''), true)], []),
+						b.template(
+							state.template.quasi.map((q) => b.quasi(q, true)),
+							state.template.expressions
+						),
 						b.literal(flags)
 					]);
 
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/HtmlTag.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/HtmlTag.js
@@ -3,13 +3,14 @@
 /** @import { ComponentContext } from '../types' */
 import { is_ignored } from '../../../../state.js';
 import * as b from '../../../../utils/builders.js';
+import { push_template_quasi } from '../utils.js';
 
 /**
  * @param {AST.HtmlTag} node
  * @param {ComponentContext} context
  */
 export function HtmlTag(node, context) {
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 
 	// push into init, so that bindings run afterwards, which might trigger another run and override hydration
 	context.state.init.push(
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/IfBlock.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/IfBlock.js
@@ -2,13 +2,14 @@
 /** @import { AST } from '#compiler' */
 /** @import { ComponentContext } from '../types' */
 import * as b from '../../../../utils/builders.js';
+import { push_template_quasi } from '../utils.js';
 
 /**
  * @param {AST.IfBlock} node
  * @param {ComponentContext} context
  */
 export function IfBlock(node, context) {
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 
 	const consequent = /** @type {BlockStatement} */ (context.visit(node.consequent));
 
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/KeyBlock.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/KeyBlock.js
@@ -2,13 +2,14 @@
 /** @import { AST } from '#compiler' */
 /** @import { ComponentContext } from '../types' */
 import * as b from '../../../../utils/builders.js';
+import { push_template_quasi } from '../utils.js';
 
 /**
  * @param {AST.KeyBlock} node
  * @param {ComponentContext} context
  */
 export function KeyBlock(node, context) {
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 
 	const key = /** @type {Expression} */ (context.visit(node.expression));
 	const body = /** @type {Expression} */ (context.visit(node.fragment));
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/RegularElement.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/RegularElement.js
@@ -19,7 +19,12 @@ import {
 import * as b from '../../../../utils/builders.js';
 import { is_custom_element_node } from '../../../nodes.js';
 import { clean_nodes, determine_namespace_for_children } from '../../utils.js';
-import { build_getter } from '../utils.js';
+import {
+	build_getter,
+	can_inline_variable,
+	push_template_expression,
+	push_template_quasi
+} from '../utils.js';
 import {
 	get_attribute_name,
 	build_attribute_value,
@@ -53,7 +58,7 @@ export function RegularElement(node, context) {
 	}
 
 	if (node.name === 'noscript') {
-		context.state.template.push('<noscript></noscript>');
+		push_template_quasi(context.state, '<noscript></noscript>');
 		return;
 	}
 
@@ -67,7 +72,7 @@ export function RegularElement(node, context) {
 		namespace: determine_namespace_for_children(node, context.state.metadata.namespace)
 	};
 
-	context.state.template.push(`<${node.name}`);
+	push_template_quasi(context.state, `<${node.name}`);
 
 	/** @type {Array<AST.Attribute | AST.SpreadAttribute>} */
 	const attributes = [];
@@ -241,7 +246,8 @@ export function RegularElement(node, context) {
 				const value = is_text_attribute(attribute) ? attribute.value[0].data : true;
 
 				if (name !== 'class' || value) {
-					context.state.template.push(
+					push_template_quasi(
+						context.state,
 						` ${attribute.name}${
 							is_boolean_attribute(name) && value === true
 								? ''
@@ -278,7 +284,7 @@ export function RegularElement(node, context) {
 		context.state.after_update.push(b.stmt(b.call('$.replay_events', node_id)));
 	}
 
-	context.state.template.push('>');
+	push_template_quasi(context.state, '>');
 
 	/** @type {SourceLocation[]} */
 	const child_locations = [];
@@ -377,7 +383,7 @@ export function RegularElement(node, context) {
 	}
 
 	if (!is_void(node.name)) {
-		context.state.template.push(`</${node.name}>`);
+		push_template_quasi(context.state, `</${node.name}>`);
 	}
 }
 
@@ -465,7 +471,7 @@ function build_element_spread_attributes(
 				value.type === 'Literal' &&
 				context.state.metadata.namespace === 'html'
 			) {
-				context.state.template.push(` is="${escape_html(value.value, true)}"`);
+				push_template_quasi(context.state, ` is="${escape_html(value.value, true)}"`);
 				continue;
 			}
 
@@ -607,6 +613,13 @@ function build_element_attribute_update_assignment(element, node_id, attribute,
 		);
 	}
 
+	const { has_expression_tag, can_inline } =
+		attribute.value === true
+			? { has_expression_tag: false, can_inline: true }
+			: can_inline_all_nodes(
+					Array.isArray(attribute.value) ? attribute.value : [attribute.value],
+					context.state
+				);
 	if (attribute.metadata.expression.has_state) {
 		if (has_call) {
 			state.init.push(build_update(update));
@@ -615,11 +628,40 @@ function build_element_attribute_update_assignment(element, node_id, attribute,
 		}
 		return true;
 	} else {
-		state.init.push(update);
+		if (has_expression_tag && can_inline) {
+			push_template_quasi(context.state, ` ${name}="`);
+			push_template_expression(context.state, value);
+			push_template_quasi(context.state, '"');
+		} else {
+			state.init.push(update);
+		}
 		return false;
 	}
 }
 
+/**
+ * @param {(import('#compiler').Text | import('#compiler').ExpressionTag)[]} nodes
+ * @param {import('../types.js').ComponentClientTransformState} state
+ */
+function can_inline_all_nodes(nodes, state) {
+	let can_inline = true;
+	let has_expression_tag = false;
+	for (let value of nodes) {
+		if (value.type === 'ExpressionTag') {
+			if (value.expression.type === 'Identifier') {
+				const binding = state.scope
+					.owner(value.expression.name)
+					?.declarations.get(value.expression.name);
+				can_inline &&= can_inline_variable(binding);
+			} else {
+				can_inline = false;
+			}
+			has_expression_tag = true;
+		}
+	}
+	return { can_inline, has_expression_tag };
+}
+
 /**
  * Like `build_element_attribute_update_assignment` but without any special attribute treatment.
  * @param {Identifier}	node_id
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/RenderTag.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/RenderTag.js
@@ -3,13 +3,14 @@
 /** @import { ComponentContext } from '../types' */
 import { unwrap_optional } from '../../../../utils/ast.js';
 import * as b from '../../../../utils/builders.js';
+import { push_template_quasi } from '../utils.js';
 
 /**
  * @param {AST.RenderTag} node
  * @param {ComponentContext} context
  */
 export function RenderTag(node, context) {
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 	const callee = unwrap_optional(node.expression).callee;
 	const raw_args = unwrap_optional(node.expression).arguments;
 
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/SlotElement.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/SlotElement.js
@@ -2,6 +2,7 @@
 /** @import { AST } from '#compiler' */
 /** @import { ComponentContext } from '../types' */
 import * as b from '../../../../utils/builders.js';
+import { push_template_quasi } from '../utils.js';
 import { build_attribute_value } from './shared/element.js';
 
 /**
@@ -10,7 +11,7 @@ import { build_attribute_value } from './shared/element.js';
  */
 export function SlotElement(node, context) {
 	// <slot {a}>fallback</slot>  -->   $.slot($$slots.default, { get a() { .. } }, () => ...fallback);
-	context.state.template.push('<!>');
+	push_template_quasi(context.state, '<!>');
 
 	/** @type {Property[]} */
 	const props = [];
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/SvelteElement.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/SvelteElement.js
@@ -9,6 +9,7 @@ import {
 } from '../../../../utils/ast.js';
 import * as b from '../../../../utils/builders.js';
 import { determine_namespace_for_children } from '../../utils.js';
+import { push_template_quasi } from '../utils.js';
 import {
 	build_attribute_value,
 	build_class_directives,
@@ -21,7 +22,7 @@ import { build_render_statement, build_update } from './shared/utils.js';
  * @param {ComponentContext} context
  */
 export function SvelteElement(node, context) {
-	context.state.template.push(`<!>`);
+	push_template_quasi(context.state, `<!>`);
 
 	/** @type {Array<AST.Attribute | AST.SpreadAttribute>} */
 	const attributes = [];
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/shared/component.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/shared/component.js
diff --git a/packages/svelte/src/compiler/phases/3-transform/client/visitors/shared/fragment.js b/packages/svelte/src/compiler/phases/3-transform/client/visitors/shared/fragment.js
diff --git a/packages/svelte/tests/snapshot/samples/inline-module-vars/_expected/client/index.svelte.js b/packages/svelte/tests/snapshot/samples/inline-module-vars/_expected/client/index.svelte.js
diff --git a/packages/svelte/tests/snapshot/samples/inline-module-vars/_expected/server/index.svelte.js b/packages/svelte/tests/snapshot/samples/inline-module-vars/_expected/server/index.svelte.js
diff --git a/packages/svelte/tests/snapshot/samples/inline-module-vars/index.svelte b/packages/svelte/tests/snapshot/samples/inline-module-vars/index.svelte

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'svelte': patch
 +---
++
 +perf: inline module variables into template