Skip to content

[FC-0099] fix: return user count of the specific scope#121

Merged
mariajgrimaldi merged 3 commits intoopenedx:mainfrom
eduNEXT:bav/fix-role-user-count
Oct 28, 2025
Merged

[FC-0099] fix: return user count of the specific scope#121
mariajgrimaldi merged 3 commits intoopenedx:mainfrom
eduNEXT:bav/fix-role-user-count

Conversation

@BryanttV
Copy link
Copy Markdown
Contributor

@BryanttV BryanttV commented Oct 28, 2025

Description

This PR fixes the current behavior of the "list role by scope" endpoint. Previously, the user count corresponded to the total number of users in the scope, that is, the total number of users assigned to all libraries. Now, it only returns the total number of users assigned to the specific library provided in the scope query parameter.

Testing Instructions

Using Tutor:

  1. Install this plugin with the changes in this PR.
  2. Run the migrations by running tutor dev exec lms python manage.py lms migrate
  3. Load the default policies by running tutor dev exec lms python manage.py lms load_policies
  4. Assign different roles to users in different scopes (different libraries).

Endpoint

GET http://local.openedx.io:8000/api/authz/v1/roles/?scope={your-scope}'

It should only return the count of users assigned to each role within the specified scope.

Merge Checklist:

Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

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

openedx-webhooks commented Oct 28, 2025

Thanks for the pull request, @BryanttV!

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

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.

@BryanttV BryanttV marked this pull request as ready for review October 28, 2025 01:28
return [
SubjectData(namespaced_key=policy[GroupingPolicyIndex.SUBJECT.value])
for policy in policies
if policy[GroupingPolicyIndex.SCOPE.value] == scope.namespaced_key
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I've also had to do this a couple of times in these functions since get_filtered_grouping_policy doesn't support filtering by more than one parameter. It'd be nice if, as a future improvement, we could implement a get_filtered_grouping_policy with N parameters as input. In any case, this looks good to me!

Copy link
Copy Markdown
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

Looks good to me, though I'm not sure if there is a use case for keeping the original around too. Should be easy enough to resurrect if we need to, though.

@BryanttV BryanttV changed the title fix: return user count of the specific scope [FC-0099] fix: return user count of the specific scope Oct 28, 2025
@mariajgrimaldi mariajgrimaldi merged commit ab9e2fb into openedx:main Oct 28, 2025
14 checks passed
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 28, 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). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants