zio update, config updates (#705)

zio · Apr 8, 2023 · 6795902 · 6795902
1 parent 44479c2
commit 6795902
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 42 deletions.
diff --git a/build.sbt b/build.sbt
@@ -51,7 +51,8 @@ inThisBuild(
         url("https://github.com/pshemass")
       ),
       Developer("justcoon", "Peter Kotula", "[email protected]", url("https://github.com/justcoon"))
-    )
+    ),
+    zioVersion             := "2.0.11"
   )
 )
 

diff --git a/core/jvm/src/test/scala/zio/logging/FileLoggerConfigSpec.scala b/core/jvm/src/test/scala/zio/logging/FileLoggerConfigSpec.scala
@@ -21,6 +21,7 @@ object FileLoggerConfigSpec extends ZIOSpecDefault {
           "logger/path"                                                -> "file:///tmp/test.log",
           "logger/autoFlushBatchSize"                                  -> "2",
           "logger/bufferedIOSize"                                      -> "4096",
+          "logger/rollingPolicy/type"                                  -> "TimeBasedRollingPolicy",
           "logger/filter/rootLevel"                                    -> LogLevel.Info.label,
           "logger/filter/mappings/zio.logging.example.LivePingService" -> LogLevel.Debug.label
         ),
@@ -31,7 +32,8 @@ object FileLoggerConfigSpec extends ZIOSpecDefault {
         assertTrue(loadedConfig.charset == StandardCharsets.UTF_8) &&
         assertTrue(loadedConfig.destination == Paths.get(URI.create("file:///tmp/test.log"))) &&
         assertTrue(loadedConfig.autoFlushBatchSize == 2) &&
-        assertTrue(loadedConfig.bufferedIOSize == Some(4096))
+        assertTrue(loadedConfig.bufferedIOSize == Some(4096)) &&
+        assertTrue(loadedConfig.rollingPolicy == Some(FileLoggerConfig.FileRollingPolicy.TimeBasedRollingPolicy))
       }
     },
     test("load default config") {

diff --git a/core/jvm/src/test/scala/zio/logging/internal/WriterProviderSpec.scala b/core/jvm/src/test/scala/zio/logging/internal/WriterProviderSpec.scala
@@ -36,7 +36,7 @@ object WriterProviderSpec extends ZIOSpecDefault {
         destination = FileSystems.getDefault.getPath("/tmp/file_app"),
         charset = StandardCharsets.UTF_8,
         bufferedIOSize = Some(1),
-        makeNewTime = testMakeNewTime
+        time = testMakeNewTime
       )
 
       val parallelExecution = ZIO

diff --git a/core/shared/src/main/scala/zio/logging/FileLoggerConfig.scala b/core/shared/src/main/scala/zio/logging/FileLoggerConfig.scala
@@ -33,19 +33,19 @@ final case class FileLoggerConfig(
 )
 
 object FileLoggerConfig {
+
   sealed trait FileRollingPolicy
+
   object FileRollingPolicy {
-    case object TimeBasedRollingPolicy extends FileRollingPolicy
 
-    private[logging] val fileRollingPolicyMapping: Map[String, FileRollingPolicy] = Map(
-      "TimeBasedRollingPolicy" -> FileRollingPolicy.TimeBasedRollingPolicy
-    )
+    final case object TimeBasedRollingPolicy extends FileRollingPolicy
 
-    private[logging] def fileRollingPolicyValue(value: String): Either[Config.Error.InvalidData, FileRollingPolicy] =
-      fileRollingPolicyMapping.get(value) match {
-        case Some(v) => Right(v)
-        case None    => Left(Config.Error.InvalidData(Chunk.empty, s"Expected a FileRollingPolicy, but found ${value}"))
-      }
+    val config: Config[FileRollingPolicy] = {
+      val tpe       = Config.string("type")
+      val timeBased = Config.succeed(TimeBasedRollingPolicy)
+
+      tpe.switch("TimeBasedRollingPolicy" -> timeBased)
+    }
   }
 
   private def charsetValue(value: String): Either[Config.Error.InvalidData, Charset] =
@@ -70,8 +70,7 @@ object FileLoggerConfig {
       Config.string.mapOrFail(charsetValue).nested("charset").withDefault(StandardCharsets.UTF_8)
     val pathConfig               = Config.string.mapOrFail(pathValue).nested("path")
     val formatConfig             = LogFormat.config.nested("format").withDefault(LogFormat.default)
-    val rollingPolicyConfig      =
-      Config.string.mapOrFail(FileRollingPolicy.fileRollingPolicyValue).nested("rollingPolicy").optional
+    val rollingPolicyConfig      = FileRollingPolicy.config.nested("rollingPolicy").optional
 
     (pathConfig ++ formatConfig ++ filterConfig ++ charsetConfig ++ autoFlushBatchSizeConfig ++ bufferedIOSizeConfig ++ rollingPolicyConfig).map {
       case (path, format, filterConfig, charset, autoFlushBatchSize, bufferedIOSize, rollingPolicy) =>

diff --git a/core/shared/src/main/scala/zio/logging/LogFilter.scala b/core/shared/src/main/scala/zio/logging/LogFilter.scala
@@ -161,26 +161,9 @@ object LogFilter {
 
   object LogLevelByNameConfig {
 
-    private[logging] val logLevelMapping: Map[String, LogLevel] = Map(
-      LogLevel.All.label     -> LogLevel.All,
-      LogLevel.Trace.label   -> LogLevel.Trace,
-      LogLevel.Debug.label   -> LogLevel.Debug,
-      LogLevel.Info.label    -> LogLevel.Info,
-      LogLevel.Warning.label -> LogLevel.Warning,
-      LogLevel.Error.label   -> LogLevel.Error,
-      LogLevel.Fatal.label   -> LogLevel.Fatal,
-      LogLevel.None.label    -> LogLevel.None
-    )
-
-    private[logging] def logLevelValue(value: String): Either[Config.Error.InvalidData, LogLevel] =
-      logLevelMapping.get(value.toUpperCase) match {
-        case Some(v) => Right(v)
-        case None    => Left(Config.Error.InvalidData(Chunk.empty, s"Expected a LogLevel, but found ${value}"))
-      }
-
     val config: Config[LogLevelByNameConfig] = {
-      val rootLevelConfig = Config.string.mapOrFail(logLevelValue).nested("rootLevel").withDefault(LogLevel.Info)
-      val mappingsConfig  = Config.table("mappings", Config.string.mapOrFail(logLevelValue)).withDefault(Map.empty)
+      val rootLevelConfig = Config.logLevel.nested("rootLevel").withDefault(LogLevel.Info)
+      val mappingsConfig  = Config.table("mappings", Config.logLevel).withDefault(Map.empty)
 
       (rootLevelConfig ++ mappingsConfig).map { case (rootLevel, mappings) =>
         LogLevelByNameConfig(rootLevel, mappings)

diff --git a/core/shared/src/main/scala/zio/logging/internal/WriterProvider.scala b/core/shared/src/main/scala/zio/logging/internal/WriterProvider.scala
@@ -30,17 +30,17 @@ private[logging] object WriterProvider {
     destination: Path,
     charset: Charset,
     bufferedIOSize: Option[Int],
-    makeNewTime: () => LocalDateTime = TimeBasedRollingWriterProvider.makeNewTime
+    time: () => LocalDateTime = TimeBasedRollingWriterProvider.makeNewTime
   ) extends WriterProvider {
     import java.util.concurrent.locks.ReentrantLock
     import TimeBasedRollingWriterProvider._
 
-    private var timeInUse             = makeNewTime()
+    private var timeInUse             = time()
     private var currentWriter: Writer = makeWriter(makePath(destination, timeInUse), charset, bufferedIOSize)
     private val lock: ReentrantLock   = new ReentrantLock()
 
     override def writer: Writer = {
-      val newTime = makeNewTime()
+      val newTime = time()
       if (newTime != timeInUse) {
         lock.lock()
         try

diff --git a/docs/console-logger.md b/docs/console-logger.md
@@ -40,6 +40,7 @@ logger {
   # log format, default value: LogFormat.default
   format = "%label{timestamp}{%fixed{32}{%timestamp}} %label{level}{%level} %label{thread}{%fiberId} %label{message}{%message} %label{cause}{%cause}"
   
+  # log filter
   filter {
     # see filter configuration
     rootLevel = INFO

diff --git a/docs/file-logger.md b/docs/file-logger.md
@@ -52,13 +52,16 @@ logger {
   # if defined, buffered writer is used, with given buffer size
   # bufferedIOSize = 8192
   
+  # if defined, file log rolling policy is used
+  rollingPolicy {
+    type = TimeBasedRollingPolicy # time based file rolling policy based on date - currently only this one is supported
+  }
+  
+  # log filter
   filter {
     # see filter configuration
     rootLevel = INFO
   }
-  
-  # log rolling, default value: None 
-  rollingPolicy = TimeBasedRollingPolicy
 }
 ```
 
@@ -87,7 +90,9 @@ object FileApp extends ZIOAppDefault {
        |logger {
        |  format = "%timestamp{yyyy-MM-dd'T'HH:mm:ssZ} %fixed{7}{%level} [%fiberId] %name:%line %message %cause"
        |  path = "file:///tmp/file_app.log"
-       |  rollingPolicy = TimeBasedRollingPolicy
+       |  rollingPolicy {
+       |    type = TimeBasedRollingPolicy
+       |  }
        |}
        |""".stripMargin
 

diff --git a/examples/core/src/main/scala/zio/logging/example/FileApp.scala b/examples/core/src/main/scala/zio/logging/example/FileApp.scala
@@ -26,7 +26,9 @@ object FileApp extends ZIOAppDefault {
        |logger {
        |  format = "%timestamp{yyyy-MM-dd'T'HH:mm:ssZ} %fixed{7}{%level} [%fiberId] %name:%line %message %cause"
        |  path = "file:///tmp/file_app.log"
-       |  rollingPolicy = TimeBasedRollingPolicy
+       |  rollingPolicy {
+       |    type = TimeBasedRollingPolicy
+       |  }
        |}
        |""".stripMargin
 

diff --git a/project/MimaSettings.scala b/project/MimaSettings.scala
@@ -5,7 +5,7 @@ import sbt.Keys.{ name, organization }
 import sbt._
 
 object MimaSettings {
-  lazy val bincompatVersionToCompare = "2.1.10"
+  lazy val bincompatVersionToCompare = "2.1.11"
 
   def mimaSettings(failOnProblem: Boolean) =
     Seq(
-Original file line number
+Diff line change
@@ Expand Up / @@ -51,7 +51,8 @@ inThisBuild( @@
             url("https://github.com/pshemass")
           ),
           Developer("justcoon", "Peter Kotula", "[email protected]", url("https://github.com/justcoon"))
-        )
+        ),
+        zioVersion             := "2.0.11"
       )
     )
@@ Expand Down @@