squash!: refactor constants

Author: rodmgwgu

openedx_authz/rest_api/data.py

@@ -58,3 +58,19 @@ class RoleOperationError(BaseEnum):
     USER_DOES_NOT_HAVE_ROLE = "user_does_not_have_role"
     ROLE_ASSIGNMENT_ERROR = "role_assignment_error"
     ROLE_REMOVAL_ERROR = "role_removal_error"
+
+
+class ScopesQuerySetFields(BaseEnum):
+    """Enum for the annotated fields used in the Scopes query set for the scopes endpoint"""
+
+    SCOPE_ID = "scope_id"
+    DISPLAY_NAME_COL = "display_name_col"
+    ORG_NAME = "org_name"
+    SCOPE_TYPE = "scope_type"
+
+
+class ScopesTypeField(BaseEnum):
+    """Enum for the scope_type query field on the scopes endpoint"""
+
+    COURSE = "course"
+    LIBRARY = "library"

openedx_authz/rest_api/v1/serializers.py

@@ -7,7 +7,7 @@
 
 from openedx_authz import api
 from openedx_authz.api.data import UserAssignments
-from openedx_authz.rest_api.data import AssignmentSortField, SortField, SortOrder
+from openedx_authz.rest_api.data import AssignmentSortField, ScopesTypeField, SortField, SortOrder
 from openedx_authz.rest_api.utils import get_generic_scope
 from openedx_authz.rest_api.v1.fields import (
     CaseSensitiveCommaSeparatedListField,
@@ -227,7 +227,9 @@ class ListScopesQuerySerializer(OrgMixin):  # pylint: disable=abstract-method
     """Serializer for validating query parameters in ScopesAPIView."""
 
     management_permission_only = serializers.BooleanField(required=False, default=False)
-    scope_type = serializers.ChoiceField(choices=["course", "library"], required=False, default=None, allow_null=True)
+    scope_type = serializers.ChoiceField(
+        choices=[(e.value, e.name) for e in ScopesTypeField], required=False, default=None, allow_null=True
+    )
     search = serializers.CharField(required=False, default="", allow_blank=True)
 
 
@@ -375,7 +377,7 @@ class ScopeSerializer(serializers.Serializer):  # pylint: disable=abstract-metho
 
     def get_external_key(self, obj: dict) -> str:
         """Get the external key for the given scope."""
-        if obj["scope_type"] == "library":
+        if obj["scope_type"] == ScopesTypeField.LIBRARY:
             return str(LibraryLocatorV2(org=obj["org_name"], slug=obj["scope_id"]))
         return obj["scope_id"]
 

openedx_authz/rest_api/v1/views.py

@@ -39,7 +39,7 @@
 from openedx_authz.api.utils import get_user_map
 from openedx_authz.constants import permissions
 from openedx_authz.models.scopes import get_content_library_model, get_course_overview_model
-from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus
+from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus, ScopesQuerySetFields, ScopesTypeField
 from openedx_authz.rest_api.decorators import authz_permissions, view_auth_classes
 from openedx_authz.rest_api.utils import (
     filter_users,
@@ -675,6 +675,14 @@ class ScopesAPIView(generics.ListAPIView):
     pagination_class = AuthZAPIViewPagination
     permission_classes = [AnyScopePermission]
 
+    # Priority for fields used for stable sorting (first has more priority)
+    ordering_priority = (
+        ScopesQuerySetFields.ORG_NAME,
+        ScopesQuerySetFields.SCOPE_TYPE,
+        ScopesQuerySetFields.DISPLAY_NAME_COL,
+        ScopesQuerySetFields.SCOPE_ID,
+    )
+
     def get_serializer_context(self):
         context = super().get_serializer_context()
         context["org_map"] = Organization.objects.filter(active=True).in_bulk(field_name="short_name")
@@ -711,7 +719,12 @@ def _get_courses_queryset(
             display_name_col=Cast("display_name", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
             org_name=Cast("org", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
             scope_type=Value("course", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
-        ).values("scope_id", "display_name_col", "org_name", "scope_type")
+        ).values(
+            ScopesQuerySetFields.SCOPE_ID,
+            ScopesQuerySetFields.DISPLAY_NAME_COL,
+            ScopesQuerySetFields.ORG_NAME,
+            ScopesQuerySetFields.SCOPE_TYPE,
+        )
 
     def _get_libraries_queryset(
         self,
@@ -748,19 +761,23 @@ def _get_libraries_queryset(
             display_name_col=Cast("learning_package__title", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
             org_name=Cast("org__short_name", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
             scope_type=Value("library", output_field=CharField(db_collation="utf8mb4_unicode_ci")),
-        ).values("scope_id", "display_name_col", "org_name", "scope_type")
+        ).values(
+            ScopesQuerySetFields.SCOPE_ID,
+            ScopesQuerySetFields.DISPLAY_NAME_COL,
+            ScopesQuerySetFields.ORG_NAME,
+            ScopesQuerySetFields.SCOPE_TYPE,
+        )
 
     def _build_queryset(self, courses_qs: QuerySet | None, libraries_qs: QuerySet | None) -> QuerySet:
         """Union the provided querysets and sort deterministically.
 
         Orders by org_name first (satisfying the 'ordered by org' requirement), then by
         scope_type, display_name_col, and scope_id as tiebreakers to ensure stable pagination.
         """
-        ordering = ("org_name", "scope_type", "display_name_col", "scope_id")
         if courses_qs is not None and libraries_qs is not None:
-            return courses_qs.union(libraries_qs).order_by(*ordering)
+            return courses_qs.union(libraries_qs).order_by(*self.ordering_priority)
         qs = courses_qs if courses_qs is not None else libraries_qs
-        return qs.order_by(*ordering)
+        return qs.order_by(*self.ordering_priority)
 
     def get_queryset(self) -> QuerySet:
         """Return scopes ordered by org, filtered by the user's permissions."""
@@ -776,8 +793,16 @@ def get_queryset(self) -> QuerySet:
         # Staff and superusers can see all scopes, skip permission filtering.
         if user.is_staff or user.is_superuser:
             return self._build_queryset(
-                courses_qs=(self._get_courses_queryset(search=search, org=org) if scope_type != "library" else None),
-                libraries_qs=(self._get_libraries_queryset(search=search, org=org) if scope_type != "course" else None),
+                courses_qs=(
+                    self._get_courses_queryset(search=search, org=org)
+                    if scope_type != ScopesTypeField.LIBRARY
+                    else None
+                ),
+                libraries_qs=(
+                    self._get_libraries_queryset(search=search, org=org)
+                    if scope_type != ScopesTypeField.COURSE
+                    else None
+                ),
             )
 
         management_only = params_serializer.validated_data["management_permission_only"]
@@ -788,7 +813,7 @@ def get_permission(scope_cls):
 
         # Resolve allowed scopes from Casbin in a single call per scope type.
         courses_qs = None
-        if scope_type != "library":
+        if scope_type != ScopesTypeField.LIBRARY:
             allowed_course_scopes = get_scopes_for_user_and_permission(
                 user.username, get_permission(CourseOverviewData).identifier
             )
@@ -804,7 +829,7 @@ def get_permission(scope_cls):
             )
 
         libraries_qs = None
-        if scope_type != "course":
+        if scope_type != ScopesTypeField.COURSE:
             allowed_library_scopes = get_scopes_for_user_and_permission(
                 user.username, get_permission(ContentLibraryData).identifier
             )