Close #441 - Add MdcAdapter for Cats Effect 3 to properly share context through MDC with IO and IOLocal from Cats Effect 3

Author: kevin-lee

.github/workflows/build.yml

@@ -19,9 +19,9 @@ jobs:
     strategy:
       matrix:
         scala:
-          - { name: "Scala 2", version: "2.12.13", binary-version: "2.12", java-version: "11", java-distribution: "temurin", report: "" }
-          - { name: "Scala 2", version: "2.13.6",  binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "report" }
-          - { name: "Scala 3", version: "3.0.2",   binary-version: "3",    java-version: "11", java-distribution: "temurin", report: "" }
+          - { name: "Scala 2", version: "2.12.18", binary-version: "2.12", java-version: "11", java-distribution: "temurin", report: "" }
+          - { name: "Scala 2", version: "2.13.11", binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "report" }
+          - { name: "Scala 3", version: "3.3.0",   binary-version: "3",    java-version: "11", java-distribution: "temurin", report: "" }
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/coverage.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         scala:
-          - { name: "Scala 2", version: "2.13.6",  binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "report" }
+          - { name: "Scala 2", version: "2.13.11",  binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "report" }
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/release.yml

@@ -22,9 +22,9 @@ jobs:
     strategy:
       matrix:
         scala:
-          - { name: "Scala 2", version: "2.12.13", binary-version: "2.12", java-version: "11", java-distribution: "temurin", report: "" }
-          - { name: "Scala 2", version: "2.13.6",  binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "" }
-          - { name: "Scala 3", version: "3.0.2",   binary-version: "3",    java-version: "11", java-distribution: "temurin", report: "" }
+          - { name: "Scala 2", version: "2.12.18", binary-version: "2.12", java-version: "11", java-distribution: "temurin", report: "" }
+          - { name: "Scala 2", version: "2.13.11", binary-version: "2.13", java-version: "11", java-distribution: "temurin", report: "" }
+          - { name: "Scala 3", version: "3.3.0",   binary-version: "3",    java-version: "11", java-distribution: "temurin", report: "" }
 
     steps:
       - uses: actions/checkout@v3

build.sbt

@@ -81,6 +81,8 @@ lazy val loggerF = (project in file("."))
     catsJs,
     logbackMdcMonix3Jvm,
     logbackMdcMonix3Js,
+    logbackMdcCatsEffect3Jvm,
+    logbackMdcCatsEffect3Js,
     testKitJvm,
     testKitJs,
     catsEffectJvm,
@@ -107,7 +109,7 @@ lazy val core    =
       ),
     )
 lazy val coreJvm = core.jvm
-lazy val coreJs  = core.js
+lazy val coreJs  = core.js.settings(commonJsSettings)
 
 lazy val slf4jLogger    = module(ProjectName("slf4j"), crossProject(JVMPlatform, JSPlatform))
   .settings(
@@ -122,7 +124,7 @@ lazy val slf4jLogger    = module(ProjectName("slf4j"), crossProject(JVMPlatform,
   )
   .dependsOn(core)
 lazy val slf4jLoggerJvm = slf4jLogger.jvm
-lazy val slf4jLoggerJs  = slf4jLogger.js
+lazy val slf4jLoggerJs  = slf4jLogger.js.settings(commonJsSettings)
 
 lazy val log4sLogger    =
   module(ProjectName("log4s"), crossProject(JVMPlatform, JSPlatform))
@@ -138,7 +140,7 @@ lazy val log4sLogger    =
     )
     .dependsOn(core)
 lazy val log4sLoggerJvm = log4sLogger.jvm
-lazy val log4sLoggerJs  = log4sLogger.js
+lazy val log4sLoggerJs  = log4sLogger.js.settings(commonJsSettings)
 
 lazy val log4jLogger    =
   module(ProjectName("log4j"), crossProject(JVMPlatform, JSPlatform))
@@ -198,7 +200,7 @@ lazy val log4jLogger    =
     )
     .dependsOn(core)
 lazy val log4jLoggerJvm = log4jLogger.jvm
-lazy val log4jLoggerJs  = log4jLogger.js
+lazy val log4jLoggerJs  = log4jLogger.js.settings(commonJsSettings)
 
 lazy val sbtLogging    =
   module(ProjectName("sbt-logging"), crossProject(JVMPlatform, JSPlatform))
@@ -230,7 +232,7 @@ lazy val sbtLogging    =
     )
     .dependsOn(core)
 lazy val sbtLoggingJvm = sbtLogging.jvm
-lazy val sbtLoggingJs  = sbtLogging.js
+lazy val sbtLoggingJs  = sbtLogging.js.settings(commonJsSettings)
 
 lazy val cats    =
   module(ProjectName("cats"), crossProject(JVMPlatform, JSPlatform))
@@ -248,7 +250,7 @@ lazy val cats    =
     )
     .dependsOn(core % props.IncludeTest)
 lazy val catsJvm = cats.jvm
-lazy val catsJs  = cats.js
+lazy val catsJs  = cats.js.settings(commonJsSettings)
 
 lazy val logbackMdcMonix3    = module(ProjectName("logback-mdc-monix3"), crossProject(JVMPlatform, JSPlatform))
   .settings(
@@ -271,7 +273,31 @@ lazy val logbackMdcMonix3    = module(ProjectName("logback-mdc-monix3"), crossPr
     slf4jLogger % Test,
   )
 lazy val logbackMdcMonix3Jvm = logbackMdcMonix3.jvm
-lazy val logbackMdcMonix3Js  = logbackMdcMonix3.js
+lazy val logbackMdcMonix3Js  = logbackMdcMonix3.js.settings(commonJsSettings)
+
+lazy val logbackMdcCatsEffect3 = module(ProjectName("logback-mdc-cats-effect3"), crossProject(JVMPlatform, JSPlatform))
+  .settings(
+    description         := "Logger for F[_] - logback MDC context map support for Cats Effect 3",
+    libraryDependencies ++= Seq(
+      libs.logbackClassic,
+      libs.logbackScalaInterop,
+      libs.catsEffect3Eap,
+      libs.tests.effectieCatsEffect3,
+      libs.tests.extrasHedgehogCatsEffect3,
+    ) ++ libs.tests.hedgehogLibs,
+    libraryDependencies := libraryDependenciesRemoveScala3Incompatible(
+      scalaVersion.value,
+      libraryDependencies.value,
+    ),
+    javaOptions += "-Dcats.effect.ioLocalPropagation=true",
+  )
+  .dependsOn(
+    core,
+    monix       % Test,
+    slf4jLogger % Test,
+  )
+lazy val logbackMdcCatsEffect3Jvm = logbackMdcCatsEffect3.jvm
+lazy val logbackMdcCatsEffect3Js  = logbackMdcCatsEffect3.js.settings(commonJsSettings)
 
 lazy val testKit    =
   module(ProjectName("test-kit"), crossProject(JVMPlatform, JSPlatform))
@@ -289,7 +315,7 @@ lazy val testKit    =
     )
     .dependsOn(core % props.IncludeTest)
 lazy val testKitJvm = testKit.jvm
-lazy val testKitJs  = testKit.js
+lazy val testKitJs  = testKit.js.settings(commonJsSettings)
 
 lazy val catsEffect    =
   module(ProjectName("cats-effect"), crossProject(JVMPlatform, JSPlatform))
@@ -304,7 +330,7 @@ lazy val catsEffect    =
     .settings(noPublish)
     .dependsOn(core % props.IncludeTest, cats)
 lazy val catsEffectJvm = catsEffect.jvm
-lazy val catsEffectJs  = catsEffect.js
+lazy val catsEffectJs  = catsEffect.js.settings(commonJsSettings)
 
 lazy val catsEffect3    =
   module(ProjectName("cats-effect3"), crossProject(JVMPlatform, JSPlatform))
@@ -322,7 +348,7 @@ lazy val catsEffect3    =
     .settings(noPublish)
     .dependsOn(core % props.IncludeTest, cats)
 lazy val catsEffect3Jvm = catsEffect3.jvm
-lazy val catsEffect3Js  = catsEffect3.js
+lazy val catsEffect3Js  = catsEffect3.js.settings(commonJsSettings)
 
 lazy val monix    =
   module(ProjectName("monix"), crossProject(JVMPlatform, JSPlatform))
@@ -337,7 +363,7 @@ lazy val monix    =
     .settings(noPublish)
     .dependsOn(core % props.IncludeTest, cats)
 lazy val monixJvm = monix.jvm
-lazy val monixJs  = monix.js
+lazy val monixJs  = monix.js.settings(commonJsSettings)
 
 lazy val testCatsEffectWithSlf4jLogger    =
   testProject(
@@ -509,8 +535,8 @@ lazy val props =
     final val GitHubUsername = "Kevin-Lee"
     final val RepoName       = "logger-f"
 
-    final val Scala3Versions = List("3.0.2")
-    final val Scala2Versions = List("2.13.6", "2.12.13")
+    final val Scala3Versions = List("3.3.0")
+    final val Scala2Versions = List("2.13.11", "2.12.18")
 
 //    final val ProjectScalaVersion = Scala3Versions.head
     final val ProjectScalaVersion = Scala2Versions.head
@@ -576,6 +602,8 @@ lazy val libs =
 
     lazy val catsEffect3 = "org.typelevel" %% "cats-effect" % props.CatsEffect3Version
 
+    lazy val catsEffect3Eap = "org.typelevel" %% "cats-effect" % "3.6-02a43a6"
+
     lazy val monix3Execution = "io.monix" %% "monix-execution" % props.Monix3Version
 
     lazy val effectieCore: ModuleID        = "io.kevinlee" %% "effectie-core"         % props.EffectieVersion
@@ -605,6 +633,8 @@ lazy val libs =
 
       lazy val extrasCats = "io.kevinlee" %% "extras-cats" % props.ExtrasVersion % Test
 
+      lazy val effectieCatsEffect3 = "io.kevinlee" %% "effectie-cats-effect3" % props.EffectieVersion
+
       lazy val extrasConcurrent        = "io.kevinlee" %% "extras-concurrent"         % props.ExtrasVersion % Test
       lazy val extrasConcurrentTesting = "io.kevinlee" %% "extras-concurrent-testing" % props.ExtrasVersion % Test
 
@@ -619,14 +649,7 @@ def prefixedProjectName(name: String) = s"${props.RepoName}${if (name.isEmpty) "
 def libraryDependenciesRemoveScala3Incompatible(
   scalaVersion: String,
   libraries: Seq[ModuleID],
-): Seq[ModuleID] =
-  (
-    if (scalaVersion.startsWith("3."))
-      libraries
-        .filterNot(props.removeDottyIncompatible)
-    else
-      libraries
-  )
+): Seq[ModuleID] = libraries
 
 lazy val mavenCentralPublishSettings: SettingsDefinition = List(
   /* Publish to Maven Central { */
@@ -655,6 +678,7 @@ def projectCommonSettings(projectName: String, crossProject: CrossProject.Builde
       //      , Compile / compile / wartremoverErrors ++= commonWarts((update / scalaBinaryVersion).value)
       //      , Test / compile / wartremoverErrors ++= commonWarts((update / scalaBinaryVersion).value)
       wartremoverErrors ++= commonWarts((update / scalaBinaryVersion).value),
+      fork                                    := true,
       Compile / console / wartremoverErrors   := List.empty,
       Compile / console / wartremoverWarnings := List.empty,
       Compile / console / scalacOptions       :=
@@ -681,3 +705,11 @@ def projectCommonSettings(projectName: String, crossProject: CrossProject.Builde
     .settings(
       mavenCentralPublishSettings
     )
+
+lazy val commonJsSettings: SettingsDefinition = List(
+  Test / fork := false,
+//  Test / scalacOptions ++= (if (scalaVersion.value.startsWith("3")) List.empty
+//  else List("-P:scalajs:nowarnGlobalExecutionContext")),
+//  Test / compile / scalacOptions ++= (if (scalaVersion.value.startsWith("3")) List.empty
+//  else List("-P:scalajs:nowarnGlobalExecutionContext")),
+)

modules/logger-f-cats/shared/src/main/scala-3/loggerf/instances/show.scala

@@ -7,7 +7,9 @@ import loggerf.core.ToLog
   * @since 2022-02-19
   */
 trait show {
-  inline given showToLog[A: Show]: ToLog[A] = Show[A].show(_)
+  given showToLog[A: Show]: ToLog[A] with {
+    inline def toLogMessage(a: A): String = Show[A].show(a)
+  }
 }
 
 object show extends show

modules/logger-f-core/shared/src/main/scala-3/loggerf/core/ToLog.scala

@@ -15,5 +15,7 @@ object ToLog {
   @SuppressWarnings(Array("org.wartremover.warts.ToString"))
   def fromToString[A]: ToLog[A] = _.toString
 
-  inline given stringToLog: ToLog[String] = identity(_)
+  given stringToLog: ToLog[String] with {
+    inline def toLogMessage(a: String): String = a
+  }
 }

modules/logger-f-logback-mdc-cats-effect3/shared/src/main/scala/loggerf/logger/logback/Ce3MdcAdapter.scala

@@ -0,0 +1,85 @@
+package loggerf.logger.logback
+
+import cats.effect.unsafe.IOLocals
+import cats.effect.{IOLocal, SyncIO}
+import cats.syntax.all._
+import ch.qos.logback.classic.LoggerContext
+import logback_scala_interop.JLoggerFMdcAdapter
+import org.slf4j.{LoggerFactory, MDC}
+
+import java.util.{Map => JMap, Set => JSet}
+import scala.jdk.CollectionConverters._
+import scala.util.control.NonFatal
+
+/** @author Kevin Lee
+  * @since 2023-07-07
+  */
+class Ce3MdcAdapter extends JLoggerFMdcAdapter {
+
+  private[this] val localContext: IOLocal[Map[String, String]] =
+    IOLocal[Map[String, String]](Map.empty[String, String])
+      .syncStep(1)
+      .flatMap(
+        _.leftMap(_ =>
+          new Error(
+            "Failed to initialize the local context of the Ce3MdcAdapter."
+          )
+        ).liftTo[SyncIO]
+      )
+      .unsafeRunSync()
+
+  override def put(key: String, `val`: String): Unit =
+    IOLocals.update(localContext)(_ + (key -> `val`))
+
+  @SuppressWarnings(Array("org.wartremover.warts.Null"))
+  override def get(key: String): String =
+    IOLocals.get(localContext).getOrElse(key, null) // scalafix:ok DisableSyntax.null
+
+  override def remove(key: String): Unit = IOLocals.update(localContext)(_ - key)
+
+  override def clear(): Unit = IOLocals.reset(localContext)
+
+  override def getCopyOfContextMap: JMap[String, String] = getPropertyMap0
+
+  override def setContextMap0(contextMap: JMap[String, String]): Unit =
+    IOLocals.set(localContext, contextMap.asScala.toMap)
+
+  private def getPropertyMap0: JMap[String, String] = IOLocals.get(localContext).asJava
+
+  override def getPropertyMap: JMap[String, String] = getPropertyMap0
+
+  override def getKeys: JSet[String] = IOLocals.get(localContext).keySet.asJava
+
+}
+object Ce3MdcAdapter {
+
+  @SuppressWarnings(Array("org.wartremover.warts.Null"))
+  private def initialize0(): Ce3MdcAdapter = {
+    val field   = classOf[MDC].getDeclaredField("mdcAdapter")
+    field.setAccessible(true)
+    val adapter = new Ce3MdcAdapter
+    field.set(null, adapter) // scalafix:ok DisableSyntax.null
+    field.setAccessible(false)
+    adapter
+  }
+
+  @SuppressWarnings(Array("org.wartremover.warts.AsInstanceOf", "scalafix:DisableSyntax.asInstanceOf"))
+  def initialize(): Ce3MdcAdapter = {
+    val loggerContext =
+      LoggerFactory.getILoggerFactory.asInstanceOf[LoggerContext]
+    initializeWithLoggerContext(loggerContext)
+  }
+
+  def initializeWithLoggerContext(loggerContext: LoggerContext): Ce3MdcAdapter = {
+    val adapter = initialize0()
+    try {
+      val field = classOf[LoggerContext].getDeclaredField("mdcAdapter")
+      field.setAccessible(true)
+      field.set(loggerContext, adapter)
+      field.setAccessible(false)
+      adapter
+    } catch {
+      case NonFatal(_) => adapter
+    }
+  }
+}