feat: rbac roles by ogzhanolguncu · Pull Request #3297 · unkeyed/unkey

ogzhanolguncu · 2025-06-04T15:49:44Z

What does this PR do?

Replaces old /roles page with new one.

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

Bug fix (non-breaking change which fixes an issue)
Chore (refactoring code, technical debt, workflow improvements)
Enhancement (small improvements)
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

How should this be tested?

Test A
Test B

Checklist

Required

Appreciated

If a UI change was made: Added a screen recording or screenshots to this PR
Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

New Features
- Added comprehensive roles management UI: listing, AI-powered search, filtering, creation, editing, and deletion.
- Introduced controls for assigning keys and permissions with search, pagination, and validation.
- Enabled bulk role selection and deletion with confirmation dialogs and animated counters.
- Added skeleton loaders and detailed role info displays.
- Integrated LLM-based structured search for roles with user-friendly error handling.
- Added advanced filter management via URL query parameters.
- Introduced new icons and improved UI components for clarity.
- Added role-related popover actions with prefetching on hover and open.
- Added new hooks for fetching connected keys and permissions, and for role upsert and deletion.
- Added utility functions for styling and option generation in key and permission selectors.
- Added dialogs for role creation and editing with persistent form state and validation.
Bug Fixes
- Enhanced loading state visuals in virtual tables with conditional row borders.
- Improved dialog keyboard event handling to prevent shortcut conflicts.
Refactor
- Migrated roles management from server-side to client-side for improved interactivity.
- Simplified navigation and modal dialogs for role creation and editing.
- Removed deprecated authorization layout and role detail pages.
Chores
- Expanded backend APIs and schemas for roles, keys, and permissions with filtering, pagination, and audit logging.
- Added new TRPC procedures for role data fetching, searching, upserting, deletion with related data, and connected keys and permissions retrieval.
- Updated router structure to include comprehensive authorization roles endpoints.

changeset-bot · 2025-06-04T15:49:49Z

⚠️ No Changeset found

Latest commit: 149b077

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

vercel · 2025-06-04T15:49:49Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 11, 2025 4:50pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 11, 2025 4:50pm

coderabbitai · 2025-06-04T15:49:54Z

📝 Walkthrough

Walkthrough

This change introduces a comprehensive rewrite and expansion of the authorization roles management feature in the dashboard application. It replaces server-side logic and legacy components with a fully client-driven, modular, and virtualized roles table, supporting advanced filtering, searching (including LLM-based queries), role creation/editing dialogs, and action menus. The backend is extended with new tRPC endpoints for querying, searching, upserting, and deleting roles, keys, and permissions, along with schema validation and audit logging. Several new UI components, hooks, schemas, and icons are added, while obsolete files and server components are removed.

Changes

File(s) / Path(s)	Change Summary
`apps/dashboard/app/(app)/authorization/roles/components/table/components/assigned-items-cell.tsx`, `.../last-updated.tsx`, `.../selection-controls/index.tsx`, `.../skeletons.tsx`, `.../roles-list.tsx`, `.../actions/components/delete-role.tsx`, `.../actions/components/edit-role.tsx`, `.../actions/components/role-info.tsx`, `.../actions/keys-table-action.popover.constants.tsx`	Added new React components for roles table: assigned items cell, last updated badge, selection controls, skeleton loaders, virtualized roles list, role actions (edit/delete/info), and popover action menu.
`apps/dashboard/app/(app)/authorization/roles/components/table/hooks/use-roles-list-query.ts`	Added hook for paginated, filtered roles query with infinite scroll support.
`apps/dashboard/app/(app)/authorization/roles/components/table/utils/get-row-class.ts`	Added utility for computing row class names based on selection state.
`apps/dashboard/app/(app)/authorization/roles/components/controls/index.tsx`, `.../logs-filters/index.tsx`, `.../logs-search/index.tsx`	Added search and filter controls for roles, including LLM-powered search and dynamic filter popover.
`apps/dashboard/app/(app)/authorization/roles/components/control-cloud/index.tsx`	Added control cloud component for roles list with filter integration.
`apps/dashboard/app/(app)/authorization/roles/components/upsert-role/index.tsx`, `.../upsert-role.schema.ts`, `.../hooks/use-upsert-role.ts`, `.../components/assign-key/key-field.tsx`, `.../components/assign-key/create-key-options.tsx`, `.../components/assign-key/hooks/use-fetch-keys.ts`, `.../components/assign-key/hooks/use-search-keys.ts`, `.../components/assign-permission/permissions-field.tsx`, `.../components/assign-permission/create-permission-options.tsx`, `.../components/assign-permission/hooks/use-fetch-permissions.ts`, `.../components/assign-permission/hooks/use-search-permissions.ts`	Added modular dialog and form logic for creating/updating roles, with assignable keys and permissions, validation, and persistent form state.
`apps/dashboard/app/(app)/authorization/roles/components/table/components/actions/components/hooks/use-delete-role.ts`, `.../use-fetch-connected-keys-and-perms.ts`	Added hooks for deleting roles (with error handling) and fetching connected keys/permissions for a role.
`apps/dashboard/app/(app)/authorization/roles/filters.schema.ts`	Added schema and types for roles filter fields, operators, and filter parsing.
`apps/dashboard/app/(app)/authorization/roles/components/table/query-logs.schema.ts`	Added schema for roles table query payload with filters and pagination.
`apps/dashboard/app/(app)/authorization/roles/hooks/use-filters.ts`	Added hook for managing role filters via URL query params.
`apps/dashboard/app/(app)/authorization/roles/navigation.tsx`	Refactored navigation to remove local state and legacy modal, now dynamically loads new upsert dialog.
`apps/dashboard/app/(app)/authorization/roles/page.tsx`	Converted from server to client component, now renders only client-side controls and roles list.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/components/actions/keys-table-action.popover.tsx`	Extended menu item type with prefetch logic, added prefetch on popover open and item hover.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/components/selection-controls/index.tsx`	Changed `AnimatedCounter` to be explicitly exported.
`apps/dashboard/app/(app)/apis/[apiId]/keys/[keyAuthId]/_components/components/table/keys-list.tsx`	Removed an extraneous blank line.
`apps/dashboard/components/virtual-table/index.tsx`	Added conditional row border to skeleton rows based on config.
`apps/dashboard/lib/trpc/routers/index.ts`	Added new `authorization.roles` router with endpoints for roles, keys, permissions, upsert, delete, LLM search, and connected keys/permissions.
`apps/dashboard/lib/trpc/routers/authorization/roles/query.ts`, `.../upsert.ts`, `.../delete.ts`, `.../llm-search/index.ts`, `.../llm-search/utils.ts`, `.../connected-keys-and-perms.ts`, `.../keys/query-keys.ts`, `.../keys/search-key.ts`, `.../keys/schema-with-helpers.ts`, `.../permissions/query-permissions.ts`, `.../permissions/search-permissions.ts`, `.../permissions/schema-with-helpers.ts`	Added tRPC procedures and helpers for querying, searching, upserting, deleting roles, keys, and permissions, including schema validation, error handling, and audit logging.
`internal/icons/src/icons/hand-holding-key.tsx`, `internal/icons/src/icons/tag.tsx`, `internal/icons/src/index.ts`	Added new SVG icon components and re-exports for hand-holding-key and tag icons.
`internal/db/src/schema/rbac.ts`	Removed a trailing blank line.
Deleted: `apps/dashboard/app/(app)/authorization/layout.tsx`, `.../roles/[roleId]/delete-role.tsx`, `.../roles/[roleId]/navigation.tsx`, `.../roles/[roleId]/page.tsx`, `.../roles/[roleId]/permission-toggle.tsx`, `.../roles/[roleId]/settings-client.tsx`, `.../roles/[roleId]/tree.tsx`, `.../roles/empty.tsx`	Removed legacy server components and client components for role details, navigation, deletion, permission toggling, and empty state.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RolesPage (Client)
    participant RolesList (Client)
    participant useRolesListQuery (Hook)
    participant trpc.authorization.roles.query (API)
    participant DB

    User->>RolesPage (Client): Visit /authorization/roles
    RolesPage->>RolesList: Render roles table
    RolesList->>useRolesListQuery: Request roles (filters, cursor)
    useRolesListQuery->>trpc.authorization.roles.query: Fetch roles
    trpc.authorization.roles.query->>DB: Query roles with filters, pagination
    DB-->>trpc.authorization.roles.query: Return roles data
    trpc.authorization.roles.query-->>useRolesListQuery: Return roles, total, nextCursor
    useRolesListQuery-->>RolesList: Provide roles data
    RolesList-->>User: Display roles table

    User->>RolesList: Click "Create new role"
    RolesList->>UpsertRoleDialog: Open dialog
    User->>UpsertRoleDialog: Fill form, submit
    UpsertRoleDialog->>trpc.authorization.roles.upsert: Upsert role
    trpc.authorization.roles.upsert->>DB: Insert/update role, keys, permissions
    DB-->>trpc.authorization.roles.upsert: Success
    trpc.authorization.roles.upsert-->>UpsertRoleDialog: Return result
    UpsertRoleDialog-->>RolesList: Close dialog, refresh roles

    User->>RolesList: Search/filter roles
    RolesList->>useFilters: Update filters
    useFilters->>useRolesListQuery: Update query params
    useRolesListQuery->>trpc.authorization.roles.query: Fetch filtered roles
    trpc.authorization.roles.query->>DB: Query with new filters
    DB-->>trpc.authorization.roles.query: Return filtered roles
    trpc.authorization.roles.query-->>useRolesListQuery: Return data
    useRolesListQuery-->>RolesList: Update table

    User->>RolesList: Click "Delete" on a role
    RolesList->>DeleteRole: Open confirmation
    User->>DeleteRole: Confirm deletion
    DeleteRole->>trpc.authorization.roles.delete: Delete role(s)
    trpc.authorization.roles.delete->>DB: Delete role(s), related keys/permissions, audit log
    DB-->>trpc.authorization.roles.delete: Success
    trpc.authorization.roles.delete-->>DeleteRole: Return result
    DeleteRole-->>RolesList: Remove role from table

Suggested labels

Feature, Dashboard

Suggested reviewers

perkinsjr
mcstepp
chronark

📜 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 cf4621c and 149b077.

📒 Files selected for processing (4)

apps/dashboard/app/(app)/authorization/roles/components/table/components/actions/components/delete-role.tsx (1 hunks)
apps/dashboard/app/(app)/authorization/roles/navigation.tsx (1 hunks)
apps/engineering/app/docs/[[...slug]]/page.tsx (1 hunks)
internal/ui/src/components/dialog/dialog-container.tsx (1 hunks)

✅ Files skipped from review due to trivial changes (1)

apps/engineering/app/docs/[[...slug]]/page.tsx

🚧 Files skipped from review as they are similar to previous changes (3)

internal/ui/src/components/dialog/dialog-container.tsx
apps/dashboard/app/(app)/authorization/roles/navigation.tsx
apps/dashboard/app/(app)/authorization/roles/components/table/components/actions/components/delete-role.tsx

⏰ Context from checks skipped due to timeout of 90000ms (16)

GitHub Check: Test Go API Local / Test (Shard 2/8)
GitHub Check: Test Go API Local / Test (Shard 5/8)
GitHub Check: Test Go API Local / Test (Shard 6/8)
GitHub Check: Test Go API Local / Test (Shard 4/8)
GitHub Check: Test Go API Local / Test (Shard 8/8)
GitHub Check: Test Go API Local / Test (Shard 7/8)
GitHub Check: Test Go API Local / Test (Shard 3/8)
GitHub Check: Test Go API Local / Test (Shard 1/8)
GitHub Check: Test API / API Test Local
GitHub Check: Build / Build
GitHub Check: Test Packages / Test ./internal/billing
GitHub Check: Test Packages / Test ./internal/clickhouse
GitHub Check: Test Packages / Test ./packages/api
GitHub Check: Test Packages / Test ./packages/cache
GitHub Check: autofix
GitHub Check: Analyze (javascript-typescript)

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

ogzhanolguncu · 2025-06-10T14:25:13Z

we never heard any complaints about case sensetivity yet 😄

...app)/authorization/roles/components/upsert-role/components/assign-key/create-key-options.tsx

mcstepp

just some nitpicks. use your own discretion if you want to address them, none of them are blocking.

ogzhanolguncu · 2025-06-11T17:01:54Z

@mcstepp could you approve again? I had to check the staging one more time with merged master

mcstepp

👍

ogzhanolguncu added 23 commits June 2, 2025 15:56

feat: add structured roles paginated result

1e9f509

feat: roles cleanup

e784aef

feat: add initial table

39beb8a

feat: iterate on roles table

2bcf464

feat: add filters

a51786d

feat: add proper filter schema

fdb3644

fix: colors

bc1380d

fix: skeletons

8675df8

feta: add upsert

576e27f

feat: add initial form elements

423b38f

feat: add searcahable combobox for keys

54f9f1a

feat: add permissions field

88d98ae

Merge branch 'main' of github.com:unkeyed/unkey into rbac-roles

363d969

chore: get rid of human_readable

452fe90

chore: rename

a74cc38

feat: add submit

8c6497c

chore: fix scoping of trpc

d355bf2

feat: add initial edit role

34c0e8b

feat: finalize form

56c442e

feat: add debounce to searches

7e6bc58

feat: add delete role

5d4af2e

feat: add role deletion

2137d9f

feat: add llm search

43b82c9

ogzhanolguncu requested review from MichaelUnkey, chronark, mcstepp and perkinsjr as code owners June 4, 2025 15:49

ogzhanolguncu added 2 commits June 10, 2025 13:50

fix: pr comments

c532f1e

Merge branch 'main' of github.com:unkeyed/unkey into rbac-roles

cf4621c

vercel bot deployed to Preview – engineering June 10, 2025 10:54 View deployment

vercel bot had a problem deploying to Preview – dashboard June 10, 2025 10:55 Failure

ogzhanolguncu added 2 commits June 10, 2025 14:14

fix: import

8486482

fix: navigation href

45bd728

vercel bot deployed to Preview – dashboard June 10, 2025 11:20 View deployment

mcstepp reviewed Jun 11, 2025

View reviewed changes

...app)/authorization/roles/components/upsert-role/components/assign-key/create-key-options.tsx Show resolved Hide resolved

mcstepp reviewed Jun 11, 2025

View reviewed changes

...app)/authorization/roles/components/upsert-role/components/assign-key/create-key-options.tsx Show resolved Hide resolved

mcstepp reviewed Jun 11, 2025

View reviewed changes

...app)/authorization/roles/components/upsert-role/components/assign-key/create-key-options.tsx Show resolved Hide resolved

mcstepp approved these changes Jun 11, 2025

View reviewed changes

ogzhanolguncu and others added 2 commits June 11, 2025 19:45

Merge branch 'main' into rbac-roles

d7e0f03

[autofix.ci] apply automated fixes

149b077

vercel bot deployed to Preview – dashboard June 11, 2025 16:50 View deployment

vercel bot deployed to Preview – engineering June 11, 2025 16:50 View deployment

ogzhanolguncu enabled auto-merge June 11, 2025 17:00

mcstepp approved these changes Jun 11, 2025

View reviewed changes

ogzhanolguncu added this pull request to the merge queue Jun 11, 2025

Merged via the queue into main with commit f4cfee5 Jun 11, 2025
31 of 37 checks passed

ogzhanolguncu deleted the rbac-roles branch June 11, 2025 17:04

coderabbitai bot mentioned this pull request Jun 12, 2025

feat: rbac keys - Merge after RBAC Permissions #3319

Closed

15 tasks

coderabbitai bot mentioned this pull request Jul 3, 2025

refactor: add util for id shortening #3403

Merged

18 tasks

coderabbitai bot mentioned this pull request Jul 11, 2025

feat: onboarding success step #3499

Merged

18 tasks

coderabbitai bot mentioned this pull request Jul 21, 2025

feat: add JSON config file support #3609

Merged

18 tasks

coderabbitai bot mentioned this pull request Jul 29, 2025

refactor: update identity param for v2 #3661

Merged

18 tasks

coderabbitai bot mentioned this pull request Sep 9, 2025

fix: delete permission or role from footer issue #3939

Closed

18 tasks

coderabbitai bot mentioned this pull request Nov 4, 2025

feat: Role and Permission rows open update dialog #4232

Merged

19 tasks

Conversation

ogzhanolguncu commented Jun 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Type of change

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

ogzhanolguncu commented Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mcstepp left a comment

Choose a reason for hiding this comment

Uh oh!

ogzhanolguncu commented Jun 11, 2025

Uh oh!

mcstepp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ogzhanolguncu commented Jun 4, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Jun 4, 2025 •

edited

Loading

vercel bot commented Jun 4, 2025 •

edited

Loading

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ogzhanolguncu commented Jun 10, 2025 •

edited

Loading