Skip to content

Conversation

@dcoa
Copy link
Contributor

@dcoa dcoa commented Oct 14, 2025

Permissions tab

This PR add the list of available permissions for libraries in the corresponding tab.

Warning

This PR preferred to merge after #7

Changes overview

  • Add table component inside the permissions tab.
  • Create the PermissionsTable that maps roles as columns and the permissions as roles .
  • The row displays a check if the role has the permission or a X if not.
  • Add the ResourceTooltip component to the matrix and the cards, to display descriptive information about the permissions.

Evidence

image

Testing instructions

  1. Create and setup a local environment (Tutor recommended)
  2. Run LMS and CMS, then clone the repo in the current branch and run the dev server npm run dev
  3. Add the URL to the CORS_WHITELIST in both LMS/CMS settings.py
# admin console MFE
CORS_ORIGIN_WHITELIST.append("http://apps.local.openedx.io:2025")
LOGIN_REDIRECT_WHITELIST.append("apps.local.openedx.io:2025")
CSRF_TRUSTED_ORIGINS.append("http://apps.local.openedx.io:2025")
  1. Create a library
  2. Navigate to http://apps.local.openedx.io:2025/admin-console/authz/libraries/:libraryId
  3. Mock the API calls for /authz/* queries, you can use 2 options
    • Use Chrome override https://developer.chrome.com/docs/devtools/overrides
    • Use an API mock tool such as Postman and Mockoon, and replace the API baseUrl with your service and, change getAuthenticatedHttpClient to getHttpClient to avoid user checks from the backend.

Additional information

  1. US: Compare role permissions openedx-authz#51

@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 Oct 14, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Oct 14, 2025

Thanks for the pull request, @dcoa!

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.


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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Oct 14, 2025
@dcoa dcoa force-pushed the dcoa/permissions-tab branch 2 times, most recently from ac0a54d to bcb2376 Compare October 14, 2025 11:27
@codecov
Copy link

codecov bot commented Oct 14, 2025

Codecov Report

❌ Patch coverage is 94.04762% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 93.66%. Comparing base (431314e) to head (c7cd081).
⚠️ Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
src/authz-module/libraries-manager/utils.ts 93.87% 3 Missing ⚠️
...-module/libraries-manager/LibrariesTeamManager.tsx 83.33% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master      #12      +/-   ##
==========================================
+ Coverage   92.44%   93.66%   +1.22%     
==========================================
  Files          31       41      +10     
  Lines         463      710     +247     
  Branches       81      147      +66     
==========================================
+ Hits          428      665     +237     
- Misses         34       42       +8     
- Partials        1        3       +2     

☔ View full report in Codecov by Sentry.
📢 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.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 15, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 15, 2025
};

const PermissionTable = ({ permissionsTable, roles }: PermissionTableProps) => (
<table className="pgn__data-table bg-light-100" data-testid="permissions-matrix">
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider removing this test id and make queries focused on real user interactions.

Copy link
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu left a comment

Choose a reason for hiding this comment

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

Permissions table looks good on the sandbox, good work 👍

@dcoa dcoa force-pushed the dcoa/permissions-tab branch from 695bff3 to a05df83 Compare October 22, 2025 09:28
@MaferMazu MaferMazu moved this to In Progress in RBAC AuthZ Board Oct 22, 2025
@dcoa dcoa force-pushed the dcoa/permissions-tab branch from a05df83 to 48efee0 Compare October 23, 2025 14:38
@dcoa dcoa marked this pull request as ready for review October 23, 2025 15:00
@dcoa dcoa moved this from In Progress to Ready for review in RBAC AuthZ Board Oct 23, 2025
Copy link

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

Overall this looks great!

I left a couple comments with questions and a couple with suggestions. Looking forward to hearing your thoughts!

</td>
{roles.map(role => (
<td key={role.name} className="text-center">
{permission.roles[role.name] ? <Icon className="d-inline-block" src={Check} /> : <Icon className="text-danger d-inline-block" src={Close} />}

Choose a reason for hiding this comment

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

Just curious as to what color we want the checkmarks to be

Current

Image

"Success"

Suggested change
{permission.roles[role.name] ? <Icon className="d-inline-block" src={Check} /> : <Icon className="text-danger d-inline-block" src={Close} />}
{permission.roles[role.name] ? <Icon className="text-success d-inline-block" src={Check} /> : <Icon className="text-danger d-inline-block" src={Close} />}
Image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The original design has no specific color https://www.figma.com/design/q3Knq0BKoVTBbtaxb81n9R/RBAC---Console---Wireframes?node-id=2750-9661&t=hu3T5aVg659Dg0J2-4

Do you consider the green is a better indicative?

Choose a reason for hiding this comment

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

I'm perfectly happy with it either way. I just saw "text-danger" for the red X and my mind jumped to using text-success for a green check, but if the designs don't have it as green then it's good as is.

Copy link

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

LGTM!

@brian-smith-tcril brian-smith-tcril merged commit 50beaef into openedx:master Oct 23, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from Ready for review to Done in RBAC AuthZ Board Oct 23, 2025
@github-project-automation github-project-automation bot moved this from Waiting on Author to Done in Contributions Oct 23, 2025
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). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants