First steps to move to SQLDelight

.github/workflows/test.yml

@@ -8,12 +8,7 @@ on:
 
 jobs:
   test:
-    strategy:
-      matrix:
-        java: [ '11' ]
-
-    name: test with java ${{ matrix.java }}
-
+    name: test
     runs-on: ubuntu-latest
 
     steps:
@@ -22,7 +17,7 @@ jobs:
       - name: Set up JDK
         uses: actions/setup-java@v3
         with:
-          java-version: ${{ matrix.java }}
+          java-version: '17'
           distribution: 'temurin'
 
       - name: Run Gradle

libpretixsync/build-postgres.gradle

@@ -6,9 +6,10 @@ plugins {
     id 'jacoco'
     id 'org.jetbrains.kotlin.jvm'
     id 'org.jetbrains.kotlin.kapt'
-    id 'com.google.protobuf' version '0.9.4'
+    id 'com.google.protobuf'
     id 'com.github.gmazzo.buildconfig' version "5.3.5"
     id 'org.gradle.idea'
+    id 'app.cash.sqldelight'
 }
 apply from: 'versions.gradle'
 
@@ -107,6 +108,8 @@ dependencies {
     implementation "net.i2p.crypto:eddsa:$eddsa_version"
     implementation "com.google.protobuf:protobuf-javalite:$protobuf_version"
 
+    implementation "app.cash.sqldelight:jdbc-driver:$sqldelight_version"
+
     kapt "io.requery:requery-processor:$requery_version"
     annotationProcessor "javax.annotation:jsr250-api:$jsr250_version"
 
@@ -121,3 +124,13 @@ task copyTestResources(type: Copy) {
     into "${buildDir}/classes/test"
 }
 processTestResources.dependsOn copyTestResources
+
+sqldelight {
+    databases {
+        SyncDatabase {
+            packageName = "eu.pretix.libpretixsync.sqldelight"
+            dialect "app.cash.sqldelight:postgresql-dialect:$sqldelight_version"
+            srcDirs('src/main/sqldelight/postgres', 'src/main/sqldelight/common', 'src/main/sqldelight/migrations')
+        }
+    }
+}

libpretixsync/build.gradle

@@ -4,9 +4,10 @@ plugins {
     id 'jacoco'
     id 'org.jetbrains.kotlin.jvm'
     id 'org.jetbrains.kotlin.kapt'
-    id 'com.google.protobuf' version '0.9.4'
+    id 'com.google.protobuf'
     id 'com.github.gmazzo.buildconfig' version '5.3.5'
     id 'org.gradle.idea'
+    id 'app.cash.sqldelight'
 }
 apply from: 'versions.gradle'
 
@@ -104,6 +105,8 @@ dependencies {
     implementation "net.i2p.crypto:eddsa:$eddsa_version"
     implementation "com.google.protobuf:protobuf-javalite:$protobuf_version"
 
+    implementation "app.cash.sqldelight:sqlite-driver:$sqldelight_version"
+
     kapt "io.requery:requery-processor:$requery_version"
     annotationProcessor "javax.annotation:jsr250-api:$jsr250_version"
 
@@ -118,3 +121,30 @@ task copyTestResources(type: Copy) {
     into "${buildDir}/classes/test"
 }
 processTestResources.dependsOn copyTestResources
+
+sqldelight {
+    databases {
+        SyncDatabase {
+            packageName = "eu.pretix.libpretixsync.sqldelight"
+            srcDirs('src/main/sqldelight/sqlite', 'src/main/sqldelight/common', 'src/main/sqldelight/migrations')
+
+            // SQLDelight supports migration validation by running the migrations against a database file from a
+            // previous version and comparing the result against the current schema.
+            //
+            // The database dumps can be generated with the Gradle task `generateMainSyncDatabaseSchema`, which will
+            // place a .db file in `schemaOutputDirectory` (e.g. 100.db for schema version 100).
+            //
+            // Unfortunately, the validation is buggy for complex schemas (see https://github.com/sqldelight/sqldelight/issues/4759)
+            // and will hang or run out of memory in the current release.
+            //
+            // Running the `verifyMainSyncDatabaseMigration` is still helpful to check the syntax of the migrations.
+            schemaOutputDirectory.set(file("src/main/sqldelight/sqlite"))
+
+
+            // Oldest dialect supported by SQLDelight 2.0.2
+            // In Android projects, it will auto-select based on SDK
+            // but not go lower than 3.18 (Android 9 is still on 3.8)
+            dialect "app.cash.sqldelight:sqlite-3-18-dialect:$sqldelight_version"
+        }
+    }
+}

libpretixsync/settings.gradle

@@ -12,7 +12,8 @@ pluginManagement {
 // but building it inside the multi module project doesn't exit with "unknown version already on classpath" error
 plugins {
     id "org.jetbrains.kotlin.jvm" version "1.9.23" apply false
+    id "com.google.protobuf" version "0.9.4" apply false
+    id "app.cash.sqldelight" version "2.0.2" apply false
 }
 
 rootProject.name = 'eu.pretix.libpretixsync'
-

libpretixsync/src/main/java/eu/pretix/libpretixsync/api/PretixApi.kt

@@ -4,8 +4,8 @@ import eu.pretix.libpretixsync.DummySentryImplementation
 import eu.pretix.libpretixsync.SentryInterface
 import eu.pretix.libpretixsync.config.ConfigStore
 import eu.pretix.libpretixsync.db.Answer
-import eu.pretix.libpretixsync.db.Question
-import eu.pretix.libpretixsync.db.QueuedCheckIn
+import eu.pretix.libpretixsync.models.Question
+import eu.pretix.libpretixsync.models.QueuedCheckIn
 import eu.pretix.libpretixsync.utils.NetUtils
 import eu.pretix.libpretixsync.utils.URLFragmentEncoder
 import okhttp3.MediaType
@@ -73,9 +73,9 @@ open class PretixApi(url: String, key: String, orgaSlug: String, version: Int, h
                         "pdf" -> "application/pdf".toMediaTypeOrNull()!!
                         else -> "application/unknown".toMediaTypeOrNull()!!
                     }, a.value.split("/").last())
-                    answerbody.put("" + (a.question as Question).getServer_id(), fileid)
+                    answerbody.put("" + (a.question as Question).serverId, fileid)
                 } else {
-                    answerbody.put("" + (a.question as Question).getServer_id(), a.value)
+                    answerbody.put("" + (a.question as Question).serverId, a.value)
                 }
             }
         }
@@ -120,9 +120,9 @@ open class PretixApi(url: String, key: String, orgaSlug: String, version: Int, h
                         "pdf" -> "application/pdf".toMediaTypeOrNull()!!
                         else -> "application/unknown".toMediaTypeOrNull()!!
                     }, a.value.split("/").last())
-                    answerbody.put("" + (a.question as Question).getServer_id(), fileid)
+                    answerbody.put("" + (a.question as Question).serverId, fileid)
                 } else {
-                    answerbody.put("" + (a.question as Question).getServer_id(), a.value)
+                    answerbody.put("" + (a.question as Question).serverId, a.value)
                 }
             }
         }
@@ -314,7 +314,7 @@ open class PretixApi(url: String, key: String, orgaSlug: String, version: Int, h
     }
 
     @Throws(ApiException::class)
-    open fun downloadFile(full_url: String): ApiResponse? {
+    open fun downloadFile(full_url: String): ApiResponse {
         var request = Request.Builder()
                 .url(full_url)
                 .header("Authorization", "Device $key")

libpretixsync/src/main/java/eu/pretix/libpretixsync/api/ProxyApi.kt

@@ -0,0 +1,61 @@
+package eu.pretix.libpretixsync.api
+
+import eu.pretix.libpretixsync.db.Answer
+import eu.pretix.libpretixsync.db.QuestionOption
+import eu.pretix.libpretixsync.models.db.toModel
+import eu.pretix.libpretixsync.sqldelight.SyncDatabase
+
+/**
+ * API types for the pretixSCAN Proxy
+ *
+ * Used as common types between the ProxyCheckProvider and the Proxy API endpoints.
+ *
+ * They replicate the field names of the old requery models, which were sent in the requests before the SQLDelight
+ * migration. This should provide reasonable backwards compatibility.
+ */
+
+data class MultiCheckInput(
+    val events_and_checkin_lists: Map<String, Long>,
+    val ticketid: String,
+    val answers: List<CheckInputAnswer>?,
+    val ignore_unpaid: Boolean,
+    val with_badge_data: Boolean,
+    val type: String?,
+    val source_type: String?,
+
+    // TODO: Check unused values
+    val allowQuestions: Boolean,
+    val nonce: String?
+)
+
+data class CheckInput(
+    val ticketid: String,
+    val answers: List<CheckInputAnswer>?,
+    val ignore_unpaid: Boolean,
+    val with_badge_data: Boolean,
+    val type: String?,
+    val source_type: String?
+)
+
+data class CheckInputAnswer(
+    var question: CheckInputQuestion,
+    var value: String,
+    var options: List<QuestionOption>? = null
+) {
+    fun toAnswer(db: SyncDatabase): Answer {
+        val q = db.questionQueries.selectByServerId(question.server_id).executeAsOne().toModel()
+        return Answer(q, value, options)
+    }
+}
+
+data class CheckInputQuestion(
+    val server_id: Long,
+)
+
+data class SearchInput(
+    val query: String,
+    val page: Int,
+
+    // TODO: Check unused values
+    val events_and_checkin_lists: Map<String, Long>,
+)