github-starred/better-auth
2
0
Fork 0
mirror of https://github.com/better-auth/better-auth.git synced 2026-05-24 16:11:53 -05:00
Code Issues 2.5k Packages Projects Releases 112 Wiki Activity

[PR #5679] fix(admin): implement missing adminRoles permission bypass logic #14400

New Issue
Open
opened 2026-04-13 09:27:21 -05:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-04-13 09:27:21 -05:00
Owner
Copy Link

Original Pull Request: https://github.com/better-auth/better-auth/pull/5679

State: open
Merged: No

Description

This PR fixes the adminRoles option in the admin plugin which was documented but not functioning. The option was defined in the types and set with a default value of ["admin"], but the actual permission bypass logic was never implemented in has-permission.ts.

Changes

  • Implemented missing permission bypass logic in has-permission.ts for the existing adminRoles option
  • Added comprehensive test coverage (10 new tests covering multiple scenarios)

Problem

The adminRoles option was documented in the TypeScript types with clear JSDoc comments stating:

"Roles that are considered admin roles. Any user role that isn't in this list, even if they have the permission, will not be considered an admin."

However, this functionality was never actually implemented. Users setting adminRoles would find it had no effect, as the permission check logic in has-permission.ts never checked this option.

Solution

Added the missing implementation in has-permission.ts that:

  • Checks if a user's role matches any role in the adminRoles array
  • Automatically grants all permissions to users with admin roles
  • Supports both single string and array formats as documented

Testing

  • ✅ All existing tests pass (62/62)
  • ✅ Added test suite for adminRoles with array of roles
  • ✅ Added test suite for adminRoles with single string
  • ✅ Tests cover userId and role parameter scenarios
  • ✅ Tests verify multi-role users work correctly
  • ✅ Code is formatted with BiomeJS

Example Usage (as originally documented)

admin({
  adminRoles: ["superadmin", "moderator"], // or single string: "admin"
  // ... other options
})

Breaking Changes

None - this implements existing documented functionality that was previously non-functional.

Related Issues

Summary by cubic

Fixes the adminRoles option in the admin plugin so listed roles bypass all permission checks. Supports single or multiple roles and works with both userId and role inputs.

  • Bug Fixes
    • Implemented adminRoles bypass logic in permission checks.
    • Supports string or array values and multi-role users (any match grants full access).
    • Added tests for array vs. string, userId vs. role, and multi-role scenarios.
    • No breaking changes; matches documented behavior.

Written for commit cb54ff1. Summary will update automatically on new commits.

**Original Pull Request:** https://github.com/better-auth/better-auth/pull/5679 **State:** open **Merged:** No --- ## Description This PR fixes the `adminRoles` option in the admin plugin which was documented but not functioning. The option was defined in the types and set with a default value of `["admin"]`, but the actual permission bypass logic was never implemented in `has-permission.ts`. ## Changes - Implemented missing permission bypass logic in `has-permission.ts` for the existing `adminRoles` option - Added comprehensive test coverage (10 new tests covering multiple scenarios) ## Problem The `adminRoles` option was documented in the TypeScript types with clear JSDoc comments stating: > "Roles that are considered admin roles. Any user role that isn't in this list, even if they have the permission, will not be considered an admin." However, this functionality was never actually implemented. Users setting `adminRoles` would find it had no effect, as the permission check logic in `has-permission.ts` never checked this option. ## Solution Added the missing implementation in `has-permission.ts` that: - Checks if a user's role matches any role in the `adminRoles` array - Automatically grants all permissions to users with admin roles - Supports both single string and array formats as documented ## Testing - ✅ All existing tests pass (62/62) - ✅ Added test suite for `adminRoles` with array of roles - ✅ Added test suite for `adminRoles` with single string - ✅ Tests cover userId and role parameter scenarios - ✅ Tests verify multi-role users work correctly - ✅ Code is formatted with BiomeJS ## Example Usage (as originally documented) ```typescript admin({ adminRoles: ["superadmin", "moderator"], // or single string: "admin" // ... other options }) ``` ## Breaking Changes None - this implements existing documented functionality that was previously non-functional. ## Related Issues <!-- If this fixes an issue, mention it here: Closes #XXX --> <!-- This is an auto-generated description by cubic. --> --- ## Summary by cubic Fixes the adminRoles option in the admin plugin so listed roles bypass all permission checks. Supports single or multiple roles and works with both userId and role inputs. - **Bug Fixes** - Implemented adminRoles bypass logic in permission checks. - Supports string or array values and multi-role users (any match grants full access). - Added tests for array vs. string, userId vs. role, and multi-role scenarios. - No breaking changes; matches documented behavior. <sup>Written for commit cb54ff1. Summary will update automatically on new commits.</sup> <!-- End of auto-generated description by cubic. -->
GiteaMirror added the pull-request label 2026-04-13 09:27:21 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
adapter
astro
awaiting external contributor
blocked
breaking
breaking change
bug
c-devops
core
credentials
database
dependencies
devops
devtools
docs
documentation
duplicate
elysia
enhancement
enterprise
expo
express
fastify
good first issue
help wanted
hono
identity
infra
integration
invalid
javascript
locked
maintenance
need-more-information
needs: info
needs: repro
nextjs
nuxt
oauth
organization
P0
payments
perf
platform
plugin
pull-request
Mirrored from GitHub Pull Request
 question
ready
regression
remix
security
social-provider
solid
stale
svelte
tanstack-start
tracking
version-bump
vue
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#14400
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?