refactor(IIIFService): zio-fying iiif service (DEV-801)

.github/workflows/main.yml

@@ -17,22 +17,17 @@ jobs:
         uses: actions/checkout@v1
         with:
           fetch-depth: 15
-      - name: Setup JDK
-        uses: actions/setup-java@v2
-        with:
-          distribution: temurin
-          java-version: 11
       - name: get current time
         uses: josStorer/get-current-time@v2
         id: current-time
         with:
           format: YYYY-MM-DD
           utcOffset: "+02:00"
-      - name: setup java version
-        uses: joschi/setup-jdk@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11' # The OpenJDK version to make available on the path
-          architecture: 'x64' # defaults to 'x64'
+          distribution: 'temurin'
+          java-version: '17'
       - name: add docker compose v2
         run: |
           mkdir -p ~/.docker/cli-plugins/
@@ -69,11 +64,11 @@ jobs:
         with:
           format: YYYY-MM-DD
           utcOffset: "+02:00"
-      - name: setup java version
-        uses: joschi/setup-jdk@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11' # The OpenJDK version to make available on the path
-          architecture: 'x64' # defaults to 'x64'
+          distribution: 'temurin'
+          java-version: '17'
       - name: add docker compose v2
         run: |
           mkdir -p ~/.docker/cli-plugins/
@@ -116,11 +111,11 @@ jobs:
         with:
           format: YYYY-MM-DD
           utcOffset: "+02:00"
-      - name: setup java version
-        uses: joschi/setup-jdk@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11' # The OpenJDK version to make available on the path
-          architecture: 'x64' # defaults to 'x64'
+          distribution: 'temurin'
+          java-version: '17'
       - name: add docker compose v2
         run: |
           mkdir -p ~/.docker/cli-plugins/
@@ -211,11 +206,11 @@ jobs:
         with:
           format: YYYY-MM-DD
           utcOffset: "+02:00"
-      - name: setup java version
-        uses: joschi/setup-jdk@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
         with:
-          java-version: '11' # The OpenJDK version to make available on the path
-          architecture: 'x64' # defaults to 'x64'
+          distribution: 'temurin'
+          java-version: '17'
       - name: add docker compose v2
         run: |
           mkdir -p ~/.docker/cli-plugins/
@@ -287,3 +282,42 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
           CUSTOM_DOMAIN: docs-api.dasch.swiss
           REQUIREMENTS: docs/requirements.txt
+
+  fmtcheck:
+    name: Check Formating
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout source
+        uses: actions/checkout@v1
+        with:
+          fetch-depth: 15
+      - name: get current time
+        uses: josStorer/get-current-time@v2
+        id: current-time
+        with:
+          format: YYYY-MM-DD
+          utcOffset: "+02:00"
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+      - name: add docker compose v2
+        run: |
+          mkdir -p ~/.docker/cli-plugins/
+          curl -SL https://github.com/docker/compose/releases/download/v2.2.3/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
+          chmod +x ~/.docker/cli-plugins/docker-compose
+      - name: install requirements
+        run: sudo apt-get install ca-certificates-java expect
+      - name: Coursier cache
+        uses: coursier/cache-action@v6
+      - name: Run fmtcheck
+        run: make check
+      - name: Cleanup before cache
+        shell: bash
+        run: |
+          rm -rf "$HOME/.ivy2/local" || true
+          find $HOME/Library/Caches/Coursier/v1        -name "ivydata-*.properties" -delete || true
+          find $HOME/.ivy2/cache                       -name "ivydata-*.properties" -delete || true
+          find $HOME/.cache/coursier/v1                -name "ivydata-*.properties" -delete || true
+          find $HOME/.sbt                              -name "*.lock"               -delete || true

Makefile

@@ -300,6 +300,10 @@ info: ## print out all variables
 	@echo "BUILD_TAG: \t\t $(BUILD_TAG)"
 	@echo "GIT_EMAIL: \t\t $(GIT_EMAIL)"
 
+.PHONY: check
+check: # Run code formating check 
+	@sbt "check"
+
 .PHONY: help
 help: ## this help
 	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort

build.sbt

@@ -49,6 +49,9 @@ lazy val root: Project = Project(id = "root", file("."))
     publish / skip := true
   )
 
+addCommandAlias("fmt", "all root/scalafmtSbt root/scalafmtAll")
+addCommandAlias("check", "all root/scalafmtSbtCheck root/scalafmtCheckAll")
+
 //////////////////////////////////////
 // DSP's custom SIPI
 //////////////////////////////////////
@@ -98,7 +101,7 @@ lazy val webApiCommonSettings = Seq(
 
 lazy val webapi: Project = Project(id = "webapi", base = file("webapi"))
   .settings(buildSettings)
-  .enablePlugins(SbtTwirl, JavaAppPackaging, DockerPlugin, GatlingPlugin, JavaAgent, RevolverPlugin, BuildInfoPlugin)
+  .enablePlugins(SbtTwirl, JavaAppPackaging, DockerPlugin, GatlingPlugin, JavaAgent, BuildInfoPlugin)
   .settings(
     name := "webapi",
     resolvers ++= Seq(
@@ -133,10 +136,6 @@ lazy val webapi: Project = Project(id = "webapi", base = file("webapi"))
     scalacOptions ++= Seq("-feature", "-unchecked", "-deprecation", "-Yresolve-term-conflict:package"),
     logLevel := Level.Info,
     run / javaOptions := webapiJavaRunOptions,
-    reStart / javaOptions ++= resolvedJavaAgents.value map { resolved =>
-      "-javaagent:" + resolved.artifact.absolutePath + resolved.agent.arguments
-    }, // allows sbt-javaagent to work with sbt-revolver
-    reStart / javaOptions ++= webapiJavaRunOptions,
     javaAgents += Dependencies.aspectjweaver,
     fork := true,                       // run tests in a forked JVM
     Test / testForkedParallel := false, // run forked tests in parallel

docs/architecture/decisions/0003-change-iiif-service-manager-and-sipi-implementation-to-zlayer.md

@@ -0,0 +1,20 @@
+# 3. Change IIIF Service Manager and Sipi implementation to zlayer
+
+Date: 2022-04-29
+
+## Status
+
+Accepted
+
+## Context
+
+Both `org.knora.webapi.store.iiif.IIIFServiceManager` and `org.knora.webapi.store.iiif.impl.IIIFServiceSipiImpl`
+where implemented as Akka-Actors 
+
+## Decision
+
+As part of the move from `Akka` to `ZIO`, it was decided that the `IIIFServiceManager` and the `IIIFServiceSipiImpl` is refactored using ZIO.
+
+## Consequences
+
+The usage from other actors stays the same. The actor messages and responses don't change.

project/Dependencies.scala

@@ -33,7 +33,7 @@ object Dependencies {
   val zioHttp           = "io.d11"  %% "zhttp"               % ZioHttpVersion
   val zioJson           = "dev.zio" %% "zio-json"            % ZioJsonVersion
   val zioPrelude        = "dev.zio" %% "zio-prelude"         % ZioPreludeVersion
-  val zioLoggingSlf4j   = "dev.zio" %% "zio-logging-slf4j"   % ZioLoggingVersion
+  val zioLogging        = "dev.zio" %% "zio-logging"         % ZioLoggingVersion
   val zioConfig         = "dev.zio" %% "zio-config"          % ZioConfigVersion
   val zioConfigMagnolia = "dev.zio" %% "zio-config-magnolia" % ZioConfigVersion
   val zioConfigTypesafe = "dev.zio" %% "zio-config-typesafe" % ZioConfigVersion
@@ -143,7 +143,7 @@ object Dependencies {
     zioConfigTypesafe,
     zioHttp,
     zioJson,
-    zioLoggingSlf4j,
+    zioLogging,
     zioPrelude,
     zioTest    % Test,
     zioTestSbt % Test

project/plugins.sbt

@@ -5,13 +5,9 @@ resolvers ++= Seq(
 // please don't remove or merge uncommented to main
 addDependencyTreePlugin
 
-// Knora
-addSbtPlugin("com.typesafe.sbt" % "sbt-git"             % "1.0.2")
-addSbtPlugin("com.github.sbt"   % "sbt-native-packager" % "1.9.9")
-addSbtPlugin("io.kamon"         % "sbt-aspectj-runner"  % "1.1.1")
-
-// webapi
-addSbtPlugin("io.spray"          % "sbt-revolver"        % "0.9.1")
+addSbtPlugin("com.typesafe.sbt"  % "sbt-git"             % "1.0.2")
+addSbtPlugin("com.github.sbt"    % "sbt-native-packager" % "1.9.9")
+addSbtPlugin("io.kamon"          % "sbt-aspectj-runner"  % "1.1.1")
 addSbtPlugin("com.typesafe.sbt"  % "sbt-twirl"           % "1.5.1")
 addSbtPlugin("com.eed3si9n"      % "sbt-assembly"        % "0.14.10")
 addSbtPlugin("com.lightbend.sbt" % "sbt-javaagent"       % "0.1.5")
@@ -20,6 +16,8 @@ addSbtPlugin("org.scoverage"     % "sbt-scoverage"       % "1.6.1")
 addSbtPlugin("com.codacy"        % "sbt-codacy-coverage" % "1.3.15")
 addSbtPlugin("com.eed3si9n"      % "sbt-buildinfo"       % "0.11.0")
 
+addSbtPlugin("org.scalameta" % "sbt-scalafmt" % "2.4.3")
+
 // ad-hoc plugins - uncomment on demenad and keep it commented out in main branch
 
 // https://github.com/rtimush/sbt-updates

sipi/scripts/jwt.lua

@@ -26,9 +26,9 @@ function get_knora_token()
     end
 
     token_issuer = webapi_hostname .. ':' .. webapi_port
-    server.log("token_issuer:" .. token_issuer, server.loglevel.LOG_DEBUG)
+    server.log("token_issuer: " .. token_issuer, server.loglevel.LOG_DEBUG)
     if token["iss"] ~= token_issuer then
-        server.log(token_issuer, server.loglevel.LOG_DEBUG)
+        server.log("Invalid token issuer: " .. token_issuer .. " . Expected: " .. token["iss"], server.loglevel.LOG_DEBUG)
         send_error(401, "Invalid token. The token was not issued by the same server that sent the request.")
         return nil
     end

webapi/src/main/resources/application.conf

@@ -296,7 +296,7 @@ app {
 
     shacl {
         # The directory that SHACL shapes are loaded from.
-        shapes-dir = "shacl"
+        shapes-dir = "../test_data/shacl"
         shapes-dir = ${?KNORA_WEBAPI_SHACLE_SHAPES_DIR}
     }
 

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

@@ -23,7 +23,6 @@ import ch.megard.akka.http.cors.scaladsl.settings.CorsSettings
 import com.typesafe.config.ConfigFactory
 import com.typesafe.scalalogging.LazyLogging
 import kamon.Kamon
-import org.knora.webapi.config.AppConfig
 import org.knora.webapi.core.LiveActorMaker
 import org.knora.webapi.exceptions.InconsistentRepositoryDataException
 import org.knora.webapi.exceptions.MissingLastModificationDateOntologyException
@@ -65,6 +64,7 @@ import org.knora.webapi.store.StoreManager
 import org.knora.webapi.store.cacheservice.CacheServiceManager
 import org.knora.webapi.store.cacheservice.impl.CacheServiceInMemImpl
 import org.knora.webapi.store.cacheservice.settings.CacheServiceSettings
+import org.knora.webapi.store.iiif.IIIFServiceManager
 import org.knora.webapi.util.cache.CacheUtil
 import redis.clients.jedis.exceptions.JedisConnectionException
 import zio.Runtime
@@ -78,58 +78,13 @@ import scala.concurrent.duration._
 import scala.util.Failure
 import scala.util.Success
 import org.knora.webapi.store.cacheservice.config.RedisConfig
+import org.knora.webapi.store.iiif.impl.IIIFServiceSipiImpl
 import zio.ZEnvironment
 import zio.RuntimeConfig
 import org.knora.webapi.core.Logging
-
-trait Managers {
-  implicit val system: ActorSystem
-  val responderManager: ActorRef
-  val storeManager: ActorRef
-}
-
-trait LiveManagers extends Managers {
-  this: Actor =>
-
-  /**
-   * Initializing the cache service manager, which is a ZLayer,
-   * by unsafe running it.
-   */
-  lazy val cacheServiceManager: CacheServiceManager =
-    Runtime(ZEnvironment.empty, RuntimeConfig.default @@ Logging.live)
-      .unsafeRun(
-        (for (manager <- ZIO.service[CacheServiceManager])
-          yield manager).provide(CacheServiceInMemImpl.layer, CacheServiceManager.layer)
-      )
-
-  /**
-   * The actor that forwards messages to actors that deal with persistent storage.
-   */
-  lazy val storeManager: ActorRef = context.actorOf(
-    Props(new StoreManager(appActor = self, csm = cacheServiceManager) with LiveActorMaker)
-      .withDispatcher(KnoraDispatchers.KnoraActorDispatcher),
-    name = StoreManagerActorName
-  )
-
-  /**
-   * The actor that forwards messages to responder actors to handle API requests.
-   */
-  lazy val responderManager: ActorRef = context.actorOf(
-    Props(
-      new ResponderManager(
-        appActor = self,
-        responderData = ResponderData(
-          system = context.system,
-          appActor = self,
-          knoraSettings = KnoraSettings(system),
-          cacheServiceSettings = new CacheServiceSettings(system.settings.config)
-        )
-      ) with LiveActorMaker
-    )
-      .withDispatcher(KnoraDispatchers.KnoraActorDispatcher),
-    name = RESPONDER_MANAGER_ACTOR_NAME
-  )
-}
+import org.knora.webapi.auth.JWTService
+import zio.ZLayer
+import org.knora.webapi.config.AppConfig
 
 /**
  * This is the first actor in the application. All other actors are children
@@ -139,8 +94,15 @@ trait LiveManagers extends Managers {
  * the startup and shutdown sequence. Further, it forwards any messages meant
  * for responders or the store to the respective actor.
  */
-class ApplicationActor extends Actor with Stash with LazyLogging with AroundDirectives with Timers {
-  this: Managers =>
+class ApplicationActor(
+  cacheServiceManager: CacheServiceManager,
+  iiifServiceManager: IIIFServiceManager,
+  appConfig: AppConfig
+) extends Actor
+    with Stash
+    with LazyLogging
+    with AroundDirectives
+    with Timers {
 
   logger.debug("entered the ApplicationManager constructor")
 
@@ -184,6 +146,34 @@ class ApplicationActor extends Actor with Stash with LazyLogging with AroundDire
     appActor = self
   )
 
+  /**
+   * The actor that forwards messages to responder actors to handle API requests.
+   */
+  lazy val responderManager: ActorRef = context.actorOf(
+    Props(
+      new ResponderManager(
+        appActor = self,
+        responderData = ResponderData(
+          system = context.system,
+          appActor = self,
+          knoraSettings = KnoraSettings(system),
+          cacheServiceSettings = new CacheServiceSettings(system.settings.config)
+        )
+      ) with LiveActorMaker
+    )
+      .withDispatcher(KnoraDispatchers.KnoraActorDispatcher),
+    name = RESPONDER_MANAGER_ACTOR_NAME
+  )
+
+  /**
+   * The actor that forwards messages to actors that deal with persistent storage.
+   */
+  lazy val storeManager: ActorRef = context.actorOf(
+    Props(new StoreManager(self, cacheServiceManager, iiifServiceManager, appConfig) with LiveActorMaker)
+      .withDispatcher(KnoraDispatchers.KnoraActorDispatcher),
+    name = StoreManagerActorName
+  )
+
   /**
    * This actor acts as the supervisor for its child actors.
    * Here we can override the default supervisor strategy.

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

@@ -15,6 +15,8 @@ import org.knora.webapi.settings.{KnoraDispatchers, KnoraSettings, KnoraSettings
 import scala.concurrent.ExecutionContext
 import scala.language.postfixOps
 import scala.languageFeature.postfixOps
+import org.knora.webapi.store.iiif.IIIFServiceManager
+import org.knora.webapi.store.cacheservice.CacheServiceManager
 
 /**
  * The applications actor system.
@@ -53,7 +55,7 @@ trait LiveCore extends Core {
    * sequences.
    */
   lazy val appActor: ActorRef = system.actorOf(
-    Props(new ApplicationActor with LiveManagers)
+    Props(new ApplicationActor(cacheServiceManager, iiifServiceManager, appConfig))
       .withDispatcher(KnoraDispatchers.KnoraActorDispatcher),
     name = APPLICATION_MANAGER_ACTOR_NAME
   )