fix(caldav): expand RRULE for recurring events

2026-09-06 15:49:09 +02:00
parent f35121b3dc
commit 8e946964ec
11 changed files with 1223 additions and 126 deletions
@@ -10,12 +10,15 @@ import (
 	"path/filepath"
 	"strings"
 	"testing"
+	"time"

 	"git.arnef.de/arnef/nidus/internal/auth"
 	"git.arnef.de/arnef/nidus/internal/config"
 	"git.arnef.de/arnef/nidus/internal/db"
+	"git.arnef.de/arnef/nidus/internal/icssub"
 	"git.arnef.de/arnef/nidus/internal/store"
 	ical "github.com/emersion/go-ical"
+	"github.com/emersion/go-webdav/caldav"
 )

 func newTestBackend(t *testing.T) (*Backend, *db.DB) {
@@ -331,3 +334,297 @@ func TestSharedCalendarNameCollidingWithOwnGetsDisambiguated(t *testing.T) {
 		t.Fatalf("GetCalendar: expected display name %q, got %q", want, cal.Name)
 	}
 }
+
+// TestHoistPropFilterTimeRangesUnit pins the shape of the hoist rewrite:
+// a prop-filter time-range (DTSTART window) is lifted onto its enclosing
+// VEVENT comp-filter, and the prop-filter's own Start/End are cleared,
+// so go-webdav's recurrence-aware comp-level check runs instead of its
+// literal-DTSTART prop check.
+func TestHoistPropFilterTimeRangesUnit(t *testing.T) {
+	loc := time.UTC
+	gs := time.Date(2026, 9, 1, 0, 0, 0, 0, loc)
+	ge := time.Date(2026, 9, 30, 0, 0, 0, 0, loc)
+
+	cf := caldav.CompFilter{
+		Name: "VCALENDAR",
+		Comps: []caldav.CompFilter{{
+			Name:  "VEVENT",
+			Props: []caldav.PropFilter{{Name: "DTSTART", Start: gs, End: ge}},
+		}},
+	}
+
+	hoistPropFilterTimeRanges(&cf)
+
+	vevent := cf.Comps[0]
+	if vevent.Start != gs || vevent.End != ge {
+		t.Fatalf("VEVENT comp should inherit the time-range, got Start=%v End=%v", vevent.Start, vevent.End)
+	}
+	if !vevent.Props[0].Start.IsZero() || !vevent.Props[0].End.IsZero() {
+		t.Fatalf("prop-filter time-range must be cleared, got Start=%v End=%v", vevent.Props[0].Start, vevent.Props[0].End)
+	}
+	// The VEVENT name is untouched — hoist must not clobber component names.
+	if vevent.Name != "VEVENT" {
+		t.Fatalf("VEVENT comp name must be preserved, got %q", vevent.Name)
+	}
+}
+
+// rruleSample is a weekly series whose base DTSTART sits in the past
+// (2025) relative to the queried 2026 window — the classic shape that
+// go-webdav's literal-DTSTART prop-time-range check drops, but that a
+// proper RRULE expansion keeps.
+const rruleSample = "BEGIN:VCALENDAR\r\n" +
+	"VERSION:2.0\r\n" +
+	"PRODID:-//nidus//test//EN\r\n" +
+	"BEGIN:VEVENT\r\n" +
+	"UID:weekly@nidus.test\r\n" +
+	"DTSTAMP:20260101T000000Z\r\n" +
+	"DTSTART:20250911T100000Z\r\n" + // 2025 base, far before the 2026-09 window
+	"DTEND:20250911T103000Z\r\n" +
+	"RRULE:FREQ=WEEKLY;UNTIL=20270826T080000Z;INTERVAL=3;BYDAY=TH;WKST=SU\r\n" +
+	"SUMMARY:Frontend Weekly\r\n" +
+	"END:VEVENT\r\n" +
+	"END:VCALENDAR\r\n"
+
+// TestQueryCalendarObjectsPropFilterTimeRangeRecurring is the regression
+// test for the "CalDAV still misses Frontend Weekly / Abstimmung /
+// Prd-Deployment" report. DAVx5 and Thunderbird issue calendar-query
+// filters as <prop-filter name="DTSTART"><time-range/></prop-filter>
+// *inside* a VEVENT comp-filter. go-webdav's matchPropTimeRange only
+// compares the literal DTSTART (2025), so without the hoist the 2026-09
+// query returns an empty result for a weekly series whose base date is
+// in 2025. The hoist lifts the time-range onto the comp-filter, where
+// go-webdav's recurrence-aware matchCompTimeRange (RecurrenceSet) keeps
+// the series.
+func TestQueryCalendarObjectsPropFilterTimeRangeRecurring(t *testing.T) {
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		_, _ = w.Write([]byte(rruleSample))
+	}))
+	defer srv.Close()
+
+	dir := t.TempDir()
+	st, err := store.NewStore(filepath.Join(dir, "data"))
+	if err != nil {
+		t.Fatalf("NewStore: %v", err)
+	}
+	dbase, err := db.Open(filepath.Join(dir, "test.db"))
+	if err != nil {
+		t.Fatalf("Open db: %v", err)
+	}
+	defer dbase.Close()
+	if err := dbase.CreateUser("alice", "pw", "", ""); err != nil {
+		t.Fatalf("CreateUser: %v", err)
+	}
+	if err := dbase.CreateICSSubscription("alice", "holidays", srv.URL, ""); err != nil {
+		t.Fatalf("CreateICSSubscription: %v", err)
+	}
+	logger := slog.New(slog.NewTextHandler(io.Discard, nil))
+	b := NewBackend(&config.Config{}, st, dbase, logger, icssub.NewCache(time.Hour))
+	ctx := auth.NewContext(context.Background(), &auth.Principal{Username: "alice"})
+
+	loc := time.UTC
+	gs := time.Date(2026, 9, 1, 0, 0, 0, 0, loc)
+	ge := time.Date(2026, 9, 30, 0, 0, 0, 0, loc)
+
+	// The DAVx5/Thunderbird form: a prop-filter time-range on DTSTART
+	// nested inside a VEVENT comp-filter under VCALENDAR.
+	q := &caldav.CalendarQuery{
+		CompFilter: caldav.CompFilter{
+			Name: "VCALENDAR",
+			Comps: []caldav.CompFilter{{
+				Name:  "VEVENT",
+				Props: []caldav.PropFilter{{Name: "DTSTART", Start: gs, End: ge}},
+			}},
+		},
+	}
+	objs, err := b.QueryCalendarObjects(ctx, "/cal/home/holidays/", q)
+	if err != nil {
+		t.Fatalf("QueryCalendarObjects: %v", err)
+	}
+	if len(objs) == 0 {
+		t.Fatal("QueryCalendarObjects with a DAVx5-shape prop-filter time-range " +
+			"returned 0 objects for a weekly series whose RRULE has 2026-09 " +
+			"occurrences, but whose base DTSTART is 2025 — this is the " +
+			"regression the hoist fix exists to prevent")
+	}
+	found := false
+	for _, co := range objs {
+		for _, ev := range co.Data.Events() {
+			if p := ev.Props.Get(ical.PropSummary); p != nil && p.Value == "Frontend Weekly" {
+				found = true
+			}
+		}
+	}
+	if !found {
+		t.Fatal("expected 'Frontend Weekly' in the query result")
+	}
+}
+
+// TestReportPropFilterTimeRangeRecurringE2E drives the *full* HTTP stack a
+// real CalDAV client uses: NewHandler → go-webdav caldav.Handler → XML decode
+// of the <calendar-query>/<prop-filter>/<time-range> body →
+// QueryCalendarObjects (hoist) → caldav.Filter. The in-process tests above
+// hand-build the CompFilter struct and therefore skip the XML-decode step,
+// so this is the only test that can catch a bug in how the client's actual
+// request gets parsed. DAVx5/Thunderbird send exactly this shape.
+func TestReportPropFilterTimeRangeRecurringE2E(t *testing.T) {
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.Header().Set("Content-Type", "text/calendar; charset=utf-8")
+		w.WriteHeader(http.StatusOK)
+		_, _ = w.Write([]byte(rruleSample))
+	}))
+	defer srv.Close()
+
+	dir := t.TempDir()
+	st, err := store.NewStore(filepath.Join(dir, "data"))
+	if err != nil {
+		t.Fatalf("NewStore: %v", err)
+	}
+	dbase, err := db.Open(filepath.Join(dir, "test.db"))
+	if err != nil {
+		t.Fatalf("db.Open: %v", err)
+	}
+	defer dbase.Close()
+	if err := dbase.CreateUser("alice", "pw", "", ""); err != nil {
+		t.Fatalf("CreateUser: %v", err)
+	}
+	if err := dbase.CreateICSSubscription("alice", "holidays", srv.URL, ""); err != nil {
+		t.Fatalf("CreateICSSubscription: %v", err)
+	}
+	logger := slog.New(slog.NewTextHandler(io.Discard, nil))
+	cfg := &config.Config{}
+	cfg.Auth.Realm = "test"
+
+	handlers := auth.NewMiddleware(cfg, dbase, logger)
+	httpd := httptest.NewServer(handlers.Wrap(NewHandler(cfg, st, dbase, logger, icssub.NewCache(time.Hour))))
+	defer httpd.Close()
+
+	reportXML := `<?xml version="1.0" encoding="utf-8"?>
+<C:calendar-query xmlns:D="DAV:" xmlns:C="urn:ietf:params:xml:ns:caldav">
+  <D:allprop/>
+  <C:filter>
+    <C:comp-filter name="VCALENDAR">
+      <C:comp-filter name="VEVENT">
+        <C:prop-filter name="DTSTART">
+          <C:time-range start="20260901T000000Z" end="20260930T000000Z"/>
+        </C:prop-filter>
+      </C:comp-filter>
+    </C:comp-filter>
+  </C:filter>
+</C:calendar-query>`
+
+	req, err := http.NewRequest("REPORT", httpd.URL+"/cal/home/holidays/", strings.NewReader(reportXML))
+	if err != nil {
+		t.Fatalf("NewRequest: %v", err)
+	}
+	req.SetBasicAuth("alice", "pw")
+	req.Header.Set("Content-Type", "application/xml; charset=utf-8")
+	req.Header.Set("Depth", "1")
+
+	resp, err := httpd.Client().Do(req)
+	if err != nil {
+		t.Fatalf("Do: %v", err)
+	}
+	defer resp.Body.Close()
+	body, _ := io.ReadAll(resp.Body)
+
+	if resp.StatusCode != http.StatusMultiStatus {
+		t.Fatalf("REPORT status = %d, want 207; body:\n%s", resp.StatusCode, body)
+	}
+	if !strings.Contains(string(body), "Frontend Weekly") {
+		t.Fatalf("REPORT response did not include the recurring 'Frontend Weekly' series. This is the exact DAVx5/Thunderbird request shape; body:\n%s", body)
+	}
+}
+
+// TestCloseOpenEndedTimeRangesUnit exercises closeOpenEndedTimeRanges
+// directly: a comp-filter with only Start set (no End) must get End
+// filled in with farFutureSentinel, and a comp-filter with neither set
+// must be left alone (it has no time-range at all, so there's nothing to
+// "close").
+func TestCloseOpenEndedTimeRangesUnit(t *testing.T) {
+	gs := time.Date(2026, 6, 8, 0, 0, 0, 0, time.UTC)
+	cf := caldav.CompFilter{
+		Name: "VCALENDAR",
+		Comps: []caldav.CompFilter{
+			{Name: "VEVENT", Start: gs}, // open-ended: no End
+			{Name: "VTODO"},             // no time-range at all
+		},
+	}
+
+	closeOpenEndedTimeRanges(&cf)
+
+	if cf.Comps[0].End != farFutureSentinel {
+		t.Fatalf("open-ended VEVENT comp-filter should get End=farFutureSentinel, got %v", cf.Comps[0].End)
+	}
+	if !cf.Comps[1].Start.IsZero() || !cf.Comps[1].End.IsZero() {
+		t.Fatalf("VTODO comp-filter without any time-range must be left untouched, got Start=%v End=%v",
+			cf.Comps[1].Start, cf.Comps[1].End)
+	}
+}
+
+// TestQueryCalendarObjectsOpenEndedTimeRangeRecurring is the regression
+// test for a real bug found while investigating the "missing recurring
+// events" report: a client asking for "everything from date X onward"
+// (RFC 4791 §9.9 explicitly permits a time-range with only a start
+// attribute) — which is exactly what a client's default "sync events
+// from N days in the past, no future limit" setting produces — decodes
+// with End left as the zero time.Time. go-webdav's matchCompTimeRange
+// then calls rrule.Set.Between(start, zero-time, true) for any recurring
+// event, which always returns zero occurrences (the "end" bound is year
+// 1, before "start"), so *every* recurring series silently vanishes from
+// an open-ended query, even though the exact same series matches fine
+// when the client happens to also send an explicit (bounded) end date.
+func TestQueryCalendarObjectsOpenEndedTimeRangeRecurring(t *testing.T) {
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		_, _ = w.Write([]byte(rruleSample))
+	}))
+	defer srv.Close()
+
+	dir := t.TempDir()
+	st, err := store.NewStore(filepath.Join(dir, "data"))
+	if err != nil {
+		t.Fatalf("NewStore: %v", err)
+	}
+	dbase, err := db.Open(filepath.Join(dir, "test.db"))
+	if err != nil {
+		t.Fatalf("Open db: %v", err)
+	}
+	defer dbase.Close()
+	if err := dbase.CreateUser("alice", "pw", "", ""); err != nil {
+		t.Fatalf("CreateUser: %v", err)
+	}
+	if err := dbase.CreateICSSubscription("alice", "holidays", srv.URL, ""); err != nil {
+		t.Fatalf("CreateICSSubscription: %v", err)
+	}
+	logger := slog.New(slog.NewTextHandler(io.Discard, nil))
+	b := NewBackend(&config.Config{}, st, dbase, logger, icssub.NewCache(time.Hour))
+	ctx := auth.NewContext(context.Background(), &auth.Principal{Username: "alice"})
+
+	// "Sync from 90 days ago, no future limit": only Start is set.
+	gs := time.Date(2026, 6, 8, 0, 0, 0, 0, time.UTC)
+	q := &caldav.CalendarQuery{
+		CompFilter: caldav.CompFilter{
+			Name: "VCALENDAR",
+			Comps: []caldav.CompFilter{{
+				Name:  "VEVENT",
+				Start: gs, // no End: open-ended
+			}},
+		},
+	}
+	objs, err := b.QueryCalendarObjects(ctx, "/cal/home/holidays/", q)
+	if err != nil {
+		t.Fatalf("QueryCalendarObjects: %v", err)
+	}
+	found := false
+	for _, co := range objs {
+		for _, ev := range co.Data.Events() {
+			if p := ev.Props.Get(ical.PropSummary); p != nil && p.Value == "Frontend Weekly" {
+				found = true
+			}
+		}
+	}
+	if !found {
+		t.Fatal("expected 'Frontend Weekly' to match an open-ended (start-only) time-range query")
+	}
+}