BatchOperation: set yield point after every 500 operations (#188)

* BatchOperation: set "yield allowed" after every 500 operations

* Only use "max. operations per yield point" for tasks.org/OpenTasks operations

Author: rfc2822

lib/src/androidTest/kotlin/at/bitfire/ical4android/AbstractTasksTest.kt renamed to lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsStyleProvidersTaskTest.kt

@@ -16,7 +16,7 @@ import java.util.logging.Logger
 
 @RunWith(Parameterized::class)
 
-abstract class AbstractTasksTest(
+abstract class DmfsStyleProvidersTaskTest(
     val providerName: TaskProvider.ProviderName
 ) {
 

lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsTaskListTest.kt

@@ -21,7 +21,7 @@ import org.junit.Assert.assertTrue
 import org.junit.Test
 
 class DmfsTaskListTest(providerName: TaskProvider.ProviderName):
-    AbstractTasksTest(providerName) {
+    DmfsStyleProvidersTaskTest(providerName) {
 
     private val testAccount = Account("AndroidTaskListTest", TaskContract.LOCAL_ACCOUNT_TYPE)
 

lib/src/androidTest/kotlin/at/bitfire/ical4android/DmfsTaskTest.kt

@@ -9,13 +9,13 @@ import android.content.ContentUris
 import android.content.ContentValues
 import android.database.DatabaseUtils
 import android.net.Uri
-import androidx.test.filters.MediumTest
 import at.bitfire.ical4android.impl.TestTask
 import at.bitfire.ical4android.impl.TestTaskList
 import at.bitfire.ical4android.util.DateUtils
 import net.fortuna.ical4j.model.Date
 import net.fortuna.ical4j.model.DateList
 import net.fortuna.ical4j.model.DateTime
+import net.fortuna.ical4j.model.component.VAlarm
 import net.fortuna.ical4j.model.parameter.Email
 import net.fortuna.ical4j.model.parameter.RelType
 import net.fortuna.ical4j.model.parameter.TzId
@@ -52,8 +52,8 @@ import org.junit.Test
 import java.time.ZoneId
 
 class DmfsTaskTest(
-        providerName: TaskProvider.ProviderName
-): AbstractTasksTest(providerName) {
+    providerName: TaskProvider.ProviderName
+): DmfsStyleProvidersTaskTest(providerName) {
 
     private val tzVienna = DateUtils.ical4jTimeZone("Europe/Vienna")!!
     private val tzChicago = DateUtils.ical4jTimeZone("America/Chicago")!!
@@ -643,7 +643,6 @@ class DmfsTaskTest(
     }
 
 
-    @MediumTest
     @Test
     fun testAddTask() {
         // build and write event to calendar provider
@@ -693,7 +692,6 @@ class DmfsTaskTest(
         }
     }
 
-    @MediumTest
     @Test(expected = CalendarStorageException::class)
     fun testAddTaskWithInvalidDue() {
         val task = Task()
@@ -705,7 +703,21 @@ class DmfsTaskTest(
         TestTask(taskList!!, task).add()
     }
 
-    @MediumTest
+    @Test
+    fun testAddTaskWithManyAlarms() {
+        val task = Task()
+        task.uid = "TaskWithManyAlarms"
+        task.summary = "Task with many alarms"
+        task.dtStart = DtStart(Date("20150102"))
+
+        for (i in 1..1050)
+            task.alarms += VAlarm(java.time.Duration.ofMinutes(i.toLong()))
+
+        val uri = TestTask(taskList!!, task).add()
+        val task2 = taskList!!.findById(ContentUris.parseId(uri))
+        assertEquals(1050, task2.task?.alarms?.size)
+    }
+
     @Test
     fun testUpdateTask() {
         // add test event without reminder
@@ -739,7 +751,6 @@ class DmfsTaskTest(
         }
     }
 
-    @MediumTest
     @Test
     fun testBuildAllDayTask() {
         // add all-day event to calendar provider

lib/src/main/kotlin/at/bitfire/ical4android/BatchOperation.kt

@@ -17,9 +17,17 @@ import java.util.logging.Level
 import java.util.logging.Logger
 
 class BatchOperation(
-    private val providerClient: ContentProviderClient
+    private val providerClient: ContentProviderClient,
+    private val maxOperationsPerYieldPoint: Int? = null
 ) {
-    
+
+    companion object {
+
+        /** Maximum number of operations per yield point in task providers that are based on SQLiteContentProvider. */
+        const val TASKS_OPERATIONS_PER_YIELD_POINT = 499
+
+    }
+
     private val logger = Logger.getLogger(javaClass.name)
 
     private val queue = LinkedList<CpoBuilder>()
@@ -96,7 +104,6 @@ class BatchOperation(
 
         try {
             val ops = toCPO(start, end)
-            logger.fine("Running ${ops.size} operations ($start .. ${end - 1})")
             val partResults = providerClient.applyBatch(ops)
 
             val n = end - start
@@ -133,6 +140,7 @@ class BatchOperation(
          * 2. If a back reference points to a row outside of start/end,
          *    replace it by the actual result, which has already been calculated. */
 
+        var currentIdx = 0
         for (cpoBuilder in queue.subList(start, end)) {
             for ((backrefKey, backref) in cpoBuilder.valueBackrefs) {
                 val originalIdx = backref.originalIndex
@@ -148,17 +156,22 @@ class BatchOperation(
                     backref.setIndex(originalIdx - start)
             }
 
+            // Set a possible yield point every MAX_OPERATIONS_PER_YIELD_POINT operations for SQLiteContentProvider
+            currentIdx += 1
+            if (maxOperationsPerYieldPoint != null && currentIdx.mod(maxOperationsPerYieldPoint) == 0)
+                cpoBuilder.withYieldAllowed()
+
             cpo += cpoBuilder.build()
         }
         return cpo
     }
 
 
     class BackReference(
-            /** index of the referenced row in the original, nonsplitted transaction */
-            val originalIndex: Int
+        /** index of the referenced row in the original, non-splitted transaction */
+        val originalIndex: Int
     ) {
-        /** overriden index, i.e. index within the splitted transaction */
+        /** overridden index, i.e. index within the splitted transaction */
         private var index: Int? = null
 
         /**
@@ -182,8 +195,8 @@ class BatchOperation(
      * value back references.
      */
     class CpoBuilder private constructor(
-            val uri: Uri,
-            val type: Type
+        val uri: Uri,
+        val type: Type
     ) {
 
         enum class Type { INSERT, UPDATE, DELETE }
@@ -197,11 +210,13 @@ class BatchOperation(
         }
 
 
-        var selection: String? = null
-        var selectionArguments: Array<String>? = null
+        private var selection: String? = null
+        private var selectionArguments: Array<String>? = null
+
+        internal val values = mutableMapOf<String, Any?>()
+        internal val valueBackrefs = mutableMapOf<String, BackReference>()
 
-        val values = mutableMapOf<String, Any?>()
-        val valueBackrefs = mutableMapOf<String, BackReference>()
+        private var yieldAllowed = false
 
 
         fun withSelection(select: String, args: Array<String>): CpoBuilder {
@@ -226,6 +241,10 @@ class BatchOperation(
             return this
         }
 
+        fun withYieldAllowed() {
+            yieldAllowed = true
+        }
+
 
         fun build(): ContentProviderOperation {
             val builder = when (type) {
@@ -242,6 +261,9 @@ class BatchOperation(
             for ((key, backref) in valueBackrefs)
                 builder.withValueBackReference(key, backref.getIndex())
 
+            if (yieldAllowed)
+                builder.withYieldAllowed(true)
+
             return builder.build()
         }
 

lib/src/main/kotlin/at/bitfire/ical4android/DmfsTask.kt

@@ -330,7 +330,7 @@ abstract class DmfsTask(
 
 
     fun add(): Uri {
-        val batch = BatchOperation(taskList.provider)
+        val batch = BatchOperation(taskList.provider, BatchOperation.TASKS_OPERATIONS_PER_YIELD_POINT)
 
         val builder = CpoBuilder.newInsert(taskList.tasksSyncUri())
         buildTask(builder, false)
@@ -350,7 +350,7 @@ abstract class DmfsTask(
         this.task = task
         val existingId = requireNotNull(id)
 
-        val batch = BatchOperation(taskList.provider)
+        val batch = BatchOperation(taskList.provider, BatchOperation.TASKS_OPERATIONS_PER_YIELD_POINT)
 
         // remove associated rows which are added later again
         batch.enqueue(CpoBuilder

lib/src/main/kotlin/at/bitfire/ical4android/DmfsTaskList.kt

@@ -163,7 +163,7 @@ abstract class DmfsTaskList<out T : DmfsTask>(
      */
     fun touchRelations(): Int {
         logger.fine("Touching relations to set parent_id")
-        val batchOperation = BatchOperation(provider)
+        val batchOperation = BatchOperation(provider, BatchOperation.TASKS_OPERATIONS_PER_YIELD_POINT)
         provider.query(
             tasksSyncUri(true), null,
             "${Tasks.LIST_ID}=? AND ${Tasks.PARENT_ID} IS NULL AND ${Relation.MIMETYPE}=? AND ${Relation.RELATED_ID} IS NOT NULL",