Merge pull request dimagi#1012 from dimagi/ay/user-visit-export-filter-date

Fixes date filtering for exporting user visits and fetching visits count

Author: ajeety4

commcare_connect/opportunity/export.py

@@ -28,6 +28,7 @@
     UserVisitReviewTable,
     UserVisitTable,
 )
+from commcare_connect.utils.datetime import get_start_end_date_range_with_time
 
 
 class UserVisitExporter:
@@ -95,6 +96,7 @@ def _process_row(self, row):
 
     def get_dataset(self, from_date, to_date, status: list[VisitValidationStatus]) -> Dataset:
         """Get dataset of all user visits for an opportunity."""
+        from_date, to_date = get_start_end_date_range_with_time(from_date, to_date)
         user_visits = UserVisit.objects.filter(
             opportunity=self.opportunity, visit_date__gte=from_date, visit_date__lte=to_date
         )
@@ -120,6 +122,7 @@ def get_dataset(self, from_date, to_date, status: list[VisitValidationStatus]) -
 def export_user_visit_review_data(
     opportunity: Opportunity, from_date, to_date, status: list[VisitReviewStatus]
 ) -> Dataset:
+    from_date, to_date = get_start_end_date_range_with_time(from_date, to_date)
     user_visits = UserVisit.objects.filter(
         opportunity=opportunity,
         review_created_on__isnull=False,

commcare_connect/opportunity/tests/test_export.py

@@ -1,3 +1,4 @@
+import datetime
 import random
 from datetime import timedelta
 
@@ -359,3 +360,93 @@ def test_export_user_visit_review_data(organization, from_date, to_date, expecte
         assert row["Program Manager Review"] in [
             status.label for status in VisitReviewStatus if status.value in review_status
         ]
+
+
+@pytest.mark.django_db
+def test_export_user_visit_review_data_boundary_dates(organization):
+    opp = ManagedOpportunityFactory(organization=organization)
+
+    from_date = datetime.date.today() - datetime.timedelta(days=4)
+    to_date = datetime.date.today() - datetime.timedelta(days=1)
+
+    on_from_date = datetime.datetime.combine(from_date, datetime.time.min, tzinfo=datetime.UTC)
+    on_to_date = datetime.datetime.combine(to_date, datetime.time.max, tzinfo=datetime.UTC)
+    before_from_date = datetime.datetime.combine(
+        from_date - datetime.timedelta(days=1), datetime.time.max, tzinfo=datetime.UTC
+    )
+    after_to_date = datetime.datetime.combine(
+        to_date + datetime.timedelta(days=1), datetime.time.min, tzinfo=datetime.UTC
+    )
+
+    UserVisitFactory.create_batch(
+        3,
+        opportunity=opp,
+        visit_date=on_from_date,
+        review_created_on=on_from_date,
+        review_status=VisitReviewStatus.pending,
+    )
+    UserVisitFactory.create_batch(
+        2,
+        opportunity=opp,
+        visit_date=on_to_date,
+        review_created_on=on_to_date,
+        review_status=VisitReviewStatus.pending,
+    )
+    UserVisitFactory(
+        opportunity=opp,
+        visit_date=before_from_date,
+        review_created_on=before_from_date,
+        review_status=VisitReviewStatus.pending,
+    )
+    UserVisitFactory(
+        opportunity=opp,
+        visit_date=after_to_date,
+        review_created_on=after_to_date,
+        review_status=VisitReviewStatus.pending,
+    )
+
+    dataset = export_user_visit_review_data(opp, from_date, to_date, [VisitReviewStatus.pending.value])
+
+    assert isinstance(dataset, Dataset)
+    assert len(dataset) == 5, f"Expected 5 visits (3 on from_date + 2 on to_date), got {len(dataset)}"
+
+
+@pytest.mark.django_db
+def test_user_visit_exporter_get_dataset_boundary_dates(opportunity, mobile_user_with_connect_link):
+    deliver_unit = DeliverUnitFactory(app=opportunity.deliver_app)
+
+    from_date = datetime.date.today() - datetime.timedelta(days=5)
+    to_date = datetime.date.today() - datetime.timedelta(days=1)
+
+    on_from_date = datetime.datetime.combine(from_date, datetime.time.min, tzinfo=datetime.UTC)
+    on_to_date = datetime.datetime.combine(to_date, datetime.time.max, tzinfo=datetime.UTC)
+    before_from_date = datetime.datetime.combine(
+        from_date - datetime.timedelta(days=1), datetime.time.max, tzinfo=datetime.UTC
+    )
+    after_to_date = datetime.datetime.combine(
+        to_date + datetime.timedelta(days=1), datetime.time.min, tzinfo=datetime.UTC
+    )
+
+    UserVisitFactory(
+        opportunity=opportunity, user=mobile_user_with_connect_link, deliver_unit=deliver_unit, visit_date=on_from_date
+    )
+    UserVisitFactory(
+        opportunity=opportunity, user=mobile_user_with_connect_link, deliver_unit=deliver_unit, visit_date=on_to_date
+    )
+    UserVisitFactory(
+        opportunity=opportunity,
+        user=mobile_user_with_connect_link,
+        deliver_unit=deliver_unit,
+        visit_date=before_from_date,
+    )
+    UserVisitFactory(
+        opportunity=opportunity,
+        user=mobile_user_with_connect_link,
+        deliver_unit=deliver_unit,
+        visit_date=after_to_date,
+    )
+
+    exporter = UserVisitExporter(opportunity, False)
+    dataset = exporter.get_dataset(from_date, to_date, [])
+
+    assert len(dataset) == 2, f"Expected 2 visits (boundary dates), got {len(dataset)}"

commcare_connect/opportunity/tests/test_views.py

@@ -1,5 +1,5 @@
 import inspect
-from datetime import date, timedelta
+from datetime import UTC, date, datetime, time, timedelta
 from http import HTTPStatus
 from unittest import mock
 from uuid import uuid4
@@ -1943,3 +1943,34 @@ def test_payment_delete_view(client: Client, opportunity: Opportunity, org_user_
 
     response = client.post(url)
     assert response.status_code == 404
+
+
+@pytest.mark.django_db
+def test_visit_export_count_boundary_dates(
+    organization: Organization, org_user_member: User, opportunity: Opportunity, client: Client
+):
+    from_date = date.today() - timedelta(days=5)
+    to_date = date.today() - timedelta(days=1)
+
+    on_from_date = datetime.combine(from_date, time.min, tzinfo=UTC)
+    on_to_date = datetime.combine(to_date, time.max, tzinfo=UTC)
+    before_from_date = datetime.combine(from_date - timedelta(days=1), time.max, tzinfo=UTC)
+    after_to_date = datetime.combine(to_date + timedelta(days=1), time.min, tzinfo=UTC)
+
+    UserVisitFactory(opportunity=opportunity, visit_date=on_from_date)
+    UserVisitFactory(opportunity=opportunity, visit_date=on_to_date)
+    UserVisitFactory(opportunity=opportunity, visit_date=before_from_date)
+    UserVisitFactory(opportunity=opportunity, visit_date=after_to_date)
+
+    url = reverse("opportunity:visit_export_count", args=(organization.slug, opportunity.pk))
+    client.force_login(org_user_member)
+    response = client.get(
+        url,
+        data={
+            "from_date": from_date.isoformat(),
+            "to_date": to_date.isoformat(),
+        },
+    )
+
+    assert response.status_code == HTTPStatus.OK
+    assert "2 visits match your filters." in response.content.decode()

commcare_connect/opportunity/views.py

@@ -185,6 +185,7 @@
 from commcare_connect.users.models import User
 from commcare_connect.utils.analytics import GA_CUSTOM_DIMENSIONS, Event, GATrackingInfo, send_event_to_ga
 from commcare_connect.utils.celery import download_export_file, render_export_status
+from commcare_connect.utils.datetime import get_start_end_date_range_with_time
 from commcare_connect.utils.db import get_object_by_uuid_or_int
 from commcare_connect.utils.file import get_file_extension
 from commcare_connect.utils.flags import FlagLabels, Flags
@@ -3047,15 +3048,18 @@ def download_invoice_line_items(request, org_slug, opp_id):
 @org_member_required
 @opportunity_required
 def visit_export_count(request, org_slug, opp_id):
-    from_date = request.GET.get("from_date")
-    if not from_date:
+    from_date_str = request.GET.get("from_date")
+    if not from_date_str:
         return HttpResponse({"error": "Please select a From Date first."}, status=400)
 
-    to_date = request.GET.get("to_date") or datetime.date.today()
+    to_date_str = request.GET.get("to_date")
     status = request.GET.get("status", None)
     review_export = request.GET.get("review_export") == "true"
     format = request.GET.get("format", "csv")
 
+    from_date = datetime.date.fromisoformat(from_date_str)
+    to_date = datetime.date.fromisoformat(to_date_str) if to_date_str else datetime.date.today()
+    from_date, to_date = get_start_end_date_range_with_time(from_date, to_date)
     visits = UserVisit.objects.filter(
         opportunity_id=request.opportunity.pk, visit_date__gte=from_date, visit_date__lte=to_date
     )

commcare_connect/utils/datetime.py

@@ -19,6 +19,15 @@ def get_month_series(from_date: datetime.date, to_date: datetime.date):
     return series
 
 
+def get_start_end_date_range_with_time(
+    from_date: datetime.date, to_date: datetime.date
+) -> tuple[datetime.datetime, datetime.datetime]:
+    """Return (start_datetime, end_datetime) spanning the full days of from_date and to_date in UTC."""
+    start_time = datetime.datetime.combine(from_date, datetime.time.min, tzinfo=datetime.UTC)
+    end_time = datetime.datetime.combine(to_date, datetime.time.max, tzinfo=datetime.UTC)
+    return start_time, end_time
+
+
 def get_start_end_dates_from_month_range(from_date: datetime.date, to_date: datetime.date):
     start_date = datetime.date(from_date.year, from_date.month, 1)
     start_time = datetime.datetime.combine(start_date, datetime.time.min, tzinfo=datetime.UTC)