feat: Add backward compatibility for retrieve_all comments (#238)

This PR adds get_user_comments api that retrieves all of the user comments as it was also supported in the cs_comments_service backend.

Co-authored-by: Taimoor  Ahmed <taimoor.ahmed@A006-01711.local>

Author: taimoor-ahmed-1

forum/__init__.py

@@ -2,4 +2,4 @@
 Openedx forum app.
 """
 
-__version__ = "0.3.6"
+__version__ = "0.3.7"

forum/api/__init__.py

@@ -9,6 +9,7 @@
     delete_comment,
     get_course_id_by_comment,
     get_parent_comment,
+    get_user_comments,
     update_comment,
 )
 from .flags import (
@@ -68,6 +69,7 @@
     "get_thread_subscriptions",
     "get_user",
     "get_user_active_threads",
+    "get_user_comments",
     "get_user_course_stats",
     "get_user_subscriptions",
     "get_user_threads",

forum/api/comments.py

@@ -3,6 +3,7 @@
 """
 
 import logging
+import math
 from typing import Any, Optional
 
 from django.core.exceptions import ObjectDoesNotExist
@@ -317,3 +318,57 @@ def get_course_id_by_comment(comment_id: str) -> str | None:
         or MySQLBackend.get_course_id_by_comment_id(comment_id)
         or None
     )
+
+
+def get_user_comments(
+    user_id: str,
+    course_id: str,
+    flagged: Optional[bool] = False,
+    page: int = 1,
+    per_page: int = 10,
+) -> dict[str, Any]:
+    """
+    Get all comments made by a user in a specific course.
+
+    Args:
+        user_id: The ID of the user
+        course_id: The ID of the course
+        flagged: Filter for flagged comments
+        page: Page number for pagination
+        per_page: Number of items per page
+
+    Returns:
+        A dictionary containing paginated comment results
+    """
+
+    backend = get_backend(course_id)()
+
+    # Build query parameters
+    query_params: dict[str, Any] = {
+        "author_id": str(user_id),
+        "course_id": course_id,
+    }
+
+    if flagged:
+        query_params["abuse_flaggers"] = {"$ne": [], "$exists": True}
+
+    # Get total count
+    comment_count = backend.get_comments_count(**query_params)
+
+    # Calculate pagination
+    num_pages = max(1, math.ceil(comment_count / per_page))
+    skip = (page - 1) * per_page
+
+    # Get paginated comments
+    query_params["resp_skip"] = skip
+    query_params["resp_limit"] = per_page
+    query_params["sort"] = -1  # Sort by newest first
+
+    comments = backend.get_comments(**query_params)
+
+    return {
+        "collection": comments,
+        "comment_count": comment_count,
+        "num_pages": num_pages,
+        "page": page,
+    }