feat: add sort option for get admins

Author: M03ED

app/db/crud/admin.py

@@ -1,4 +1,5 @@
 from datetime import datetime, timezone
+from enum import Enum
 
 from sqlalchemy import func, select
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -15,6 +16,19 @@ async def load_admin_attrs(admin: Admin):
         pass
 
 
+AdminsSortingOptions = Enum(
+    "AdminsSortingOptions",
+    {
+        "username": Admin.username.asc(),
+        "created_at": Admin.created_at.asc(),
+        "used_traffic": Admin.used_traffic.asc(),
+        "-username": Admin.username.desc(),
+        "-created_at": Admin.created_at.desc(),
+        "-used_traffic": Admin.used_traffic.desc(),
+    },
+)
+
+
 async def get_admin(db: AsyncSession, username: str) -> Admin:
     """
     Retrieves an admin by username.
@@ -154,7 +168,11 @@ async def get_admin_by_discord_id(db: AsyncSession, discord_id: int) -> Admin:
 
 
 async def get_admins(
-    db: AsyncSession, offset: int | None = None, limit: int | None = None, username: str | None = None
+    db: AsyncSession,
+    offset: int | None = None,
+    limit: int | None = None,
+    username: str | None = None,
+    sort: list[AdminsSortingOptions] | None = None,
 ) -> list[Admin]:
     """
     Retrieves a list of admins with optional filters and pagination.
@@ -164,13 +182,18 @@ async def get_admins(
         offset (Optional[int]): The number of records to skip (for pagination).
         limit (Optional[int]): The maximum number of records to return.
         username (Optional[str]): The username to filter by.
+        sort (Optional[list[AdminsSortingOptions]]): Sort options for ordering results.
 
     Returns:
         List[Admin]: A list of admin objects.
     """
     query = select(Admin)
     if username:
         query = query.where(Admin.username.ilike(f"%{username}%"))
+
+    if sort:
+        query = query.order_by(*sort)
+
     if offset:
         query = query.offset(offset)
     if limit:

app/operation/admin.py

@@ -5,6 +5,7 @@
 from app import notification
 from app.db import AsyncSession
 from app.db.crud.admin import (
+    AdminsSortingOptions,
     create_admin,
     get_admins,
     get_admins_count,
@@ -75,9 +76,24 @@ async def remove_admin(self, db: AsyncSession, username: str, current_admin: Adm
             asyncio.create_task(notification.remove_admin(username, current_admin.username))
 
     async def get_admins(
-        self, db: AsyncSession, username: str | None = None, offset: int | None = None, limit: int | None = None
+        self,
+        db: AsyncSession,
+        username: str | None = None,
+        offset: int | None = None,
+        limit: int | None = None,
+        sort: str | None = None,
     ) -> list[DBAdmin]:
-        return await get_admins(db, offset, limit, username)
+        sort_list = []
+        if sort is not None:
+            opts = sort.strip(",").split(",")
+            for opt in opts:
+                try:
+                    enum_member = AdminsSortingOptions[opt]
+                    sort_list.append(enum_member.value)
+                except KeyError:
+                    await self.raise_error(message=f'"{opt}" is not a valid sort option', code=400)
+
+        return await get_admins(db, offset, limit, username, sort_list if sort_list else None)
 
     async def get_admins_count(self, db: AsyncSession) -> int:
         return await get_admins_count(db)

app/routers/admin.py

@@ -121,11 +121,12 @@ async def get_admins(
     username: str | None = None,
     offset: int | None = None,
     limit: int | None = None,
+    sort: str | None = None,
     db: AsyncSession = Depends(get_db),
     _: AdminDetails = Depends(check_sudo_admin),
 ):
     """Fetch a list of admins with optional filters for pagination and username."""
-    return await admin_operator.get_admins(db, username=username, offset=offset, limit=limit)
+    return await admin_operator.get_admins(db, username=username, offset=offset, limit=limit, sort=sort)
 
 
 @router.post("/{username}/users/disable", responses={404: responses._404})

tests/api/test_a_admin.py

@@ -81,6 +81,7 @@ def test_get_admins(access_token):
     username = "testadmincreate"
     response = client.get(
         url="/api/admins",
+        params={"sort": "-created_at"},
         headers={"Authorization": f"Bearer {access_token}"},
     )
     assert response.status_code == status.HTTP_200_OK