Skip to content

fix(nuxt): allow scanning metadata from multiple files with same route#29969

Merged
danielroe merged 2 commits intomainfrom
fix/scan-meta
Nov 19, 2024
Merged

fix(nuxt): allow scanning metadata from multiple files with same route#29969
danielroe merged 2 commits intomainfrom
fix/scan-meta

Conversation

@danielroe
Copy link
Member

@danielroe danielroe commented Nov 19, 2024 •
edited by coderabbitai bot
Loading

🔗 Linked issue

resolves #29361

📚 Description

When scanning page metadata, if a given file was encountered more than once in the scanner, it was ignored the second time. This fix ensures that we do not ignore files we have encountered in the same 'scan'.

Summary by CodeRabbit

  • Refactor
    • Improved the structure and clarity of existing functions related to page augmentation and route handling.
    • Updated method signatures to enhance parameter organization and encapsulation.
  • Bug Fixes
    • Enhanced handling of route metadata extraction for better consistency.

@danielroe danielroe self-assigned this Nov 19, 2024
@bolt-new-by-stackblitz
Copy link

bolt-new-by-stackblitz bot commented Nov 19, 2024

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 19, 2024 •
edited
Loading

Walkthrough

The pull request modifies the resolvePagesRoutes and augmentPages functions in the packages/nuxt/src/pages/utils.ts file. Changes include a new structure for handling augmented pages through an AugmentPagesContext interface, which encapsulates properties like pagesToSkip and augmentedPages. The function signature for augmentPages has been updated accordingly, and the return value now reflects the context object instead of a direct set. These adjustments enhance the clarity of the code without introducing new functionality.

Changes

File Change Summary
packages/nuxt/src/pages/utils.ts Updated augmentPages function signature to accept AugmentPagesContext.
Introduced interface AugmentPagesContext for better parameter handling.
Modified logic in resolvePagesRoutes to use encapsulated pagesToSkip.
Changed return value of augmentPages to return ctx.augmentedPages.

Assessment against linked issues

Objective Addressed Explanation
Ensure page layouts function correctly after upgrade (Issue #29361) ❌ Changes do not address layout functionality issues.

Possibly related PRs

  • fix(nuxt): recompile templates on change events #29954: This PR modifies the build function in packages/nuxt/src/core/builder.ts, which may relate to the overall handling of templates and components, similar to the changes made in the augmentPages function in the main PR.
  • refactor(nuxt): define layouts as async vue components #29957: This PR involves changes to the LayoutLoader component in packages/nuxt/src/app/components/nuxt-layout.ts, which may connect to the handling of layout components and their loading, paralleling the structural changes in the augmentPages function in the main PR.

🐇 In the code, I hop and play,
With pages and routes, I find my way.
A context here, a structure bright,
Enhancing the flow, oh what a sight!
Through Nuxt I leap, with joy I sing,
For clarity and order, these changes bring! 🌟

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 87ed7d6 and d2764ac.

📒 Files selected for processing (1)
  • packages/nuxt/src/pages/utils.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/pages/utils.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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[bot]
coderabbitai bot reviewed Nov 19, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 02b57d4 and 87ed7d6.

📒 Files selected for processing (1)
  • packages/nuxt/src/pages/utils.ts (2 hunks)
🔇 Additional comments (3)
packages/nuxt/src/pages/utils.ts (3)

80-81: LGTM: Improved handling of duplicate page processing

The changes correctly prevent re-processing of already augmented pages while ensuring proper cleanup of the augmented pages set.

158-161: LGTM: Well-designed context interface

The AugmentPagesContext interface provides a clean and type-safe way to manage page processing state. Using Sets for tracking is an efficient choice for handling uniqueness.

162-179: LGTM: Improved page augmentation with state management

The changes effectively implement the tracking of processed pages while maintaining the core augmentation logic.

@danielroe danielroe requested a review from Copilot November 19, 2024 11:57
Copilot AI reviewed Nov 19, 2024
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

@danielroe danielroe merged commit e87f6d3 into main Nov 19, 2024
@danielroe danielroe deleted the fix/scan-meta branch November 19, 2024 12:00
@github-actions github-actions bot mentioned this pull request Nov 19, 2024
Merged
danielroe added a commit that referenced this pull request Nov 19, 2024
@danielroe
fix(nuxt): allow scanning metadata from 2+ files at same path (#29969)
cea11d5
This was referenced Nov 19, 2024
Merged
Closed
This was referenced Nov 22, 2024
Merged
Closed
Closed
@coderabbitai coderabbitai bot mentioned this pull request Dec 2, 2024
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@danielroe @Kamsou
fix(nuxt): allow scanning metadata from 2+ files at same path (nuxt#2…
19e2a12 
…9969)
@coderabbitai coderabbitai bot mentioned this pull request Jan 4, 2026
Closed
@coderabbitai coderabbitai bot mentioned this pull request Feb 13, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Copilot code review Copilot Copilot left review comments

Assignees

@danielroe danielroe

Labels

3.x bug 🔨 p3-minor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Page layout stopped working after upgrading nuxt from 3.11 to 3.13

2 participants

@danielroe