Add attendees to the ics file (#1410)

Author: davinotdavid

backend/src/appointment/controller/calendar.py

@@ -43,6 +43,7 @@ class RemoteEventState(Enum):
     REJECTED = 'REJECTED'
     TENTATIVE = 'TENTATIVE'
     CONFIRMED = 'CONFIRMED'
+    ACCEPTED = 'ACCEPTED'
 
 
 class BaseConnector:
@@ -599,12 +600,14 @@ def create_vevent(
     ):
         """create an event in ical format for .ics file creation"""
         cal = Calendar()
-        cal.add('prodid', '-//Thunderbird Appointment//tba.dk//')
+        cal.add('prodid', '-//thunderbird.net/Thunderbird Appointment//EN')
         cal.add('version', '2.0')
         cal.add('method', 'CANCEL' if event_status == RemoteEventState.CANCELLED.value else 'REQUEST')
+
         org = vCalAddress('MAILTO:' + organizer.preferred_email)
         org.params['cn'] = vText(organizer.preferred_email)
         org.params['role'] = vText('CHAIR')
+
         event = Event()
         event.add('uid', appointment.uuid.hex)
         event.add('summary', appointment.title)
@@ -618,6 +621,20 @@ def create_vevent(
         event['description'] = appointment.details
         event['organizer'] = org
 
+        if slot.attendee:
+            attendee = vCalAddress(f'MAILTO:{slot.attendee.email}')
+
+            if slot.attendee.name and len(slot.attendee.name.strip()) > 0:
+                attendee.params['cn'] = vText(slot.attendee.name)
+            else:
+                attendee.params['cn'] = vText(slot.attendee.email)
+
+            # Set the attendee status to accepted by default
+            # since they are the ones who are submitting the request
+            attendee.params['partstat'] = vText(RemoteEventState.ACCEPTED.value)
+            attendee.params['role'] = vText('REQ-PARTICIPANT')
+            event.add('attendee', attendee)
+
         # Prefer the slot meeting link url over the appointment location url
         location_url = slot.meeting_link_url if slot.meeting_link_url is not None else appointment.location_url
 

backend/test/unit/test_calendar_tools.py

@@ -191,6 +191,72 @@ def test_meeting_url_in_location(
         assert ics
         assert ':'.join(['LOCATION', slot.meeting_link_url]) in ics.decode()
 
+    def test_prodid_is_set(self, make_google_calendar, make_appointment, make_pro_subscriber):
+        """Verify that the prodid is set correctly in the calendar"""
+        subscriber = make_pro_subscriber()
+        calendar = make_google_calendar(subscriber_id=subscriber.id)
+        appointment = make_appointment(calendar_id=calendar.id)
+        slot = appointment.slots[0]
+
+        ics = Tools().create_vevent(appointment, slot, subscriber)
+        ics_str = ics.decode()
+
+        assert 'PRODID:-//thunderbird.net/Thunderbird Appointment//EN' in ics_str
+
+    def test_attendee_with_name(self, make_google_calendar, make_appointment, make_pro_subscriber):
+        """Verify attendee is added with name when slot has an attendee with a name"""
+        subscriber = make_pro_subscriber()
+        calendar = make_google_calendar(subscriber_id=subscriber.id)
+        appointment = make_appointment(calendar_id=calendar.id)
+        slot = appointment.slots[0]
+        slot.attendee = models.Attendee(email='[email protected]', name='John Doe', timezone='Europe/Berlin')
+
+        ics = Tools().create_vevent(appointment, slot, subscriber)
+        ics_str = ics.decode()
+
+        # Unfold lines (remove CRLF + leading space) and drop CR to keep assertions simple
+        ics_str = ics_str.replace('\r\n ', '').replace('\r', '')
+
+        assert 'ATTENDEE' in ics_str
+        assert 'MAILTO:[email protected]' in ics_str
+        assert 'CN="John Doe"' in ics_str
+        assert 'ROLE=REQ-PARTICIPANT' in ics_str
+        assert 'PARTSTAT=ACCEPTED' in ics_str
+
+    def test_attendee_without_name_uses_email(self, make_google_calendar, make_appointment, make_pro_subscriber):
+        """Verify attendee is added with email as name when slot has an attendee without a name"""
+        subscriber = make_pro_subscriber()
+        calendar = make_google_calendar(subscriber_id=subscriber.id)
+        appointment = make_appointment(calendar_id=calendar.id)
+        slot = appointment.slots[0]
+        slot.attendee = models.Attendee(email='[email protected]', name=None, timezone='Europe/Berlin')
+
+        ics = Tools().create_vevent(appointment, slot, subscriber)
+        ics_str = ics.decode()
+
+        # Unfold lines (remove CRLF + leading space) and drop CR to keep assertions simple
+        ics_str = ics_str.replace('\r\n ', '').replace('\r', '')
+
+        assert 'ATTENDEE' in ics_str
+        assert 'MAILTO:[email protected]' in ics_str
+        assert '[email protected]' in ics_str
+        assert 'ROLE=REQ-PARTICIPANT' in ics_str
+        assert 'PARTSTAT=ACCEPTED' in ics_str
+
+    def test_no_attendee(self, make_google_calendar, make_appointment, make_pro_subscriber):
+        """Verify no attendee is added when slot has no attendee"""
+        subscriber = make_pro_subscriber()
+        calendar = make_google_calendar(subscriber_id=subscriber.id)
+        appointment = make_appointment(calendar_id=calendar.id)
+        slot = appointment.slots[0]
+        slot.attendee = None
+
+        ics = Tools().create_vevent(appointment, slot, subscriber)
+        ics_str = ics.decode()
+
+        # The ATTENDEE field should not be present when there's no attendee
+        assert 'ATTENDEE' not in ics_str
+
 
 class TestDnsCaldavLookup:
     def test_for_host(self):