Skip to content

Conversation

huang-julien
Copy link
Member

🔗 Linked issue

fix #32637

📚 Description

This PR makes nuxtisland use joinURL instead of cosntructing the URL with new URL which removes any base path from the provided remote source

@huang-julien huang-julien requested a review from danielroe as a code owner July 26, 2025 16:12
Copy link

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

Copy link

pkg-pr-new bot commented Jul 26, 2025

Open in StackBlitz

@nuxt/kit

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

nuxt

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

@nuxt/rspack-builder

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

@nuxt/schema

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

@nuxt/vite-builder

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

@nuxt/webpack-builder

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

commit: 1424422

Copy link

coderabbitai bot commented Jul 26, 2025

Walkthrough

The changes update the URL construction logic in the Nuxt Island component by replacing the use of the URL constructor with the joinURL utility when generating fetch URLs for remote component islands. This affects how URLs are assembled when a source prop is provided. In the test suite, a new test is added to verify correct URL handling with a base path, and existing client component tests are modified to remove data-island-uid attributes from HTML snapshots using a newly introduced helper function. The helper function is appended to the test file, and snapshots are updated accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes


📜 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 2f7d45b and 1424422.

📒 Files selected for processing (2)
  • packages/nuxt/src/app/components/nuxt-island.ts (1 hunks)
  • test/nuxt/nuxt-island.test.ts (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{ts,tsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Follow standard TypeScript conventions and best practices

Files:

  • packages/nuxt/src/app/components/nuxt-island.ts
  • test/nuxt/nuxt-island.test.ts
**/*.{test,spec}.{ts,tsx,js,jsx}

📄 CodeRabbit Inference Engine (.github/copilot-instructions.md)

Write unit tests for core functionality using vitest

Files:

  • test/nuxt/nuxt-island.test.ts
🧠 Learnings (3)
📓 Common learnings
Learnt from: huang-julien
PR: nuxt/nuxt#29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In `packages/nuxt/src/app/components/nuxt-root.vue`, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

```js
const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null
```

instead of wrapping the import in a computed property or importing the component unconditionally.
Learnt from: GalacticHypernova
PR: nuxt/nuxt#26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In `packages/nuxt/src/components/plugins/loader.ts`, the references to `resolve` and `distDir` are legacy code from before Nuxt used the new unplugin VFS and will be removed.
Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/e2e/**/*.{ts,js} : Write end-to-end tests using Playwright and `@nuxt/test-utils`
packages/nuxt/src/app/components/nuxt-island.ts (2)

Learnt from: huang-julien
PR: #29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In packages/nuxt/src/app/components/nuxt-root.vue, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: GalacticHypernova
PR: #26468
File: packages/nuxt/src/components/plugins/loader.ts:24-24
Timestamp: 2024-11-05T15:22:54.759Z
Learning: In packages/nuxt/src/components/plugins/loader.ts, the references to resolve and distDir are legacy code from before Nuxt used the new unplugin VFS and will be removed.

test/nuxt/nuxt-island.test.ts (4)

Learnt from: Tofandel
PR: nuxt/nuxt#0
File: :0-0
Timestamp: 2024-11-11T12:34:22.648Z
Learning: Ensure that AI-generated summaries accurately reflect the key changes in the PR, focusing on notable changes such as the removal of unused imports and variables starting with underscores.

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to /e2e//*.{ts,js} : Write end-to-end tests using Playwright and @nuxt/test-utils

Learnt from: huang-julien
PR: #29366
File: packages/nuxt/src/app/components/nuxt-root.vue:16-19
Timestamp: 2024-12-12T12:36:34.871Z
Learning: In packages/nuxt/src/app/components/nuxt-root.vue, when optimizing bundle size by conditionally importing components based on route metadata, prefer using inline conditional imports like:

const IsolatedPage = route?.meta?.isolate ? defineAsyncComponent(() => import('#build/isolated-page.mjs')) : null

instead of wrapping the import in a computed property or importing the component unconditionally.

Learnt from: CR
PR: nuxt/nuxt#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-07-18T16:46:07.446Z
Learning: Applies to **/*.{test,spec}.{ts,tsx,js,jsx} : Write unit tests for core functionality using vitest

⏰ 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). (5)
  • GitHub Check: test-fixtures (windows-latest, built, vite, default, manifest-on, json, 20)
  • GitHub Check: test-fixtures (windows-latest, built, webpack, async, manifest-on, json, 20)
  • GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-on, json, 20)
  • GitHub Check: test-fixtures (windows-latest, built, vite, async, manifest-off, json, 20)
  • GitHub Check: test-benchmark
🔇 Additional comments (4)
packages/nuxt/src/app/components/nuxt-island.ts (1)

198-198: Excellent fix for preserving base paths in remote island URLs.

The change from using the URL constructor to joinURL correctly preserves the base path in the remote source URL, which addresses the core issue. The joinURL utility is designed for this exact use case and prevents the URL constructor from normalising away important path segments.

test/nuxt/nuxt-island.test.ts (3)

97-124: Comprehensive test coverage for base URL handling.

This test effectively validates the URL construction fix by:

  1. Setting up a mock server to capture the actual request URL
  2. Providing a source URL with a base path (/app)
  3. Asserting that the request URL correctly includes the base path

The test design properly isolates the URL construction behaviour and provides clear validation of the fix.


377-379: Clean helper function for normalising test snapshots.

The removeDataIslandUid function provides a clean way to strip dynamic data-island-uid attributes from HTML for consistent snapshot testing. The regex pattern correctly matches the attribute format and handles various quote scenarios.


241-241: Consistent snapshot normalisation improves test reliability.

Using removeDataIslandUid for snapshot assertions removes the dynamic data-island-uid attributes that would otherwise cause test flakiness. This approach maintains test readability whilst ensuring consistent results across test runs.

Also applies to: 267-267, 360-360

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/island_baseurl

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

codspeed-hq bot commented Jul 26, 2025

CodSpeed Performance Report

Merging #32772 will not alter performance

Comparing fix/island_baseurl (1424422) with main (3db3a78)1

Summary

✅ 10 untouched benchmarks

Footnotes

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

@danielroe
Copy link
Member

does this also resolve #32751?

@danielroe danielroe merged commit c2c18e7 into main Jul 26, 2025
153 of 157 checks passed
@danielroe danielroe deleted the fix/island_baseurl branch July 26, 2025 21:27
@github-actions github-actions bot mentioned this pull request Jul 25, 2025
@github-actions github-actions bot mentioned this pull request Jul 28, 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.

Applications with a base URL cannot be used as a source for remote component islands
2 participants