Skip to content
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

fix: user homePath no effect sometimes #5166

Merged
merged 1 commit into from
Dec 17, 2024
Merged

Conversation

mynetfan
Copy link
Collaborator

@mynetfan mynetfan commented Dec 17, 2024

Description

修复登录后,在浏览器地址栏手输地址导航到"/"时,用户信息中的homePath未能覆盖默认首页地址的问题。

fix #5152

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

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

  • New Features

    • Added a homePath property to user information, allowing for personalized user redirection.
  • Bug Fixes

    • Improved user redirection logic to prioritize user-specific home paths during authentication.
    • Enhanced handling of query parameters for redirection, reducing unnecessary parameters.
  • Refactor

    • Updated the logic for fetching user roles and access control to ensure accuracy based on the latest user data.

@mynetfan mynetfan requested review from anncwb, vince292007 and a team as code owners December 17, 2024 13:17
Copy link

changeset-bot bot commented Dec 17, 2024

⚠️ No Changeset found

Latest commit: 553bc32

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

Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/backend-mock/utils/mock-data.ts

Oops! Something went wrong! :(

ESLint: 9.16.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find module '/node_modules/@vben/eslint-config/dist/index.mjs' imported from /eslint.config.mjs
at finalizeResolution (node:internal/modules/esm/resolve:257:11)
at moduleResolve (node:internal/modules/esm/resolve:914:10)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

Walkthrough

The pull request introduces modifications to handle user-specific home paths across multiple router guard implementations. The changes primarily focus on enhancing the redirection logic when users log in or navigate between routes. A new optional homePath property has been added to the UserInfo interface in the mock data, and the router guard implementations in different frontend applications (Antd, Element, Naive, and Playground) have been updated to leverage this property for more dynamic route redirection.

Changes

File Change Summary
apps/backend-mock/utils/mock-data.ts Added optional homePath to UserInfo interface and populated for specific mock users
apps/web-*/src/router/guard.ts (Antd, Element, Naive, Playground) Updated router guard redirection logic to use userInfo.homePath when available

Assessment against linked issues

Objective Addressed Explanation
Handle userInfo.homePath for dynamic routing [#5152]
Prevent 404 when manually changing URL after login [#5152] Requires further testing to confirm complete resolution

Suggested reviewers

  • anncwb
  • vince292007

Poem

🐰 A router's tale of paths anew,
Where home is not just one view
Dynamic routes now dance and sway
Guided by user's chosen way
Hop, hop, hooray! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


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.

Copy link
Contributor

@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 b22d900 and 553bc32.

📒 Files selected for processing (5)
  • apps/backend-mock/utils/mock-data.ts (2 hunks)
  • apps/web-antd/src/router/guard.ts (3 hunks)
  • apps/web-ele/src/router/guard.ts (3 hunks)
  • apps/web-naive/src/router/guard.ts (3 hunks)
  • playground/src/router/guard.ts (3 hunks)
🔇 Additional comments (9)
playground/src/router/guard.ts (3)

55-57: LGTM: Login redirection logic properly prioritizes user's home path

The implementation correctly prioritizes:

  1. Redirect query parameter
  2. User's custom home path
  3. Default home path as fallback

75-78: LGTM: Query parameter handling prevents redirect loops

The implementation correctly omits the redirect query when accessing the default home path, preventing potential redirect loops.


108-111: Verify edge case: undefined userInfo

The logic looks correct, but let's verify the edge case where userInfo might be undefined despite having an accessToken.

✅ Verification successful

Edge case is properly handled

Looking at the complete guard implementation, the userInfo is safely handled:

  1. The userInfo is obtained through userStore.userInfo || (await authStore.fetchUserInfo()), ensuring it's always defined
  2. The homePath access is used with the OR operator (||) to fallback to DEFAULT_HOME_PATH if userInfo.homePath is undefined
  3. The code is within a guard that already checks for accessToken, and the userInfo is fetched before being used
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for places where userInfo might be null/undefined while accessToken exists
ast-grep --pattern 'if ($accessStore.accessToken) {
  $$$
  $userInfo
  $$$
}'

Length of output: 80


Script:

#!/bin/bash
# Let's search for the userInfo variable declaration and usage
ast-grep --pattern '$userInfo = $$$'

# Also search for any null checks on userInfo
ast-grep --pattern 'if ($userInfo) { $$$ }'

# And search for the actual getUserInfo function
rg "getUserInfo" -A 5

Length of output: 4964


Script:

#!/bin/bash
# Let's check the router guard implementation to see how userInfo is obtained and used
rg -A 10 "userInfo.*homePath" playground/src/router/guard.ts

# Also check for error handling around getUserInfo
ast-grep --pattern 'try {
  $$$
  getUserInfo
  $$$
} catch'

Length of output: 566


Script:

#!/bin/bash
# Let's check how userInfo is obtained in the guard context
rg -B 10 "userInfo.*homePath" playground/src/router/guard.ts

# And check the complete guard implementation for context
cat playground/src/router/guard.ts

Length of output: 4104

apps/web-naive/src/router/guard.ts (1)

57-59: LGTM: Implementation consistent with playground version

The changes mirror the playground implementation, maintaining consistency across the codebase:

  • Login redirection logic (57-59)
  • Query parameter handling (77-80)
  • Default path redirection (109-112)

Also applies to: 77-80, 109-112

apps/web-antd/src/router/guard.ts (1)

57-59: LGTM: Implementation consistent across all variants

The changes maintain consistency with both playground and naive implementations, ensuring uniform behavior across different UI frameworks.

Also applies to: 77-80, 110-113

✅ Verification successful

Implementation verified as consistent across all variants

The search results confirm that the router guard implementation is identical across all UI framework variants (Antd, Naive, Element Plus, and Playground), with the same redirect logic using:

  • to.query?.redirect
  • userInfo?.homePath
  • DEFAULT_HOME_PATH

All implementations share the same fallback pattern and home path handling, ensuring uniform behavior across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify if there are any Antd-specific router configurations that might affect this implementation
rg -g '!node_modules' -g '*.ts' -g '*.tsx' 'router.*config.*antd' .

Length of output: 69


Script:

#!/bin/bash
# Let's check for router guard implementations across different UI variants
rg -g '!node_modules' -g '*.ts' -g '*.tsx' 'userInfo\?\.homePath.*DEFAULT_HOME_PATH' .

# Also check for similar redirect logic in other variants
rg -g '!node_modules' -g '*.ts' -g '*.tsx' '(to\.query\?\.redirect|DEFAULT_HOME_PATH)' .

# Look for router guard files in playground and naive implementations
fd "guard.ts" .

Length of output: 3890

apps/backend-mock/utils/mock-data.ts (2)

7-7: LGTM: Well-structured interface update

The optional homePath property is correctly added to the UserInfo interface, maintaining backward compatibility.


24-24: Verify that the homePath values match existing routes

The homePath values look correct and match the available dashboard routes. Let's verify all paths exist in the routing configuration.

Also applies to: 32-32

✅ Verification successful

Both homePath values are correctly mapped to existing routes

The verification confirms that both '/workspace' and '/analytics' paths are properly defined as routes across multiple frontend implementations (web-antd, web-naive, web-ele) and are consistently documented. The homePath values in mock-data.ts align perfectly with the available routing configurations.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the specified homePaths exist as valid routes
# Expected: Both '/workspace' and '/analytics' should be found in route definitions

echo "Checking for '/workspace' and '/analytics' routes..."
rg -l "path: '/workspace'" 
rg -l "path: '/analytics'"

Length of output: 830

apps/web-ele/src/router/guard.ts (2)

57-59: LGTM: Improved redirection logic

The redirection precedence is correctly implemented:

  1. Use redirect query parameter if present
  2. Fall back to user's homePath if available
  3. Finally use DEFAULT_HOME_PATH

77-80: LGTM: Optimized query parameter handling

Good optimization to omit the redirect query parameter when navigating to the default home path, resulting in cleaner URLs.

apps/web-ele/src/router/guard.ts Show resolved Hide resolved
@mynetfan mynetfan merged commit a97c998 into vbenjs:main Dec 17, 2024
14 checks passed
@mynetfan mynetfan deleted the fix/home-path branch December 17, 2024 13:39
@RanMaoting
Copy link

感谢大佬的付出,经测试在hash模式下还有点问题

QQ20241218-111932.mp4

如果输入http://localhost:5555跳转是正常的,但是输入http://localhost:5555/#/表现就是异常的

@github-actions github-actions bot locked and limited conversation to collaborators Jan 18, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: userInfo.homePath 指定路径时表现异常
2 participants