Skip to content

feat(nuxt): add ssr debug prompt with link #31968

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.

Sign up for GitHub

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

Jump to bottom
Open
CodeMan62 wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(nuxt): add ssr debug prompt with link #31968

CodeMan62 wants to merge 9 commits into from

Conversation

@CodeMan62
Copy link
Contributor

@CodeMan62 CodeMan62 commented May 1, 2025 •
edited by danielroe
Loading

🔗 Linked issue

resolves #21633

📚 Description

In this PR I am trying to add an ssr debug prompt whenever an error is encountered rendering a page with vite-node or nitro, so it will show a prompt in console or a special link that allows opening the page in browser with ssr: false (dev mode only) for debugging

@CodeMan62 CodeMan62 requested a review from danielroe as a code owner May 1, 2025 13:10
@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented May 1, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@github-actions github-actions bot added the 3.x label May 1, 2025
@coderabbitai
Copy link

coderabbitai bot commented May 1, 2025 •
edited
Loading

Walkthrough

This change introduces a development-only feature for debugging SSR (Server-Side Rendering) errors in Nuxt. A new middleware checks for the presence of a nuxt-no-ssr query parameter and sets a flag to disable SSR for that request. When an error occurs in development mode and is not a recursive SSR error, a debug prompt is displayed in the console with a link to reload the page with SSR disabled. Supporting utility and middleware files are added, and the middleware is conditionally registered during development. No changes are made to public API signatures.

📜 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 4f95177 and b139c38.

📒 Files selected for processing (2)
  • packages/nuxt/src/core/nitro.ts (1 hunks)
  • packages/nuxt/src/core/runtime/nitro/handlers/error.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/nuxt/src/core/runtime/nitro/handlers/error.ts
  • packages/nuxt/src/core/nitro.ts
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment

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 auto-generate unit tests to generate unit tests for 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.

@danielroe danielroe changed the title add ssr debug prompt with link feat(nuxt): add ssr debug prompt with link May 1, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented May 1, 2025 •
edited
Loading

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: b139c38

@codspeed-hq
Copy link

codspeed-hq bot commented May 1, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #31968 will not alter performance

Comparing CodeMan62:ssr-debug-prompt (b139c38) with main (d680c3f)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe added this to the 3.18 milestone May 13, 2025
@danielroe
Copy link
Member

danielroe commented Jun 27, 2025

This is looking great. I think I'm going to merge this into some work I plan to do to display errors on the client side with Youch, so I'll complete that first and then merge this PR (in case you're wondering on the status).

@danielroe danielroe modified the milestones: 3.18, 4.2 Sep 12, 2025
@danielroe danielroe mentioned this pull request Sep 29, 2025
Merged
5 tasks
@harlan-zw
Copy link
Contributor

harlan-zw commented Dec 17, 2025

It could be more integrated into existing error flows more but it does solve the problem, so I'd happily see it merged, nice work 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielroe danielroe Awaiting requested review from danielroe danielroe is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

3.x enhancement

Projects

None yet

Milestone

4.3

Development

Successfully merging this pull request may close these issues.

reload with ssr: false when a server error is encountered

3 participants

@CodeMan62 @danielroe @harlan-zw