feat(vapor): hydration

[edison1105]

Compiler Changes

• SSR Compiler (@vue/compiler-ssr):
  • Modified to inject special comment anchors (e.g., <!--if-->, <!--for-->, <!--slot-->, <!--dynamic-component-->, <!--[[-->, <!--]]-->) into the server-rendered HTML output. These anchors are essential markers for the client-side hydration process.
• Vapor Compiler (@vue/compiler-vapor):
  • Updated transformChildren to create placeholder nodes (<!>) in the template string for each dynamic child, facilitating node matching during hydration.

Runtime Changes

• Hydration-Aware APIs (@vue/runtime-vapor):

  • Runtime functions like createIf, createFor, createDynamicComponent, and createSlot are now hydration-aware. They use the SSR anchors (identified by labels like IF_ANCHOR_LABEL, FOR_ANCHOR_LABEL, etc.) to locate and reuse corresponding DOM nodes rendered by the server.

• DOM Traversal (@vue/runtime-vapor/dom):

  • Introduced hydration-specific implementations for DOM traversal helpers (__child, __next, __nthChild). These versions intelligently skip over SSR comment anchors and insignificant text nodes to correctly find the target nodes for hydration.

  • Added enableHydrationNodeLookup and disableHydrationNodeLookup to switch between standard and hydration-specific traversal logic.

  • see benchmark for direct function call vs delegated function call

    benchmark result

    benchmark                   avg (min … max) p75 / p99    (min … top 1%)
    ------------------------------------------- -------------------------------
    direct function call         534.76 ps/iter   1.22 ns █                     !
                           (0.00 ps … 19.53 ns)   2.44 ns █         █          
                        (  0.00  b …   0.00  b)   0.00  b █▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁
    
    impl function call           536.44 ps/iter   1.22 ns █                     !
                           (0.00 ps … 21.97 ns)   2.44 ns █         █          
                        (  0.00  b …   0.00  b)   0.00  b █▁▁▁▁▁▁▁▁▁█▁▁▁▁▁▁▁▁▁▁
    
    summary
      direct function call
       1x faster than impl function call

• Core Runtime (@vue/runtime-core):

  • Enhanced the existing hydration.ts to recognize and correctly handle the hydration of Vapor components embedded within VDOM components.
  • Updated core hydration logic to skip Vapor-specific anchors during traversal.

• VDOM Interop (@vue/runtime-vapor/vdomInterop.ts):

  • Updated the interop plugin to support hydration when mixing VDOM and Vapor components. Ensures that VDOM components rendered within Vapor contexts, and vice-versa, are correctly hydrated.

• Shared Utilities (@vue/shared):

  • Added domAnchors.ts defining constants for the various anchor labels (e.g., IF_ANCHOR_LABEL, DYNAMIC_START_ANCHOR_LABEL) and utility functions (isVaporAnchors, isDynamicAnchor, isVaporFragmentAnchor) to identify these special comment nodes.

Tests

• Hydration Tests (runtime-vapor/__tests__/hydration.spec.ts):
  • Added extensive tests specifically for Vapor mode hydration, covering:
    • Basic text and element hydration.
    • Hydration of components (including fragment components, dynamic components).
    • Control flow directives (v-if, v-for).
    • slots and dynamic components (<component :is="...">).
    • Scenarios involving nested structures and adjacent dynamic nodes requiring dynamic anchors (<!--[[-->, <!--]]-->).
    • VDOM interop hydration scenarios.

NOTE

The following two PR changes have already been included in this PR

• fix(compiler-vapor): move next, child and nthChild before setInsertionState #13057
• fix(compiler-vapor): properly handle static ref in inline mode #13257

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for vapor-repl ready!

Name	Link
🔨 Latest commit	d776a26
🔍 Latest deploy log	https://app.netlify.com/sites/vapor-repl/deploys/6811c29be9c29e0008c327a1
😎 Deploy Preview	https://deploy-preview-13226--vapor-repl.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[pkg-pr-new]

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@13226

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@13226

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@13226

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@13226

@vue/compiler-vapor

npm i https://pkg.pr.new/@vue/compiler-vapor@13226

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@13226

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@13226

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@13226

@vue/runtime-vapor

npm i https://pkg.pr.new/@vue/runtime-vapor@13226

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@13226

@vue/shared

npm i https://pkg.pr.new/@vue/shared@13226

vue

npm i https://pkg.pr.new/vue@13226

@vue/compat

npm i https://pkg.pr.new/@vue/compat@13226

commit: d776a26