Improve addListener api

cashapp · Jun 8, 2023 · 928427a · 928427a
1 parent 60938e2
commit 928427a
Show file tree

Hide file tree

Showing 35 changed files with 161 additions and 177 deletions.
diff --git a/...rs/android-driver/src/main/java/app/cash/sqldelight/driver/android/AndroidSqliteDriver.kt b/...rs/android-driver/src/main/java/app/cash/sqldelight/driver/android/AndroidSqliteDriver.kt
@@ -81,23 +81,23 @@ class AndroidSqliteDriver private constructor(
 
   private val listeners = linkedMapOf<String, MutableSet<Query.Listener>>()
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     synchronized(listeners) {
       queryKeys.forEach {
         listeners.getOrPut(it, { linkedSetOf() }).add(listener)
       }
     }
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     synchronized(listeners) {
       queryKeys.forEach {
         listeners[it]?.remove(listener)
       }
     }
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     val listenersToNotify = linkedSetOf<Query.Listener>()
     synchronized(listeners) {
       queryKeys.forEach { listeners[it]?.let(listenersToNotify::addAll) }

diff --git a/drivers/driver-test/src/commonMain/kotlin/com/squareup/sqldelight/driver/test/QueryTest.kt b/drivers/driver-test/src/commonMain/kotlin/com/squareup/sqldelight/driver/test/QueryTest.kt
@@ -137,31 +137,23 @@ abstract class QueryTest {
   @Test fun notifyDataChangedNotifiesListeners() {
     val notifies = AtomicInt(0)
     val query = testDataQuery()
-    val listener = object : Query.Listener {
-      override fun queryResultsChanged() {
-        notifies.incrementAndGet()
-      }
-    }
+    val listener = Query.Listener { notifies.incrementAndGet() }
 
     query.addListener(listener)
     assertEquals(0, notifies.get())
 
-    driver.notifyListeners(arrayOf("test"))
+    driver.notifyListeners("test")
     assertEquals(1, notifies.get())
   }
 
   @Test fun removeListenerActuallyRemovesListener() {
     val notifies = AtomicInt(0)
     val query = testDataQuery()
-    val listener = object : Query.Listener {
-      override fun queryResultsChanged() {
-        notifies.incrementAndGet()
-      }
-    }
+    val listener = Query.Listener { notifies.incrementAndGet() }
 
     query.addListener(listener)
     query.removeListener(listener)
-    driver.notifyListeners(arrayOf("test"))
+    driver.notifyListeners("test")
     assertEquals(0, notifies.get())
   }
 
@@ -179,11 +171,11 @@ abstract class QueryTest {
       }
 
       override fun addListener(listener: Listener) {
-        driver.addListener(listener, arrayOf("test"))
+        driver.addListener("test", listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        driver.removeListener(listener, arrayOf("test"))
+        driver.removeListener("test", listener = listener)
       }
     }
   }

diff --git a/drivers/jdbc-driver/src/main/kotlin/app/cash/sqldelight/driver/jdbc/JdbcDriver.kt b/drivers/jdbc-driver/src/main/kotlin/app/cash/sqldelight/driver/jdbc/JdbcDriver.kt
@@ -26,15 +26,15 @@ fun DataSource.asJdbcDriver() = object : JdbcDriver() {
     connection.close()
   }
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     // No-op. JDBC Driver is not set up for observing queries by default.
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     // No-op. JDBC Driver is not set up for observing queries by default.
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     // No-op. JDBC Driver is not set up for observing queries by default.
   }
 }

diff --git a/...ative-driver/src/nativeMain/kotlin/app/cash/sqldelight/driver/native/NativeSqlDatabase.kt b/...ative-driver/src/nativeMain/kotlin/app/cash/sqldelight/driver/native/NativeSqlDatabase.kt
@@ -172,19 +172,19 @@ class NativeSqliteDriver(
     }
   }
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners.getOrPut(it) { mutableMapOf() }.put(listener, Unit)
     }
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners.get(it)?.remove(listener)
     }
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     val listenersToNotify = mutableSetOf<Query.Listener>()
     queryKeys.forEach { key -> listeners.get(key)?.let { listenersToNotify.addAll(it.keys) } }
     listenersToNotify.forEach(Query.Listener::queryResultsChanged)
@@ -303,15 +303,15 @@ internal class SqliterWrappedConnection(
     block: ThreadConnection.() -> R,
   ): R = threadConnection.block()
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     // No-op
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     // No-op
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     // No-op
   }
 

diff --git a/...veTest/kotlin/com/squareup/sqldelight/drivers/native/connectionpool/WalConcurrencyTest.kt b/...veTest/kotlin/com/squareup/sqldelight/drivers/native/connectionpool/WalConcurrencyTest.kt
@@ -107,11 +107,11 @@ class WalConcurrencyTest : BaseConcurrencyTest() {
       }
 
       override fun addListener(listener: Listener) {
-        driver.addListener(listener, arrayOf("test"))
+        driver.addListener("test", listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        driver.removeListener(listener, arrayOf("test"))
+        driver.removeListener("test", listener = listener)
       }
     }
   }

diff --git a/drivers/r2dbc-driver/src/main/kotlin/app/cash/sqldelight/driver/r2dbc/R2dbcDriver.kt b/drivers/r2dbc-driver/src/main/kotlin/app/cash/sqldelight/driver/r2dbc/R2dbcDriver.kt
@@ -84,9 +84,9 @@ class R2dbcDriver(
 
   override fun currentTransaction(): Transacter.Transaction? = transaction
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) = Unit
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) = Unit
-  override fun notifyListeners(queryKeys: Array<String>) = Unit
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) = Unit
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) = Unit
+  override fun notifyListeners(vararg queryKeys: String) = Unit
 
   override fun close() {
     // Normally, this is just a Mono, so it completes directly without onNext.

diff --git a/.../sqlite-driver/src/main/kotlin/app/cash/sqldelight/driver/jdbc/sqlite/JdbcSqliteDriver.kt b/.../sqlite-driver/src/main/kotlin/app/cash/sqldelight/driver/jdbc/sqlite/JdbcSqliteDriver.kt
@@ -21,23 +21,23 @@ class JdbcSqliteDriver constructor(
 ) : JdbcDriver(), ConnectionManager by connectionManager(url, properties) {
   private val listeners = linkedMapOf<String, MutableSet<Query.Listener>>()
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     synchronized(listeners) {
       queryKeys.forEach {
         listeners.getOrPut(it, { linkedSetOf() }).add(listener)
       }
     }
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     synchronized(listeners) {
       queryKeys.forEach {
         listeners[it]?.remove(listener)
       }
     }
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     val listenersToNotify = linkedSetOf<Query.Listener>()
     synchronized(listeners) {
       queryKeys.forEach { listeners[it]?.let(listenersToNotify::addAll) }

diff --git a/drivers/sqljs-driver/src/jsMain/kotlin/app/cash/sqldelight/driver/sqljs/JsSqlDriver.kt b/drivers/sqljs-driver/src/jsMain/kotlin/app/cash/sqldelight/driver/sqljs/JsSqlDriver.kt
@@ -29,19 +29,19 @@ class JsSqlDriver(private val db: Database) : SqlDriver {
   private var transaction: Transacter.Transaction? = null
   private val listeners = mutableMapOf<String, MutableSet<Query.Listener>>()
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners.getOrPut(it, { mutableSetOf() }).add(listener)
     }
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners[it]?.remove(listener)
     }
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     queryKeys.flatMap { listeners[it].orEmpty() }
       .distinct()
       .forEach(Query.Listener::queryResultsChanged)

diff --git a/drivers/sqljs-driver/src/jsTest/kotlin/com/squareup/sqldelight/drivers/sqljs/JsQueryTest.kt b/drivers/sqljs-driver/src/jsTest/kotlin/com/squareup/sqldelight/drivers/sqljs/JsQueryTest.kt
@@ -135,32 +135,24 @@ class JsQueryTest {
 
     val notifies = AtomicInt(0)
     val query = driver.testDataQuery()
-    val listener = object : Query.Listener {
-      override fun queryResultsChanged() {
-        notifies.incrementAndGet()
-      }
-    }
+    val listener = Query.Listener { notifies.incrementAndGet() }
 
     query.addListener(listener)
     assertEquals(0, notifies.get())
 
-    driver.notifyListeners(arrayOf("test"))
+    driver.notifyListeners("test")
     assertEquals(1, notifies.get())
   }
 
   @Test fun removeListenerActuallyRemovesListener() = testing { driver ->
 
     val notifies = AtomicInt(0)
     val query = driver.testDataQuery()
-    val listener = object : Query.Listener {
-      override fun queryResultsChanged() {
-        notifies.incrementAndGet()
-      }
-    }
+    val listener = Query.Listener { notifies.incrementAndGet() }
 
     query.addListener(listener)
     query.removeListener(listener)
-    driver.notifyListeners(arrayOf("test"))
+    driver.notifyListeners("test")
     assertEquals(0, notifies.get())
   }
 
@@ -178,11 +170,11 @@ class JsQueryTest {
       }
 
       override fun addListener(listener: Listener) {
-        addListener(listener, arrayOf("test"))
+        addListener("test", listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        removeListener(listener, arrayOf("test"))
+        removeListener("test", listener = listener)
       }
     }
   }

diff --git a/.../web-worker-driver/src/jsMain/kotlin/app/cash/sqldelight/driver/worker/WebWorkerDriver.kt b/.../web-worker-driver/src/jsMain/kotlin/app/cash/sqldelight/driver/worker/WebWorkerDriver.kt
@@ -65,19 +65,19 @@ class WebWorkerDriver(private val worker: Worker) : SqlDriver {
     }
   }
 
-  override fun addListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun addListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners.getOrPut(it) { mutableSetOf() }.add(listener)
     }
   }
 
-  override fun removeListener(listener: Query.Listener, queryKeys: Array<String>) {
+  override fun removeListener(vararg queryKeys: String, listener: Query.Listener) {
     queryKeys.forEach {
       listeners[it]?.remove(listener)
     }
   }
 
-  override fun notifyListeners(queryKeys: Array<String>) {
+  override fun notifyListeners(vararg queryKeys: String) {
     queryKeys.flatMap { listeners[it].orEmpty() }
       .distinct()
       .forEach(Query.Listener::queryResultsChanged)

diff --git a/...-paging3/src/commonTest/kotlin/app/cash/sqldelight/paging3/OffsetQueryPagingSourceTest.kt b/...-paging3/src/commonTest/kotlin/app/cash/sqldelight/paging3/OffsetQueryPagingSourceTest.kt
@@ -524,8 +524,8 @@ class OffsetQueryPagingSourceTest : DbTest {
       bindLong(1, offset)
     }
 
-    override fun addListener(listener: Listener) = driver.addListener(listener, arrayOf("TestItem"))
-    override fun removeListener(listener: Listener) = driver.removeListener(listener, arrayOf("TestItem"))
+    override fun addListener(listener: Listener) = driver.addListener("TestItem", listener = listener)
+    override fun removeListener(listener: Listener) = driver.removeListener("TestItem", listener = listener)
   }
 
   private fun countQuery() = Query(

diff --git a/...ions/coroutines-extensions/src/commonTest/kotlin/app/cash/sqldelight/coroutines/TestDb.kt b/...ions/coroutines-extensions/src/commonTest/kotlin/app/cash/sqldelight/coroutines/TestDb.kt
@@ -38,17 +38,17 @@ class TestDb(
       }
 
       override fun addListener(listener: Listener) {
-        db.addListener(listener, arrayOf(key))
+        db.addListener(key, listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        db.removeListener(listener, arrayOf(key))
+        db.removeListener(key, listener = listener)
       }
     }
   }
 
   fun notify(key: String) {
-    db.notifyListeners(arrayOf(key))
+    db.notifyListeners(key)
   }
 
   fun close() {

diff --git a/extensions/rxjava2-extensions/src/test/kotlin/app/cash/sqldelight/rx2/TestDb.kt b/extensions/rxjava2-extensions/src/test/kotlin/app/cash/sqldelight/rx2/TestDb.kt
@@ -37,17 +37,17 @@ class TestDb(
       }
 
       override fun addListener(listener: Listener) {
-        db.addListener(listener, arrayOf(key))
+        db.addListener(key, listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        db.removeListener(listener, arrayOf(key))
+        db.removeListener(key, listener = listener)
       }
     }
   }
 
   fun notify(key: String) {
-    db.notifyListeners(arrayOf(key))
+    db.notifyListeners(key)
   }
 
   fun close() {

diff --git a/extensions/rxjava3-extensions/src/test/kotlin/app/cash/sqldelight/rx3/TestDb.kt b/extensions/rxjava3-extensions/src/test/kotlin/app/cash/sqldelight/rx3/TestDb.kt
@@ -36,17 +36,17 @@ class TestDb(
       }
 
       override fun addListener(listener: Listener) {
-        db.addListener(listener, arrayOf(key))
+        db.addListener(key, listener = listener)
       }
 
       override fun removeListener(listener: Listener) {
-        db.removeListener(listener, arrayOf(key))
+        db.removeListener(key, listener = listener)
       }
     }
   }
 
   fun notify(key: String) {
-    db.notifyListeners(arrayOf(key))
+    db.notifyListeners(key)
   }
 
   fun close() {

diff --git a/runtime/api/runtime.api b/runtime/api/runtime.api
@@ -185,13 +185,13 @@ public abstract interface class app/cash/sqldelight/db/SqlCursor {
 }
 
 public abstract interface class app/cash/sqldelight/db/SqlDriver : java/io/Closeable {
-	public abstract fun addListener (Lapp/cash/sqldelight/Query$Listener;[Ljava/lang/String;)V
+	public abstract fun addListener ([Ljava/lang/String;Lapp/cash/sqldelight/Query$Listener;)V
 	public abstract fun currentTransaction ()Lapp/cash/sqldelight/Transacter$Transaction;
 	public abstract fun execute (Ljava/lang/Integer;Ljava/lang/String;ILkotlin/jvm/functions/Function1;)Lapp/cash/sqldelight/db/QueryResult;
 	public abstract fun executeQuery (Ljava/lang/Integer;Ljava/lang/String;Lkotlin/jvm/functions/Function1;ILkotlin/jvm/functions/Function1;)Lapp/cash/sqldelight/db/QueryResult;
 	public abstract fun newTransaction ()Lapp/cash/sqldelight/db/QueryResult;
 	public abstract fun notifyListeners ([Ljava/lang/String;)V
-	public abstract fun removeListener (Lapp/cash/sqldelight/Query$Listener;[Ljava/lang/String;)V
+	public abstract fun removeListener ([Ljava/lang/String;Lapp/cash/sqldelight/Query$Listener;)V
 }
 
 public final class app/cash/sqldelight/db/SqlDriver$DefaultImpls {
@@ -215,14 +215,14 @@ public abstract interface class app/cash/sqldelight/db/SqlSchema {
 
 public final class app/cash/sqldelight/logs/LogSqliteDriver : app/cash/sqldelight/db/SqlDriver {
 	public fun <init> (Lapp/cash/sqldelight/db/SqlDriver;Lkotlin/jvm/functions/Function1;)V
-	public fun addListener (Lapp/cash/sqldelight/Query$Listener;[Ljava/lang/String;)V
+	public fun addListener ([Ljava/lang/String;Lapp/cash/sqldelight/Query$Listener;)V
 	public fun close ()V
 	public fun currentTransaction ()Lapp/cash/sqldelight/Transacter$Transaction;
 	public fun execute (Ljava/lang/Integer;Ljava/lang/String;ILkotlin/jvm/functions/Function1;)Lapp/cash/sqldelight/db/QueryResult;
 	public fun executeQuery (Ljava/lang/Integer;Ljava/lang/String;Lkotlin/jvm/functions/Function1;ILkotlin/jvm/functions/Function1;)Lapp/cash/sqldelight/db/QueryResult;
 	public fun newTransaction ()Lapp/cash/sqldelight/db/QueryResult;
 	public fun notifyListeners ([Ljava/lang/String;)V
-	public fun removeListener (Lapp/cash/sqldelight/Query$Listener;[Ljava/lang/String;)V
+	public fun removeListener ([Ljava/lang/String;Lapp/cash/sqldelight/Query$Listener;)V
 }
 
 public final class app/cash/sqldelight/logs/StatementParameterInterceptor : app/cash/sqldelight/db/SqlPreparedStatement {