Skip to content

fix(nuxt): consider full path when de-duplicating routes #31849

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.

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

Merged
merged 1 commit into from
Apr 19, 2025

Conversation

Aareksio
Copy link
Contributor

@Aareksio Aareksio commented Apr 19, 2025

🔗 Linked issue

Resolves #31848

📚 Description

The de-duplication logic did not compute proper absolutePagePath. It was relative to the parent . This caused nested routes sharing common suffix to be treated as the same page, despite being different. The fix ensures we actually use absolute path.

Logs debug: { router: true }

# Before
<index>
├─ typed-pages
├─┬ typed-pages/parent1
│ └─┬ :param()
│   └─ items
└─┬ typed-pages/parent2
  └─ :param()
# After
<index>
├─ typed-pages
├─┬ typed-pages/parent1
│ └─┬ :param()
│   └─ items
└─┬ typed-pages/parent2
  └─┬ :param()
    └─ items

@Aareksio Aareksio requested a review from danielroe as a code owner April 19, 2025 14:39
Copy link

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

@Aareksio Aareksio changed the title fix(typed-routes): consider full path when de-duplicating routes fix(nuxt): consider full path when de-duplicating routes Apr 19, 2025
Copy link

coderabbitai bot commented Apr 19, 2025

Walkthrough

The changes modify the addPage function within the beforeWriteFiles hook in the typed router options of the Nuxt pages module. The function signature is updated to accept an additional optional parameter, basePath, which defaults to an empty string. The logic for determining the absolutePagePath is altered to concatenate basePath with page.path instead of using parent.path and page.path. Furthermore, when recursively invoking addPage for child pages, the current absolutePagePath is now passed as the new basePath argument. This adjustment affects how absolute paths for pages are constructed during the recursive process of adding pages. No other exported or public entities are changed outside of this function signature update.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 1a1432e and 0fc70c5.

📒 Files selected for processing (1)
  • packages/nuxt/src/pages/module.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: code
🔇 Additional comments (3)
packages/nuxt/src/pages/module.ts (3)

201-201: Function signature updated to fix route de-duplication logic.

The addition of an optional basePath parameter with a default empty string allows for correctly tracking the full absolute path during recursion, rather than just using paths relative to the parent route.


203-203: Fixed path concatenation for proper route de-duplication.

This change addresses the core issue by constructing the absolute page path using the explicit basePath instead of relying on the parent's path. This ensures that nested routes with common suffixes aren't incorrectly identified as duplicates.


229-229: Correctly passing the full absolute path to child routes.

Now passing the calculated absolutePagePath as the basePath parameter to child routes ensures that the complete path context is preserved in the nested route structure, which resolves the issue of incorrect route de-duplication.

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

Copy link

pkg-pr-new bot commented Apr 19, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 0fc70c5

Copy link

codspeed-hq bot commented Apr 19, 2025

CodSpeed Performance Report

Merging #31849 will not alter performance

Comparing Aareksio:fix/typed-routes-deduplicate-path (0fc70c5) with main (1a1432e)

Summary

✅ 10 untouched benchmarks

@danielroe danielroe merged commit c1080c7 into nuxt:main Apr 19, 2025
48 of 49 checks passed
@github-actions github-actions bot mentioned this pull request Apr 19, 2025
@github-actions github-actions bot mentioned this pull request Apr 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typed routes are not generated for some route names
2 participants
pFad - Phonifier reborn

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

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy