Skip to content

fix(nuxt): add sourcemap path transformation for client builds #32313

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 4 commits into from
Aug 4, 2025

Conversation

peterbud
Copy link
Contributor

@peterbud peterbud commented Jun 5, 2025

🔗 Linked issue

Resolves #32009

📚 Description

This change fixes the source map paths in client builds, to point them to the right sourcemaps.

My first contribution to this repo, pls check if I used the nuxt config dirs properly.

Question: should I add a test for checking the generated sourcemap content? I have seen that all fixtures have disabled sourcemaps, so maybe I need to add a new fixture? LMK!

@Copilot Copilot AI review requested due to automatic review settings June 5, 2025 21:15
@peterbud peterbud requested a review from danielroe as a code owner June 5, 2025 21:15
Copy link

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

Copy link

@Copilot 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.

Pull Request Overview

This PR ensures client build source maps point to the final output directory by transforming their paths.

  • Added sourcemapPathTransform to adjust source map paths from the temp build directory to .output/public.
  • Imported dirname and relative from pathe to compute the correct relative paths.
  • Used ctx.config.root! and ctx.nuxt.options.app.buildAssetsDir to locate the public assets directory.
Comments suppressed due to low confidence (3)

packages/vite/src/client.ts:181

  • [nitpick] The variable name newRelativePath is generic; consider renaming to outputRelativePath to clarify that this path targets the final output directory.
const newRelativePath = relative(

packages/vite/src/client.ts:175

  • Add unit tests covering sourcemapPathTransform for both relative and non-relative source paths to ensure correct behavior across different build scenarios.
sourcemapPathTransform (relativeSourcePath, sourcemapPath) {

packages/vite/src/client.ts:175

  • [nitpick] Include a JSDoc comment above sourcemapPathTransform describing its purpose, parameters, and return value to aid future maintainers.
sourcemapPathTransform (relativeSourcePath, sourcemapPath) {

Copy link

pkg-pr-new bot commented Jun 5, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 327afed

Copy link

coderabbitai bot commented Jun 5, 2025

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

A new function, sourcemapPathTransform, has been added to the Rollup output options within the client build configuration. This function modifies source map paths during the client build by transforming relative source paths to be relative to the final public build directory instead of the temporary client build directory. It resolves absolute paths based on the source map file location and then computes new relative paths from the final client output directory to these absolute paths. Absolute source paths are returned unchanged. The import statement from pathe is expanded to include dirname, isAbsolute, and relative functions. No changes were made to exported or public entity declarations; all modifications are internal to the buildClient function.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 2f3cd70 and 327afed.

📒 Files selected for processing (1)
  • packages/vite/src/client.ts (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/vite/src/client.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: code
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
    • Explain this complex logic.
    • 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 explain this code block.
  • 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 explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests 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

@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
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 42114f4 and 2f3cd70.

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

2-2: LGTM! Import statement correctly updated.

The import statement appropriately adds dirname and relative functions from the pathe module, which are used in the new sourcemap transformation logic below.

Copy link

codspeed-hq bot commented Jun 5, 2025

CodSpeed Performance Report

Merging #32313 will not alter performance

Comparing peterbud:32009 (327afed) with main (29afb8b)1

Summary

✅ 10 untouched benchmarks

Footnotes

  1. No successful run was found on main (9e63b3b) during the generation of this report, so 29afb8b was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@peterbud
Copy link
Contributor Author

peterbud commented Aug 1, 2025

Is there anything I can do to move this PR forward? Please let me know.

@danielroe danielroe merged commit fa6de58 into nuxt:main Aug 4, 2025
80 of 83 checks passed
@github-actions github-actions bot mentioned this pull request Aug 4, 2025
This was referenced Aug 5, 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.

Invalid relative paths in sourcemap "sources" under .output/public
2 participants