Skip to content

Conversation

@dcoa
Copy link
Contributor

@dcoa dcoa commented Oct 2, 2025

Roles tab

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

Warning

This PR depends on #6 and #5 for getting the roles and permissions metadata and the RoleCard.

Changes overview

  • Add the list of roles using the RoleCard component.
  • Enhance some of the card styles.
  • Add a divided for the permissions.

Out of scope

  • Error handling

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: View available library roles openedx-authz#53

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

openedx-webhooks commented Oct 2, 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.

@codecov
Copy link

codecov bot commented Oct 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.44%. Comparing base (315e5c6) to head (1c583b9).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master       #7      +/-   ##
==========================================
+ Coverage   92.29%   92.44%   +0.14%     
==========================================
  Files          31       31              
  Lines         454      463       +9     
  Branches       77       69       -8     
==========================================
+ Hits          419      428       +9     
  Misses         34       34              
  Partials        1        1              

☔ 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 2, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 2, 2025
@dcoa dcoa force-pushed the dcoa/roles-tab branch 2 times, most recently from eb57121 to 35093b8 Compare October 13, 2025 11:19
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.

I tested the roles tab on the sandbox and everything looks fine. The cards look fine and the user counter is correct.
Despite I dont have the information/resources to make sure the permissions rendered are correct.
It would be nice for future iterations to revisit the component declarations to have consistency, I see some components across the repo being declared like:
const ComponentName: FC<ComponentNameProps> = ({ prop1, prop2}) =>
and some others:
const ComponentName = ({ prop1, prop2}: ComponentNameProps) =>.
I will go with the first way.
Anyways, good work!

@dcoa dcoa marked this pull request as ready for review October 22, 2025 08:46
@dcoa
Copy link
Contributor Author

dcoa commented Oct 22, 2025

I tested the roles tab on the sandbox and everything looks fine. The cards look fine and the user counter is correct. Despite I dont have the information/resources to make sure the permissions rendered are correct. It would be nice for future iterations to revisit the component declarations to have consistency, I see some components across the repo being declared like: const ComponentName: FC<ComponentNameProps> = ({ prop1, prop2}) => and some others: const ComponentName = ({ prop1, prop2}: ComponentNameProps) =>. I will go with the first way. Anyways, good work!

Yes, I agree that the code style need alignment. I create a issue for that.

Copy link

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

The code looks good, and the feature seems to do what it purports to. However, I'm seeing an empty title for what I believe is the Library Contributor role:

Image

Is this missing a translation string somewhere? Or does it have something to do with the fact I'm running openedx_authz@0.5.0 in the backend and this PR hasn't been updated accordingly, yet?

@dcoa
Copy link
Contributor Author

dcoa commented Oct 22, 2025

@arbrandes it is because the collaborator is not updated in the metadata. Here the associated PR #15

@arbrandes arbrandes merged commit f6bd291 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

Archived in project
Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants