fix(nuxt): use name to index route providers in dev #31544

danielroe · 2025-03-26T13:35:12Z

🔗 Linked issue

resolves #31446

📚 Description

as proposed by @Mini-ghost, this uses the route name to index the route providers in development.

I've also moved the map out of the component setup function as the route provider component is only unique by name, and we also now only use it in the browser to avoid any memory issues on the server

bolt-new-by-stackblitz · 2025-03-26T13:35:15Z

Run & review this pull request in StackBlitz Codeflow.

coderabbitai · 2025-03-26T13:36:35Z

Walkthrough

This change introduces a new constant named _routeProviders, which is initialised as either a Map or a WeakMap based on the import.meta.dev flag. The refactoring removes the previous implementation that used a WeakMap called routerProviderLookup. The retrieval process for the PageRouteProvider has been updated. Instead of using the old lookup, it now checks _routeProviders using a key derived from the runtime flag. In client mode, if the provider does not exist in _routeProviders, a new provider is defined and then stored in this constant. This centralises the management and caching of route providers in one location while maintaining the original control flow.

📜 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 637c245 and 8e9ae54.

📒 Files selected for processing (1)

packages/nuxt/src/pages/runtime/page.ts (2 hunks)

🔇 Additional comments (3)

packages/nuxt/src/pages/runtime/page.ts (3)

34-35: Good approach using a Map in development mode and WeakMap in production

This change sensibly creates a constant outside the component definition to store route providers. Using a standard Map in development mode with names as keys (line 194) will preserve all route providers, making it more predictable for debugging. The WeakMap in production allows for garbage collection of unused route providers.

194-195: Effective indexing strategy based on environment

Using the component name as the key in development mode is a clever approach that aligns with the PR objective. This provides more stable references compared to using the component object itself, which helps prevent memory issues when components are recreated.

199-201: Client-side only caching prevents server memory issues

Good implementation of the client-only check before storing route providers. This ensures route providers are only stored in the browser environment, preventing potential memory leaks on the server side as mentioned in the PR description.

✨ 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 plan to trigger planning for file edits and PR creation.
@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-03-26T13:47:58Z

Open in Stackblitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 8e9ae54

codspeed-hq · 2025-03-26T13:59:56Z

CodSpeed Performance Report

Merging #31544 will not alter performance

_{Comparing fix/keepalive-hmr (8e9ae54) with main (637c245)}

Summary

✅ 10 untouched benchmarks

packages/nuxt/src/pages/runtime/page.ts

fix(nuxt): use name to index route providers in dev

8e9ae54

danielroe added bug vite labels Mar 26, 2025

danielroe requested a review from Mini-ghost March 26, 2025 13:35

danielroe self-assigned this Mar 26, 2025

github-actions bot added the 3.x label Mar 26, 2025

danielroe merged commit cd8e10c into main Mar 26, 2025
47 checks passed

danielroe deleted the fix/keepalive-hmr branch March 26, 2025 14:18

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

v4.0.0 #27716

Draft

Mini-ghost reviewed Mar 26, 2025

View reviewed changes

packages/nuxt/src/pages/runtime/page.ts Show resolved Hide resolved

packages/nuxt/src/pages/runtime/page.ts Show resolved Hide resolved

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

fix(nuxt): use name to index route providers in dev (#31544)

1db4dbe

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

v3.16.2 #31463

Merged

danielroe mentioned this pull request May 21, 2025

Nuxt 3.16.x breaks hot reloading when using nuxt-mapbox #31471

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(nuxt): use name to index route providers in dev #31544

fix(nuxt): use name to index route providers in dev #31544

Uh oh!

danielroe commented Mar 26, 2025

Uh oh!

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

Uh oh!

coderabbitai bot commented Mar 26, 2025

Chat

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 Mar 26, 2025

Uh oh!

codspeed-hq bot commented Mar 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

fix(nuxt): use name to index route providers in dev #31544

fix(nuxt): use name to index route providers in dev #31544

Uh oh!

Conversation

danielroe commented Mar 26, 2025

🔗 Linked issue

📚 Description

Uh oh!

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

Uh oh!

coderabbitai bot commented Mar 26, 2025

Walkthrough

Chat

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 Mar 26, 2025

Uh oh!

codspeed-hq bot commented Mar 26, 2025

CodSpeed Performance Report

Merging #31544 will not alter performance

Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

CodeRabbit Configuration File (`.coderabbit.yaml`)