Skip to content

fix(nuxt): account for app's base URL when reloading app in nuxt:chunk-reload-immediate #32382

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 2 commits into from
Jun 23, 2025

Conversation

DamianGlowala
Copy link
Member

🔗 Linked issue

resolves #32312

📚 Description

Takes into account app's base URL when reloading an app on chunk error/manifest update.

@Copilot Copilot AI review requested due to automatic review settings June 13, 2025 07:49
@DamianGlowala DamianGlowala requested a review from danielroe as a code owner June 13, 2025 07:49
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 updates the chunk reload plugin to factor in the application’s baseURL when rebuilding the reload path, ensuring the app reloads correctly on chunk errors or manifest updates.

  • Tracks the full RouteLocationNormalized object instead of just to.path
  • Introduces reloadAppAtPath to construct reload URLs using baseURL and handle hash navigation
  • Replaces the old reloadNuxtApp_ wrapper and updates hooks to use the new function
Comments suppressed due to low confidence (2)

packages/nuxt/src/app/plugins/chunk-reload-immediate.client.ts:20

  • The new reloadAppAtPath function’s logic for combining baseURL, fullPath, and hash handling isn’t covered by existing tests. Please add Vitest unit tests to validate URL construction under different baseURL and hash scenarios.
function reloadAppAtPath (to: RouteLocationNormalized) {

packages/nuxt/src/app/plugins/chunk-reload-immediate.client.ts:20

  • [nitpick] Add a JSDoc or inline comment above reloadAppAtPath explaining its purpose and detailing how it constructs the reload URL with baseURL and hash-based navigation for future maintainability.
function reloadAppAtPath (to: RouteLocationNormalized) {

Comment on lines 21 to 22
const isHash = 'href' in to && (to.href as string)[0] === '#'
const path = isHash ? config.app.baseURL + (to as any).href : joinURL(config.app.baseURL, to.fullPath)
Copy link
Preview

Copilot AI Jun 13, 2025

Choose a reason for hiding this comment

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

RouteLocationNormalized does not include an href property, so this check will always fail. Consider using to.hash (e.g. const isHash = to.hash.startsWith('#')) or inspecting to.fullPath to detect hash-based navigation.

Suggested change
const isHash = 'href' in to && (to.href as string)[0] === '#'
const path = isHash ? config.app.baseURL + (to as any).href : joinURL(config.app.baseURL, to.fullPath)
const isHash = to.hash && to.hash.startsWith('#')
const path = isHash ? config.app.baseURL + to.hash : joinURL(config.app.baseURL, to.fullPath)

Copilot uses AI. Check for mistakes.

Copy link

coderabbitai bot commented Jun 13, 2025

Walkthrough

The plugin has been updated to track the complete route object (RouteLocationNormalized) instead of only the path string during navigation events. A new helper function, reloadAppAtPath, has been introduced to manage reloading the application at a specified route. This function constructs the reload URL by joining the app's base URL from runtime config with the route's full path. Inline reload logic using path strings has been replaced by calls to this helper function, standardising the reload process. Additionally, conditional logic handling hash-prefixed hrefs in reload URLs was removed in favour of always joining the base URL with the full path. No changes were made to exported or public entity declarations.


📜 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 c4b1911 and 07a4640.

📒 Files selected for processing (2)
  • packages/nuxt/src/app/plugins/chunk-reload-immediate.client.ts (1 hunks)
  • packages/nuxt/src/app/plugins/chunk-reload.client.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/nuxt/src/app/plugins/chunk-reload.client.ts
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/nuxt/src/app/plugins/chunk-reload-immediate.client.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: code
  • GitHub Check: codeql (javascript-typescript)
  • GitHub Check: codeql (actions)
  • GitHub Check: build
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch fix/chunk-reload-immediate-path
  • Post Copyable Unit Tests in 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.
    • @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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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

pkg-pr-new bot commented Jun 13, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 07a4640

Copy link

codspeed-hq bot commented Jun 13, 2025

CodSpeed Performance Report

Merging #32382 will not alter performance

Comparing fix/chunk-reload-immediate-path (07a4640) with main (215fdbd)

Summary

✅ 10 untouched benchmarks

@OrbisK
Copy link
Collaborator

OrbisK commented Jun 13, 2025

@DamianGlowala I wonder it this can fix #31915 too?

@DamianGlowala
Copy link
Member Author

DamianGlowala commented Jun 13, 2025

@OrbisK as this PR introduces changes which take effect only behind an experimental flag, I am pretty confident it doesn't fix mentioned issue

UPDATE: #31915 is no longer relevant in latest Nuxt (v3.17.5)

@danielroe danielroe merged commit f99b7b0 into main Jun 23, 2025
117 of 120 checks passed
@danielroe danielroe deleted the fix/chunk-reload-immediate-path branch June 23, 2025 19:39
@github-actions github-actions bot mentioned this pull request Jun 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.

chunk-reload-immediate client composable does not take into account the base path, thus can reload and send users to a 404
3 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