feat: migrate chore UI to load events from local computed objects

Author: thisislawatts

chores/tests/fixtures/api_schema.json

@@ -0,0 +1,96 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "",
+  "type": "object",
+  "properties": {
+    "title": {
+      "type": "string",
+      "minLength": 1
+    },
+    "version": {
+      "type": "string",
+      "minLength": 1
+    },
+    "chores": {
+      "type": "array",
+      "uniqueItems": true,
+      "minItems": 1,
+      "items": {
+        "required": ["ts_str", "timestamp"],
+        "properties": {
+          "ts_str": {
+            "type": "string",
+            "minLength": 1
+          },
+          "timestamp": {
+            "type": "number"
+          },
+          "events": {
+            "type": "array",
+            "uniqueItems": true,
+            "minItems": 1,
+            "items": {
+              "required": ["time_str", "wiki_url"],
+              "properties": {
+                "chore": {
+                  "type": "object",
+                  "properties": {
+                    "chore_id": {
+                      "type": "number"
+                    },
+                    "description": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "min_required_people": {
+                      "type": "number"
+                    },
+                    "name": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  },
+                  "required": [
+                    "chore_id",
+                    "description",
+                    "min_required_people",
+                    "name"
+                  ]
+                },
+                "when": {
+                  "type": "object",
+                  "properties": {
+                    "human_str": {
+                      "type": "string",
+                      "minLength": 1
+                    },
+                    "timestamp": {
+                      "type": "number"
+                    }
+                  },
+                  "required": ["human_str", "timestamp"]
+                },
+                "time_str": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "volunteers": {
+                  "type": "array",
+                  "items": {
+                    "required": [],
+                    "properties": {}
+                  }
+                },
+                "wiki_url": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "required": ["title", "version", "chores"]
+}

chores/tests/test_api.py

@@ -0,0 +1,98 @@
+import json
+
+import time_machine
+from django.contrib.auth import get_user_model
+from django.test import TestCase
+from django.urls import reverse
+from faker import Faker
+from rest_framework import status
+
+from ..models import Chore
+from .factories import UserFactory
+
+fake = Faker()
+
+User = get_user_model()
+
+
+# Load the schema from a file
+def load_schema(schema_path):
+    with open(schema_path, "r") as schema_file:
+        return json.load(schema_file)
+
+
+class ChoresAPITest(TestCase):
+    def setUp(self):
+        self.user = UserFactory()
+
+    def test_empty_chores_api_list_endpoint_returns_404(self):
+        """Test that the chores API list endpoint returns a 404 response"""
+        url = reverse("chores_api")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+
+    @time_machine.travel("2025-07-13 14:56")
+    def test_chores_api_list_endpoint_returns_200(self):
+        """Test that the chores API list endpoint returns a 200 response"""
+        url = reverse("chores_api")
+        Chore.objects.create(
+            name=fake.name(),
+            description="A test chore that needs volunteers.",
+            class_type="BasicChore",
+            wiki_url=fake.url(),
+            configuration={
+                "min_required_people": 1,
+                "events_generation": {
+                    "event_type": "recurrent",
+                    "starting_time": "21/7/2021 8:00",
+                    "crontab": "0 22 * * sun",
+                    "take_one_every": 2,
+                },
+                "reminders": [
+                    {
+                        "reminder_type": "missing_volunteers",
+                        "when": {"days_before": 10, "time": "17:00"},
+                        "nudges": [
+                            {
+                                "nudge_type": "email",
+                                "nudge_key": "gentle_email_reminder",
+                                "destination": "[email protected]",
+                                "subject_template": "Volunteers needed next week",
+                                "body_template": "Hallo, we hebben {num_volunteers_needed} vrijwilliger nodig volgende week.\n\nOm stof in onze makerspace tegen te gaan willen we je vragen om te stofzuigen in de voorste ruimte en de houtwerkplaats, en eventueel de grote hal. \n\nAls je daar zin in hebt kun je ook de voorste ruimte dweilen met de hippe turbodweil die we hebben, maar als je weinig tijd hebt: Met alleen stofzuigen is al veel te winnen.\n\nDeze taak kan op elk moment gedurende de week worden gedaan. Je helpt wanneer het jou uitkomt, alle hulp is welkom!\n\nInformatie over schoonmaken op de Wiki: https://wiki.makerspaceleiden.nl/mediawiki/index.php/Chore_-_Dedustify \n\n\nClick here to sign up: {signup_url}",
+                            }
+                        ],
+                    },
+                    {
+                        "reminder_type": "missing_volunteers",
+                        "when": {"days_before": 6, "time": "17:00"},
+                        "nudges": [
+                            {
+                                "nudge_type": "email",
+                                "nudge_key": "hard_email_reminder",
+                                "destination": "[email protected]",
+                                "subject_template": "Volunteers REALLY needed for this week",
+                                "body_template": "Hallo, we hebben nog steeds {num_volunteers_needed} vrijwilliger nodig voor deze week.\n\nOm stof in onze makerspace tegen te gaan willen we je vragen om te stofzuigen in de voorste ruimte en de houtwerkplaats, en eventueel de grote hal. \n\nAls je daar zin in hebt kun je ook de voorste ruimte dweilen met de hippe turbodweil die we hebben, maar als je weinig tijd hebt: Met alleen stofzuigen is al veel te winnen.\n\nDeze taak kan op elk moment gedurende de week worden gedaan. Je helpt wanneer het jou uitkomt, alle hulp is welkom!\n\nInformatie over schoonmaken op de Wiki: https://wiki.makerspaceleiden.nl/mediawiki/index.php/Chore_-_Dedustify \n\nClick here to sign up: {signup_url}",
+                            }
+                        ],
+                    },
+                    {
+                        "reminder_type": "volunteers_who_signed_up",
+                        "when": {"days_before": 7, "time": "19:00"},
+                    },
+                ],
+            },
+            creator=self.user,
+        )
+
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        jsonBody = json.loads(response.content)
+        print("------------------------------------------------")
+        self.assertEqual(len(jsonBody["chores"]), 6)
+
+        # LADEBUG: Fixme
+        # schema = load_schema(
+        #     os.path.join(os.path.dirname(__file__), "./fixtures/api_schema.json")
+        # )
+        # jsonschema.validate(jsonBody, schema)

chores/views.py

@@ -12,33 +12,39 @@
 from django.shortcuts import redirect, render
 from django.template.loader import render_to_string
 
-from selfservice.aggregator_adapter import get_aggregator_adapter
-
+from .core import ChoreEventsLogic, Time
 from .models import Chore, ChoreVolunteer
 
 logger = logging.getLogger(__name__)
 
+NUMBER_OF_DAYS_AHEAD = 90
 
-def getall(current_user_id=None, subset=None):
-    aggregator_adapter = get_aggregator_adapter()
-    if not aggregator_adapter:
-        return HttpResponse(
-            "No aggregator configuration found", status=500, content_type="text/plain"
-        )
 
+def chores_get_all_from(now):
+    # FIXME: replace use of aggregator_adapter.get_chores()
+    then = now + (NUMBER_OF_DAYS_AHEAD * 24 * 60 * 60)  # Add 14 days
+    chores = Chore.objects.all()
+    data = ChoreEventsLogic(chores).get_events_from_to(
+        Time.from_timestamp(now), Time.from_timestamp(then)
+    )
+    return [e.for_json() for e in data]
+
+
+def getall(current_user_id=None, subset=None):
     now = time.time()
     volunteers_turns = ChoreVolunteer.objects.filter(timestamp__gte=now)
     volunteers_by_key = defaultdict(list)
     for turn in volunteers_turns:
         key = f"{turn.chore.id}-{turn.timestamp}"
         volunteers_by_key[key].append(turn.user)
 
-    data = aggregator_adapter.get_chores()
+    # FIXME: replace use of aggregator_adapter.get_chores()
+    data = chores_get_all_from(now)
 
     event_groups = []
     ts = None
     if data is not None:
-        for event in data["events"]:
+        for event in data:
             event_ts = datetime.fromtimestamp(event["when"]["timestamp"])
             event_ts_str = event_ts.strftime("%d%m%Y")
             event["time_str"] = event_ts.strftime("%H:%M")
@@ -87,6 +93,7 @@ def index_api(request, name=None):
 
     if not chores:
         return HttpResponse("No chores found", status=404, content_type="text/plain")
+
     payload = {
         "title": "Chores of this week",
         "version": "1.00",
@@ -115,23 +122,21 @@ def index(request):
 
 
 def get_chores_overview(current_user_id=None, subset=None):
-    aggregator_adapter = get_aggregator_adapter()
-    if not aggregator_adapter:
-        return None, "No aggregator configuration found"
+    now = time.time()
 
     volunteers_turns = ChoreVolunteer.objects.all()
     volunteers_by_key = defaultdict(list)
     for turn in volunteers_turns:
         key = f"{turn.chore.id}-{turn.timestamp}"
         volunteers_by_key[key].append(turn.user)
 
-    data = aggregator_adapter.get_chores()
-    if data is None:
+    chore_events = chores_get_all_from(now)
+    if chore_events is None:
         return None, "No data available"
 
     event_groups = {}
 
-    for event in data["events"]:
+    for event in chore_events:
         event_ts = datetime.fromtimestamp(event["when"]["timestamp"])
 
         event["time_str"] = event_ts.strftime("%H:%M")

selfservice/aggregator_adapter.py

@@ -59,15 +59,6 @@ def notification_test(self, user_id):
     def checkout(self, user_id):
         self._request_with_user_id("/space/checkout", user_id)
 
-    def get_chores(self):
-        payload = self._request_with_user_id("/chores/overview")
-        if payload:
-            try:
-                return json.loads(payload)
-            except Exception:
-                logger.error("Failed to parse the json chore: '{}'.".format(payload))
-        return None
-
 
 def initialize_aggregator_adapter(base_url, username, password):
     return AggregatorAdapter(base_url, username, password)

selfservice/test_helpers/mocks.py

@@ -16,6 +16,3 @@ def notification_test(self, user_id):
 
     def checkout(self, user_id):
         pass
-
-    def get_chores(self):
-        return {"chores": ["mocked-chore-1", "mocked-chore-2"]}