fix: add date filter in payments api

Author: tehreem-sadat

futurex_openedx_extensions/dashboard/details/courses.py

@@ -1,6 +1,7 @@
 """Courses details collectors"""
 from __future__ import annotations
 
+from datetime import date
 from typing import List
 
 from common.djangoapps.student.models import CourseEnrollment
@@ -298,7 +299,7 @@ def get_courses_feedback_queryset(  # pylint: disable=too-many-arguments
     return queryset
 
 
-def get_courses_orders_queryset(  # pylint: disable=too-many-arguments
+def get_courses_orders_queryset(  # pylint: disable=too-many-arguments, too-many-locals
     fx_permission_info: dict,
     user_ids: list = None,
     course_ids: list = None,
@@ -311,6 +312,8 @@ def get_courses_orders_queryset(  # pylint: disable=too-many-arguments
     include_user_details: bool = False,
     status: str | None = None,
     item_type: str | None = None,
+    date_from: date | None = None,
+    date_to: date | None = None,
 ) -> QuerySet:
     """
     Returns a filtered queryset of Cart Orders based on provided criteria.
@@ -356,4 +359,6 @@ def get_courses_orders_queryset(  # pylint: disable=too-many-arguments
         item_type=item_type,
         include_invoice=include_invoice,
         include_user_details=include_user_details,
+        date_from=date_from,
+        date_to=date_to,
     )

futurex_openedx_extensions/dashboard/docs_src.py

@@ -1694,6 +1694,22 @@ def get_optional_parameter(path: str) -> Any:
                     'Note: right now only paid_course is implemented.'
                 )
             ),
+            query_parameter(
+                'date_from',
+                str,
+                description=(
+                    'The start date of the range for filtering results. Must be provided in `YYYY-MM-DD` format. '
+                    'Can be used together with `date_to` to limit results within a specific date range.'
+                ),
+            ),
+            query_parameter(
+                'date_to',
+                str,
+                description=(
+                    'The end date of the range for filtering results. Must be provided in `YYYY-MM-DD` format. '
+                    'Can be used together with `date_from` to limit results within a specific date range.'
+                ),
+            ),
             common_parameters['include_staff'],
             common_parameters['download'],
         ],

futurex_openedx_extensions/dashboard/serializers.py

@@ -1601,3 +1601,18 @@ def create(self, validated_data: Any) -> Any:
     def update(self, instance: Any, validated_data: Any) -> Any:
         """Not implemented: Update an existing object."""
         raise ValueError('This serializer does not support update.')
+
+
+class ReportDateFilterSerializer(ReadOnlySerializer):
+    """
+    Serializer for date filter.
+    Ensures date_from and date_to follow YYYY-MM-DD format and are parsed into Python date objects.
+    """
+    date_from = serializers.DateField(
+        required=False,
+        input_formats=['%Y-%m-%d'],
+    )
+    date_to = serializers.DateField(
+        required=False,
+        input_formats=['%Y-%m-%d'],
+    )

futurex_openedx_extensions/dashboard/views.py

@@ -305,16 +305,10 @@ def _load_query_params(self, request: Any) -> None:
 
         self.fill_missing_periods = request.query_params.get('fill_missing_periods', '1') == '1'
 
-        date_from = request.query_params.get('date_from')
-        date_to = request.query_params.get('date_to')
-
-        try:
-            self.date_from = datetime.strptime(date_from, '%Y-%m-%d').date() if date_from else None
-            self.date_to = datetime.strptime(date_to, '%Y-%m-%d').date() if date_to else None
-        except (ValueError, TypeError) as exc:
-            raise ParseError(
-                'Invalid dates. You must provide a valid date_from and date_to formated as YYYY-MM-DD'
-            ) from exc
+        date_serializer = serializers.ReportDateFilterSerializer(data=self.request.query_params)
+        date_serializer.is_valid(raise_exception=True)
+        self.date_from = date_serializer.validated_data.get('date_from')
+        self.date_to = date_serializer.validated_data.get('date_to')
 
     def _get_certificates_count_data(self, one_tenant_permission_info: dict) -> int:
         """Get the count of certificates for the given tenant"""
@@ -1939,6 +1933,9 @@ def get_queryset(self) -> QuerySet:
                 message=f'Invalid item_type: {item_type}, must be one of {CatalogueItem.valid_item_types()}.'
             )
 
+        date_serializer = serializers.ReportDateFilterSerializer(data=self.request.query_params)
+        date_serializer.is_valid(raise_exception=True)
+
         qs = get_courses_orders_queryset(
             fx_permission_info=self.fx_permission_info,
             user_ids=user_ids_list,
@@ -1952,6 +1949,8 @@ def get_queryset(self) -> QuerySet:
             include_user_details=self.request.query_params.get('include_user_details', '0') == '1',
             status=status,
             item_type=item_type,
+            date_from=date_serializer.validated_data.get('date_from'),
+            date_to=date_serializer.validated_data.get('date_to'),
         )
         self._cached_course_map = getattr(qs, 'courses_map', {})
         return qs

test_utils/edx_platform_mocks_shared/zeitlabs_payments/querysets.py

@@ -1,4 +1,6 @@
 """Mock"""
+from datetime import date
+
 from django.db.models.query import QuerySet
 
 
@@ -10,6 +12,8 @@ def get_orders_queryset(  # pylint: disable=too-many-arguments,unused-argument
     item_type: str | None = None,
     include_invoice: bool = False,
     include_user_details: bool = False,
+    date_from: date | None = None,
+    date_to: date | None = None,
 ):
     """
     Mock.

tests/test_dashboard/test_details/test_details_courses.py

@@ -1,4 +1,5 @@
 """Tests for courses details collectors"""
+from datetime import datetime
 from unittest.mock import Mock, patch
 
 import pytest
@@ -247,6 +248,7 @@ def test_get_courses_orders_queryset(  # pylint: disable=too-many-locals
     include_user_details = True
     status = 'paid'
     item_type = 'paid_course'
+    date_from = datetime.strptime('2025-01-01', '%Y-%m-%d').date()
     mock_accessible_users = Mock(name='UsersQS')
     mock_accessible_courses = Mock(name='CoursesQS')
     mock_get_users_and_courses.return_value = (
@@ -269,6 +271,8 @@ def test_get_courses_orders_queryset(  # pylint: disable=too-many-locals
         user_ids=user_ids,
         item_type=item_type,
         learner_search=learner_search,
+        date_from=date_from,
+        date_to=None,
     )
 
     mock_get_users_and_courses.assert_called_once_with(
@@ -290,6 +294,8 @@ def test_get_courses_orders_queryset(  # pylint: disable=too-many-locals
         item_type=item_type,
         include_invoice=include_invoice,
         include_user_details=include_user_details,
+        date_from=date_from,
+        date_to=None,
     )
 
     assert result == mock_orders_qs

tests/test_dashboard/test_views.py

@@ -218,30 +218,32 @@ def test_invalid_stats(self):
 
     @patch('futurex_openedx_extensions.dashboard.views.AggregatedCountsView._construct_result')
     @ddt.data(
-        (None, '2024-01-01', '2024-01-01', 'Invalid aggregate_period: None'),
-        ('day', '2024-01-01', '2024-01-01', None),
-        ('day', '2024-01-01', '2024-01-02', None),
-        ('day', '2024-01-02', '2024-01-01', None),
-        ('day', None, '2024-01-01', None),
-        ('day', '2024-01-02', None, None),
-        ('day', None, None, None),
-        ('invalid', '2024-01-01', '2024-01-02', 'Invalid aggregate_period: invalid'),
+        (None, '2024-01-01', '2024-01-01', 'Invalid aggregate_period: None', None),
+        ('day', '2024-01-01', '2024-01-01', None, None),
+        ('day', '2024-01-01', '2024-01-02', None, None),
+        ('day', '2024-01-02', '2024-01-01', None, None),
+        ('day', None, '2024-01-01', None, None),
+        ('day', '2024-01-02', None, None, None),
+        ('day', None, None, None, None),
+        ('invalid', '2024-01-01', '2024-01-02', 'Invalid aggregate_period: invalid', None),
         (
             'day',
             'invalid', '2024-01-02',
-            'Invalid dates. You must provide a valid date_from and date_to formated as YYYY-MM-DD'
+            'Date has wrong format. Use one of these formats instead: YYYY-MM-DD.',
+            'date_from'
         ),
         (
             'day',
             '2024-01-01',
             'invalid',
-            'Invalid dates. You must provide a valid date_from and date_to formated as YYYY-MM-DD'
+            'Date has wrong format. Use one of these formats instead: YYYY-MM-DD.',
+            'date_to'
         ),
-        ('day', '2024-01-03', '2024-01-02', None),
+        ('day', '2024-01-03', '2024-01-02', None, None),
     )
     @ddt.unpack
     def test_load_query_params(
-        self, aggregate_period, date_from, date_to, error_message, mock_construct_result,
+        self, aggregate_period, date_from, date_to, error_message, error_date_field, mock_construct_result
     ):  # pylint: disable=too-many-arguments
         """Verify that _load_query_params works as expected"""
         mock_construct_result.return_value = {
@@ -268,7 +270,10 @@ def test_load_query_params(
         response = self.client.get(url)
         if error_message:
             self.assertEqual(response.status_code, http_status.HTTP_400_BAD_REQUEST)
-            self.assertEqual(str(response.data['detail']), error_message)
+            if error_date_field:
+                self.assertEqual(str(response.data[error_date_field][0]), error_message)
+            else:
+                self.assertEqual(str(response.data['detail']), error_message)
         else:
             self.assertEqual(response.status_code, http_status.HTTP_200_OK)