make $capture_state/$inject_state act on entire state (#3822)

Previously, these methods only applied to exported props.

Also, add $$inject option to constructor, which injects state before
running the update loop.
pull/4449/head
rixo 5 years ago committed by GitHub
parent a53da7e4b0
commit cb64fb2ac9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -91,7 +91,10 @@ export default function dom(
const accessors = [];
const not_equal = component.component_options.immutable ? x`@not_equal` : x`@safe_not_equal`;
let dev_props_check; let inject_state; let capture_state;
let dev_props_check: Node[] | Node;
let inject_state: Expression;
let capture_state: Expression;
let props_inject: Node[] | Node;
props.forEach(prop => {
const variable = component.var_lookup.get(prop.name);
@ -164,27 +167,30 @@ export default function dom(
`;
}
capture_state = (uses_props || writable_props.length > 0) ? x`
() => {
return { ${component.vars.filter(prop => prop.writable).map(prop => p`${prop.name}`)} };
}
` : x`
() => {
return {};
}
`;
const capturable_vars = component.vars.filter(v => !v.internal && !v.name.startsWith('$$'));
const writable_vars = component.vars.filter(variable => !variable.module && variable.writable);
inject_state = (uses_props || writable_vars.length > 0) ? x`
${$$props} => {
${uses_props && renderer.invalidate('$$props', x`$$props = @assign(@assign({}, $$props), $$new_props)`)}
${writable_vars.map(prop => b`
if ('${prop.name}' in $$props) ${renderer.invalidate(prop.name, x`${prop.name} = ${$$props}.${prop.name}`)};
`)}
}
` : x`
${$$props} => {}
`;
if (capturable_vars.length > 0) {
capture_state = x`() => ({ ${capturable_vars.map(prop => p`${prop.name}`)} })`;
}
const injectable_vars = capturable_vars.filter(v => !v.module && v.writable && v.name[0] !== '$');
if (uses_props || injectable_vars.length > 0) {
inject_state = x`
${$$props} => {
${uses_props && renderer.invalidate('$$props', x`$$props = @assign(@assign({}, $$props), $$new_props)`)}
${injectable_vars.map(
v => b`if ('${v.name}' in $$props) ${renderer.invalidate(v.name, x`${v.name} = ${$$props}.${v.name}`)};`
)}
}
`;
props_inject = b`
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
`;
}
}
// instrument assignments
@ -246,7 +252,12 @@ export default function dom(
}
const args = [x`$$self`];
if (props.length > 0 || component.has_reactive_assignments || component.slots.size > 0) {
const has_invalidate = props.length > 0 ||
component.has_reactive_assignments ||
component.slots.size > 0 ||
capture_state ||
inject_state;
if (has_invalidate) {
args.push(x`$$props`, x`$$invalidate`);
}
@ -294,7 +305,9 @@ export default function dom(
uses_props ||
component.partly_hoisted.length > 0 ||
initial_context.length > 0 ||
component.reactive_declarations.length > 0
component.reactive_declarations.length > 0 ||
capture_state ||
inject_state
);
const definition = has_definition
@ -409,6 +422,8 @@ export default function dom(
${injected.map(name => b`let ${name};`)}
${/* before reactive declarations */ props_inject}
${reactive_declarations.length > 0 && b`
$$self.$$.update = () => {
${reactive_declarations}

@ -120,6 +120,10 @@ export class SvelteComponentDev extends SvelteComponent {
console.warn(`Component was already destroyed`); // eslint-disable-line no-console
};
}
$capture_state() {}
$inject_state() {}
}
export function loop_guard(timeout) {

@ -0,0 +1,5 @@
export default {
options: {
dev: true
}
};

@ -0,0 +1,197 @@
/* generated by Svelte vX.Y.Z */
import {
SvelteComponentDev,
add_location,
append_dev,
detach_dev,
dispatch_dev,
element,
init,
insert_dev,
noop,
safe_not_equal,
set_data_dev,
space,
subscribe,
text,
validate_store
} from "svelte/internal";
const file = undefined;
function create_fragment(ctx) {
let p;
let t0;
let t1;
let t2;
let t3;
let t4;
let t5;
let t6;
let t7;
let t8;
let t9;
let t10;
const block = {
c: function create() {
p = element("p");
t0 = text(/*prop*/ ctx[0]);
t1 = space();
t2 = text(/*realName*/ ctx[1]);
t3 = space();
t4 = text(/*local*/ ctx[3]);
t5 = space();
t6 = text(priv);
t7 = space();
t8 = text(/*$prop*/ ctx[2]);
t9 = space();
t10 = text(/*shadowedByModule*/ ctx[4]);
add_location(p, file, 22, 0, 430);
},
l: function claim(nodes) {
throw new Error("options.hydrate only works if the component was compiled with the `hydratable: true` option");
},
m: function mount(target, anchor) {
insert_dev(target, p, anchor);
append_dev(p, t0);
append_dev(p, t1);
append_dev(p, t2);
append_dev(p, t3);
append_dev(p, t4);
append_dev(p, t5);
append_dev(p, t6);
append_dev(p, t7);
append_dev(p, t8);
append_dev(p, t9);
append_dev(p, t10);
},
p: function update(ctx, [dirty]) {
if (dirty & /*prop*/ 1) set_data_dev(t0, /*prop*/ ctx[0]);
if (dirty & /*realName*/ 2) set_data_dev(t2, /*realName*/ ctx[1]);
if (dirty & /*$prop*/ 4) set_data_dev(t8, /*$prop*/ ctx[2]);
},
i: noop,
o: noop,
d: function destroy(detaching) {
if (detaching) detach_dev(p);
}
};
dispatch_dev("SvelteRegisterBlock", {
block,
id: create_fragment.name,
type: "component",
source: "",
ctx
});
return block;
}
let moduleLiveBinding;
const moduleContantProps = 4;
let moduleLet;
const moduleConst = 2;
let shadowedByModule;
const priv = "priv";
function instance($$self, $$props, $$invalidate) {
let $prop,
$$unsubscribe_prop = noop,
$$subscribe_prop = () => ($$unsubscribe_prop(), $$unsubscribe_prop = subscribe(prop, $$value => $$invalidate(2, $prop = $$value)), prop);
$$self.$$.on_destroy.push(() => $$unsubscribe_prop());
let { prop } = $$props;
validate_store(prop, "prop");
$$subscribe_prop();
let { alias: realName } = $$props;
let local;
let shadowedByModule;
const writable_props = ["prop", "alias"];
Object.keys($$props).forEach(key => {
if (!~writable_props.indexOf(key) && key.slice(0, 2) !== "$$") console.warn(`<Component> was created with unknown prop '${key}'`);
});
$$self.$set = $$props => {
if ("prop" in $$props) $$subscribe_prop($$invalidate(0, prop = $$props.prop));
if ("alias" in $$props) $$invalidate(1, realName = $$props.alias);
};
$$self.$capture_state = () => ({
moduleLiveBinding,
moduleContantProps,
moduleLet,
moduleConst,
shadowedByModule,
prop,
realName,
local,
priv,
shadowedByModule,
computed,
$prop
});
$$self.$inject_state = $$props => {
if ("prop" in $$props) $$subscribe_prop($$invalidate(0, prop = $$props.prop));
if ("realName" in $$props) $$invalidate(1, realName = $$props.realName);
if ("local" in $$props) $$invalidate(3, local = $$props.local);
if ("shadowedByModule" in $$props) $$invalidate(4, shadowedByModule = $$props.shadowedByModule);
if ("computed" in $$props) computed = $$props.computed;
};
let computed;
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
$: computed = local * 2;
return [prop, realName, $prop, local, shadowedByModule];
}
class Component extends SvelteComponentDev {
constructor(options) {
super(options);
init(this, options, instance, create_fragment, safe_not_equal, { prop: 0, alias: 1 });
dispatch_dev("SvelteRegisterComponent", {
component: this,
tagName: "Component",
options,
id: create_fragment.name
});
const { ctx } = this.$$;
const props = options.props || {};
if (/*prop*/ ctx[0] === undefined && !("prop" in props)) {
console.warn("<Component> was created without expected prop 'prop'");
}
if (/*realName*/ ctx[1] === undefined && !("alias" in props)) {
console.warn("<Component> was created without expected prop 'alias'");
}
}
get prop() {
throw new Error("<Component>: Props cannot be read directly from the component instance unless compiling with 'accessors: true' or '<svelte:options accessors/>'");
}
set prop(value) {
throw new Error("<Component>: Props cannot be set directly on the component instance unless compiling with 'accessors: true' or '<svelte:options accessors/>'");
}
get alias() {
throw new Error("<Component>: Props cannot be read directly from the component instance unless compiling with 'accessors: true' or '<svelte:options accessors/>'");
}
set alias(value) {
throw new Error("<Component>: Props cannot be set directly on the component instance unless compiling with 'accessors: true' or '<svelte:options accessors/>'");
}
}
export default Component;
export { moduleLiveBinding, moduleContantProps };

@ -0,0 +1,23 @@
<script context="module">
export let moduleLiveBinding;
export const moduleContantProps = 4;
let moduleLet;
const moduleConst = 2;
let shadowedByModule;
</script>
<script>
export let prop;
let realName;
export { realName as alias };
let local;
const priv = 'priv';
$: computed = local * 2;
let shadowedByModule;
</script>
<!-- NOTE $prop ensures store subscriptions are not part of captured state -->
<p>{prop} {realName} {local} {priv} {$prop} {shadowedByModule}</p>

@ -79,14 +79,16 @@ function instance($$self, $$props, $$invalidate) {
if ("name" in $$props) $$invalidate(0, name = $$props.name);
};
$$self.$capture_state = () => {
return { name };
};
$$self.$capture_state = () => ({ name });
$$self.$inject_state = $$props => {
if ("name" in $$props) $$invalidate(0, name = $$props.name);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
return [name];
}

@ -186,9 +186,7 @@ function instance($$self, $$props, $$invalidate) {
if ("baz" in $$props) $$invalidate(3, baz = $$props.baz);
};
$$self.$capture_state = () => {
return { things, foo, bar, baz };
};
$$self.$capture_state = () => ({ things, foo, bar, baz });
$$self.$inject_state = $$props => {
if ("things" in $$props) $$invalidate(0, things = $$props.things);
@ -197,6 +195,10 @@ function instance($$self, $$props, $$invalidate) {
if ("baz" in $$props) $$invalidate(3, baz = $$props.baz);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
return [things, foo, bar, baz];
}

@ -176,15 +176,17 @@ function instance($$self, $$props, $$invalidate) {
if ("foo" in $$props) $$invalidate(1, foo = $$props.foo);
};
$$self.$capture_state = () => {
return { things, foo };
};
$$self.$capture_state = () => ({ things, foo });
$$self.$inject_state = $$props => {
if ("things" in $$props) $$invalidate(0, things = $$props.things);
if ("foo" in $$props) $$invalidate(1, foo = $$props.foo);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
return [things, foo];
}

@ -47,19 +47,20 @@ function create_fragment(ctx) {
return block;
}
function instance($$self) {
function instance($$self, $$props, $$invalidate) {
let obj = { x: 5 };
let kobzol = 5;
$$self.$capture_state = () => {
return {};
};
$$self.$capture_state = () => ({ obj, kobzol });
$$self.$inject_state = $$props => {
if ("obj" in $$props) $$invalidate(0, obj = $$props.obj);
if ("kobzol" in $$props) $$invalidate(1, kobzol = $$props.kobzol);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
return [obj, kobzol];
}

@ -76,15 +76,17 @@ function instance($$self, $$props, $$invalidate) {
if ("foo" in $$props) $$invalidate(0, foo = $$props.foo);
};
$$self.$capture_state = () => {
return { foo, bar };
};
$$self.$capture_state = () => ({ foo, bar });
$$self.$inject_state = $$props => {
if ("foo" in $$props) $$invalidate(0, foo = $$props.foo);
if ("bar" in $$props) $$invalidate(1, bar = $$props.bar);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
$$self.$$.update = () => {
if ($$self.$$.dirty & /*foo*/ 1) {
$: $$invalidate(1, bar = foo * 2);

@ -108,14 +108,16 @@ function instance($$self, $$props, $$invalidate) {
});
}
$$self.$capture_state = () => {
return {};
};
$$self.$capture_state = () => ({ node, foo, console });
$$self.$inject_state = $$props => {
if ("node" in $$props) $$invalidate(0, node = $$props.node);
};
if ($$props && "$$inject" in $$props) {
$$self.$inject_state($$props.$$inject);
}
$: {
const guard_4 = loop_guard(100);

Loading…
Cancel
Save