Use explicit Magnum imports

adamw · adamw · commit 81d8b61bb699 · 2025-07-29T11:33:51.000+02:00
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/email/EmailModel.scala b/backend/src/main/scala/com/softwaremill/bootzooka/email/EmailModel.scala
@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.email
 
-import com.augustnagro.magnum.{PostgresDbType, Repo, Spec, SqlNameMapper, Table}
-import com.softwaremill.bootzooka.infrastructure.Magnum.{*, given}
+import com.augustnagro.magnum.{DbTx, PostgresDbType, Repo, Spec, SqlNameMapper, Table}
+import com.softwaremill.bootzooka.infrastructure.Magnum.given
 import com.softwaremill.bootzooka.util.Strings.Id
 import ox.discard
 
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/email/EmailService.scala b/backend/src/main/scala/com/softwaremill/bootzooka/email/EmailService.scala
@@ -1,8 +1,8 @@
 package com.softwaremill.bootzooka.email
 
+import com.augustnagro.magnum.DbTx
 import com.softwaremill.bootzooka.email.sender.EmailSender
 import com.softwaremill.bootzooka.infrastructure.DB
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.metrics.Metrics
 import com.softwaremill.bootzooka.util.IdGenerator
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/DB.scala b/backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/DB.scala
@@ -1,18 +1,16 @@
 package com.softwaremill.bootzooka.infrastructure
 
-import org.flywaydb.core.Flyway
-
-import scala.concurrent.duration.*
-import Magnum.*
-import com.augustnagro.magnum.{SqlLogger, Transactor, connect}
+import com.augustnagro.magnum.{DbCodec, DbTx, SqlLogger, Transactor, connect, sql}
 import com.softwaremill.bootzooka.infrastructure.DB.LeftException
 import com.softwaremill.bootzooka.logging.Logging
 import com.zaxxer.hikari.{HikariConfig, HikariDataSource}
+import org.flywaydb.core.Flyway
 import ox.*
 
 import java.io.Closeable
 import javax.sql.DataSource
 import scala.annotation.tailrec
+import scala.concurrent.duration.*
 import scala.util.NotGiven
 import scala.util.control.{NoStackTrace, NonFatal}
 
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Magnum.scala b/backend/src/main/scala/com/softwaremill/bootzooka/infrastructure/Magnum.scala
@@ -1,19 +1,16 @@
 package com.softwaremill.bootzooka.infrastructure
 
-import com.augustnagro.magnum.{DbCodec, Frag}
+import com.augustnagro.magnum.DbCodec
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.util.Strings.*
 
 import java.time.{Instant, OffsetDateTime, ZoneOffset}
 
-/** Import the members of this object when defining SQL queries using Magnum. */
+/** Magnum codecs for custom types, useful when writing SQL queries. */
 object Magnum extends Logging:
   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)
-
-  // proxies to the magnum functions/types, so that we can have only one import
-  export com.augustnagro.magnum.{sql, DbTx, DbCon, DbCodec}
 end Magnum
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetCodeModel.scala b/backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetCodeModel.scala
@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.passwordreset
 
-import com.augustnagro.magnum.{PostgresDbType, Repo, SqlName, SqlNameMapper, Table}
-import com.softwaremill.bootzooka.infrastructure.Magnum.{*, given}
+import com.augustnagro.magnum.{DbCodec, DbTx, PostgresDbType, Repo, SqlName, SqlNameMapper, Table}
+import com.softwaremill.bootzooka.infrastructure.Magnum.given
 import com.softwaremill.bootzooka.security.AuthTokenOps
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.Strings.Id
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetService.scala b/backend/src/main/scala/com/softwaremill/bootzooka/passwordreset/PasswordResetService.scala
@@ -1,9 +1,9 @@
 package com.softwaremill.bootzooka.passwordreset
 
+import com.augustnagro.magnum.DbTx
 import com.softwaremill.bootzooka.Fail
 import com.softwaremill.bootzooka.email.{EmailData, EmailScheduler, EmailSubjectContent, EmailTemplates}
 import com.softwaremill.bootzooka.infrastructure.DB
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.security.Auth
 import com.softwaremill.bootzooka.user.{User, UserModel}
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/security/ApiKeyModel.scala b/backend/src/main/scala/com/softwaremill/bootzooka/security/ApiKeyModel.scala
@@ -1,7 +1,7 @@
 package com.softwaremill.bootzooka.security
 
-import com.augustnagro.magnum.{PostgresDbType, Repo, SqlName, SqlNameMapper, Table, TableInfo}
-import com.softwaremill.bootzooka.infrastructure.Magnum.{*, given}
+import com.augustnagro.magnum.{DbTx, PostgresDbType, Repo, SqlName, SqlNameMapper, Table, TableInfo, sql}
+import com.softwaremill.bootzooka.infrastructure.Magnum.given
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.Strings.Id
 import ox.discard
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/security/ApiKeyService.scala b/backend/src/main/scala/com/softwaremill/bootzooka/security/ApiKeyService.scala
@@ -1,6 +1,6 @@
 package com.softwaremill.bootzooka.security
 
-import com.softwaremill.bootzooka.infrastructure.Magnum.DbTx
+import com.augustnagro.magnum.DbTx
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.Strings.Id
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/security/Auth.scala b/backend/src/main/scala/com/softwaremill/bootzooka/security/Auth.scala
@@ -1,8 +1,8 @@
 package com.softwaremill.bootzooka.security
 
+import com.augustnagro.magnum.DbTx
 import com.softwaremill.bootzooka.*
 import com.softwaremill.bootzooka.infrastructure.DB
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.user.User
 import com.softwaremill.bootzooka.util.*
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/user/UserModel.scala b/backend/src/main/scala/com/softwaremill/bootzooka/user/UserModel.scala
@@ -1,8 +1,8 @@
 package com.softwaremill.bootzooka.user
 
-import com.augustnagro.magnum.{Frag, PostgresDbType, Repo, Spec, SqlName, SqlNameMapper, Table, TableInfo}
+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.Magnum.given
 import com.softwaremill.bootzooka.user.User.PasswordHashing
 import com.softwaremill.bootzooka.user.User.PasswordHashing.Argon2Config.*
 import com.softwaremill.bootzooka.util.PasswordVerificationStatus
diff --git a/backend/src/main/scala/com/softwaremill/bootzooka/user/UserService.scala b/backend/src/main/scala/com/softwaremill/bootzooka/user/UserService.scala
@@ -1,8 +1,8 @@
 package com.softwaremill.bootzooka.user
 
+import com.augustnagro.magnum.DbTx
 import com.softwaremill.bootzooka.*
 import com.softwaremill.bootzooka.email.{EmailData, EmailScheduler, EmailTemplates}
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
 import com.softwaremill.bootzooka.logging.Logging
 import com.softwaremill.bootzooka.security.{ApiKey, ApiKeyService}
 import com.softwaremill.bootzooka.util.*
diff --git a/docs/devtips.md b/docs/devtips.md
@@ -41,13 +41,15 @@ There are two imports that are useful when developing a new functionality:
 
 ### Database
 
-If you are defining database queries or running transactions, add the following import:
+If you are defining database queries or running transactions, add the following imports:
 
 ```scala
-import com.softwaremill.bootzooka.infrastructure.Magnum.*
+import com.softwaremill.bootzooka.infrastructure.Magnum.given
+import com.augustnagro.magnum.{sql, DbTx}
 ```
 
-This will bring into scope custom [Magnum](https://github.com/AugustNagro/magnum) codecs.
+This will bring into scope custom [Magnum](https://github.com/AugustNagro/magnum) codecs, the sql query interpolator
+as well as the given instance which is required by methods that should run in a transaction.
 
 ### HTTP API
 
diff --git a/ui/src/api/apiComponents.ts b/ui/src/api/apiComponents.ts
@@ -19,6 +19,9 @@ export type PostUserRegisterVariables = {
   body: Schemas.RegisterIN;
 } & ApiContext["fetcherOptions"];
 
+/**
+ * Registers and logs in a new user, returning an API key.
+ */
 export const fetchPostUserRegister = (
   variables: PostUserRegisterVariables,
   signal?: AbortSignal,
@@ -32,6 +35,9 @@ export const fetchPostUserRegister = (
     {}
   >({ url: "/user/register", method: "post", ...variables, signal });
 
+/**
+ * Registers and logs in a new user, returning an API key.
+ */
 export const usePostUserRegister = (
   options?: Omit<
     reactQuery.UseMutationOptions<
@@ -63,6 +69,9 @@ export type PostUserLoginVariables = {
   body: Schemas.LoginIN;
 } & ApiContext["fetcherOptions"];
 
+/**
+ * Logs in a user, returning an API key.
+ */
 export const fetchPostUserLogin = (
   variables: PostUserLoginVariables,
   signal?: AbortSignal,
@@ -74,6 +83,9 @@ export const fetchPostUserLogin = (
     signal,
   });
 
+/**
+ * Logs in a user, returning an API key.
+ */
 export const usePostUserLogin = (
   options?: Omit<
     reactQuery.UseMutationOptions<
@@ -105,6 +117,9 @@ export type PostUserLogoutVariables = {
   body: Schemas.LogoutIN;
 } & ApiContext["fetcherOptions"];
 
+/**
+ * Logs out a user, invalidating the used API key.
+ */
 export const fetchPostUserLogout = (
   variables: PostUserLogoutVariables,
   signal?: AbortSignal,
@@ -118,6 +133,9 @@ export const fetchPostUserLogout = (
     {}
   >({ url: "/user/logout", method: "post", ...variables, signal });
 
+/**
+ * Logs out a user, invalidating the used API key.
+ */
 export const usePostUserLogout = (
   options?: Omit<
     reactQuery.UseMutationOptions<
@@ -191,6 +209,9 @@ export type GetUserError = Fetcher.ErrorWrapper<{
 
 export type GetUserVariables = ApiContext["fetcherOptions"];
 
+/**
+ * Gets the currently logged in user's information.
+ */
 export const fetchGetUser = (
   variables: GetUserVariables,
   signal?: AbortSignal,
@@ -202,6 +223,9 @@ export const fetchGetUser = (
     signal,
   });
 
+/**
+ * Gets the currently logged in user's information.
+ */
 export const useGetUser = <TData = Schemas.GetUserOUT,>(
   variables: GetUserVariables,
   options?: Omit<
