fix(nuxt): return non-existent route component in RouteProvider #32266

danielroe · 2025-06-02T10:09:29Z

🔗 Linked issue

📚 Description

when rendering a nested child page that doesn't exist an undefined vnode might be passed to <RouteProvider>, leading to a long and unclear warning in the terminal. This directly returns the vnode in this case.

bolt-new-by-stackblitz · 2025-06-02T10:09:31Z

Run & review this pull request in StackBlitz Codeflow.

Copilot

Pull Request Overview

This PR updates the RouteProvider component to immediately return when the passed vnode prop is undefined, preventing unclear warnings in nested child pages that don't exist.

Made the vnode prop optional instead of required.
Added an early return guard for !props.vnode.
Ensures undefined vnodes are returned directly to avoid long warnings.

Comments suppressed due to low confidence (2)

packages/nuxt/src/app/components/route-provider.ts:47

There's no test covering the new branch where props.vnode is undefined. Consider adding a unit test to verify that the component returns without warning when vnode is missing.

if (!props.vnode) {

packages/nuxt/src/app/components/route-provider.ts:47

[nitpick] Returning props.vnode (undefined) from a render function could lead to ambiguous behavior. It may be clearer to return null or an explicit empty comment node to signal an intentional no-op render.

if (!props.vnode) {

Copilot · 2025-06-02T10:10:30Z

packages/nuxt/src/app/components/route-provider.ts

    route: {
      type: Object as () => RouteLocationNormalizedLoaded,
      required: true,
    },
+    vnode: Object as () => VNode,


The vnode prop is now optional but its definition lacks clarity. Consider using PropType<VNode | undefined> with an explicit required: false or default value to clearly communicate its optional nature.

coderabbitai · 2025-06-02T10:12:21Z

Walkthrough

The changes modify the defineRouteProvider component by making the vnode prop optional instead of required. In the render function, an early return was added to handle cases where props.vnode is falsy, preventing further rendering logic from executing. The rest of the render logic remains unchanged, still conditionally wrapping the vnode with a ref in development mode. No other component logic or structure was altered.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f910b3c and d4e16aa.

📒 Files selected for processing (1)

packages/nuxt/src/app/components/route-provider.ts (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: code

🔇 Additional comments (2)

packages/nuxt/src/app/components/route-provider.ts (2)

47-49: LGTM! Early return guard effectively handles falsy vnode cases.

The early return guard is a clean solution that addresses the PR objective. When props.vnode is falsy (undefined, null, etc.), returning it directly prevents the subsequent rendering logic from executing and should eliminate the unclear warning messages mentioned in the PR description.

The logic is sound:

Returns immediately for falsy vnode values

Maintains existing behaviour for truthy values

Preserves the development mode tracking functionality

13-13:
✅ Verification successful

Verify backwards compatibility for the breaking change.

Making the vnode prop optional is a breaking change that could affect existing consumers of this component. Whilst this change aligns with the PR objective to handle non-existent route components, ensure that all usages throughout the Nuxt codebase have been updated to handle the optional nature of this prop.

🏁 Script executed:
#!/bin/bash
# Description: Search for all usages of RouteProvider and defineRouteProvider to verify they handle optional vnode prop
# Expected: All usages should either provide vnode or handle undefined cases

echo "=== Searching for RouteProvider component usages ==="
rg -A 5 -B 2 "RouteProvider|defineRouteProvider" --type ts --type vue

echo -e "\n=== Searching for vnode prop usage patterns ==="
rg -A 3 -B 1 "vnode.*:" --type ts --type vue

echo -e "\n=== Checking for required vnode prop references ==="
rg "required.*true.*vnode|vnode.*required.*true" --type ts --type vue
Length of output: 619

🏁 Script executed:
#!/bin/bash
# Re-run searches without relying on ripgrep file-type definitions

echo "=== Searching for RouteProvider and defineRouteProvider usages ==="
rg -A5 -B2 "RouteProvider|defineRouteProvider" -g "*.ts" -g "*.js" -g "*.vue"

echo -e "\n=== Searching for vnode prop in component prop definitions ==="
rg "vnode\s*:" -g "*.ts" -g "*.js" -g "*.vue"

echo -e "\n=== Searching for vnode property accesses ==="
rg "\.vnode" -g "*.ts" -g "*.js" -g "*.vue"
Length of output: 7846
RouteProvider vnode prop usages validated — no internal breakage detected
All instances of RouteProvider/defineRouteProvider in the Nuxt codebase supply a vnode value, so making it optional does not introduce any internal breaking changes.

• defineRouteProvider is only consumed in packages/nuxt/src/pages/runtime/page.ts.
• Every h(RouteProvider, …) and h(PageRouteProvider, …) call passes a vnode property.
• No occurrences of RouteProvider without a vnode argument were found.

No further modifications are required for backwards compatibility.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

pkg-pr-new · 2025-06-02T10:13:13Z

Open in StackBlitz

@nuxt/kit

npm i https://pkg.pr.new/@nuxt/kit@32266

nuxt

npm i https://pkg.pr.new/nuxt@32266

@nuxt/rspack-builder

npm i https://pkg.pr.new/@nuxt/rspack-builder@32266

@nuxt/schema

npm i https://pkg.pr.new/@nuxt/schema@32266

@nuxt/vite-builder

npm i https://pkg.pr.new/@nuxt/vite-builder@32266

@nuxt/webpack-builder

npm i https://pkg.pr.new/@nuxt/webpack-builder@32266

commit: d4e16aa

codspeed-hq · 2025-06-02T10:23:41Z

CodSpeed Performance Report

Merging #32266 will not alter performance

_{Comparing fix/route-provider-null (d4e16aa) with main (f910b3c)}

Summary

✅ 10 untouched benchmarks

fix(nuxt): return non-existent route component directly in RouteProvider

d4e16aa

Copilot AI review requested due to automatic review settings June 2, 2025 10:09

github-actions bot added 3.x bug labels Jun 2, 2025

Copilot AI reviewed Jun 2, 2025

View reviewed changes

danielroe merged commit f7aadd5 into main Jun 2, 2025
47 checks passed

danielroe deleted the fix/route-provider-null branch June 2, 2025 10:33

github-actions bot mentioned this pull request Jun 2, 2025

v4.0.0 #27716

Draft

danielroe added a commit that referenced this pull request Jun 2, 2025

fix(nuxt): return non-existent route component in RouteProvider (#32266)

1463f2d

github-actions bot mentioned this pull request Jun 2, 2025

v3.17.5 #32188

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): return non-existent route component in RouteProvider #32266

fix(nuxt): return non-existent route component in RouteProvider #32266

Uh oh!

danielroe commented Jun 2, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Jun 2, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jun 2, 2025

Uh oh!

coderabbitai bot commented Jun 2, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 2, 2025

Uh oh!

codspeed-hq bot commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

fix(nuxt): return non-existent route component in RouteProvider #32266

fix(nuxt): return non-existent route component in RouteProvider #32266

Uh oh!

Conversation

danielroe commented Jun 2, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Jun 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Jun 2, 2025

Walkthrough

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jun 2, 2025

Uh oh!

codspeed-hq bot commented Jun 2, 2025

CodSpeed Performance Report

Merging #32266 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

CodeRabbit Configuration File (`.coderabbit.yaml`)