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: menuVisibleWithForbidden: true route auth #5083

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

miaolq
Copy link

@miaolq miaolq commented Dec 9, 2024

Description

目前设置了authority和menuVisibleWithForbidden: true的route,即使用户有权限访问,也会被替换成403组件

Type of change

Please delete options that are not relevant.

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

Summary by CodeRabbit

  • New Features

    • Introduced a new function to determine if a route is forbidden based on user roles.
  • Bug Fixes

    • Improved logic for route access control to ensure proper assignment of forbidden components.

Copy link

changeset-bot bot commented Dec 9, 2024

⚠️ No Changeset found

Latest commit: 274d066

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 9, 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.

packages/utils/src/helpers/generate-routes-frontend.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 changes include the addition of a new function, isForBidden, in the generate-routes-frontend.ts file. This function checks if a route is forbidden based on user roles and their associated authorities. The existing logic in the generateRoutesByFrontend function has been updated to utilize this new function, enhancing the criteria for determining access to routes while maintaining the overall structure of the function.

Changes

File Path Change Summary
packages/utils/src/helpers/generate-routes-frontend.ts Added isForBidden function to evaluate route access based on user roles and modified generateRoutesByFrontend to use this new logic.

Suggested labels

bug

Suggested reviewers

  • vince292007
  • anncwb

Poem

🐇 In the code where routes do play,
A new check for roles came to stay.
Forbidden paths now find their way,
With isForBidden, clear as day!
Hopping through logic, we cheer and sway! 🎉


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

🧹 Outside diff range and nitpick comments (1)
packages/utils/src/helpers/generate-routes-frontend.ts (1)

31-38: Improve function implementation and documentation

Several improvements can be made to the isForBidden function:

  1. Follow camelCase naming convention
  2. Add proper JSDoc param type annotations
  3. Simplify the logic using optional chaining

Suggested improvements:

/**
 * Check if route access is forbidden
- * @param route
- * @returns
+ * @param {RouteRecordRaw} route - The route to check
+ * @param {string[]} roles - User roles to check against
+ * @returns {boolean} True if access is forbidden, false otherwise
 */
-function isForBidden (route: RouteRecordRaw, roles: string[]) {
-  return !!route.meta?.authority && !roles.some((role) => route.meta?.authority?.includes(role));
+function isForbidden(route: RouteRecordRaw, roles: string[]) {
+  return !!route.meta?.authority && !roles.some((role) => route.meta?.authority?.includes(role));
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 018ddc7 and 274d066.

📒 Files selected for processing (1)
  • packages/utils/src/helpers/generate-routes-frontend.ts (1 hunks)
🔇 Additional comments (1)
packages/utils/src/helpers/generate-routes-frontend.ts (1)

24-38: Verify usage of menuVisibleWithForbidden across the codebase

Let's ensure this change doesn't break other use cases of menuVisibleWithForbidden.

✅ Verification successful

Let me gather more context about the usage of menuVisibleWithForbidden to understand its relationship with isForBidden.


Based on the gathered information, I can now provide the final response:

Function isForBidden is safely scoped and menuVisibleWithForbidden usage is consistent

  • The isForBidden function is only used within generate-routes-frontend.ts and has no other dependencies
  • The menuVisibleWithForbidden meta property is properly typed in @core/base/typings and consistently used across the codebase for route configuration
  • The changes are localized to route generation logic and maintain the expected behavior with forbidden routes
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other usages of menuVisibleWithForbidden
echo "Searching for menuVisibleWithForbidden usage:"
rg "menuVisibleWithForbidden" --type ts

# Search for potential usages of isForBidden function
echo -e "\nSearching for isForBidden usage:"
rg "isForBidden\(" --type ts

Length of output: 1174


Script:

#!/bin/bash
# Get context around menuVisibleWithForbidden usages
echo "Context for menuVisibleWithForbidden in generate-routes-frontend.ts:"
rg "menuVisibleWithForbidden" packages/utils/src/helpers/generate-routes-frontend.ts -B 2 -A 2

echo -e "\nContext for menuVisibleWithForbidden in access.ts files:"
rg "menuVisibleWithForbidden" "apps/*/src/router/access.ts" -B 2 -A 2
rg "menuVisibleWithForbidden" "playground/src/router/access.ts" -B 2 -A 2

# Get the full implementation of isForBidden function
echo -e "\nFull implementation of isForBidden:"
ast-grep --pattern 'function isForBidden($_) { $$$ }'

Length of output: 1008

Comment on lines +24 to 27
if (isForBidden(route, roles)) {
route.component = forbiddenComponent;
}
return route;
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Critical: Current implementation doesn't fix the reported issue

The change doesn't address the original problem where routes with both authority and menuVisibleWithForbidden: true show 403 even when the user has permissions. The new isForBidden function only checks authority without considering menuVisibleWithForbidden.

Suggested fix:

- if (isForBidden(route, roles)) {
+ if (isForBidden(route, roles) && !menuHasVisibleWithForbidden(route)) {
    route.component = forbiddenComponent;
  }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (isForBidden(route, roles)) {
route.component = forbiddenComponent;
}
return route;
if (isForBidden(route, roles) && !menuHasVisibleWithForbidden(route)) {
route.component = forbiddenComponent;
}
return route;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant