fix(nuxt): show fatal errors thrown in middleware #31518

danielroe · 2025-03-24T14:17:28Z

🔗 Linked issue

resolves #22731

📚 Description

this handles two additional ways errors can be thrown in middleware - either directly returning a fatal error or throwing an error.

in either case this is checked for the fatal property (which triggers showing an error page). Otherwise the error is returned to vue router for handling there.

bolt-new-by-stackblitz · 2025-03-24T14:17:31Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-03-24T14:20:27Z

Walkthrough

The changes introduce improvements to error handling during middleware execution in the routing process. A new import, isNuxtError, is added from the #app/composables/error module. The middleware variable is explicitly typed as RouteMiddleware. The middleware execution is wrapped in a try-catch block to manage errors effectively; if an error occurs, a new error is created using createError(err). If this error is deemed fatal, the showError function is called to present the error. Furthermore, the result of the middleware execution is assessed; if it is an instance of isNuxtError and is fatal, the showError function is also invoked. These modifications enhance the robustness of error handling in middleware processing.

📜 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 b65f209 and 8fb2336.

📒 Files selected for processing (1)

test/bundle.test.ts (1 hunks)

🔇 Additional comments (1)

test/bundle.test.ts (1)

120-120: The bundle size increase is expected and reasonable.

The server bundle size has increased from 280k to 281k, which is a minimal 1KB increase. This aligns with the PR's objective of improving error handling for middleware, where the additional code for checking fatal errors and displaying appropriate error pages would naturally result in a slightly larger bundle size.

✨ 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.
- 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 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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

packages/nuxt/src/pages/runtime/plugins/router.ts (1)

215-215: Consider replacing the any type for better maintainability.
Using (r: any) => r.default || r may introduce uncertainty around the imported module type. Providing a more precise type instead of any will improve type safety and future refactoring.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f2124b3 and b65f209.

📒 Files selected for processing (1)

packages/nuxt/src/pages/runtime/plugins/router.ts (3 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

packages/nuxt/src/pages/runtime/plugins/router.ts (2)

packages/nuxt/src/app/composables/router.ts (1)

RouteMiddleware (45-47)

packages/nuxt/src/app/composables/error.ts (3)

createError (63-78)

showError (19-41)

isNuxtError (58-60)

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

GitHub Check: codeql (javascript-typescript)
GitHub Check: code

🔇 Additional comments (3)

packages/nuxt/src/pages/runtime/plugins/router.ts (3)

15-15: No issues with the new imports.
The additional imports for clearError, isNuxtError, showError and useError neatly align with the subsequent usage in this file’s error-handling flow and appear consistent with the PR’s objectives.

224-247: Logic for middleware result checking looks sound, but verify all return paths.
The checks for false and JavaScript Error objects effectively prevent navigation or show a 404. In line with Nuxt’s approach, returning true continues the chain, while returning a truthy value (e.g., a route) halts and redirects. Please ensure all return paths are tested to confirm expected behaviour in edge cases (e.g., thrown JavaScript errors vs. custom Nuxt errors).

248-252: Fatal error handling is properly segregated.
Catching errors and rethrowing them as fatal using showError aligns with the updated error-handling approach. Returning the error for non-fatal scenarios is consistent with the new logic. No further concerns.

pkg-pr-new · 2025-03-24T14:27:52Z

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 8fb2336

codspeed-hq · 2025-03-24T14:44:52Z

CodSpeed Performance Report

Merging #31518 will not alter performance

_{Comparing fix/middleware-errors (8fb2336) with main (f2124b3)}

Summary

✅ 10 untouched benchmarks

fix(nuxt): show fatal errors thrown in middleware

b65f209

danielroe requested a review from TheAlexLichter March 24, 2025 14:17

danielroe self-assigned this Mar 24, 2025

github-actions bot added 3.x bug labels Mar 24, 2025

[autofix.ci] apply automated fixes

8fb2336

coderabbitai bot reviewed Mar 24, 2025

View reviewed changes

danielroe merged commit 69c0d5d into main Mar 26, 2025
46 checks passed

danielroe deleted the fix/middleware-errors branch March 26, 2025 10:24

github-actions bot mentioned this pull request Mar 26, 2025

v4.0.0 #27716

Merged

danielroe added a commit that referenced this pull request Mar 26, 2025

fix(nuxt): show fatal errors thrown in middleware (#31518)

f9adf10

github-actions bot mentioned this pull request Mar 26, 2025

v3.16.2 #31463

Merged

Cheaterman mentioned this pull request Apr 14, 2025

Unable to render error from route middleware #22731

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): show fatal errors thrown in middleware #31518

fix(nuxt): show fatal errors thrown in middleware #31518

Uh oh!

danielroe commented Mar 24, 2025

Uh oh!

bolt-new-by-stackblitz bot commented Mar 24, 2025

Uh oh!

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

pkg-pr-new bot commented Mar 24, 2025

Uh oh!

codspeed-hq bot commented Mar 24, 2025

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

fix(nuxt): show fatal errors thrown in middleware #31518

fix(nuxt): show fatal errors thrown in middleware #31518

Uh oh!

Conversation

danielroe commented Mar 24, 2025

🔗 Linked issue

📚 Description

Uh oh!

bolt-new-by-stackblitz bot commented Mar 24, 2025

Uh oh!

coderabbitai bot commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Mar 24, 2025

Uh oh!

codspeed-hq bot commented Mar 24, 2025

CodSpeed Performance Report

Merging #31518 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

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

coderabbitai bot commented Mar 24, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)