chore(deps): bump ZIO version (DEV-893) (#2056)

Author: subotic

build.sbt

@@ -133,7 +133,13 @@ lazy val webapi: Project = Project(id = "webapi", base = file("webapi"))
     Test / exportJars := true
   )
   .settings(
-    scalacOptions ++= Seq("-feature", "-unchecked", "-deprecation", "-Yresolve-term-conflict:package"),
+    scalacOptions ++= Seq(
+      "-feature",
+      "-unchecked",
+      "-deprecation",
+      "-Yresolve-term-conflict:package",
+      "-Ymacro-annotations"
+    ),
     logLevel := Level.Info,
     run / javaOptions := webapiJavaRunOptions,
     javaAgents += Dependencies.aspectjweaver,

project/Dependencies.scala

@@ -20,17 +20,18 @@ object Dependencies {
   val jenaVersion       = "4.4.0"
   val metricsVersion    = "4.0.1"
   val scalaVersion      = "2.13.8"
-  val ZioVersion        = "2.0.0-RC5"
+  val ZioVersion        = "2.0.0-RC6"
   val ZioHttpVersion    = "2.0.0-RC4"
   val ZioJsonVersion    = "0.3.0-RC3"
-  val ZioConfigVersion  = "3.0.0-RC8"
+  val ZioConfigVersion  = "3.0.0-RC9"
   val ZioSchemaVersion  = "0.2.0-RC5"
-  val ZioLoggingVersion = "2.0.0-RC8"
+  val ZioLoggingVersion = "2.0.0-RC9"
   val ZioZmxVersion     = "2.0.0-RC4"
   val ZioPreludeVersion = "1.0.0-RC13"
 
   // ZIO - all Scala 3 compatible
   val zio               = "dev.zio" %% "zio"                 % ZioVersion
+  val zioMacros         = "dev.zio" %% "zio-macros"          % ZioVersion
   val zioHttp           = "io.d11"  %% "zhttp"               % ZioHttpVersion
   val zioJson           = "dev.zio" %% "zio-json"            % ZioJsonVersion
   val zioPrelude        = "dev.zio" %% "zio-prelude"         % ZioPreludeVersion
@@ -145,13 +146,15 @@ object Dependencies {
     zioHttp,
     zioJson,
     zioLogging,
+    zioMacros,
     zioPrelude,
     zioTest    % Test,
     zioTestSbt % Test
   )
 
   val dspApiMainLibraryDependencies = Seq(
-    zio
+    zio,
+    zioMacros
   )
 
   val schemaApiLibraryDependencies = Seq(

webapi/src/main/scala/org/knora/webapi/app/Main.scala

@@ -25,8 +25,12 @@ import java.util.concurrent.TimeUnit
  */
 object Main extends scala.App with LiveCore {
 
-  // The ZIO runtime used to run functional effects
-  val runtime = Runtime(ZEnvironment.empty, RuntimeConfig.default @@ Logging.fromInfo)
+  /**
+   * Unsafely creates a `Runtime` from a `ZLayer` whose resources will be
+   * allocated immediately, and not released until the `Runtime` is shut down or
+   * the end of the application.
+   */
+  val runtime = Runtime.unsafeFromLayer(Logging.fromInfo)
 
   // The effect for building a cache service manager, a IIIF service manager, and AppConfig.
   val managers = for {

webapi/src/main/scala/org/knora/webapi/core/Logging.scala

@@ -1,9 +1,9 @@
 package org.knora.webapi.core
 
 import zio.LogLevel
-import zio.RuntimeConfigAspect
 import zio.logging.LogFormat._
 import zio.logging._
+import zio.ZLayer
 
 object Logging {
   val logFormat             = "[correlation-id = %s] %s"
@@ -12,14 +12,14 @@ object Logging {
   val textFormat: LogFormat =
     timestamp.fixed(32).color(LogColor.BLUE) |-| level.highlight.fixed(14) |-| line.highlight
 
-  val fromDebug: RuntimeConfigAspect = {
+  val fromDebug: ZLayer[Any, Nothing, Unit] = {
     console(
       logLevel = LogLevel.Debug,
       format = textFormat
     )
   }
 
-  val fromInfo: RuntimeConfigAspect = {
+  val fromInfo: ZLayer[Any, Nothing, Unit] = {
     console(
       logLevel = LogLevel.Info,
       format = textFormat

webapi/src/main/scala/org/knora/webapi/store/cacheservice/api/CacheService.scala

@@ -11,10 +11,12 @@ import org.knora.webapi.messages.admin.responder.usersmessages.UserADM
 import org.knora.webapi.messages.admin.responder.usersmessages.UserIdentifierADM
 import org.knora.webapi.messages.store.cacheservicemessages.CacheServiceStatusResponse
 import zio._
+import zio.macros.accessible
 
 /**
  * Cache Service Interface
  */
+@accessible
 trait CacheService {
   def putUserADM(value: UserADM): Task[Unit]
   def getUserADM(identifier: UserIdentifierADM): Task[Option[UserADM]]
@@ -46,4 +48,3 @@ trait CacheService {
  *     } yield ()
  * }}}
  */
-object CacheService extends Accessible[CacheService]

webapi/src/main/scala/org/knora/webapi/store/cacheservice/impl/CacheServiceInMemImpl.scala

@@ -157,8 +157,8 @@ case class CacheServiceInMemImpl(
     val emptyValueError = EmptyValue("The string value is empty. Aborting write to cache.")
 
     (for {
-      key   <- if (key.isEmpty()) Task.fail(emptyKeyError) else Task.succeed(key)
-      value <- if (value.isEmpty()) Task.fail(emptyValueError) else Task.succeed(value)
+      key   <- if (key.isEmpty()) ZIO.fail(emptyKeyError) else ZIO.succeed(key)
+      value <- if (value.isEmpty()) ZIO.fail(emptyValueError) else ZIO.succeed(value)
       _     <- lut.put(key, value).commit
     } yield ()).tap(_ => ZIO.logDebug(s"Wrote key: $key with value: $value to cache."))
   }
@@ -196,7 +196,7 @@ case class CacheServiceInMemImpl(
    * Pings the in-memory cache to see if it is available.
    */
   def ping(): Task[CacheServiceStatusResponse] =
-    Task.succeed(CacheServiceStatusOK)
+    ZIO.succeed(CacheServiceStatusOK)
 }
 
 /**

webapi/src/main/scala/org/knora/webapi/store/cacheservice/impl/CacheServiceRedisImpl.scala

@@ -147,7 +147,7 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
    * @param key   the key.
    * @param value the value.
    */
-  def putStringValue(key: String, value: String): Task[Unit] = Task.attempt {
+  def putStringValue(key: String, value: String): Task[Unit] = ZIO.attempt {
 
     if (key.isEmpty)
       throw EmptyKey("The key under which the value should be written is empty. Aborting writing to redis.")
@@ -176,18 +176,18 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
       conn  <- ZIO.attempt(pool.getResource)
       value <- ZIO.attemptBlocking(conn.get(key))
       res <-
-        if (value == "nil".getBytes) Task.succeed(None)
-        else Task.succeed(Some(value))
+        if (value == "nil".getBytes) ZIO.succeed(None)
+        else ZIO.succeed(Some(value))
       _ = conn.close()
     } yield res
-  }.catchAll(ex => ZIO.logError(s"Reading string from Redis failed: ${ex.getMessage}") *> Task.succeed(None))
+  }.catchAll(ex => ZIO.logError(s"Reading string from Redis failed: ${ex.getMessage}") *> ZIO.succeed(None))
 
   /**
    * Removes values for the provided keys. Any invalid keys are ignored.
    *
    * @param keys the keys.
    */
-  def removeValues(keys: Set[String]): Task[Unit] = Task.attemptBlocking {
+  def removeValues(keys: Set[String]): Task[Unit] = ZIO.attemptBlocking {
 
     // del takes a vararg so I nee to convert the set to a swq and then to vararg
     val conn: Jedis = pool.getResource
@@ -206,7 +206,7 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
    * @param key   the key.
    * @param value the value.
    */
-  private def putBytesValue(key: String, value: Array[Byte]): Task[Unit] = Task.attemptBlocking {
+  private def putBytesValue(key: String, value: Array[Byte]): Task[Unit] = ZIO.attemptBlocking {
 
     if (key.isEmpty)
       throw EmptyKey("The key under which the value should be written is empty. Aborting writing to redis.")
@@ -236,15 +236,15 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
       conn  <- ZIO.attempt(pool.getResource).onError(ZIO.logErrorCause(_)).orDie
       value <- ZIO.attemptBlocking(conn.get(key.getBytes))
       res <-
-        if (value == "nil".getBytes) Task.succeed(None)
-        else Task.succeed(Some(value))
+        if (value == "nil".getBytes) ZIO.succeed(None)
+        else ZIO.succeed(Some(value))
       _ = conn.close()
     } yield res
 
   /**
    * Flushes (removes) all stored content from the Redis store.
    */
-  def flushDB(requestingUser: UserADM): Task[Unit] = Task.attemptBlocking {
+  def flushDB(requestingUser: UserADM): Task[Unit] = ZIO.attemptBlocking {
 
     if (!requestingUser.isSystemUser) {
       throw ForbiddenException("Only the system user is allowed to perform this operation.")
@@ -265,7 +265,7 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
   /**
    * Pings the Redis store to see if it is available.
    */
-  def ping(): Task[CacheServiceStatusResponse] = Task.attemptBlocking {
+  def ping(): Task[CacheServiceStatusResponse] = ZIO.attemptBlocking {
 
     val conn: Jedis = pool.getResource
     try {
@@ -274,7 +274,7 @@ case class CacheServiceRedisImpl(pool: JedisPool) extends CacheService {
     } finally {
       conn.close()
     }
-  }.catchAll(ex => ZIO.logError(s"Ping failed: ${ex.getMessage}") *> Task.succeed(CacheServiceStatusNOK))
+  }.catchAll(ex => ZIO.logError(s"Ping failed: ${ex.getMessage}") *> ZIO.succeed(CacheServiceStatusNOK))
 }
 
 object CacheServiceRedisImpl {

webapi/src/main/scala/org/knora/webapi/store/iiif/api/IIIFService.scala

@@ -9,7 +9,9 @@ import org.knora.webapi.messages.store.sipimessages.SipiGetTextFileRequest
 import org.knora.webapi.messages.store.sipimessages.SipiGetTextFileResponse
 import org.knora.webapi.messages.v2.responder.SuccessResponseV2
 import zio._
+import zio.macros.accessible
 
+@accessible
 trait IIIFService {
 
   /**
@@ -50,5 +52,3 @@ trait IIIFService {
    */
   def getStatus(): Task[IIIFServiceStatusResponse]
 }
-
-object IIIFService extends Accessible[IIIFService]

webapi/src/main/scala/org/knora/webapi/util/ActorUtil.scala

@@ -25,6 +25,13 @@ import scala.util.Try
 
 object ActorUtil {
 
+  /**
+   * Unsafely creates a `Runtime` from a `ZLayer` whose resources will be
+   * allocated immediately, and not released until the `Runtime` is shut down or
+   * the end of the application.
+   */
+  private val runtime = Runtime.unsafeFromLayer(Logging.fromInfo)
+
   /**
    * Transforms ZIO Task returned to the receive method of an actor to a message. Used mainly during the refactoring
    * phase, to be able to return ZIO inside an Actor.
@@ -37,7 +44,7 @@ object ActorUtil {
    * Since this is the "edge" of the ZIO world for now, we need to log all errors that ZIO has potentially accumulated
    */
   def zio2Message[A](sender: ActorRef, zioTask: zio.Task[A], log: LoggingAdapter, appConfig: AppConfig): Unit =
-    Runtime(ZEnvironment.empty, RuntimeConfig.default @@ Logging.fromInfo)
+    runtime
       .unsafeRunTask(
         zioTask.foldCauseZIO(cause => handleCause(cause, sender), success => ZIO.succeed(sender ! success))
       )

webapi/src/test/scala/org/knora/webapi/AsyncCoreSpec.scala

@@ -52,7 +52,6 @@ import org.scalatest.matchers.should.Matchers
 import org.scalatest.wordspec.AsyncWordSpecLike
 import zio.&
 import zio.Runtime
-import zio.RuntimeConfig
 import zio.ZEnvironment
 import zio.ZIO
 import zio.ZLayer
@@ -117,7 +116,7 @@ abstract class AsyncCoreSpec(_system: ActorSystem)
   val log: LoggingAdapter = akka.event.Logging(system, this.getClass)
 
   // The ZIO runtime used to run functional effects
-  val runtime = Runtime(ZEnvironment.empty, RuntimeConfig.default @@ Logging.fromInfo)
+  val runtime = Runtime.unsafeFromLayer(Logging.fromInfo)
 
   // The effect for building a cache service manager and a IIIF service manager.
   val managers = for {