Skip to content

feat(authz): list roles from the catalog in the new roles and permiss… - #285

Open
jacobo-dominguez-wgu wants to merge 2 commits into
masterfrom
jacobo/roles-table-custom
Open

jacobo-dominguez-wgu wants to merge 2 commits into
masterfrom
jacobo/roles-table-custom

Conversation

@jacobo-dominguez-wgu

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Description

The "Roles and Permissions" tab now shows a roles table read from the authz catalog (GET /api/authz/v1/roles/, ADR 0028), so the client keeps no copy of the roles. It replaces the roles and permissions matrix in that tab.

Closes openedx/openedx-authz#568

Changes

  • Columns: Role, Type of resource (Courses / Libraries pill), Members, Permissions ("N Granted"), Last updated and Actions. Role, Type of resource, Members and Last updated are sortable.
  • Custom roles: roles with definition_kind: "user_defined" show a "Custom Role" sub-label and a pencil (edit) action. Standard roles show an eye (view) action. Every row has a ⋮ menu with "Duplicate" and "Assign role".
  • Filter bar:
    • Search by role name.
    • A "Type of resource" filter that only offers the resource types the user can view.
    • A chip for each applied filter, plus a "Clear filters" button.
    • A "Showing N roles of M" count.
  • States: loading spinner, error alert and a "No roles found." empty state.
  • Code organization: follows the proposal in Proposal - feature based code organization #247.
    • The table sits at the feature root, with the cells and the filter bar in roles-permissions/components/.
    • It is exported from roles-permissions/index.ts, and authz-home imports it from there.
  • Styling: Paragon utility classes, plus one rule in authz-module/index.scss. That rule sets the eye and pencil buttons to --pgn-color-info-500 and keeps the primary variant's white icon on hover, because Paragon has no info IconButton variant.

Testing

Requires the endpoint modifications of openedx/openedx-authz#623

Go to the Roles and Permissions tab to check for the new table.

  • Added RolesPermissionsTable.test.tsx. It covers:
    • the column headers
    • the catalog rows and permission counts
    • custom vs. standard roles and their actions
    • the viewable resource types only
    • search, the resource type filter and its chips
    • the empty, loading and error states

Notes for reviewers

Screenshots / Demos

image

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 9, 2026
@openedx-webhooks

openedx-webhooks commented Nov 9, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @jacobo-dominguez-wgu!

This repository is currently maintained by @openedx/committers-frontend.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@jacobo-dominguez-wgu

Copy link
Copy Markdown
Contributor Author

Marked as draft until the api is modified with the filtering, sorting and pagination features and the missing columns are added.

@codecov

codecov Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 99.24812% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 99.05%. Comparing base (ab1b4bb) to head (9d6e732).

Files with missing lines Patch % Lines
...es-permissions/components/RolesTableControlBar.tsx 94.73% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #285      +/-   ##
==========================================
+ Coverage   98.96%   99.05%   +0.08%     
==========================================
  Files          78       88      +10     
  Lines        1453     1580     +127     
  Branches      445      485      +40     
==========================================
+ Hits         1438     1565     +127     
  Misses         15       15              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Base automatically changed from dcoa/catalog-8-role-names to master November 11, 2026 22:12
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Nov 16, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Nov 16, 2026
@jacobo-dominguez-wgu
jacobo-dominguez-wgu marked this pull request as ready for review November 18, 2026 16:58
@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from Waiting on Author to Ready for Review in Contributions Nov 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

Frontend: Roles and Permissions table view

3 participants