Skip to content

chore: simplify updates #10912

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
Mar 25, 2024
Merged

chore: simplify updates #10912

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
7 changes: 0 additions & 7 deletions packages/svelte/src/compiler/phases/3-transform/client/transform-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,6 @@ export function client_component(source, analysis, options) {
error(null, 'INTERNAL', 'update.push should not be called outside create_block');
return a;
},
get update_effects() {
/** @type {any[]} */
const a = [];
a.push = () =>
error(null, 'INTERNAL', 'update_effects.push should not be called outside create_block');
return a;
},
get after_update() {
/** @type {any[]} */
const a = [];
Expand Down
3 changes: 0 additions & 3 deletions packages/svelte/src/compiler/phases/3-transform/client/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,8 @@ export interface ComponentClientTransformState extends ClientTransformState {

/** Stuff that happens before the render effect(s) */
readonly init: Statement[];
/** Stuff that happens inside separate render effects (due to call expressions) */
readonly update_effects: Statement[];
/** Stuff that happens inside the render effect */
readonly update: {
init?: Statement;
/** If the update array only contains a single entry, this singular entry will be used, if present */
singular?: Statement;
/** Used if condition for singular prop is false (see comment above) */
Expand Down
97 changes: 19 additions & 78 deletions packages/svelte/src/compiler/phases/3-transform/client/visitors/template.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ function serialize_style_directives(style_directives, element_id, context, is_at
);

if (!is_attributes_reactive && contains_call_expression) {
state.update_effects.push(singular);
state.init.push(singular);
} else if (is_attributes_reactive || directive.metadata.dynamic || contains_call_expression) {
state.update.push({ grouped, singular });
} else {
Expand Down Expand Up @@ -153,7 +153,7 @@ function serialize_class_directives(class_directives, element_id, context, is_at
const contains_call_expression = directive.expression.type === 'CallExpression';

if (!is_attributes_reactive && contains_call_expression) {
state.update_effects.push(singular);
state.init.push(singular);
} else if (is_attributes_reactive || directive.metadata.dynamic || contains_call_expression) {
state.update.push({ grouped, singular });
} else {
Expand Down Expand Up @@ -326,11 +326,11 @@ function serialize_element_spread_attributes(
// objects could contain reactive getters -> play it safe and always assume spread attributes are reactive
if (needs_isolation) {
if (needs_select_handling) {
context.state.update_effects.push(
context.state.init.push(
b.stmt(b.call('$.render_effect', b.arrow([], b.block([inside_effect]))))
);
} else {
context.state.update_effects.push(standalone);
context.state.init.push(standalone);
}
} else {
context.state.update.push({
Expand Down Expand Up @@ -408,7 +408,7 @@ function serialize_dynamic_element_attributes(attributes, context, element_id) {
);

if (needs_isolation) {
context.state.update_effects.push(isolated);
context.state.init.push(isolated);
return false;
} else if (is_reactive) {
const id = context.state.scope.generate('spread_attributes');
Expand Down Expand Up @@ -710,7 +710,7 @@ function serialize_update_assignment(state, id, init, value, assignment, contain
);

if (contains_call_expression && assignment.singular) {
state.update_effects.push(assignment.singular);
state.init.push(assignment.singular);
} else {
if (assignment.skip_condition) {
if (assignment.singular) {
Expand All @@ -719,21 +719,21 @@ function serialize_update_assignment(state, id, init, value, assignment, contain
grouped: assignment.grouped
});
} else {
state.init.push(b.var(id, init));
state.update.push({
init: b.var(id, init),
grouped
});
}
} else {
if (assignment.singular) {
state.init.push(b.var(id, init));
state.update.push({
init: b.var(id, init),
singular: assignment.singular,
grouped
});
} else {
state.init.push(b.var(id, init));
state.update.push({
init: b.var(id, init),
grouped
});
}
Expand Down Expand Up @@ -1132,7 +1132,6 @@ function create_block(parent, name, nodes, context) {
...context.state,
init: [],
update: [],
update_effects: [],
after_update: [],
template: [],
metadata: {
Expand Down Expand Up @@ -1241,32 +1240,8 @@ function create_block(parent, name, nodes, context) {
body.push(...state.init);
}

if (state.update.length > 0 || state.update_effects.length > 0) {
/** @type {import('estree').Statement | undefined} */
let update;

if (state.update_effects.length > 0) {
for (const render of state.update_effects) {
if (!update) {
update = render;
}
body.push(render);
}
}
if (state.update.length > 0) {
const render = serialize_render_stmt(state, body);
if (!update) {
update = render;
}
body.push(render);
}

/** @type {import('estree').Statement} */ (update).leadingComments = [
{
type: 'Block',
value: ` Update `
}
];
if (state.update.length > 0) {
body.push(serialize_render_stmt(state));
}

body.push(...state.after_update);
Expand All @@ -1284,15 +1259,6 @@ function create_block(parent, name, nodes, context) {
body.push(close);
}

if (body[0]) {
body[0].leadingComments = [
{
type: 'Block',
value: ` Init `
}
];
}

return body;
}

Expand All @@ -1316,30 +1282,13 @@ function get_template_function(namespace, state) {
/**
*
* @param {import('../types.js').ComponentClientTransformState} state
* @param {import('estree').Statement[]} body
*/
function serialize_render_stmt(state, body) {
let render;
function serialize_render_stmt(state) {
if (state.update.length === 1 && state.update[0].singular) {
render = state.update[0].singular;
} else {
render = b.stmt(
b.call(
'$.render_effect',
b.thunk(
b.block(
state.update.map((n) => {
if (n.init) {
body.push(n.init);
}
return n.grouped;
})
)
)
)
);
return state.update[0].singular;
}
return render;

return b.stmt(b.call('$.render_effect', b.thunk(b.block(state.update.map((n) => n.grouped)))));
}

/**
Expand Down Expand Up @@ -1573,7 +1522,7 @@ function process_children(nodes, expression, is_element, { visit, state }) {
);

if (node.metadata.contains_call_expression && !within_bound_contenteditable) {
state.update_effects.push(singular);
state.init.push(singular);
} else if (node.metadata.dynamic && !within_bound_contenteditable) {
state.update.push({
singular,
Expand Down Expand Up @@ -1615,7 +1564,7 @@ function process_children(nodes, expression, is_element, { visit, state }) {
const singular = b.stmt(b.call('$.text_effect', text_id, b.thunk(assignment)));

if (contains_call_expression && !within_bound_contenteditable) {
state.update_effects.push(singular);
state.init.push(singular);
} else if (
sequence.some((node) => node.type === 'ExpressionTag' && node.metadata.dynamic) &&
!within_bound_contenteditable
Expand Down Expand Up @@ -2214,7 +2163,6 @@ export const template_visitors = {
node: element_id,
init: [],
update: [],
update_effects: [],
after_update: []
}
};
Expand Down Expand Up @@ -2259,15 +2207,8 @@ export const template_visitors = {

/** @type {import('estree').Statement[]} */
const inner = inner_context.state.init;
if (inner_context.state.update.length > 0 || inner_context.state.update_effects.length > 0) {
if (inner_context.state.update_effects.length > 0) {
for (const render of inner_context.state.update_effects) {
inner.push(render);
}
}
if (inner_context.state.update.length > 0) {
inner.push(serialize_render_stmt(inner_context.state, inner));
}
if (inner_context.state.update.length > 0) {
inner.push(serialize_render_stmt(inner_context.state));
}
inner.push(...inner_context.state.after_update);
inner.push(
Expand Down
3 changes: 1 addition & 2 deletions packages/svelte/tests/snapshot/samples/bind-this/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ export default function Bind_this($$anchor, $$props) {
$.push($$props, false);
$.init();

/* Init */
var fragment = $.comment($$anchor);
var node = $.first_child(fragment);

$.bind_this(Foo(node, {}), ($$value) => foo = $$value, () => foo);
$.close_frag($$anchor, fragment);
$.pop();
}
}
19 changes: 10 additions & 9 deletions ...s/svelte/tests/snapshot/samples/dynamic-attributes-casing/_expected/client/main.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,24 @@ export default function Main($$anchor, $$props) {
// needs to be a snapshot test because jsdom does auto-correct the attribute casing
let x = 'test';
let y = () => 'test';
/* Init */
var fragment = $.open_frag($$anchor, frag, false);
var div = $.first_child(fragment);
var div_foobar;
var svg = $.sibling($.sibling(div, true));
var svg_viewBox;
var custom_element = $.sibling($.sibling(svg, true));
var custom_element_fooBar;
var div_1 = $.sibling($.sibling(custom_element, true));
var svg_1 = $.sibling($.sibling(div_1, true));
var custom_element_1 = $.sibling($.sibling(svg_1, true));

/* Update */
$.attr_effect(div_1, "foobar", y);

var svg_1 = $.sibling($.sibling(div_1, true));

$.attr_effect(svg_1, "viewBox", y);
$.set_custom_element_data_effect(custom_element_1, "fooBar", y);

var div_foobar;
var svg_viewBox;
var custom_element_fooBar;
var custom_element_1 = $.sibling($.sibling(svg_1, true));

$.set_custom_element_data_effect(custom_element_1, "fooBar", y);

$.render_effect(() => {
if (div_foobar !== (div_foobar = x)) {
Expand All @@ -45,4 +46,4 @@ export default function Main($$anchor, $$props) {

$.close_frag($$anchor, fragment);
$.pop();
}
}
5 changes: 1 addition & 4 deletions packages/svelte/tests/snapshot/samples/each-string-template/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export default function Each_string_template($$anchor, $$props) {
$.push($$props, false);
$.init();

/* Init */
var fragment = $.comment($$anchor);
var node = $.first_child(fragment);

Expand All @@ -16,10 +15,8 @@ export default function Each_string_template($$anchor, $$props) {
() => ['foo', 'bar', 'baz'],
1,
($$anchor, thing, $$index) => {
/* Init */
var text = $.space_frag($$anchor);

/* Update */
$.text_effect(text, () => `${$.stringify($.unwrap(thing))}, `);
return $.close($$anchor, text);
},
Expand All @@ -28,4 +25,4 @@ export default function Each_string_template($$anchor, $$props) {

$.close_frag($$anchor, fragment);
$.pop();
}
}
5 changes: 1 addition & 4 deletions ...es/svelte/tests/snapshot/samples/function-prop-no-getter/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ export default function Function_prop_no_getter($$anchor, $$props) {
}

const plusOne = (num) => num + 1;
/* Init */
var fragment = $.comment($$anchor);
var node = $.first_child(fragment);

Expand All @@ -22,15 +21,13 @@ export default function Function_prop_no_getter($$anchor, $$props) {
onmouseup,
onmouseenter: () => $.set(count, $.proxy(plusOne($.get(count)))),
children: ($$anchor, $$slotProps) => {
/* Init */
var text = $.space_frag($$anchor);

/* Update */
$.text_effect(text, () => `clicks: ${$.stringify($.get(count))}`);
return $.close($$anchor, text);
}
});

$.close_frag($$anchor, fragment);
$.pop();
}
}
3 changes: 1 addition & 2 deletions packages/svelte/tests/snapshot/samples/hello-world/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ export default function Hello_world($$anchor, $$props) {
$.push($$props, false);
$.init();

/* Init */
var h1 = $.open($$anchor, frag);

$.close($$anchor, h1);
$.pop();
}
}
3 changes: 1 addition & 2 deletions packages/svelte/tests/snapshot/samples/state-proxy-literal/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ export default function State_proxy_literal($$anchor, $$props) {

let str = $.source('');
let tpl = $.source(``);
/* Init */
var fragment = $.open_frag($$anchor, frag);
var input = $.first_child(fragment);

Expand All @@ -36,4 +35,4 @@ export default function State_proxy_literal($$anchor, $$props) {
$.pop();
}

$.delegate(["click"]);
$.delegate(["click"]);
3 changes: 1 addition & 2 deletions packages/svelte/tests/snapshot/samples/svelte-element/_expected/client/index.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ export default function Svelte_element($$anchor, $$props) {
$.push($$props, true);

let tag = $.prop($$props, "tag", 3, 'hr');
/* Init */
var fragment = $.comment($$anchor);
var node = $.first_child(fragment);

$.element(node, tag, false);
$.close_frag($$anchor, fragment);
$.pop();
}
}