Skip to content

Conversation

@wyc001122
Copy link
Contributor

@wyc001122 wyc001122 commented May 28, 2025

Description

close #6285
添加了混合权限访问控制模式,允许同时使用前端和后端权限控制方式,提供两者结合控制的方式

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)
  • 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
    • Introduced a new "Mixed Access Control" mode, allowing simultaneous use of frontend and backend access control for greater flexibility.
  • Documentation
    • Updated documentation to describe the new mixed access control mode, its advantages, and configuration steps.

@changeset-bot
Copy link

changeset-bot bot commented May 28, 2025

⚠️ No Changeset found

Latest commit: 3db6375

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
Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

A "mixed" access control mode was introduced, combining frontend and backend access control mechanisms. Documentation was updated to describe this new mode, and the type definition for access mode was extended to include "mixed." The route generation logic was modified to merge frontend and backend routes when in mixed mode.

Changes

File(s) Change Summary
docs/src/en/guide/in-depth/access.md, docs/src/guide/in-depth/access.md Documentation updated to add and explain mixed access control mode, including configuration steps.
packages/@core/base/typings/src/app.d.ts Added 'mixed' to AccessModeType type alias and updated comments.
packages/effects/access/src/accessible.ts Added logic to generate and merge routes from both frontend and backend in the new "mixed" mode.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant FrontendAccess
    participant BackendAccess

    User->>App: Request Access (mixed mode)
    App->>FrontendAccess: Generate Frontend Routes
    App->>BackendAccess: Generate Backend Routes
    FrontendAccess-->>App: Frontend Routes
    BackendAccess-->>App: Backend Routes
    App->>App: Merge Routes
    App-->>User: Combined Accessible Routes
Loading

Suggested reviewers

  • mynetfan
  • anncwb
  • jinmao88

Poem

In the warren of code, three paths now exist,
Frontend, backend, and a mix in the mist.
Routes merge like carrots in a basket so wide,
Permissions united, no need to hide.
With "mixed" in our paws, we leap with delight—
All bunnies can frolic, by day or by night! 🥕✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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

🧹 Nitpick comments (1)
packages/effects/access/src/accessible.ts (1)

99-107: Consider potential route conflicts in mixed mode.

The implementation correctly uses Promise.all for concurrent execution and merges the results. However, consider these scenarios:

  1. Route name/path conflicts: What happens if frontend and backend generate routes with identical names or paths?
  2. Route precedence: Frontend routes are placed first in the merged array - is this the intended behavior?

Consider adding conflict detection or a merge strategy:

case 'mixed': {
  const [frontend_resultRoutes, backend_resultRoutes] = await Promise.all([
    generateRoutesByFrontend(routes, roles || [], forbiddenComponent),
    generateRoutesByBackend(options),
  ]);

+ // Optional: Add conflict detection
+ const frontendNames = new Set(frontend_resultRoutes.map(r => r.name));
+ const conflicts = backend_resultRoutes.filter(r => frontendNames.has(r.name));
+ if (conflicts.length > 0) {
+   console.warn('Route name conflicts detected in mixed mode:', conflicts.map(r => r.name));
+ }

  resultRoutes = [...frontend_resultRoutes, ...backend_resultRoutes];
  break;
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5330451 and 3db6375.

📒 Files selected for processing (4)
  • docs/src/en/guide/in-depth/access.md (2 hunks)
  • docs/src/guide/in-depth/access.md (2 hunks)
  • packages/@core/base/typings/src/app.d.ts (1 hunks)
  • packages/effects/access/src/accessible.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Check (windows-latest)
  • GitHub Check: Test (windows-latest)
  • GitHub Check: post-update (windows-latest)
  • GitHub Check: post-update (ubuntu-latest)
🔇 Additional comments (5)
packages/@core/base/typings/src/app.d.ts (1)

63-65: LGTM! Clean type definition extension.

The addition of the 'mixed' access mode to the type system is well-documented and follows the existing pattern. The comment clearly explains the purpose of the mixed mode.

docs/src/guide/in-depth/access.md (2)

7-11: Excellent documentation update for mixed mode introduction.

The update correctly reflects the new count of access control methods and provides a clear overview of the mixed mode capability.


163-199: Comprehensive mixed mode documentation.

The new section provides excellent coverage of the mixed access control mode:

  • Clear implementation principle explanation
  • Well-defined advantages
  • Step-by-step configuration instructions
  • Proper cross-references to existing sections

The documentation will help users understand and implement the mixed mode effectively.

docs/src/en/guide/in-depth/access.md (2)

7-11: Consistent English documentation update.

The English version correctly mirrors the Chinese documentation updates, maintaining consistency across both language versions.


155-191: Well-structured English mixed mode documentation.

The English documentation provides the same comprehensive coverage as the Chinese version:

  • Clear technical explanations
  • Proper translation of concepts
  • Complete configuration guidance
  • Consistent formatting and structure

This ensures users can access the mixed mode documentation in their preferred language.

@jinmao88 jinmao88 merged commit f31360b into vbenjs:main May 28, 2025
13 of 15 checks passed
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 4, 2025
…into web

* 'main' of https://github.com/baohaojie123/vue-vben-admin:
  types: 扩展user-dropdown组件的menus类型,支持iconify (vbenjs#6283)
  fix: resolve onClosed method failure in connectedComponent of useVbenModal (vbenjs#6309)
  fix: 修复使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 (vbenjs#6310)
  fix:  When defaultHomePage is inconsistent with user.homePath, the pa… (vbenjs#6299)
  docs(settings): 完善'生产环境动态配置'步骤 (vbenjs#6297)
  fix: alert width fixed in small  screen (vbenjs#6312)
  style: fix lint error (vbenjs#6298)
  feat: support for hybrid permission access control mode (vbenjs#6294)
  fix: fix table-title slot not work (vbenjs#6295)

# Conflicts:
#	docs/src/en/guide/in-depth/access.md
baohaojie123 added a commit to baohaojie123/vue-vben-admin that referenced this pull request Jun 11, 2025
* 'main' of https://github.com/baohaojie123/vue-vben-admin: (35 commits)
  chore: release 5.5.7
  feat: improve vbenCheckButtonGroup (vbenjs#6329)
  types: 扩展user-dropdown组件的menus类型,支持iconify (vbenjs#6283)
  fix: resolve onClosed method failure in connectedComponent of useVbenModal (vbenjs#6309)
  fix: 修复使用useVbenVxeGrid配置hasEmptyText、hasEmptyRender不生效的问题 (vbenjs#6310)
  fix:  When defaultHomePage is inconsistent with user.homePath, the pa… (vbenjs#6299)
  docs(settings): 完善'生产环境动态配置'步骤 (vbenjs#6297)
  fix: alert width fixed in small  screen (vbenjs#6312)
  style: fix lint error (vbenjs#6298)
  feat: support for hybrid permission access control mode (vbenjs#6294)
  fix: fix table-title slot not work (vbenjs#6295)
  fix: Update index.ts (vbenjs#6268)
  fix: reset slider-captcha after login failed (vbenjs#6275)
  fix: json-bigint parse used in vxeTable (vbenjs#6271)
  fix: repair the unexpected form default value (vbenjs#5567)
  feat: optimize logo display (vbenjs#6267)
  feat: improve check updates (vbenjs#6257)
  feat: enhances compatibility with APIs returning large numeric values (vbenjs#6250)
  fix: component Input is not registered when initialize page (vbenjs#6246)
  feat: ellipsis text automatically displays tooltip based on ellipsis (vbenjs#6244)
  ...

# Conflicts:
#	apps/web-naive/src/adapter/form.ts
#	apps/web-naive/src/bootstrap.ts
#	docs/src/components/common-ui/vben-ellipsis-text.md
#	docs/src/en/guide/in-depth/access.md
#	docs/src/guide/essentials/build.md
#	docs/src/guide/essentials/route.md
@github-actions github-actions bot locked and limited conversation to collaborators Jun 28, 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: 动态路由放到:无需走权限验证(会一直显示在菜单中),然后菜单中并不会显示

2 participants