-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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
Timing of cloning for the <selectedoption>
element
#10520
Comments
MutationObserver kind of uses microtask timing, but it uses a very special sort, with the compound microtasks. I wonder if the difference will be observable. I think it will, as it will set the "mutation observer microtask queued" agent-wide flag, which will impact the behavior of other web developer-created MutationObservers. |
+1 to microtask timing to avoid over-cloning To @domenic 's point, I wonder whether we should use a special type of observer with special microtask timing to minimize observable differences in mutation observers created by web developers. The "clone into The downside is that approach does introduce more complexity, both conceptually and implementation wise. But that might be safer from a web compat perspective. |
The over-cloning would happen only if one mutates the content of the selected option, no? The normal case is that user selects one option and the contents get cloned once. So CEReaction or even more synchronous cloning might not be too bad in this case. Microtasks were designed for MutationObserver, and the reason was to improve performance in cases when one does lots of DOM mutation all over the place. That is not quite the case here. svg:use, at least in Gecko, is re-cloned when needed when layout is flushed, but of course we don't want to expose layout flush timing. |
I think cloning would also need to happen if the select element APIs, ex. setting |
Chromium has already been using a regular MutationObserver to observe changes to child content in option elements, so I don't see how any behavior could be changed by re-purposing this MutationObserver to be used for
The prototype uses a synchronous mutation observer right now in chromium, and I think that the performance is quite bad because every dom mutation to any element in the whole tree requires us to start walking the dom tree to figure out if we need to update an option/selectedoption: https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/html/forms/html_selected_option_element.cc;l=27-32;drc=11e2d7ffa05a985a084057676f9c76c6e88018fa Using CEReaction sounds much better than synchronous, but I'm still inclined to just reuse MutationObserver the way it is. |
The fact that Chrome is violating the spec currently by causing web developer mutation observers to fire at times the spec says are not allowed doesn't seem like a good reason to introduce more such violations. |
If we created an alternate set of MutationObserver infrastructure for user-agent MutationObservers, would that resolve this issue? I'm trying to understand what it would mean for us to do CEReactions timing instead of microtask timing as well. Does it mean that all of the DOM algorithms that append nodes, remove nodes, or modify attributes would have a new step at the end of it to run user-agent MutationObservers? |
Yes.
In terms of observable effects, yes. In terms of how you would implement it, I think you'd add a step wherever https://html.spec.whatwg.org/#invoke-custom-element-reactions is called. (Click on the definition to see all call sites.) I'm not sure how much else of the CE reactions infrastructure we'd want to import... you'd probably need some sort of microtask timing backup for cases like contenteditable, similar to the backup element queue. |
Thanks! I will draft something to create an alternate set of MutationObserver infrastructure in the DOM spec.
I see, this sounds tricker than going with microtasks. I think we should go with microtasks instead of CEReactions for the following reasons:
This might be true, perhaps authors won't be doing lots of imperative modifications to an option element subtree - although we are enabling all sorts of new use cases with the customizable select proposal. Likewise, perhaps authors won't be needing to synchronously query the state of the updated DOM content in the selectedoption element, and if they need to, they can easily queue a microtask or rAF to do so. |
So to be clear the proposal is something like "any mutation to the selected option subtree queues a micro-task to re-clone the subtree, unless one is already queued", presumably? That seems fair, if we're fine with all the relevant weirdness that it causes. It might indeed be the less-bad option... |
Yes, that sounds correct |
This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39
This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39
This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5758741 Reviewed-by: Mason Freed <masonf@chromium.org> Commit-Queue: Joey Arhar <jarhar@chromium.org> Cr-Commit-Position: refs/heads/main@{#1337462}
This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5758741 Reviewed-by: Mason Freed <masonf@chromium.org> Commit-Queue: Joey Arhar <jarhar@chromium.org> Cr-Commit-Position: refs/heads/main@{#1337462}
This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5758741 Reviewed-by: Mason Freed <masonf@chromium.org> Commit-Queue: Joey Arhar <jarhar@chromium.org> Cr-Commit-Position: refs/heads/main@{#1337462}
…testonly Automatic update from web-platform-tests Improve <selectedoption> performance This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5758741 Reviewed-by: Mason Freed <masonf@chromium.org> Commit-Queue: Joey Arhar <jarhar@chromium.org> Cr-Commit-Position: refs/heads/main@{#1337462} -- wpt-commits: d32c223215aaa166fce5162b4f76d323e9d513e7 wpt-pr: 47467
…testonly Automatic update from web-platform-tests Improve <selectedoption> performance This patch improves the performance of <selectedoption> by replacing the SynchronousMutationObserver with the existing async MutationObserver in HTMLOptionElement. The change from sync to async impacts some tests. The timing is being discussed in a standards issue here: whatwg/html#10520 Fixed: 336844298 Change-Id: I9693de9cf35913e7daaebb364c4923dcd4a2dc39 Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5758741 Reviewed-by: Mason Freed <masonf@chromium.org> Commit-Queue: Joey Arhar <jarhar@chromium.org> Cr-Commit-Position: refs/heads/main@{#1337462} -- wpt-commits: d32c223215aaa166fce5162b4f76d323e9d513e7 wpt-pr: 47467
@smaug---- do you have any additional feedback? I'd like to get started on this, and I'd still prefer to use microtask timing. |
Are we also guarding the cloning on the element being connected? I could see synchronously working as well. Either way there will be some weirdness as this is novel behavior. |
Using microtasks for this does feel odd. One couldn't check the value of the select after modifying the selected option. And I don't understand "the performance is quite bad because every dom mutation to any element in the whole tree requires us to start walking the dom tree to figure out if we need to update an option/selectedoption". That sounds like some limitation in Blink. In Gecko we'd just observe changes at |
Not cloning when the element is disconnected sounds like a good idea to me.
If you were to serialize the contents of the
This was an issue with the initial implementation which did things synchronously. I'll try studying what the web-exposed MutationObserver does to see if there are any optimizations which could be rebuilt into a synchronous mutation observer. I do prefer doing it synchronously over CEReactions timing because figuring out how to make a new type of MutationObserver which operates at that timing sounds difficult to implement and very difficult to spec, but ideally I'd still use a normal MutationObserver with microtask timing. |
I've thought some more about this, and I think I understand how we could leverage CEReactions to only do one clone per script call to a DOM api which performs a mutation. I could create a special kind of MutationObserver which instead of queueing a microtask looks to see if there is a CE reactions stack present, and tells that CE reactions stack to "notify" this MutationObserver when it is popped. If there is no CE reactions stack present, then just clone synchronously. I wonder if this will be really slow when parsing though when the parser does one mutation at a time. Presumbaly there is no CE reactions stack present when we are just doing the initial parsing of the HTML for the document. I also wonder if using CEReactions like this is just an internal optimization to run clones less often and is functionally the same as just synchronously cloning every time, in which case we could make the spec a lot simpler and keep it in the DOM spec. Maybe doing anything with MutationObservers is also just an optimization, and we could just add steps to the insertion/removal/attributechange steps in the HTML spec to do the cloning when appropriate...? |
To add some more context to my last comment, here are some notes about how I'd want to implement this in blink: We have a "CEReactionsScope" class which is stack allocated by generated bindings code every time a method with the [CEReactions] IDL is called from script. It can be globally accessed by anything which wants to enqueue CE reactions stuff. In its destructor, which should be run right before the IDL method returns control back to script, it invokes reactions on a CustomElementReactionStack. In order to implement this cloning at CEReactions time, I'd want to identify DOM mutations which should trigger a cloning of the selected I'm not sure if the "CEReactionsScope" class has an equivalent thing that exists in the spec. I'm also not sure if we will always have a context available during HTML parsing. I can see that we create a CEReactionsScope when running CreateElement for a custom element and when the parser inserts elements. |
I'm not sure if CEReaction is any better (or worse) to synchronous cloning (and I think I'd implement this as synchronous cloning). Parsing is an interesting case. No matter what timing is used, cloning might need to happen several times, once for the first Still pondering issues around microtasks: |
Based on the WHATNOT discussion, I'm going to pursue synchronous cloning |
That was our original proposal (async mutation observer-like behavior), but WebKit and Gecko had some really good points about why that would be confusing to developers. We agree and that's why we changed to the new synchronous clone behavior. For example, in a modified version of your example: const div = document.createElement('div');
option.append(div);
select.querySelector(‘selectedoption’).firstChild.id === undefined;
div.setAttribute('id', 'whatever');
select.querySelector(‘selectedoption’).firstChild.id === ‘whatever’; The issue they rightly pointed out is that it’s confusing if changes to
I see how incrementally cloning individual modifications might be faster than just cloning the entire subtree of the option element. There’s also the chance that for common/small option elements, it might be slower to maintain such a “linked clone”, as compared to just doing a full-clone at discrete points in time. I'm also worried that this would also require us to watch for modifications inside the
In the case that the author is modifying the style attribute every frame inside an option element, and there isn’t a huge number of nodes inside the option, then cloning a few nodes within the option element doesn’t seem like a performance issue and is less than the cost of doing the rest of the rendering for the new style attribute. Maintaining references to the cloned nodes and handling what happens when the clones get modified in an unexpected way sounds like it could be more work, especially for common cases where cloning only happens when the user picks a new option. |
Right, but in the sync model, it's still very confusing. Developers are going to wonder why their custom element constructors are running eg four times per frame, due to a seemingly unrelated spinner animation in the option element. And why aren't their CSS animations working in the
This isn't just about performance, it's about reducing unexpected behaviour.
It wouldn't. The rule is simple: Mutations in the
Web platform features shouldn't be designed so they only make sense in what is assumed to be the "common case". This feature will live a loooooong time, and the "common case" may change. It's better to design a system that makes sense overall, rather than cut corners. |
This comment was marked as spam.
This comment was marked as spam.
@josepharhar I feel pretty strongly that synchronous clone of the whole subtree is a mistake. The platform doesn't do that today, and it cannot be polyfilled without monkey patching the entire DOM surface. It also has a huge number of caveats related to performance, losing state (ex. animated images, videos or canvas), running custom element callbacks, etc. It feels like going in the wrong direction if we just removed mutation events too. As a web developer the whole platform is based around batching too, so doing The userland API shape for something like this would be for |
If the driving force here is avoiding things that would be confusing to developers, here are the possible confusing things:
And let's put those against the proposals in this thread:
I don't think the proposed change in this issue (change from "Asynchronously re-clone everything" to "Synchronously re-clone everything") reduces developer confusion, it removes one bit of confusion whilst adding another that's as bad, if not worse, and definitely harder to spot. I don't think "this won't come up in 'common' usage" is a useful argument, as this whole change is being driven by the case where developers edit the content of the selected I don't think "State missing in "Changes are one-way" seems like an easy rule to discover/learn/teach. The only solution I see to "Changes are unexpectedly applied" is to clone synchronously, once, on The more I think about it, the more I think that could be the best way forward. It solves the "works without JS" case. It's really easy to understand. And its limitations, which only really surface when you're using JS to modify the content of the selected Here's where the idea of updating |
I think Jake's suggestion of cloning once synchronously when changing the selected option and then only recloning on an explicit method call on the Someday if the platform adds built in reconciliation we can make that opt in with a new attribute on |
Yeah. The remaining issue is when to clone during the initial setup of the element. All solutions there seem to require some kind of end tag listener in the parser, which is rather unfortunate. |
A hook for end tag parsing already exists in all major browsers: https://searchfox.org/mozilla-central/search?q=DoneAddingChildren&redirect=false There's also specs that depend on it, ex. which says:
|
That is a monkey patch if I've ever seen one. Geez. Anyway, I know it's possible, but that doesn't make it great. It's a complete mismatch with building up the tree using imperative APIs. |
I wasn't trying to point out it was possible, I was pointing out that spec'ing it increases interoperability since all the major browsers already use it across many features. I don't think the spec avoiding that hook when everyone needs it to implement the web makes sense. |
👋 coming from the blog
IMO this feels like a nice solution. I think if I was writing JS I'd rather discover it not automatically updating and handle calling For a none js use case it feels like it's adding a lot of complexity for something that might not be used much in the wild? Maybe syncing could be an opt-in attribute in the future if use cases come up? |
Cross posting another possibility. |
I was just going to ask why we are assuming the content of selectedoption should match what is in the option at all? Few dropdowns do this. For example, look at the dropdown that github provides when selecting the branch. I think it should be possible to specify a template tag used for the selectedoption, and pass in the textContent and value from the selected option, and make this our first practical example of template instantiation. A default template could be provided by the platform if none is provided. Has that been ruled out? |
Completely agree with the above. I'm surprised that Given the complex nature of implementing this, I'd be intereseted in a better explanation for the motivation for going this route |
It's similar to how
|
If you wanted the |
That's true. Each approach has its advantages and disadvantages. The disadvantages of the mirroring approach are:
Advantages of the mirroring approach vs a templating solution
There may be more pro's and con's to each approach that I'm missing, but those seem the most transparent. |
The motivation for this suggestion was to support rich behavior that involved event listeners and custom elements inside the select button, selectedoption, and/or options. However, given the proposed content model, it really looks like any kind of extra interactivity inside If that's the case, then I think just cloning/replacing on selection is fine and no sync'ing should occur by default. I'm ambivalent about adding I do think that if there is a way to do this, it shouldn't be possible to move or modify the children of |
Some examples are given here https://jakearchibald.com/2024/how-should-selectedoption-work/#but-what-if-the-selected-option-is-modified |
In general, it seems reasonable for devs to be responsible for updating the DOM in the Not sync'ing would be very different from the default |
We discussed this in openui and resolved on not observing/responding to mutations within the option element: openui/open-ui#825 (comment) I will update the PR to incorporate this. |
We still need to account for the initial parse somehow, tho, right? E.g. a large option with the parser yielding in the middle should probably still be cloned... |
I thought the resolution there was that cloning wouldn't happen until the end tag was parsed? |
Jake is correct. I'm not currently planning on adding any behavior which specifically accounts for or hooks into the yielding behavior of the parser. I added a step to clone the option into selectedoption (now called selectedcontent) at option end tag parsing here: #10633 The cloning will only occur if the newly appended option element is the selected option in a non-multiple select. This behavior is implemented in chromium: https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/html/parser/html_tree_builder.cc;l=2097-2112;drc=d9b7d6fc39b8525c84f5e97854d966f304291419 |
The end tag parsing cloning will clone when the newly appended option is selected. Since the first option always becomes the selected until others are added, this means that the first option will always be cloned. If another option is parsed and appended which has the selected attribute, then it will cause a second clone. |
I guess there are two options for the parsing case:
The first is better for incremental rendering, but will clone twice if there's an The second will only do one clone, but there won't be any clone until the whole Has this second option been considered and rejected, or not discussed? |
It has been discussed, also in this issue (#10520 (comment)) and during WHATNOT. I think I'd prefer to avoid it and let user know sooner that there is something in the select. |
What is the issue with the HTML Standard?
The
<selectedoption>
element is discussed more generally here, and this issue is for a topic which has been split out: w3c/csswg-drafts#10242When the author modifies content inside an
<option>
element, we will clone the contents of that<option>
into the<selectedoption>
, but the timing at which we do this cloning has not yet been decided.The timing will be web observable. For example, if the author modifies an option and then tries to query the layout of
<selectedoption>
, they will have to wait until the cloning happens.Some possible options for cloning timing are:
I think that we should do microtask timing because I am planning on using a MutationObserver internally to implement this, and MutationObserver already uses microtask timing: https://dom.spec.whatwg.org/#queue-a-mutation-observer-compound-microtask
If we diverge from microtask timing, we would have to make a special kind of mutationobserver that does different timing, right?
@emilio @smaug----
The text was updated successfully, but these errors were encountered: