Skip to content
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

fix(14815): warn when an invalid <select multiple> value is given #14816

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

GauBen
Copy link
Contributor

@GauBen GauBen commented Dec 23, 2024

Before submitting the PR, please make sure you do the following

Emit a warning instead of crashing the runtime when an invalid value is provided

Closes #14815

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • Prefix your PR title with feat:, fix:, chore:, or docs:.
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.
  • If this PR changes code within packages/svelte/src, add a changeset (npx changeset).

Tests and linting

  • Run the tests with pnpm test and lint the project with pnpm lint

Copy link

changeset-bot bot commented Dec 23, 2024

🦋 Changeset detected

Latest commit: 6564b41

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
svelte Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Rich-Harris
Copy link
Member

preview: https://svelte-dev-git-preview-svelte-14816-svelte.vercel.app/

this is an automated message

Copy link
Contributor

Playground

pnpm add https://pkg.pr.new/svelte@14816

Copy link
Member

@paoloricciuti paoloricciuti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall is good...however we recently switched to let TS handle this kind of typing issues so maybe we can just prevent the fail without throwing the warning.

In this case it's a bit different tho because this will be a much more descriptive error... I'll let some other maintainer with more experience decide on this 😁

*/
function select_options(select, value) {
for (var option of select.options) {
// @ts-ignore
option.selected = ~value.indexOf(get_option_value(option));
option.selected = value.includes(get_option_value(option));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this has performance implications...I don't know why it was written this way tho

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want better (theoretical) performance, we should use neither .indexOf nor .includes (code will be O(select.options.length * value.length)) but rewrite it as

const values = new Set(value);
for (var option of select.options) {
  option.selected = values.has(get_option_value(option));
}

which is now O(select.options.length + value.length)

We'll see what perf addicts say of this 👀

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be the better choice... I'm just saying that it seems an odd change I would like whoever wrote that code opinion on 😁

* @param {HTMLSelectElement} select
* @param {V} value
* @param {unknown[]} value
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't make much sense to have a templated function that does not use nor restrict its type parameter, it can be replaced with any. Asking for unknown[] makes it more type-safe, // @ts-ignore is no longer required.

@GauBen
Copy link
Contributor Author

GauBen commented Dec 24, 2024

Thanks for the review @paoloricciuti!

For consistency, I'd say that <select multiple value={null / undefined}> should be accepted and ignored, like how other properties behave when given a nullish value. Regarding non-array values, TS can do the trick, we can hard-crash on them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

<select multiple value={123}> crashes the runtime
3 participants