Fix for recurring tasks with recurrence-instances with mixed STATUS

Fixes #495

This fixes two things:

* Non-expanded recurring tasks with mixed STATUS from the server would be silently ignored if asking for pending tasks.  Clearly a bug.  This bug happened before client-side expansion.
* Client-side expansion should consider that we may have asked only for pending tasks - then the COMPLETED recurrences should be ignored.

Author: tobixen

CHANGELOG.md

@@ -28,6 +28,7 @@ Python 3.7 is no longer tested (dependency problems) - but it should work.  Plea
 * Bugfix for saving component failing on multi-component recurrence objects - https://github.com/python-caldav/caldav/pull/467
 * Some exotic servers may return object URLs on search, but it does not work out to fetch the calendar data.  Now it will log an error instead of raising an error in such cases.
 * Some workarounds and fixes for getting tests passing on all the test servers I had at hand in https://github.com/python-caldav/caldav/pull/492
+* Search for todo-items would ignore recurring tasks with COMPLETED recurrence instances, ref https://github.com/python-caldav/caldav/issues/495, fixed in https://github.com/python-caldav/caldav/pull/496
 
 ### Changed
 

caldav/calendarobjectresource.py

@@ -160,7 +160,9 @@ def split_expanded(self) -> List[Self]:
             ret.append(obj)
         return ret
 
-    def expand_rrule(self, start: datetime, end: datetime) -> None:
+    def expand_rrule(
+        self, start: datetime, end: datetime, include_completed: bool = True
+    ) -> None:
         """This method will transform the calendar content of the
         event and expand the calendar data from a "master copy" with
         RRULE set and into a "recurrence set" with RECURRENCE-ID set
@@ -186,6 +188,7 @@ def expand_rrule(self, start: datetime, end: datetime) -> None:
         # FIXME too much copying
         stripped_event = self.copy(keep_uid=True)
 
+        ## TODO: use icalendar_instance instead
         if stripped_event.vobject_instance is None:
             raise ValueError(
                 "Unexpected value None for stripped_event.vobject_instance"
@@ -203,6 +206,13 @@ def expand_rrule(self, start: datetime, end: datetime) -> None:
         calendar = self.icalendar_instance
         calendar.subcomponents = []
         for occurrence in recurrings:
+            ## Ignore completed task recurrences
+            if (
+                not include_completed
+                and occurrence.name == "VTODO"
+                and occurrence.get("STATUS") in ("COMPLETED", "CANCELLED")
+            ):
+                continue
             if "RECURRENCE-ID" not in occurrence:
                 occurrence.add("RECURRENCE-ID", occurrence.get("DTSTART"))
             calendar.add_component(occurrence)
@@ -1329,8 +1339,6 @@ def complete(
         self.save()
 
     def _complete_ical(self, i=None, completion_timestamp=None) -> None:
-        ## my idea was to let self.complete call this one ... but self.complete
-        ## should use vobject and not icalendar library due to backward compatibility.
         if i is None:
             i = self.icalendar_component
         assert self._is_pending(i)

caldav/collection.py

@@ -850,10 +850,9 @@ def search(
                     ## and still, Zimbra seems to deliver too many TODOs in the
                     ## matches2 ... let's do some post-filtering in case the
                     ## server fails in filtering things the right way
-                    if "STATUS:NEEDS-ACTION" in item.data or (
-                        "\nCOMPLETED:" not in item.data
-                        and "\nSTATUS:COMPLETED" not in item.data
-                        and "\nSTATUS:CANCELLED" not in item.data
+                    if any(
+                        x.get("STATUS") not in ("COMPLETED", "CANCELLED")
+                        for x in item.icalendar_instance.subcomponents
                     ):
                         objects.append(item)
         else:
@@ -925,7 +924,7 @@ def search(
                     continue
                 recurrence_properties = ["exdate", "exrule", "rdate", "rrule"]
                 if any(key in component for key in recurrence_properties):
-                    o.expand_rrule(start, end)
+                    o.expand_rrule(start, end, include_completed=include_completed)
 
             ## An expanded recurring object comes as one Event() with
             ## icalendar data containing multiple objects.  The caller may

tests/test_caldav_unit.py

@@ -154,6 +154,115 @@
 END:VTODO
 END:VCALENDAR"""
 
+## from https://github.com/python-caldav/caldav/issues/495
+recurring_task_response = """<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:cal="urn:ietf:params:xml:ns:caldav" xmlns:cs="http://calendarserver.org/ns/" xmlns:oc="http://owncloud.org/ns" xmlns:nc="http://nextcloud.org/ns">
+  <d:response>
+    <d:href>/remote.php/dav/calendars/oxi/personal/A9FFE819-5DDB-4947-A09C-308EEE5DA1F9.ics</d:href>
+    <d:propstat>
+      <d:prop>
+        <cal:calendar-data>BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:+//IDN bitfire.at//ical4android (at.techbee.jtx)
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:23
+CREATED:20250411T233004Z
+LAST-MODIFIED:20250522T075137Z
+SUMMARY:Clean Rosie filter
+DTSTART;VALUE=DATE:20250415
+RRULE:FREQ=WEEKLY;BYDAY=TU,FR
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250414T082134Z
+SUMMARY:Clean Rosie filter
+STATUS:COMPLETED
+DTSTART;VALUE=DATE:20250415
+RECURRENCE-ID;VALUE=DATE:20250415
+COMPLETED:20250414T082134Z
+PERCENT-COMPLETE:100
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250414T082134Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250418
+RECURRENCE-ID;VALUE=DATE:20250418
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250414T082134Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250422
+RECURRENCE-ID;VALUE=DATE:20250422
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250425T124511Z
+SUMMARY:Clean Rosie filter
+STATUS:COMPLETED
+DTSTART;VALUE=DATE:20250425
+RECURRENCE-ID;VALUE=DATE:20250425
+COMPLETED:20250425T124511Z
+PERCENT-COMPLETE:100
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250425T124511Z
+SUMMARY:Clean Rosie filter
+STATUS:CANCELLED
+DTSTART;VALUE=DATE:20250429
+RECURRENCE-ID;VALUE=DATE:20250429
+COMPLETED:20250425T124511Z
+PERCENT-COMPLETE:100
+PRIORITY:0
+END:VTODO
+BEGIN:VTODO
+DTSTAMP:20250522T075151Z
+UID:8a8736b4-bc35-4085-a98b-89c2f52a5c51
+SEQUENCE:1
+CREATED:20250411T234336Z
+LAST-MODIFIED:20250502T113705Z
+SUMMARY:Clean Rosie filter
+STATUS:COMPLETED
+DTSTART;VALUE=DATE:20250502
+RECURRENCE-ID;VALUE=DATE:20250502
+COMPLETED:20250502T113705Z
+PERCENT-COMPLETE:100
+PRIORITY:0
+END:VTODO
+END:VCALENDAR
+</cal:calendar-data>
+      </d:prop>
+      <d:status>HTTP/1.1 200 OK</d:status>
+    </d:propstat>
+  </d:response>
+</d:multistatus>
+"""
+
 
 def MockedDAVResponse(text, davclient=None):
     """
@@ -167,14 +276,20 @@ def MockedDAVResponse(text, davclient=None):
     return DAVResponse(resp, davclient)
 
 
-def MockedDAVClient(xml_returned):
+class MockedDAVClient(DAVClient):
     """
     For unit testing - a mocked DAVClient returning some specific content every time
     a request is performed
     """
-    client = DAVClient(url="https://somwhere.in.the.universe.example/some/caldav/root")
-    client.request = mock.MagicMock(return_value=MockedDAVResponse(xml_returned))
-    return client
+
+    def __init__(self, xml_returned):
+        self.xml_returned = xml_returned
+        DAVClient.__init__(
+            self, url="https://somwhere.in.the.universe.example/some/caldav/root"
+        )
+
+    def request(self, *largs, **kwargs):
+        return MockedDAVResponse(self.xml_returned)
 
 
 class TestExpandRRule:
@@ -272,6 +387,28 @@ def testRequestNonAscii(self, mocked):
         assert response.status == 200
         assert response.tree is None
 
+    def testSearchForRecurringTask(self):
+        client = MockedDAVClient(recurring_task_response)
+        calendar = Calendar(client, url="/calendar/issue491/")
+        mytasks = calendar.search(todo=True, expand=False)
+        assert len(mytasks) == 1
+        mytasks = calendar.search(
+            todo=True,
+            expand="client",
+            start=datetime(2025, 5, 5),
+            end=datetime(2025, 6, 5),
+        )
+        assert len(mytasks) == 9
+
+        ## It should not include the COMPLETED recurrences
+        mytasks = calendar.search(
+            todo=True,
+            expand="client",
+            start=datetime(2025, 1, 1),
+            end=datetime(2025, 6, 5),
+        )
+        assert len(mytasks) == 9
+
     def testLoadByMultiGet404(self):
         xml = """
 <D:multistatus xmlns:D="DAV:">