Skip to content

fix(nuxt): use node location instead of range for route meta property extraction #30447

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
Merged
merged 3 commits into from
Jan 4, 2025
Merged

fix(nuxt): use node location instead of range for route meta property extraction #30447

merged 3 commits into from
Jan 4, 2025

Conversation

cernymatej
Copy link
Member

@cernymatej cernymatej commented Jan 3, 2025 •
edited
Loading

🔗 Linked issue

fix #30445

📚 Description

This PR fixes an issue introduced in #30088, where the range property of the ESTree node was used to get the character locations, but ranges: true was no longer present in the parse options in the parseAndWalk function, with which the original parse function had been replaced.

The start and end properties should represent the same values, quote:

ranges: Nodes have their start and end characters offsets recorded in start and end properties (directly on the node, rather than the loc object, which holds line/column data. To also add a semi-standardized range property holding a [start, end] array with the same numbers, set the ranges optionto true.

source: https://github.com/acornjs/acorn/blob/master/acorn/README.md

@cernymatej cernymatej requested a review from danielroe as a code owner January 3, 2025 23:52
@bolt-new-by-stackblitz Bolt.new (by StackBlitz)
Copy link

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

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 3, 2025 •
edited
Loading

Warning

Rate limit exceeded

@cernymatej has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 55 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9847441 and 06f6501.

📒 Files selected for processing (1)
  • packages/nuxt/src/pages/utils.ts (4 hunks)

Walkthrough

The pull request introduces modifications to the getRouteMeta function in the Nuxt package's page utilities. The primary change involves incorporating the withLocations import from the ../core/utils/parse module to enhance metadata extraction capabilities. The updated implementation focuses on improving the precision of property value retrieval by capturing their start and end positions.

The modifications target the internal logic of metadata processing, specifically for handling ObjectExpression and ArrayExpression types. The new approach uses a propertyValue variable derived from withLocations, which allows for more robust metadata extraction. The function's core structure remains consistent, with refinements made to type checking and value extraction mechanisms.

The changes also include updates to the test cases for the getRouteMeta function, enhancing the validation of metadata extraction by incorporating additional properties and ensuring comprehensive coverage of various scenarios, including error handling.

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 Jan 4, 2025
View reviewed changes
Copy link

@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: 0

🧹 Nitpick comments (1)
packages/nuxt/test/page-metadata.test.ts (1)

85-89: Coverage of newly added metadata properties.
These lines add crucial properties (name, props, and alias) to the test, reflecting real-world usage. Make sure they are also validated in multiple scenarios, for instance a case where props is an empty object or alias is nil, to confirm consistent behaviour.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a78048a and 9847441.

📒 Files selected for processing (1)
  • packages/nuxt/test/page-metadata.test.ts (1 hunks)
🔇 Additional comments (4)
packages/nuxt/test/page-metadata.test.ts (4)

84-84: Good contextual comment for default extraction keys.
Thank you for clarifying why these keys are part of the default extraction. No action needed.

96-98: Verification of alias in snapshot.
The updated snapshot correctly includes the new alias array. This appears well-aligned with the intended metadata extraction logic.

101-101: Confirmation of extracted dynamic meta key usage.
Retaining both "props" and "meta" is consistent with the framework’s extraction mechanism. No issues found.

107-109: Validation of props: correct insertion into the output.
The props object is properly included in the final output, bolstering test coverage for complex metadata usage. Looks good.

@cernymatej
Merge branch 'main' into fix-route-meta-extraction
06f6501 
# Conflicts:
#	packages/nuxt/src/pages/utils.ts
@cernymatej
Copy link
Member Author

Should we consider changing withLocations to perform a runtime check instead of just type assert?

@danielroe danielroe merged commit b3ddc31 into nuxt:main Jan 4, 2025
45 checks passed
@github-actions github-actions bot mentioned this pull request Jan 4, 2025
Merged
@cernymatej cernymatej deleted the fix-route-meta-extraction branch January 4, 2025 21:17
danielroe pushed a commit that referenced this pull request Jan 4, 2025
@cernymatej @danielroe
fix(nuxt): use node location instead of range for route meta prop…
b00264c 
…erty extraction (#30447)
@github-actions github-actions bot mentioned this pull request Jan 4, 2025
Merged
Kamsou pushed a commit to Kamsou/nuxt that referenced this pull request Feb 5, 2025
@cernymatej @Kamsou
fix(nuxt): use node location instead of range for route meta prop…
8050492 
…erty extraction (nuxt#30447)
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

@danielroe danielroe danielroe approved these changes

Assignees
No one assigned
Labels
3.x bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[3.15.0] ERROR [unhandledRejection] Cannot read properties of undefined (reading '0')
2 participants
@cernymatej @danielroe
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