fix(@vben/layouts): respect base URL when opening route in new window

[slshsl]

Previously, the generated URL for opening routes in a new window did not include the router base, which led to incorrect paths when the app was deployed under a subdirectory (e.g., /admin/). This change ensures that the resolved path includes the configured base by using router.resolve(path).href.

Description

This change ensures that the resolved path includes the configured base by using router.resolve(path).href.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• Bug Fixes
  • Improved navigation behavior so that opening routes in a new window now uses fully resolved URLs, ensuring more reliable and accurate routing.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0b59fd4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

A helper function named resolveHref was introduced inside the useNavigation hook to convert route paths into fully resolved href strings using the router. The navigation logic was updated to use this resolved href when opening routes in a new window, ensuring URLs are fully constructed before navigation.

Changes

Cohort / File(s)	Change Summary
Navigation Helper Update packages/effects/layouts/src/basic/menu/use-navigation.ts	Added resolveHref function to resolve paths to hrefs. Updated navigation logic to use resolved hrefs when opening routes in new windows.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A helper hops in, neat and spry,
To turn plain paths to hrefs that fly.
Now when new windows open wide,
The routes are clear, with nothing to hide.
A bunny’s work: resolve, then run—
Navigation’s never been more fun! 🐇✨

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 193f5b6 and 0b59fd4.

📒 Files selected for processing (1)

• packages/effects/layouts/src/basic/menu/use-navigation.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: dingdayu
PR: vbenjs/vue-vben-admin#5500
File: packages/stores/src/modules/tabbar.ts:557-559
Timestamp: 2025-02-08T07:05:28.825Z
Learning: In Vue Vben Admin, while tab identification uses `path` to group tabs with same path but different queries, router navigation operations (router.push) and new window operations should use `fullPath` to preserve the complete URL including query parameters. This applies specifically to:
1. Router navigation in tab maximize/restore feature
2. Opening tabs in new window via openTabInNewWindow

packages/effects/layouts/src/basic/menu/use-navigation.ts (1)

Learnt from: dingdayu
PR: #5500
File: packages/stores/src/modules/tabbar.ts:557-559
Timestamp: 2025-02-08T07:05:28.825Z
Learning: In Vue Vben Admin, while tab identification uses path to group tabs with same path but different queries, router navigation operations (router.push) and new window operations should use fullPath to preserve the complete URL including query parameters. This applies specifically to:

1. Router navigation in tab maximize/restore feature
2. Opening tabs in new window via openTabInNewWindow

⏰ 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). (8)

• GitHub Check: Check (windows-latest)
• GitHub Check: Check (ubuntu-latest)
• GitHub Check: Test (windows-latest)
• GitHub Check: Lint (windows-latest)
• GitHub Check: Lint (ubuntu-latest)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: post-update (windows-latest)
• GitHub Check: post-update (ubuntu-latest)

🔇 Additional comments (2)

packages/effects/layouts/src/basic/menu/use-navigation.ts (2)

35-37: LGTM! Correctly resolves paths with base URL.

The resolveHref function properly uses router.resolve(path).href to generate fully resolved URLs that include the router base configuration. This directly addresses the issue described in the PR objectives where URLs were missing the base path when deployed under subdirectories.

---

47-47: Consider using fullPath to preserve query parameters

The update to use resolveHref(path) correctly fixes the base-URL issue for subdirectory deployments, but since path may omit query parameters, opening a new window via this method could strip them. To ensure the full URL (including ?foo=bar) is preserved, you may need to pass the route’s fullPath instead of path.

Suggested diff in
packages/effects/layouts/src/basic/menu/use-navigation.ts:

- openRouteInNewWindow(resolveHref(path));
+ openRouteInNewWindow(resolveHref(fullPath));

Please verify that fullPath is in scope here (e.g. from the current route) and test opening various routes with queries to confirm they’re retained.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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