Skip to content

feat: disallow fallback values with bindings in runes mode #9784

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.

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 2 commits into from
Dec 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/polite-ravens-study.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'svelte': patch
---

feat: disallow fallback values with bindings in runes mode
10 changes: 9 additions & 1 deletion packages/svelte/src/compiler/phases/3-transform/client/utils.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import * as b from '../../../utils/builders.js';
import { extract_paths, is_simple_expression } from '../../../utils/ast.js';
import { error } from '../../../errors.js';
import { PROPS_CALL_DEFAULT_VALUE, PROPS_IS_IMMUTABLE } from '../../../../constants.js';
import {
PROPS_CALL_DEFAULT_VALUE,
PROPS_IS_IMMUTABLE,
PROPS_IS_RUNES
} from '../../../../constants.js';

/**
* @template {import('./types').ClientTransformState} State
Expand Down Expand Up @@ -369,6 +373,10 @@ export function get_props_method(binding, state, name, default_value) {
flags |= PROPS_IS_IMMUTABLE;
}

if (state.analysis.runes) {
flags |= PROPS_IS_RUNES;
}

if (default_value) {
// To avoid eagerly evaluating the right-hand-side, we wrap it in a thunk if necessary
if (is_simple_expression(default_value)) {
Expand Down
3 changes: 2 additions & 1 deletion packages/svelte/src/constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ export const EACH_IS_ANIMATED = 1 << 4;
export const EACH_IS_IMMUTABLE = 1 << 6;

export const PROPS_IS_IMMUTABLE = 1;
export const PROPS_CALL_DEFAULT_VALUE = 1 << 1;
export const PROPS_IS_RUNES = 1 << 1;
export const PROPS_CALL_DEFAULT_VALUE = 1 << 2;

/** List of Element events that will be delegated */
export const DelegatedEvents = [
Expand Down
7 changes: 6 additions & 1 deletion packages/svelte/src/internal/client/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { DEV } from 'esm-env';
import { subscribe_to_store } from '../../store/utils.js';
import { EMPTY_FUNC, run_all } from '../common.js';
import { get_descriptor, get_descriptors, is_array } from './utils.js';
import { PROPS_CALL_DEFAULT_VALUE, PROPS_IS_IMMUTABLE } from '../../constants.js';
import { PROPS_CALL_DEFAULT_VALUE, PROPS_IS_IMMUTABLE, PROPS_IS_RUNES } from '../../constants.js';

export const SOURCE = 1;
export const DERIVED = 1 << 1;
Expand Down Expand Up @@ -1428,6 +1428,11 @@ export function prop_source(props_obj, key, flags, default_value) {
let value = props[key];
const should_set_default_value = value === undefined && default_value !== undefined;

if (update_bound_prop && default_value !== undefined && (flags & PROPS_IS_RUNES) !== 0) {
// TODO consolidate all these random runtime errors
throw new Error('Cannot use fallback values with bind:');
}

if (should_set_default_value) {
value =
// @ts-expect-error would need a cumbersome method overload to type this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,7 @@ export default test({
await btn?.click();

assert.htmlEqual(target.innerHTML, `<button>1</button><span>1</span>`);
}
},

error: `Cannot use fallback values with bind:`
});
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ export default test({
readonly:
readonlyWithDefault: 1
binding:
bindingWithDefault: 1
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>
Expand All @@ -20,27 +19,24 @@ export default test({
readonly: 0
readonlyWithDefault: 0
binding: 0
bindingWithDefault: 0
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings undefined:</p>
<p>
readonly:
readonlyWithDefault: 1
binding:
bindingWithDefault: 1
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings defined:</p>
<p>
readonly: 0
readonlyWithDefault: 0
binding: 0
bindingWithDefault: 0
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>
Expand All @@ -50,19 +46,13 @@ export default test({
readonly_undefined:
readonlyWithDefault_undefined:
binding_undefined:
bindingWithDefault_undefined:
readonly_defined: 0
readonlyWithDefault_defined: 0
binding_defined: 0
bindingWithDefault_defined: 0
bind_readonly_undefined:
bind_readonlyWithDefault_undefined: 1
bind_binding_undefined:
bind_bindingWithDefault_undefined: 1
bind_readonly_defined: 0
bind_readonlyWithDefault_defined: 0
bind_binding_defined: 0
bind_bindingWithDefault_defined: 0
</p>

<button>set everything to 10</button>
Expand Down Expand Up @@ -93,64 +83,54 @@ export default test({
`
<p>props undefined:</p>
<p>
readonly:
readonly:
readonlyWithDefault: 1
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>props defined:</p>
<p>
readonly: 0
readonlyWithDefault: 0
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings undefined:</p>
<p>
readonly:
readonlyWithDefault: 1
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings defined:</p>
<p>
readonly: 0
readonlyWithDefault: 0
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>
Main:
readonly_undefined:
readonlyWithDefault_undefined:
binding_undefined:
bindingWithDefault_undefined:
readonly_defined: 0
readonlyWithDefault_defined: 0
binding_defined: 0
bindingWithDefault_defined: 0
bind_readonly_undefined:
bind_readonlyWithDefault_undefined: 1
bind_binding_undefined:
bind_bindingWithDefault_undefined:
bind_readonly_defined: 0
bind_readonlyWithDefault_defined: 0
bind_binding_defined:
bind_bindingWithDefault_defined:
</p>

<button>set everything to 10</button>
<button>set everything to undefined</button>
`
Expand All @@ -169,61 +149,51 @@ export default test({
readonly:
readonlyWithDefault: 1
binding: 5
bindingWithDefault: 5
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>props defined:</p>
<p>
readonly: 0
readonlyWithDefault: 0
binding: 5
bindingWithDefault: 5
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings undefined:</p>
<p>
readonly:
readonlyWithDefault: 1
binding: 5
bindingWithDefault: 5
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings defined:</p>
<p>
readonly: 0
readonlyWithDefault: 0
binding: 5
bindingWithDefault: 5
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>
Main:
readonly_undefined:
readonlyWithDefault_undefined:
binding_undefined:
bindingWithDefault_undefined:
readonly_defined: 0
readonlyWithDefault_defined: 0
binding_defined: 0
bindingWithDefault_defined: 0
bind_readonly_undefined:
bind_readonlyWithDefault_undefined: 1
bind_binding_undefined: 5
bind_bindingWithDefault_undefined: 5
bind_readonly_defined: 0
bind_readonlyWithDefault_defined: 0
bind_binding_defined: 5
bind_bindingWithDefault_defined: 5
</p>

<button>set everything to 10</button>
<button>set everything to undefined</button>
`
Expand All @@ -239,61 +209,51 @@ export default test({
readonly: 10
readonlyWithDefault: 10
binding: 10
bindingWithDefault: 10
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>props defined:</p>
<p>
readonly: 10
readonlyWithDefault: 10
binding: 10
bindingWithDefault: 10
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings undefined:</p>
<p>
readonly: 10
readonlyWithDefault: 10
binding: 10
bindingWithDefault: 10
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings defined:</p>
<p>
readonly: 10
readonlyWithDefault: 10
binding: 10
bindingWithDefault: 10
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>
Main:
readonly_undefined: 10
readonlyWithDefault_undefined: 10
binding_undefined: 10
bindingWithDefault_undefined: 10
readonly_defined: 10
readonlyWithDefault_defined: 10
binding_defined: 10
bindingWithDefault_defined: 10
bind_readonly_undefined: 10
bind_readonlyWithDefault_undefined: 10
bind_binding_undefined: 10
bind_bindingWithDefault_undefined: 10
bind_readonly_defined: 10
bind_readonlyWithDefault_defined: 10
bind_binding_defined: 10
bind_bindingWithDefault_defined: 10
</p>

<button>set everything to 10</button>
<button>set everything to undefined</button>
`
Expand All @@ -309,61 +269,51 @@ export default test({
readonly:
readonlyWithDefault:
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>props defined:</p>
<p>
readonly:
readonlyWithDefault:
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings undefined:</p>
<p>
readonly:
readonlyWithDefault:
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>bindings defined:</p>
<p>
readonly:
readonlyWithDefault:
binding:
bindingWithDefault:
</p>
<button>set bindings to 5</button>
<button>set bindings to undefined</button>

<p>
Main:
readonly_undefined:
readonlyWithDefault_undefined:
binding_undefined:
bindingWithDefault_undefined:
readonly_defined:
readonlyWithDefault_defined:
binding_defined:
bindingWithDefault_defined:
bind_readonly_undefined:
bind_readonlyWithDefault_undefined:
bind_binding_undefined:
bind_bindingWithDefault_undefined:
bind_readonly_defined:
bind_readonlyWithDefault_defined:
bind_binding_defined:
bind_bindingWithDefault_defined:
</p>

<button>set everything to 10</button>
<button>set everything to undefined</button>
`
Expand Down
Loading