squash!: Remove redundant functions and attend PR comments

Author: rodmgwgu

CHANGELOG.rst

@@ -21,7 +21,6 @@ Added
 =====
 
 * Add ADR for global scope support for role assignments.
-* Add ``get_all_subject_role_assignments`` and ``get_all_user_role_assignments`` api functions to fetch all user role assignments.
 * Add ``users/`` endpoint to fetch all team members, with optional filters for orgs, scopes, search by username user full name or email, sorting and pagination.
 
 Fixed

openedx_authz/api/data.py

@@ -1187,6 +1187,8 @@ def __repr__(self):
 
 @define
 class UserAssignments:
+    """A user with their role assignments"""
+
     user: "User"
     assignments: list[RoleAssignmentData]
 

openedx_authz/api/users.py

@@ -28,7 +28,6 @@
     assign_role_to_subject_in_scope,
     batch_assign_role_to_subjects_in_scope,
     batch_unassign_role_from_subjects_in_scope,
-    get_all_subject_role_assignments,
     get_all_subject_role_assignments_in_scope,
     get_role_assignments,
     get_scopes_for_subject_and_permission,
@@ -51,9 +50,8 @@
     "get_user_role_assignments_in_scope",
     "get_user_role_assignments_for_role_in_scope",
     "get_user_role_assignments_filtered",
-    "get_all_user_role_assignments",
     "get_all_user_role_assignments_in_scope",
-    "get_all_user_role_assignments_by_user_filtered",
+    "get_visible_role_assignments_for_user",
     "is_user_allowed",
     "get_scopes_for_user_and_permission",
     "get_users_for_role_in_scope",
@@ -202,15 +200,6 @@ def get_user_role_assignments_filtered(
     )
 
 
-def get_all_user_role_assignments() -> list[RoleAssignmentData]:
-    """Get all roles for all users across all scopes.
-
-    Returns:
-        list[RoleAssignmentData]: A list of role assignments and all their metadata assigned to the user.
-    """
-    return get_all_subject_role_assignments()
-
-
 def get_all_user_role_assignments_in_scope(
     scope_external_key: str,
 ) -> list[RoleAssignmentData]:
@@ -251,7 +240,7 @@ def _filter_allowed_assignments(
     return allowed_assignments
 
 
-def get_all_user_role_assignments_by_user_filtered(
+def get_visible_role_assignments_for_user(
     orgs: list[str] = None,
     scopes: list[str] = None,
     allowed_for_user_external_key: str = None,
@@ -268,7 +257,7 @@ def get_all_user_role_assignments_by_user_filtered(
     Returns:
         list[UserAssignments]: A list of users with their role assignments, filtered by orgs/scopes and permissions.
     """
-    user_role_assignments = get_all_user_role_assignments()
+    user_role_assignments = get_user_role_assignments_filtered()
     # Filter assignments based on the user's permissions
     user_role_assignments = _filter_allowed_assignments(
         user_external_key=allowed_for_user_external_key,

openedx_authz/rest_api/v1/views.py

@@ -487,7 +487,7 @@ def get(self, request: HttpRequest) -> Response:
         serializer.is_valid(raise_exception=True)
         query_params = serializer.validated_data
 
-        users_with_assignments = api.get_all_user_role_assignments_by_user_filtered(
+        users_with_assignments = api.get_visible_role_assignments_for_user(
             orgs=query_params.get("orgs"),
             scopes=query_params.get("scopes"),
             allowed_for_user_external_key=request.user.username,

openedx_authz/tests/api/test_users.py

@@ -7,7 +7,6 @@
     assign_role_to_user_in_scope,
     batch_assign_role_to_users_in_scope,
     batch_unassign_role_from_users,
-    get_all_user_role_assignments,
     get_all_user_role_assignments_in_scope,
     get_user_role_assignments,
     get_user_role_assignments_for_role_in_scope,
@@ -291,43 +290,6 @@ def test_unassign_all_roles_from_user_removes_all_assignments(self, username, sc
             )
             self.assertEqual(len(scope_assignments), 0)
 
-    def test_get_all_user_role_assignments(self):
-        """Test retrieving all role assignments across all users and scopes.
-
-        Expected result:
-            - Returns all role assignments present in the system.
-            - Each assignment includes subject, role, and scope.
-            - Known assignments from the test setup are present in the result.
-        """
-        role_assignments = get_all_user_role_assignments()
-
-        self.assertGreater(len(role_assignments), 0)
-
-        # Verify each assignment has the expected structure
-        for assignment in role_assignments:
-            self.assertIsNotNone(assignment.subject)
-            self.assertIsNotNone(assignment.scope)
-            self.assertGreater(len(assignment.roles), 0)
-            for role in assignment.roles:
-                self.assertIsNotNone(role.external_key)
-
-        # Verify known assignments from setup are present
-        user_scope_role_triples = {
-            (a.subject.username, a.scope.external_key, a.roles[0].external_key) for a in role_assignments
-        }
-        self.assertIn(
-            ("alice", "lib:Org1:math_101", roles.LIBRARY_ADMIN.external_key),
-            user_scope_role_triples,
-        )
-        self.assertIn(
-            ("eve", "lib:Org2:physics_401", roles.LIBRARY_ADMIN.external_key),
-            user_scope_role_triples,
-        )
-        self.assertIn(
-            ("liam", "lib:Org4:art_101", roles.LIBRARY_AUTHOR.external_key),
-            user_scope_role_triples,
-        )
-
     def test_unassign_all_roles_from_user_with_no_roles_returns_false(self):
         """Test that unassigning a user with no roles returns False.