Skip HTML comments during hydration #3771
Open
+16
−2
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📊 Tachometer Benchmark ResultsSummaryduration
usedJSHeapSize
Results02_replace1k
duration
usedJSHeapSize
run-warmup-0
run-warmup-1
run-warmup-2
run-warmup-3
run-warmup-4
run-final
03_update10th1k_x16
duration
usedJSHeapSize
07_create10k
duration
usedJSHeapSize
filter_list
duration
usedJSHeapSize
hydrate1k
duration
usedJSHeapSize
many_updates
duration
usedJSHeapSize
text_update
duration
usedJSHeapSize
todo
duration
usedJSHeapSize
|
|
Size Change: +137 B (0%) Total Size: 54.5 kB
ℹ️ View Unchanged
|
1 task
marvinhagemeister
requested review from
JoviDeCroock,
andrewiggins and
developit
developit
reviewed
Oct 17, 2022
| @@ -92,6 +92,7 @@ describe('hydrate()', () => { | |||
| scratch | |||
| ); | |||
| expect(scratch.innerHTML).to.equal('<p><i>0</i><b>1</b></p>'); | |||
| expect(getLog()).to.deep.equal(['Comment.remove()']); | |||
There was a problem hiding this comment.
It's strange that we end up removing the comment. I would have thought it would be skipped and ignored?
There was a problem hiding this comment.
IIUC, the comment will get removed in diffElementNodes here: https://github.com/preactjs/preact/blob/master/src/diff/index.js#L447-L451
There was a problem hiding this comment.
I assume for streaming we need to preserve these nodes until they are revived?
There was a problem hiding this comment.
Yeah. Ideally we would just walk over them and ignore, but I guess we need to do that in two places due to this being a new type of Node to deal with (vs skipped Text/Element nodes, which we always walk here)
There was a problem hiding this comment.
An alternative would be to special case a branch for selective hydration where we manually walk over the comment nodes as part of diff:
if (vnode.type === Island) {
// We know that island is surrounded with comment nodes
oldDom = oldDom.nextSibling
}Was thinking some more about comment nodes and I'm not sure how they would behave if we'd just skip over them. Imagine a scenario where we'll support selective hydration and have a non-hydrated subtree marked with comment nodes that is only activated when the user hovers with the mouse over the area or otherwise interacts with it. In that scenario we'd likely be rendering on the client already before all subtrees are hydrated.
This could have an effect on our ordering:
<div>
<A />
<B />
<NonHydrated />
<C />
</div>Now, if we render on the client and need to re-order nodes due to various conditional rendering, our skip comment logic would likely bias in favor of moving the comments at the end of the childNode list.
I'm wondering if that means that we'd need to move the comment node as part of NonHydrated here. That would ensure that the order is always correct.
developit
reviewed
Feb 24, 2023
| // in diff so that the vnode tree matches the DOM tree again. | ||
| do { | ||
| oldDom = oldDom.nextSibling; | ||
| } while (oldDom !== null && oldDom.nodeType === 8); |
There was a problem hiding this comment.
I wonder if it would be possible to use a similar (or the same somehow?) check to the one we have for node types here?
Lines 358 to 359 in de08e91
The other one knows what type it's looking for, so maybe it isn't possible? Just trying to think of ways to avoid checking the nodeType getter.
JoviDeCroock
force-pushed
the
comment-nodes
branch
from
b844b56
to
d128bf4
Compare
JoviDeCroock
force-pushed
the
comment-nodes
branch
from
d128bf4
to
d35efab
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We'd unnecessarily move nodes when the HTML we're going to hydrate contains comments. This is expected because it's sort of a mismatch between the SSR'd tree vs the virtual tree. But it turns out that this feature is needed for streaming SSR as comment nodes are used to indicate hydration boundaries.
Fixes #3767 .