All files / src/compiler/phases/3-transform/client/visitors/shared utils.js

100% Statements 273/273
96.22% Branches 51/53
100% Functions 10/10
100% Lines 265/265

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 2662x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 3240x 3240x 3240x 6774x 6774x 6774x 4587x 465x 465x 4587x 4327x 4327x 4587x 6774x 3240x 3240x 3240x 2x 2x 2x 2x 2x 2x 2x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 1797x 3827x 3827x 3827x 1264x 3827x 14x 14x 14x 2563x 2549x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 24x 2549x 932x 932x 932x 2522x 1593x 1593x 1617x 1617x 1617x 1617x 3827x 865x 1797x 2482x 2482x 865x 865x 865x 865x 865x 2x 2x 2x 2x 2x 1280x 1280x 1280x 1280x 1280x 2x 2x 2x 2x 2x 1283x 1283x 1283x 1283x 2x 2x 2x 2x 2x 2x 2x 200x 200x 200x 200x 200x 200x 200x 200x 14x 14x 14x 200x 200x 200x 2x 2x 2x 2x 2x 2x 2x 2x 2x 56x 56x 56x 56x 56x 2x 2x 2x 2x 2x 2x 2x 2x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 140x 140x 140x 140x 140x 130x 130x 140x 129x 139x 817x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 21x 817x 140x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 110x 29x 29x 29x 110x 110x 110x 110x 110x 110x 110x 110x 110x 2x 2x 2x 2x 2x 2x 2x 16x 16x 16x 16x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x  
/** @import { Expression, ExpressionStatement, Identifier, MemberExpression, Statement, Super } from 'estree' */
/** @import { AST, SvelteNode } from '#compiler' */
/** @import { ComponentClientTransformState } from '../../types' */
import { walk } from 'zimmerframe';
import { object } from '../../../../../utils/ast.js';
import * as b from '../../../../../utils/builders.js';
import { sanitize_template_string } from '../../../../../utils/sanitize_template_string.js';
import { regex_is_valid_identifier } from '../../../../patterns.js';
import { create_derived } from '../../utils.js';
import is_reference from 'is-reference';
import { locator } from '../../../../../state.js';
 
/**
 * @param {Array<AST.Text | AST.ExpressionTag>} values
 */
export function get_states_and_calls(values) {
	let states = 0;
	let calls = 0;
	for (let i = 0; i < values.length; i++) {
		const node = values[i];
 
		if (node.type === 'ExpressionTag') {
			if (node.metadata.expression.has_call) {
				calls++;
			}
			if (node.metadata.expression.has_state) {
				states++;
			}
		}
	}
 
	return { states, calls };
}
 
/**
 * @param {Array<AST.Text | AST.ExpressionTag>} values
 * @param {(node: SvelteNode, state: any) => any} visit
 * @param {ComponentClientTransformState} state
 */
export function build_template_literal(values, visit, state) {
	/** @type {Expression[]} */
	const expressions = [];
 
	let quasi = b.quasi('');
	const quasis = [quasi];
 
	const { states, calls } = get_states_and_calls(values);
 
	let has_call = calls > 0;
	let has_state = states > 0;
	let contains_multiple_call_expression = calls > 1;
 
	for (let i = 0; i < values.length; i++) {
		const node = values[i];
 
		if (node.type === 'Text') {
			quasi.value.cooked += node.data;
		} else if (node.type === 'ExpressionTag' && node.expression.type === 'Literal') {
			if (node.expression.value != null) {
				quasi.value.cooked += node.expression.value + '';
			}
		} else {
			if (contains_multiple_call_expression) {
				const id = b.id(state.scope.generate('stringified_text'));
				state.init.push(
					b.const(
						id,
						create_derived(
							state,
							b.thunk(
								b.logical(
									'??',
									/** @type {Expression} */ (visit(node.expression, state)),
									b.literal('')
								)
							)
						)
					)
				);
				expressions.push(b.call('$.get', id));
			} else if (values.length === 1) {
				// If we have a single expression, then pass that in directly to possibly avoid doing
				// extra work in the template_effect (instead we do the work in set_text).
				return { value: visit(node.expression, state), has_state, has_call };
			} else {
				expressions.push(b.logical('??', visit(node.expression, state), b.literal('')));
			}
 
			quasi = b.quasi('', i + 1 === values.length);
			quasis.push(quasi);
		}
	}
 
	for (const quasi of quasis) {
		quasi.value.raw = sanitize_template_string(/** @type {string} */ (quasi.value.cooked));
	}
 
	const value = b.template(quasis, expressions);
 
	return { value, has_state, has_call };
}
 
/**
 * @param {Statement} statement
 */
export function build_update(statement) {
	const body =
		statement.type === 'ExpressionStatement' ? statement.expression : b.block([statement]);
 
	return b.stmt(b.call('$.template_effect', b.thunk(body)));
}
 
/**
 * @param {Statement[]} update
 */
export function build_render_statement(update) {
	return update.length === 1
		? build_update(update[0])
		: b.stmt(b.call('$.template_effect', b.thunk(b.block(update))));
}
 
/**
 * For unfortunate legacy reasons, directive names can look like this `use:a.b-c`
 * This turns that string into a member expression
 * @param {string} name
 */
export function parse_directive_name(name) {
	// this allow for accessing members of an object
	const parts = name.split('.');
	let part = /** @type {string} */ (parts.shift());
 
	/** @type {Identifier | MemberExpression} */
	let expression = b.id(part);
 
	while ((part = /** @type {string} */ (parts.shift()))) {
		const computed = !regex_is_valid_identifier.test(part);
		expression = b.member(expression, computed ? b.literal(part) : b.id(part), computed);
	}
 
	return expression;
}
 
/**
 * @param {ComponentClientTransformState} state
 * @param {string} id
 * @param {Expression | undefined} init
 * @param {Expression} value
 * @param {ExpressionStatement} update
 */
export function build_update_assignment(state, id, init, value, update) {
	state.init.push(b.var(id, init));
	state.update.push(
		b.if(b.binary('!==', b.id(id), b.assignment('=', b.id(id), value)), b.block([update]))
	);
}
 
/**
 * Serializes `bind:this` for components and elements.
 * @param {Identifier | MemberExpression} expression
 * @param {Expression} value
 * @param {import('zimmerframe').Context<SvelteNode, ComponentClientTransformState>} context
 */
export function build_bind_this(expression, value, { state, visit }) {
	/** @type {Identifier[]} */
	const ids = [];
 
	/** @type {Expression[]} */
	const values = [];
 
	/** @type {string[]} */
	const seen = [];
 
	const transform = { ...state.transform };
 
	// Pass in each context variables to the get/set functions, so that we can null out old values on teardown.
	// Note that we only do this for each context variables, the consequence is that the value might be stale in
	// some scenarios where the value is a member expression with changing computed parts or using a combination of multiple
	// variables, but that was the same case in Svelte 4, too. Once legacy mode is gone completely, we can revisit this.
	walk(expression, null, {
		Identifier(node, { path }) {
			if (seen.includes(node.name)) return;
			seen.push(node.name);
 
			const parent = /** @type {Expression} */ (path.at(-1));
			if (!is_reference(node, parent)) return;
 
			const binding = state.scope.get(node.name);
			if (!binding) return;
 
			for (const [owner, scope] of state.scopes) {
				if (owner.type === 'EachBlock' && scope === binding.scope) {
					ids.push(node);
					values.push(/** @type {Expression} */ (visit(node)));
 
					if (transform[node.name]) {
						transform[node.name] = {
							...transform[node.name],
							read: (node) => node
						};
					}
 
					break;
				}
			}
		}
	});
 
	const child_state = { ...state, transform };
 
	const get = /** @type {Expression} */ (visit(expression, child_state));
	const set = /** @type {Expression} */ (
		visit(b.assignment('=', expression, b.id('$$value')), child_state)
	);
 
	// If we're mutating a property, then it might already be non-existent.
	// If we make all the object nodes optional, then it avoids any runtime exceptions.
	/** @type {Expression | Super} */
	let node = get;
 
	while (node.type === 'MemberExpression') {
		node.optional = true;
		node = node.object;
	}
 
	return b.call(
		'$.bind_this',
		value,
		b.arrow([b.id('$$value'), ...ids], set),
		b.arrow([...ids], get),
		values.length > 0 && b.thunk(b.array(values))
	);
}
 
/**
 * @param {ComponentClientTransformState} state
 * @param {AST.BindDirective} binding
 * @param {MemberExpression} expression
 */
export function validate_binding(state, binding, expression) {
	// If we are referencing a $store.foo then we don't need to add validation
	const left = object(binding.expression);
	const left_binding = left && state.scope.get(left.name);
	if (left_binding?.kind === 'store_sub') return;
 
	const loc = locator(binding.start);
 
	state.init.push(
		b.stmt(
			b.call(
				'$.validate_binding',
				b.literal(state.analysis.source.slice(binding.start, binding.end)),
				b.thunk(/** @type {Expression} */ (expression.object)),
				b.thunk(
					/** @type {Expression} */ (
						expression.computed
							? expression.property
							: b.literal(/** @type {Identifier} */ (expression.property).name)
					)
				),
				loc && b.literal(loc.line),
				loc && b.literal(loc.column)
			)
		)
	);
}