refactor: Make Loggable less convenient

Removing kotlin context receivers makes the logging API less convenient but has to be done because they're deprecated and will be removed. Closes #432
OmriCat · Nov 23, 2024 · 97b6199 · 97b6199
1 parent 4be8d13
commit 97b6199
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 27 deletions.
diff --git a/app/src/main/kotlin/com/omricat/maplibrarian/chartlist/FirebaseChartsRepository.kt b/app/src/main/kotlin/com/omricat/maplibrarian/chartlist/FirebaseChartsRepository.kt
@@ -1,6 +1,7 @@
 package com.omricat.maplibrarian.chartlist
 
 import co.touchlab.kermit.Severity.Warn
+import co.touchlab.kermit.Tag
 import com.github.michaelbull.result.Result
 import com.github.michaelbull.result.andThen
 import com.github.michaelbull.result.combine
@@ -21,6 +22,7 @@ import com.google.firebase.firestore.QuerySnapshot
 import com.omricat.firebase.interop.runCatchingFirebaseException
 import com.omricat.logging.Loggable
 import com.omricat.logging.Logger
+import com.omricat.logging.classTag
 import com.omricat.logging.log
 import com.omricat.maplibrarian.chartlist.ChartsRepository.AddNewChartError
 import com.omricat.maplibrarian.chartlist.ChartsRepository.AddNewChartError.Cancelled
@@ -35,7 +37,6 @@ import com.omricat.maplibrarian.model.DbChartModel
 import com.omricat.maplibrarian.model.UnsavedChartModel
 import com.omricat.maplibrarian.model.User
 import com.omricat.maplibrarian.utils.DispatcherProvider
-import com.omricat.maplibrarian.utils.logAndMapException
 import kotlinx.coroutines.tasks.await
 import kotlinx.coroutines.withContext
 
@@ -44,6 +45,9 @@ class FirebaseChartsRepository(
     private val dispatchers: DispatcherProvider = DispatcherProvider.Default,
     override val logger: Logger,
 ) : ChartsRepository, Loggable {
+
+    override val loggingTag: Tag = classTag()
+
     override suspend fun chartsListForUser(
         user: User
     ): Result<List<DbChartModel>, ChartsRepository.Error> =
@@ -52,7 +56,8 @@ class FirebaseChartsRepository(
                     db.mapsCollection(user).get().await()
                 }
             }
-            .logAndMapException(::ExceptionWrappingError)
+            .onFailure { log(Warn, throwable = it) }
+            .mapError(::ExceptionWrappingError)
             .andThen { snapshot ->
                 snapshot
                     .map { m -> m.parseMapModel() }
@@ -71,7 +76,8 @@ class FirebaseChartsRepository(
                         .await()
                 }
             }
-            .logAndMapException { exception ->
+            .onFailure { log(Warn, throwable = it) }
+            .mapError { exception: FirebaseFirestoreException ->
                 when (exception.code) {
                     UNAVAILABLE -> Unavailable
                     ALREADY_EXISTS -> ChartExists(newChart)
@@ -83,6 +89,7 @@ class FirebaseChartsRepository(
                             "FirebaseFirestoreException $exception had a status code of OK. " +
                                 "Docs say this should never happen."
                         )
+
                     UNKNOWN -> OtherException(exception)
                     else -> OtherException(exception)
                 }

diff --git a/app/src/main/kotlin/com/omricat/maplibrarian/utils/LogErrorAndMap.kt b/app/src/main/kotlin/com/omricat/maplibrarian/utils/LogErrorAndMap.kt
diff --git a/core/src/main/kotlin/com/omricat/maplibrarian/root/RootWorkflow.kt b/core/src/main/kotlin/com/omricat/maplibrarian/root/RootWorkflow.kt
@@ -1,7 +1,9 @@
 package com.omricat.maplibrarian.root
 
+import co.touchlab.kermit.Tag
 import com.omricat.logging.Loggable
 import com.omricat.logging.Logger
+import com.omricat.logging.classTag
 import com.omricat.logging.log
 import com.omricat.maplibrarian.auth.AuthResult
 import com.omricat.maplibrarian.auth.AuthResult.Authenticated
@@ -46,6 +48,8 @@ private class RootWorkflowImpl(
     override val logger: Logger,
 ) : StatefulWorkflow<Unit, State, Nothing, Screen>(), Loggable, RootWorkflow {
 
+    override val loggingTag: Tag = classTag()
+
     override fun initialState(props: Unit, snapshot: Snapshot?): State = Unauthorized
 
     override fun render(renderProps: Unit, renderState: State, context: RenderContext): Screen =

diff --git a/util/logging/src/main/kotlin/com/omricat/logging/Loggable.kt b/util/logging/src/main/kotlin/com/omricat/logging/Loggable.kt
@@ -8,25 +8,22 @@ import kotlin.reflect.KClass
 /** Convenience "mixin" interface to make logging easy. */
 public interface Loggable {
     public val logger: Logger
+    public val loggingTag: Tag
 }
 
-context(Loggable)
-public inline fun <reified T : Any> T.log(
-    priority: Severity = Debug,
-    tag: String? = null,
-    noinline message: () -> String,
-) {
-    logger.log(priority, Tag(tag ?: T::class.outerClassSimpleName()), message)
+public inline fun <reified T : Any> T.classTag(): Tag = Tag(T::class.outerClassSimpleName())
+
+public fun Loggable.log(priority: Severity = Debug, tag: String? = null, message: () -> String) {
+    logger.log(priority, tag?.let { Tag(it) } ?: this.loggingTag, message)
 }
 
-context(Loggable)
-public inline fun <reified T : Any> T.log(
+public fun Loggable.log(
     priority: Severity = Debug,
     tag: String? = null,
     throwable: Throwable,
-    noinline message: () -> String = { throwable.message ?: "$throwable" },
+    message: () -> String = { throwable.message ?: "$throwable" },
 ) {
-    logger.log(priority, Tag(tag ?: T::class.outerClassSimpleName()), throwable, message)
+    logger.log(priority, tag?.let { Tag(it) } ?: this.loggingTag, throwable, message)
 }
 
 public fun KClass<*>.outerClassSimpleName(): String {

diff --git a/util/logging/src/main/kotlin/com/omricat/logging/Logger.kt b/util/logging/src/main/kotlin/com/omricat/logging/Logger.kt
@@ -4,6 +4,10 @@ import co.touchlab.kermit.Severity
 import co.touchlab.kermit.Severity.Debug
 import co.touchlab.kermit.Tag
 
+/**
+ * Facade for logging. Presents a simplified interface on top of more fully-featured logging
+ * implementations.
+ */
 public interface Logger {
     public fun log(
         priority: Severity = Debug,