add pagination

Author: avirajsingh7

backend/app/api/routes/project_user.py

@@ -1,5 +1,5 @@
 import uuid
-from fastapi import APIRouter, Depends, HTTPException
+from fastapi import APIRouter, Depends, HTTPException, Query
 from sqlmodel import Session
 from typing import Annotated
 from app.api.deps import get_db, verify_user_project_organization
@@ -42,14 +42,22 @@ def add_user(
 @router.get("/", response_model=APIResponse[list[ProjectUserPublic]])
 def list_project_users(
     session: Session = Depends(get_db),
-    current_user: UserProjectOrg = Depends(verify_user_project_organization)
+    current_user: UserProjectOrg = Depends(verify_user_project_organization),
+    skip: int = Query(0, ge=0),
+    limit: int = Query(100, ge=1, le=100)
 ):
     """
     Get all users in a project.
     """
-    users = get_users_by_project(session, current_user.project_id)
-    return APIResponse.success_response(users)
+    users, total_count = get_users_by_project(session, current_user.project_id, skip, limit)
+
+    metadata = {
+        "total_count": total_count,
+        "limit": limit,
+        "skip": skip
+    }
 
+    return APIResponse.success_response(data=users, metadata=metadata)
 
 # Remove a user from a project
 @router.delete("/{user_id}", response_model=APIResponse[Message])

backend/app/crud/project_user.py

@@ -1,5 +1,5 @@
 import uuid
-from sqlmodel import Session, select, delete
+from sqlmodel import Session, select, delete, func
 from app.models import ProjectUser, ProjectUserPublic, User
 from datetime import datetime
 
@@ -60,10 +60,23 @@ def remove_user_from_project(session: Session, project_id: uuid.UUID, user_id: u
     session.commit()
 
 
-def get_users_by_project(session: Session, project_id: uuid.UUID) -> list[ProjectUserPublic]:
+def get_users_by_project(
+    session: Session, project_id: uuid.UUID, skip: int = 0, limit: int = 100
+) -> tuple[list[ProjectUserPublic], int]:
     """
-    Returns all users in a given project.
+    Returns paginated users in a given project along with the total count.
     """
-    statement = select(ProjectUser).where(ProjectUser.project_id == project_id, ProjectUser.is_deleted == False)
+    count_statement = select(func.count()).select_from(ProjectUser).where(
+        ProjectUser.project_id == project_id, ProjectUser.is_deleted == False
+    )
+    total_count = session.exec(count_statement).one()
+
+    statement = (
+        select(ProjectUser)
+        .where(ProjectUser.project_id == project_id, ProjectUser.is_deleted == False)
+        .offset(skip)
+        .limit(limit)
+    )
     users = session.exec(statement).all()
-    return [ProjectUserPublic.model_validate(user) for user in users]
+
+    return [ProjectUserPublic.model_validate(user) for user in users], total_count

backend/app/tests/crud/test_project_user.py

@@ -129,5 +129,7 @@ def test_get_users_by_project(db: Session) -> None:
     project_user_crud.add_user_to_project(db, project.id, user1.id)
     project_user_crud.add_user_to_project(db, project.id, user2.id)
 
-    users = project_user_crud.get_users_by_project(db, project.id)
+    users, total_count = project_user_crud.get_users_by_project(db, project.id, skip=0, limit=10)
+
+    assert total_count == 2
     assert len(users) == 2

backend/app/utils.py

@@ -24,10 +24,11 @@ class APIResponse(BaseModel, Generic[T]):
     success: bool
     data: Optional[T] = None
     error: Optional[str] = None
+    metadata: Optional[Dict[str, Any]] = None
 
     @classmethod
-    def success_response(cls, data: T) -> "APIResponse[T]":
-        return cls(success=True, data=data, error=None)
+    def success_response(cls, data: T, metadata: Optional[Dict[str, Any]] = None) -> "APIResponse[T]":
+        return cls(success=True, data=data, error=None, metadata=metadata)
 
     @classmethod
     def failure_response(cls, error: str) -> "APIResponse[None]":