Simplify numDirectInstances / numInstances to only numInstances

Author: rfc2822

lib/src/androidTest/kotlin/at/bitfire/synctools/storage/calendar/AndroidCalendarTest.kt

@@ -286,42 +286,42 @@ class AndroidCalendarTest {
     // event instances
 
     @Test
-    fun testNumDirectInstances_SingleInstance() {
+    fun testNumInstances_SingleInstance() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to now,
             Events.DTEND to now + 3600000,
             Events.TITLE to "Event with 1 instance"
         )))
-        assertEquals(1, calendar.numDirectInstances(id))
+        assertEquals(1, calendar.numInstances(id))
     }
 
     @Test
-    fun testNumDirectInstances_Recurring() {
+    fun testNumInstances_Recurring() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to now,
             Events.DURATION to "PT1H",
             Events.TITLE to "Event with 5 instances",
             Events.RRULE to "FREQ=DAILY;COUNT=5"
         )))
-        assertEquals(5, calendar.numDirectInstances(id))
+        assertEquals(5, calendar.numInstances(id))
     }
 
     @Test
-    fun testNumDirectInstances_Recurring_Endless() {
+    fun testNumInstances_Recurring_Endless() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to now,
             Events.DURATION to "PT1H",
             Events.TITLE to "Event without end",
             Events.RRULE to "FREQ=DAILY"
         )))
-        assertNull(calendar.numDirectInstances(id))
+        assertNull(calendar.numInstances(id))
     }
 
     @Test
-    fun testNumDirectInstances_Recurring_LateEnd() {
+    fun testNumInstances_Recurring_LateEnd() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to 1642640523000,
@@ -331,13 +331,13 @@ class AndroidCalendarTest {
         )))
 
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R)
-            assertEquals(52, calendar.numDirectInstances(id))
+            assertEquals(52, calendar.numInstances(id))
         else    // year 2074 is not supported by Android <11 Calendar Storage
-            assertNull(calendar.numDirectInstances(id))
+            assertNull(calendar.numInstances(id))
     }
 
     @Test
-    fun testNumDirectInstances_Recurring_ManyInstances() {
+    fun testNumInstances_Recurring_Until() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to 1642640523000,
@@ -350,12 +350,12 @@ class AndroidCalendarTest {
                 365 * 2       // Android <9: does not include UNTIL (incorrect!)
             else
                 365 * 2 + 1,  // Android ≥9: includes UNTIL (correct)
-            calendar.numDirectInstances(id)
+            calendar.numInstances(id)
         )
     }
 
     @Test
-    fun testNumDirectInstances_RecurringWithExdate() {
+    fun testNumInstances_RecurringWithExdate() {
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.DTSTART to 1642640523000,
@@ -364,18 +364,18 @@ class AndroidCalendarTest {
             Events.RRULE to "FREQ=DAILY;COUNT=5",
             Events.EXDATE to "20220121T010203Z"
         )))
-        assertEquals(4, calendar.numDirectInstances(id))
+        assertEquals(4, calendar.numInstances(id))
     }
 
     @Test
-    fun testNumDirectInstances_RecurringWithExceptions() {
+    fun testNumInstances_RecurringWithExceptions_MatchingOrigInstanceTime() {
         val syncId = "recurring-with-exceptions"
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events._SYNC_ID to syncId,
             Events.DTSTART to 1642640523000,
             Events.DURATION to "PT1H",
-            Events.TITLE to "Event with 5 instances, two of them excluded",
+            Events.TITLE to "Event with 5 instances, two of them are exceptions",
             Events.RRULE to "FREQ=DAILY;COUNT=5"
         )))
         calendar.addEvent(Entity(contentValuesOf(
@@ -394,88 +394,19 @@ class AndroidCalendarTest {
             Events.DURATION to "PT1H",
             Events.TITLE to "Exception on 5th day",
         )))
-        assertEquals(5 - 2, calendar.numDirectInstances(id))
-    }
-
-    @Test
-    fun testNumInstances_SingleInstance() {
-        val id = calendar.addEvent(Entity(contentValuesOf(
-            Events.CALENDAR_ID to calendar.id,
-            Events.DTSTART to now,
-            Events.DTEND to now + 3600000,
-            Events.TITLE to "Event with 1 instance"
-        )))
-        assertEquals(1, calendar.numInstances(id))
+        assertEquals(5 - 2, calendar.numInstances(id))
     }
 
     @Test
-    fun testNumInstances_Recurring() {
-        val id = calendar.addEvent(Entity(contentValuesOf(
-            Events.CALENDAR_ID to calendar.id,
-            Events.DTSTART to now,
-            Events.DURATION to "PT1H",
-            Events.TITLE to "Event with 5 instances",
-            Events.RRULE to "FREQ=DAILY;COUNT=5"
-        )))
-        assertEquals(5, calendar.numInstances(id))
-    }
-
-    @Test
-    fun testNumInstances_Recurring_Endless() {
-        val id = calendar.addEvent(Entity(contentValuesOf(
-            Events.CALENDAR_ID to calendar.id,
-            Events.DTSTART to now,
-            Events.DURATION to "PT1H",
-            Events.TITLE to "Event without end",
-            Events.RRULE to "FREQ=DAILY"
-        )))
-        assertNull(calendar.numInstances(id))
-    }
-
-    @Test
-    fun testNumInstances_Recurring_LateEnd() {
-        val id = calendar.addEvent(Entity(contentValuesOf(
-            Events.CALENDAR_ID to calendar.id,
-            Events.DTSTART to 1642640523000,
-            Events.DURATION to "PT1H",
-            Events.TITLE to "Event until 2074",
-            Events.RRULE to "FREQ=YEARLY;UNTIL=20740119T010203Z"
-        )))
-
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R)
-            assertEquals(52, calendar.numInstances(id))
-        else
-            assertNull(calendar.numInstances(id))
-    }
-
-    @Test
-    fun testNumInstances_Recurring_ManyInstances() {
-        val id = calendar.addEvent(Entity(contentValuesOf(
-            Events.CALENDAR_ID to calendar.id,
-            Events.DTSTART to 1642640523000,
-            Events.DURATION to "PT1H",
-            Events.TITLE to "Event with 2 years",
-            Events.RRULE to "FREQ=DAILY;UNTIL=20240120T010203Z"
-        )))
-        assertEquals(
-            if (Build.VERSION.SDK_INT < Build.VERSION_CODES.P)
-                365 * 2       // Android <9: does not include UNTIL (incorrect!)
-            else
-                365 * 2 + 1,  // Android ≥9: includes UNTIL (correct)
-            calendar.numInstances(id)
-        )
-    }
-
-    @Test
-    fun testNumInstances_RecurringWithExceptions() {
+    fun testNumInstances_RecurringWithExceptions_NotMatchingOrigInstanceTime() {
         val syncId = "recurring-with-exceptions"
         val id = calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events._SYNC_ID to syncId,
             Events.DTSTART to 1642640523000,
             Events.DURATION to "PT1H",
-            Events.TITLE to "Event with 6 instances",
-            Events.RRULE to "FREQ=DAILY;COUNT=6"
+            Events.TITLE to "Event with 5 instances, two of them are exceptions",
+            Events.RRULE to "FREQ=DAILY;COUNT=5"
         )))
         calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
@@ -488,13 +419,12 @@ class AndroidCalendarTest {
         calendar.addEvent(Entity(contentValuesOf(
             Events.CALENDAR_ID to calendar.id,
             Events.ORIGINAL_SYNC_ID to syncId,
-            Events.ORIGINAL_INSTANCE_TIME to 1642640523000 + 4*86400000,
+            Events.ORIGINAL_INSTANCE_TIME to 1642640523000 + 4*86400000 + 100,  // doesn't match original instance time!
             Events.DTSTART to 1642640523000 + 4*86400000 + 3600000, // one hour later
             Events.DURATION to "PT1H",
-            Events.TITLE to "Exception on 5th day",
+            Events.TITLE to "Exception on 5th day (wrong instance time)",
         )))
-
-        assertEquals(6, calendar.numInstances(id))
+        assertEquals(5 - 1, calendar.numInstances(id))
     }
 
 }

lib/src/main/kotlin/at/bitfire/synctools/storage/calendar/AndroidCalendar.kt

@@ -16,6 +16,7 @@ import android.provider.CalendarContract.Calendars
 import android.provider.CalendarContract.Events
 import android.provider.CalendarContract.EventsEntity
 import android.provider.CalendarContract.ExtendedProperties
+import android.provider.CalendarContract.Instances
 import android.provider.CalendarContract.Reminders
 import at.bitfire.ical4android.UnknownProperty
 import at.bitfire.ical4android.util.MiscUtils.asSyncAdapter
@@ -342,24 +343,25 @@ class AndroidCalendar(
 
 
 
-    // event instances (these methods operate directly with event IDs and without the events themselves and thus belong to the calendar class)
+    // event instances (these methods operate directly with event IDs and without the events
+    // themselves and thus belong to the calendar class)
 
     /**
-     * Finds the amount of direct instances this event has (without exceptions); used by [numInstances]
-     * to find the number of instances of exceptions.
+     * Finds the amount of direct instances this event has. Exceptions have their own instances
+     * and are not taken into account by this value.
      *
-     * The number of returned instances may vary with the Android version.
+     * Use [numInstances] to find the total number of instances (including exceptions) of this event.
      *
      * @return number of direct event instances (not counting instances of exceptions); *null* if
      * the number can't be determined or if the event has no last date (recurring event without last instance)
      *
      * @throws LocalStorageException when the content provider returns an error
      */
-    fun numDirectInstances(eventId: Long): Int? {
+    fun numInstances(eventId: Long): Int? {
         // query event to get first and last instance
         var first: Long? = null
         var last: Long? = null
-        getEventRow(id, arrayOf(Events.DTSTART, Events.LAST_DATE))?.let { values ->
+        getEventRow(eventId, arrayOf(Events.DTSTART, Events.LAST_DATE))?.let { values ->
             first = values.getAsLong(Events.DTSTART)
             last = values.getAsLong(Events.LAST_DATE)
         }
@@ -370,7 +372,7 @@ class AndroidCalendar(
         /* We can't use Long.MIN_VALUE and Long.MAX_VALUE because Android generates the instances
          on the fly and it doesn't accept those values. So we use the first/last actual occurrence
          of the event (as calculated by Android). */
-        val instancesUri = CalendarContract.Instances.CONTENT_URI.asSyncAdapter(account)
+        val instancesUri = Instances.CONTENT_URI.asSyncAdapter(account)
             .buildUpon()
             .appendPath(first.toString())       // begin timestamp
             .appendPath(last.toString())        // end timestamp
@@ -379,8 +381,8 @@ class AndroidCalendar(
         var numInstances: Int? = null
         try {
             client.query(
-                instancesUri, null,
-                "${CalendarContract.Instances.EVENT_ID}=?", arrayOf(eventId.toString()),
+                instancesUri, arrayOf(/* we're only interested in the number of results */),
+                "${Instances.EVENT_ID}=?", arrayOf(eventId.toString()),
                 null
             )?.use { cursor ->
                 numInstances = cursor.count
@@ -391,34 +393,6 @@ class AndroidCalendar(
         return numInstances
     }
 
-    /**
-     * Finds the total number of instances this event has (including instances of exceptions)
-     *
-     * The number of returned instances may vary with the Android version.
-     *
-     * @return number of event instances (including instances of exceptions); *null* if
-     * the number can't be determined or if the event has no last date (recurring event without last instance)
-     */
-    fun numInstances(eventId: Long): Int? {
-        // num instances of the main event
-        val numDirectInstances = numDirectInstances(eventId) ?: return null
-
-        // add the number of instances of every main event's exception
-        var numExInstances = 0
-        iterateEventRows(
-            arrayOf(Events._ID),
-            "${Events.ORIGINAL_ID}=?",  // get exception events of the main event
-            arrayOf(eventId.toString())
-        ) { values ->
-            val exceptionEventId = values.getAsLong(Events._ID)
-            val exceptionInstances = numDirectInstances(exceptionEventId)
-
-            if (exceptionInstances != null)
-                numExInstances += exceptionInstances
-        }
-        return numDirectInstances - numExInstances
-    }
-
 
     // shortcuts to upper level