task: Migrate the infrastructure layer (DB.scala and Magnum.scala) to parlance

Author: adamw

backend/src/main/scala/com/softwaremill/bootzooka/email/EmailModel.scala

@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.email
 
 import com.augustnagro.magnum.{DbTx, PostgresDbType, Repo, Spec, SqlNameMapper, Table}
-import com.softwaremill.bootzooka.infrastructure.Magnum.given
+import com.softwaremill.bootzooka.infrastructure.Codecs.given
 import com.softwaremill.bootzooka.util.Strings.Id
 import ox.discard
 

…ll/bootzooka/infrastructure/Magnum.scala …ll/bootzooka/infrastructure/Codecs.scalabackend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Magnum.scala renamed to backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Codecs.scala backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Magnum.scala renamed to backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Codecs.scala

@@ -1,16 +1,15 @@
 package com.softwaremill.bootzooka.infrastructure
 
-import com.augustnagro.magnum.DbCodec
-import com.softwaremill.bootzooka.logging.Logging
+import ma.chinespirit.parlance.DbCodec
 import com.softwaremill.bootzooka.util.Strings.*
 
 import java.time.{Instant, OffsetDateTime, ZoneOffset}
 
-/** Magnum codecs for custom types, useful when writing SQL queries. */
-object Magnum extends Logging:
+/** parlance [[DbCodec]]s for custom types, useful when writing SQL queries. */
+object Codecs:
   given DbCodec[Instant] = summon[DbCodec[OffsetDateTime]].biMap(_.toInstant, _.atOffset(ZoneOffset.UTC))
 
   given idCodec[T]: DbCodec[Id[T]] = DbCodec.StringCodec.biMap(_.asId[T], _.toString)
   given DbCodec[Hashed] = DbCodec.StringCodec.biMap(_.asHashed, _.toString)
   given DbCodec[LowerCased] = DbCodec.StringCodec.biMap(_.toLowerCased, _.toString)
-end Magnum
+end Codecs

backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/DB.scala

@@ -1,6 +1,6 @@
 package com.softwaremill.bootzooka.infrastructure
 
-import com.augustnagro.magnum.{DbCodec, DbTx, SqlLogger, Transactor, connect, sql}
+import ma.chinespirit.parlance.{DbTx, Postgres, SqlLogger, Transactor, sql}
 import com.softwaremill.bootzooka.infrastructure.DB.LeftException
 import com.softwaremill.bootzooka.logging.Logging
 import com.zaxxer.hikari.{HikariConfig, HikariDataSource}
@@ -15,21 +15,20 @@ import scala.util.NotGiven
 import scala.util.control.{NoStackTrace, NonFatal}
 
 class DB(dataSource: DataSource & Closeable) extends Logging with AutoCloseable:
-  private val transactor = Transactor(
-    dataSource = dataSource,
-    sqlLogger = SqlLogger.logSlowQueries(200.millis)
-  )
+  // the database type is pinned explicitly so that the `DbTx[Postgres]` context type matches throughout the codebase
+  // (otherwise `Transactor(Postgres, ...)` would infer the singleton type `Postgres.type`)
+  private val transactor = Transactor[Postgres](Postgres, dataSource, SqlLogger.logSlowQueries(200.millis))
 
   /** Runs `f` in a transaction. The transaction is commited if the result is a [[Right]], and rolled back otherwise. */
-  def transactEither[E, T](f: DbTx ?=> Either[E, T]): Either[E, T] =
-    try com.augustnagro.magnum.transact(transactor)(Right(f.fold(e => throw LeftException(e), identity)))
+  def transactEither[E, T](f: DbTx[Postgres] ?=> Either[E, T]): Either[E, T] =
+    try transactor.transact(Right(f.fold(e => throw LeftException(e), identity)))
     catch case e: LeftException[E] @unchecked => Left(e.left)
 
   /** Runs `f` in a transaction. The result cannot be an `Either`, as then [[transactEither]] should be used. The transaction is commited if
     * no exception is thrown.
     */
-  def transact[T](f: DbTx ?=> T)(using NotGiven[T <:< Either[?, ?]]): T =
-    com.augustnagro.magnum.transact(transactor)(f)
+  def transact[T](f: DbTx[Postgres] ?=> T)(using NotGiven[T <:< Either[?, ?]]): T =
+    transactor.transact(f)
 
   override def close(): Unit = dataSource.close()
 end DB
@@ -56,7 +55,7 @@ object DB extends Logging:
       .load()
 
     def migrate(): Unit = if config.migrateOnStart then flyway.migrate().discard
-    def testConnection(ds: DataSource): Unit = connect(ds)(sql"SELECT 1".query[Int].run()).discard
+    def testConnection(ds: DataSource): Unit = Transactor[Postgres](Postgres, ds).connect(sql"SELECT 1".query[Int].run()).discard
 
     @tailrec
     def connectAndMigrate(ds: DataSource): Unit =

backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetCodeModel.scala

@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.passwordreset
 
 import com.augustnagro.magnum.{DbCodec, DbTx, PostgresDbType, Repo, SqlName, SqlNameMapper, Table}
-import com.softwaremill.bootzooka.infrastructure.Magnum.given
+import com.softwaremill.bootzooka.infrastructure.Codecs.given
 import com.softwaremill.bootzooka.security.AuthTokenOps
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.Strings.Id

backend/src/main/scala/com/softwaremill/bootzooka/security/ApiKeyModel.scala

@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.security
 
 import com.augustnagro.magnum.{DbTx, PostgresDbType, Repo, SqlName, SqlNameMapper, Table, TableInfo, sql}
-import com.softwaremill.bootzooka.infrastructure.Magnum.given
+import com.softwaremill.bootzooka.infrastructure.Codecs.given
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.Strings.Id
 import ox.discard

backend/src/main/scala/com/softwaremill/bootzooka/user/UserModel.scala

@@ -2,7 +2,7 @@ package com.softwaremill.bootzooka.user
 
 import com.augustnagro.magnum.{DbCodec, DbTx, Frag, PostgresDbType, Repo, Spec, SqlName, SqlNameMapper, Table, TableInfo, sql}
 import com.password4j.{Argon2Function, Password}
-import com.softwaremill.bootzooka.infrastructure.Magnum.given
+import com.softwaremill.bootzooka.infrastructure.Codecs.given
 import com.softwaremill.bootzooka.user.User.PasswordHashing
 import com.softwaremill.bootzooka.user.User.PasswordHashing.Argon2Config.*
 import com.softwaremill.bootzooka.util.PasswordVerificationStatus

docs/devtips.md

@@ -44,11 +44,11 @@ There are two imports that are useful when developing a new functionality:
 If you are defining database queries or running transactions, add the following imports:
 
 ```scala
-import com.softwaremill.bootzooka.infrastructure.Magnum.given
-import com.augustnagro.magnum.{sql, DbTx}
+import com.softwaremill.bootzooka.infrastructure.Codecs.given
+import ma.chinespirit.parlance.{sql, DbTx, Postgres}
 ```
 
-This will bring into scope custom [Magnum](https://github.com/AugustNagro/magnum) codecs, the sql query interpolator
+This will bring into scope custom [parlance](https://github.com/lbialy/parlance) codecs, the sql query interpolator
 as well as the given instance which is required by methods that should run in a transaction.
 
 ### HTTP API

parlance-migration-notes.md

@@ -24,13 +24,13 @@ parlance 0.1.0 is a redesigned, Active-Record-inspired ORM (92 core source files
 |---|---|---|
 | `import com.augustnagro.magnum.*` | `import ma.chinespirit.parlance.*` | package rename |
 | `DbCodec`, `.biMap(to, from)` | same | ✓ identical |
-| `DbCodec.StringCodec` | `DbCodec[String]` (i.e. `summon[DbCodec[String]]`) | `StringCodec` given exists; prefer `DbCodec[String]` |
+| `DbCodec.StringCodec` | `DbCodec.StringCodec` (also `DbCodec[String]`) | ✓ `StringCodec` is a given in `object DbCodec`; `DbCodec.StringCodec.biMap(...)` compiles as-is |
 | `summon[DbCodec[OffsetDateTime]]` | same | ✓ `OffsetDateTimeCodec` given exists |
-| custom `given DbCodec[Instant]` (in `infrastructure/Magnum.scala`) | **remove** | parlance already ships `given DbCodec[Instant]`; keeping the custom one is an ambiguous-given conflict |
-| `Transactor(dataSource = ds, sqlLogger = ...)` | `Transactor(Postgres, ds, SqlLogger.logSlowQueries(200.millis))` | **DB type is now a required first arg**; `Transactor[D <: DatabaseType]` |
+| custom `given DbCodec[Instant]` (in `infrastructure/Codecs.scala`) | **keep** | parlance ships `given InstantCodec: DbCodec[Instant]` in `object DbCodec`, but an *imported* given (via `import Codecs.given`) takes precedence over implicit/companion scope — **verified: no ambiguity**. (Corrects the earlier note that said to remove it.) |
+| `Transactor(dataSource = ds, sqlLogger = ...)` | `Transactor[Postgres](Postgres, ds, SqlLogger.logSlowQueries(200.millis))` | **DB type is a required first arg** AND must be **pinned** as `[Postgres]` — `Transactor(Postgres, ...)` infers the singleton `Postgres.type`, which then mismatches `DbTx[Postgres]` everywhere. |
 | `SqlLogger.logSlowQueries(200.millis)` | same | ✓ |
-| top-level `transact(transactor)(f)` | **`transactor.transact(f)`** (instance method) | `def transact[T](f: DbTx[D] ?=> T): T` |
-| top-level `connect(ds)(f)` | **`transactor.connect(f)`** (instance method) | `connect` takes no DataSource — needs a `Transactor`; `def connect[T](f: DbCon[D] ?=> T): T`. DB.scala `testConnection(ds)` must build/reuse a Transactor instead of passing a raw `DataSource`. |
+| top-level `transact(transactor)(f)` | **`transactor.transact(f)`** (instance method) | `def transact[T](f: DbTx[D] ?=> T): T`. Rolls back only on a thrown exception (then rethrows) — so the `LeftException` rollback-on-`Left` trick still works unchanged. |
+| top-level `connect(ds)(f)` | **`transactor.connect(f)`** (instance method) | `connect` takes no DataSource — needs a `Transactor`; `def connect[T](f: DbCon[D] ?=> T): T`. DB.scala `testConnection(ds)` builds a throwaway `Transactor[Postgres](Postgres, ds)` to run the test query. |
 | `(using DbTx)`, `DbTx ?=> T` | **`(using DbTx[Postgres])`, `DbTx[Postgres] ?=> T`** | `DbCon`/`DbTx` are parameterized by DB type. Touches *every* model/service/api file with a `DbTx` param (UserModel, UserService, ApiKeyModel, ApiKeyService, Auth, PasswordResetCodeModel, PasswordResetService, EmailModel, EmailService, the `*Api` files, `AuthTokenOps`). Read-only sites may use `DbCon[Postgres]`. |
 | `sql"..."` interpolator | same | ✓ available via wildcard import; if selectively imported, confirm the `sql` name is importable |
 | `.query[T].run()`, `.update.run()` | same | ✓ require a `DbCon`/`DbTx` in scope |
@@ -52,6 +52,6 @@ parlance 0.1.0 is a redesigned, Active-Record-inspired ORM (92 core source files
 2. `TableInfo` column-reference + `sql"$u"` table interpolation: confirm the API matches Magnum's usage in `UserModel`/`ApiKeyModel`.
 3. Add `derives EntityMeta` to all entities; drop the DB-type arg from every `@Table`.
 4. Parameterize all `DbTx`/`DbCon` usages with `[Postgres]`.
-5. Rework `DB.scala`: `Transactor(Postgres, ds, ...)`, instance `transact`/`connect`, and `testConnection` (no raw-DataSource `connect`).
-6. Remove the custom `given DbCodec[Instant]`; switch `DbCodec.StringCodec` → `DbCodec[String]`.
+5. ~~Rework `DB.scala`~~ **DONE** (and `infrastructure/Magnum.scala` → `infrastructure/Codecs.scala`, with the four import sites updated).
+6. ~~Remove the custom `given DbCodec[Instant]`~~ — keep it; `DbCodec.StringCodec` works as-is (see table).
 7. `insert` → `rawInsert`; add `()` to `Repo[...]` constructions.