Address PR feedback for the as_of_date filter to include valid_from dates and without it returns all baselines see HEA-914

Author: girumb

apps/baseline/models.py

@@ -138,12 +138,20 @@ class LivelihoodZoneBaselineQuerySet(models.QuerySet):
     """
 
     def filter_current(self, as_of_date=None):
+        """
+        Return a queryset filtered to the baselines that are valid as of the date specified.
+        """
         if not as_of_date:
             as_of_date = datetime.date.today()
-        return self.filter(models.Q(valid_to_date__isnull=True) | models.Q(valid_to_date__gte=as_of_date))
+        return self.filter(
+            (models.Q(valid_from_date__lte=as_of_date) | models.Q(valid_from_date__isnull=True))
+            & (models.Q(valid_to_date__gte=as_of_date) | models.Q(valid_to_date__isnull=True))
+        )
 
     def current_all(self, as_of_date=None):
-        # Return all the baselines that are valid as of the date specified.
+        """
+        Return all the baselines that are valid as of the date specified.
+        """
         return self.filter_current(as_of_date).all()
 
 

apps/baseline/tests/test_viewsets.py

@@ -596,50 +596,75 @@ def test_filter_by_wealth_characteristic(self):
         self.assertEqual(len(response.json()), 1)
 
     def test_as_of_date_filter_returns_valid_baselines(self):
-        # Test that the as_of_date filter returns valid baselines as of the specified date.
+        """
+        Test that the as_of_date filter returns only baselines valid as of the specified date.
+        """
         today = datetime.date.today()
+
+        # Baseline that expired in the past
         expired_baseline = LivelihoodZoneBaselineFactory(
             valid_from_date=today - datetime.timedelta(days=365),
             valid_to_date=today - datetime.timedelta(days=30),
         )
+
+        # Baseline currently valid
         current_baseline = LivelihoodZoneBaselineFactory(
             valid_from_date=today - datetime.timedelta(days=30),
             valid_to_date=today + datetime.timedelta(days=365),
         )
-        # Test default behavior (as of today) - should exclude expired_baseline
+
+        # Baseline that starts in the future (not yet valid)
+        future_baseline = LivelihoodZoneBaselineFactory(
+            valid_from_date=today + datetime.timedelta(days=30),
+            valid_to_date=today + datetime.timedelta(days=365),
+        )
+
+        # Test default behavior (no as_of_date param) - should return all baselines
         response = self.client.get(self.url)
         self.assertEqual(response.status_code, 200)
         baseline_ids = [b["id"] for b in response.json()]
         self.assertIn(current_baseline.id, baseline_ids)
+        self.assertIn(expired_baseline.id, baseline_ids)
+        self.assertIn(future_baseline.id, baseline_ids)
+
+        # Test with explicit as_of_date=today - should filter to current baselines
+        response = self.client.get(self.url, {"as_of_date": today.isoformat()})
+        self.assertEqual(response.status_code, 200)
+        baseline_ids = [b["id"] for b in response.json()]
+        self.assertIn(current_baseline.id, baseline_ids)
         self.assertNotIn(expired_baseline.id, baseline_ids)
+        self.assertNotIn(future_baseline.id, baseline_ids)
 
-        # Test with a past date before the expired_baseline's valid_to_date
+        # Test with a past date when expired_baseline was still valid
+        # current_baseline hadn't started yet, so it should be excluded
         past_date = today - datetime.timedelta(days=180)
         response = self.client.get(self.url, {"as_of_date": past_date.isoformat()})
         self.assertEqual(response.status_code, 200)
         baseline_ids = [b["id"] for b in response.json()]
         self.assertIn(expired_baseline.id, baseline_ids)
-        self.assertIn(current_baseline.id, baseline_ids)
+        self.assertNotIn(current_baseline.id, baseline_ids)  # hadn't started yet
+        self.assertNotIn(future_baseline.id, baseline_ids)
 
-        # Test with a future date - expired_baseline should still be excluded
+        # Test with a future date when future_baseline will be valid
         future_date = today + datetime.timedelta(days=60)
         response = self.client.get(self.url, {"as_of_date": future_date.isoformat()})
         self.assertEqual(response.status_code, 200)
         baseline_ids = [b["id"] for b in response.json()]
         self.assertNotIn(expired_baseline.id, baseline_ids)
         self.assertIn(current_baseline.id, baseline_ids)
+        self.assertIn(future_baseline.id, baseline_ids)
 
-        # test as of date filter handles null dates
+        # Baseline with null valid_from_date (valid from the beginning of time)
         baseline_no_from = LivelihoodZoneBaselineFactory(
             valid_from_date=None,
             valid_to_date=today + datetime.timedelta(days=365),
         )
-        # Create a baseline with null valid_to_date (valid indefinitely)
+        # Baseline with null valid_to_date (valid indefinitely)
         baseline_no_to = LivelihoodZoneBaselineFactory(
             valid_from_date=today - datetime.timedelta(days=365),
             valid_to_date=None,
         )
-        # Create a baseline with both dates null (always valid)
+        # Baseline with both dates null (always valid)
         baseline_no_dates = LivelihoodZoneBaselineFactory(
             valid_from_date=None,
             valid_to_date=None,

apps/baseline/viewsets.py

@@ -254,14 +254,6 @@ def filter_by_wealth_characteristic(self, queryset, name, value):
 class LivelihoodZoneBaselineViewSet(BaseModelViewSet):
     """
     API endpoint that allows livelihood zone baselines to be viewed or edited.
-
-    By default, this endpoint returns only baselines that are currently valid (as of today's date).
-    This behavior can be controlled using the `as_of_date` query parameter:
-
-    - No `as_of_date` parameter: Returns baselines valid as of today
-    - `as_of_date=YYYY-MM-DD`: Returns baselines valid as of the specified date
-    - `as_of_date=today`: Returns baselines valid as of today (explicit)
-    - `as_of_date=<special_value>`: Supports special values like 'last_month', 'one_year_ago', etc.
     """
 
     queryset = LivelihoodZoneBaseline.objects.select_related(
@@ -278,22 +270,6 @@ class LivelihoodZoneBaselineViewSet(BaseModelViewSet):
     ordering_fields = ["livelihood_zone__code", "reference_year_end_date"]
     ordering = ["livelihood_zone__code", "reference_year_end_date"]
 
-    def get_queryset(self):
-        """
-        Override get_queryset to apply default as_of_date filter for list actions.
-        """
-        queryset = super().get_queryset()
-
-        if self.action != "list":
-            return queryset
-
-        as_of_date_param = self.request.query_params.get("as_of_date", None)
-
-        if as_of_date_param is None:
-            queryset = queryset.filter_current()
-
-        return queryset
-
     def get_serializer_class(self):
         if self.request.accepted_renderer.format == "geojson":
             return LivelihoodZoneBaselineGeoSerializer  # Use GeoFeatureModelSerializer for GeoJSON