Replace DbClient.addTransactionListener with DataSource.withTransactionListener

Author: aboisvert

scalasql/core/src/DbClient.scala

@@ -8,14 +8,6 @@ import scalasql.core.DialectConfig
  */
 trait DbClient {
 
-  /**
-   * Adds a listener to be notified of transaction events.
-   *
-   * Listeners added on DbClient are automatically added to all transactions created by this
-   * DbClient.
-   */
-  def addTransactionListener(listener: DbApi.TransactionListener): Unit
-
   /**
    * Converts the given query [[Q]] into a string. Useful for debugging and logging
    */
@@ -69,17 +61,10 @@ object DbClient {
       connection: java.sql.Connection,
       config: Config = new Config {},
       /** Listeners that are added to all transactions created by this connection */
-      defaultListeners: Iterable[DbApi.TransactionListener] = Seq.empty
+      listeners: Seq[DbApi.TransactionListener] = Seq.empty
   )(implicit dialect: DialectConfig)
       extends DbClient {
 
-    val listeners =
-      collection.mutable.ArrayDeque.empty[DbApi.TransactionListener].addAll(defaultListeners)
-
-    override def addTransactionListener(listener: DbApi.TransactionListener): Unit = {
-      listeners.append(listener)
-    }
-
     def renderSql[Q, R](query: Q, castParams: Boolean = false)(
         implicit qr: Queryable[Q, R]
     ): String = {
@@ -130,15 +115,13 @@ object DbClient {
       dataSource: javax.sql.DataSource,
       config: Config = new Config {},
       /** Listeners that are added to all transactions created through the [[DataSource]] */
-      defaultListeners: Iterable[DbApi.TransactionListener] = Seq.empty
+      listeners: Seq[DbApi.TransactionListener] = Seq.empty
   )(implicit dialect: DialectConfig)
       extends DbClient {
 
-    val listeners =
-      collection.mutable.ArrayDeque.empty[DbApi.TransactionListener].addAll(defaultListeners)
-
-    override def addTransactionListener(listener: DbApi.TransactionListener): Unit = {
-      listeners.append(listener)
+    /** Returns a new [[DataSource]] with the given listener added */
+    def withTransactionListener(listener: DbApi.TransactionListener): DbClient = {
+      new DataSource(dataSource, config, listeners :+ listener)
     }
 
     def renderSql[Q, R](query: Q, castParams: Boolean = false)(

scalasql/test/src/api/TransactionTests.scala

@@ -578,8 +578,7 @@ trait TransactionTests extends ScalaSqlSuite {
     test("listener") {
       test("beforeCommit and afterCommit are called under normal circumstances") {
         val listener = new StubTransactionListener()
-        dbClient.addTransactionListener(listener)
-        dbClient.transaction { _ =>
+        dbClient.withTransactionListener(listener).transaction { _ =>
           // do nothing
         }
         listener.beginCalled ==> true

scalasql/test/src/utils/TestChecker.scala

@@ -6,7 +6,7 @@ import scalasql.query.SubqueryRef
 import scalasql.{DbClient, Queryable, Expr, UtestFramework}
 
 class TestChecker(
-    val dbClient: DbClient,
+    val dbClient: DbClient.DataSource,
     testSchemaFileName: String,
     testDataFileName: String,
     suiteName: String,