libs-scala/resources-akka: Make the Akka resources an optional dep.

digital-asset · mergify · Jan 16, 2020 · Jan 16, 2020 · Jan 16, 2020 · Jan 16, 2020
commit f617022ac907ba791354642c5c66064410953bb8
diff --git a/ledger/api-server-damlonx/reference-v2/BUILD.bazel b/ledger/api-server-damlonx/reference-v2/BUILD.bazel
@@ -46,6 +46,7 @@ da_scala_binary(
         "//ledger/participant-state/kvutils",
         "//ledger/sandbox",
         "//libs-scala/resources",
+        "//libs-scala/resources-akka",
         "@maven//:com_github_scopt_scopt_2_12",
         "@maven//:com_typesafe_akka_akka_actor_2_12",
         "@maven//:com_typesafe_akka_akka_stream_2_12",

diff --git a/...e-v2/src/main/scala/com/daml/ledger/api/server/damlonx/reference/v2/ReferenceServer.scala b/...e-v2/src/main/scala/com/daml/ledger/api/server/damlonx/reference/v2/ReferenceServer.scala
@@ -16,6 +16,7 @@ import com.digitalasset.ledger.api.auth.{AuthService, AuthServiceWildcard}
 import com.digitalasset.platform.apiserver.{ApiServerConfig, StandaloneApiServer}
 import com.digitalasset.platform.common.logging.NamedLoggerFactory
 import com.digitalasset.platform.indexer.{IndexerConfig, StandaloneIndexerServer}
+import com.digitalasset.resources.akka.AkkaResourceOwner
 import com.digitalasset.resources.{Resource, ResourceOwner}
 import org.slf4j.LoggerFactory
 
@@ -42,8 +43,8 @@ object ReferenceServer extends App {
   val resource = for {
     // Take ownership of the actor system and materializer so they're cleaned up properly.
     // This is necessary because we can't declare them as implicits within a `for` comprehension.
-    _ <- ResourceOwner.forActorSystem(() => system).acquire()
-    _ <- ResourceOwner.forMaterializer(() => materializer).acquire()
+    _ <- AkkaResourceOwner.forActorSystem(() => system).acquire()
+    _ <- AkkaResourceOwner.forMaterializer(() => materializer).acquire()
     ledger <- ResourceOwner
       .forCloseable(() => new InMemoryKVParticipantState(config.participantId))
       .acquire()

diff --git a/ledger/participant-state/kvutils/app/BUILD.bazel b/ledger/participant-state/kvutils/app/BUILD.bazel
@@ -35,6 +35,7 @@ da_scala_library(
         "//ledger/participant-state/kvutils",
         "//ledger/sandbox",
         "//libs-scala/resources",
+        "//libs-scala/resources-akka",
         "@maven//:com_github_scopt_scopt_2_12",
         "@maven//:com_google_protobuf_protobuf_java",
         "@maven//:com_typesafe_akka_akka_actor_2_12",

diff --git a/...ate/kvutils/app/src/main/scala/com/daml/ledger/participant/state/kvutils/app/Runner.scala b/...ate/kvutils/app/src/main/scala/com/daml/ledger/participant/state/kvutils/app/Runner.scala
@@ -21,6 +21,7 @@ import com.digitalasset.platform.indexer.{
   IndexerStartupMode,
   StandaloneIndexerServer
 }
+import com.digitalasset.resources.akka.AkkaResourceOwner
 import com.digitalasset.resources.{Resource, ResourceOwner}
 import org.slf4j.LoggerFactory
 import scopt.OptionParser
@@ -48,8 +49,8 @@ class Runner[Extra](
     val resource = for {
       // Take ownership of the actor system and materializer so they're cleaned up properly.
       // This is necessary because we can't declare them as implicits within a `for` comprehension.
-      _ <- ResourceOwner.forActorSystem(() => system).acquire()
-      _ <- ResourceOwner.forMaterializer(() => materializer).acquire()
+      _ <- AkkaResourceOwner.forActorSystem(() => system).acquire()
+      _ <- AkkaResourceOwner.forMaterializer(() => materializer).acquire()
       readerWriter <- ResourceOwner
         .forCloseable(() => construct(config.participantId, config.extra))
         .acquire()

diff --git a/ledger/sandbox/BUILD.bazel b/ledger/sandbox/BUILD.bazel
@@ -58,6 +58,7 @@ da_scala_library(
         "//ledger/participant-state-index",
         "//libs-scala/direct-execution-context",
         "//libs-scala/resources",
+        "//libs-scala/resources-akka",
         "@maven//:ch_qos_logback_logback_classic",
         "@maven//:ch_qos_logback_logback_core",
         "@maven//:com_github_scopt_scopt_2_12",
@@ -133,6 +134,7 @@ da_scala_library(
         "//ledger/participant-state-index",
         "//libs-scala/direct-execution-context",
         "//libs-scala/resources",
+        "//libs-scala/resources-akka",
         "@maven//:ch_qos_logback_logback_classic",
         "@maven//:ch_qos_logback_logback_core",
         "@maven//:com_github_scopt_scopt_2_12",

diff --git a/ledger/sandbox/src/main/scala/com/digitalasset/platform/apiserver/StandaloneApiServer.scala b/ledger/sandbox/src/main/scala/com/digitalasset/platform/apiserver/StandaloneApiServer.scala
@@ -23,6 +23,7 @@ import com.digitalasset.platform.common.logging.NamedLoggerFactory
 import com.digitalasset.platform.sandbox.BuildInfo
 import com.digitalasset.platform.sandbox.config.SandboxConfig
 import com.digitalasset.platform.sandbox.stores.InMemoryPackageStore
+import com.digitalasset.resources.akka.AkkaResourceOwner
 import com.digitalasset.resources.{Resource, ResourceOwner}
 
 import scala.collection.JavaConverters._
@@ -89,10 +90,8 @@ final class StandaloneApiServer(
     preloadPackages(packageStore)
 
     for {
-      actorSystem <- ResourceOwner.forActorSystem(() => ActorSystem(actorSystemName)).acquire()
-      materializer <- ResourceOwner
-        .forMaterializer(() => Materializer(actorSystem))
-        .acquire()
+      actorSystem <- AkkaResourceOwner.forActorSystem(() => ActorSystem(actorSystemName)).acquire()
+      materializer <- AkkaResourceOwner.forMaterializer(() => Materializer(actorSystem)).acquire()
       initialConditions <- ResourceOwner
         .forFuture(() => readService.getLedgerInitialConditions().runWith(Sink.head)(materializer))
         .acquire()

diff --git a/...er/sandbox/src/main/scala/com/digitalasset/platform/indexer/StandaloneIndexerServer.scala b/...er/sandbox/src/main/scala/com/digitalasset/platform/indexer/StandaloneIndexerServer.scala
@@ -8,6 +8,7 @@ import com.codahale.metrics.MetricRegistry
 import com.daml.ledger.participant.state.v1.ReadService
 import com.digitalasset.platform.common.logging.NamedLoggerFactory
 import com.digitalasset.platform.indexer.StandaloneIndexerServer._
+import com.digitalasset.resources.akka.AkkaResourceOwner
 import com.digitalasset.resources.{Resource, ResourceOwner}
 
 import scala.concurrent.duration.{DurationInt, FiniteDuration}
@@ -24,7 +25,7 @@ class StandaloneIndexerServer(
   override def acquire()(implicit executionContext: ExecutionContext): Resource[Unit] =
     for {
       // ActorSystem name not allowed to contain daml-lf LedgerString characters ".:#/ "
-      actorSystem <- ResourceOwner
+      actorSystem <- AkkaResourceOwner
         .forActorSystem(() =>
           ActorSystem("StandaloneIndexerServer-" + config.participantId.filterNot(".:#/ ".toSet)))
         .acquire()

diff --git a/ledger/sandbox/src/main/scala/com/digitalasset/platform/sandbox/SandboxServer.scala b/ledger/sandbox/src/main/scala/com/digitalasset/platform/sandbox/SandboxServer.scala
@@ -43,6 +43,7 @@ import com.digitalasset.platform.sandbox.stores.{
   SandboxIndexAndWriteService
 }
 import com.digitalasset.platform.services.time.TimeProviderType
+import com.digitalasset.resources.akka.AkkaResourceOwner
 import com.digitalasset.resources.{Resource, ResourceOwner}
 import org.slf4j.LoggerFactory
 
@@ -285,10 +286,8 @@ final class SandboxServer(config: => SandboxConfig) extends AutoCloseable {
   private def start()(implicit executionContext: ExecutionContext): Resource[SandboxState] = {
     val packageStore = loadDamlPackages()
     for {
-      actorSystem <- ResourceOwner.forActorSystem(() => ActorSystem(ActorSystemName)).acquire()
-      materializer <- ResourceOwner
-        .forMaterializer(() => Materializer(actorSystem))
-        .acquire()
+      actorSystem <- AkkaResourceOwner.forActorSystem(() => ActorSystem(ActorSystemName)).acquire()
+      materializer <- AkkaResourceOwner.forMaterializer(() => Materializer(actorSystem)).acquire()
     } yield {
       val apiServerResource = buildAndStartApiServer(
         materializer,

diff --git a/libs-scala/resources-akka/BUILD.bazel b/libs-scala/resources-akka/BUILD.bazel
@@ -0,0 +1,30 @@
+# Copyright (c) 2020 The DAML Authors. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+load("//bazel_tools:scala.bzl", "da_scala_library", "da_scala_test_suite")
+
+da_scala_library(
+    name = "resources-akka",
+    srcs = glob(["src/main/scala/**/*.scala"]),
+    tags = ["maven_coordinates=com.digitalasset:resources-akka:__VERSION__"],
+    visibility = [
+        "//visibility:public",
+    ],
+    deps = [
+        "//libs-scala/resources",
+        "@maven//:com_typesafe_akka_akka_actor_2_12",
+        "@maven//:com_typesafe_akka_akka_stream_2_12",
+    ],
+)
+
+da_scala_test_suite(
+    name = "resources-akka-tests",
+    srcs = glob(["src/test/suite/**/*.scala"]),
+    deps = [
+        ":resources-akka",
+        "//libs-scala/resources",
+        "//libs-scala/resources:resources-test-lib",
+        "@maven//:com_typesafe_akka_akka_actor_2_12",
+        "@maven//:com_typesafe_akka_akka_stream_2_12",
+    ],
+)
diff --git a/...rces/ActorMaterializerResourceOwner.scala → ...akka/ActorMaterializerResourceOwner.scala b/...rces/ActorMaterializerResourceOwner.scala → ...akka/ActorMaterializerResourceOwner.scala
@@ -1,9 +1,10 @@
 // Copyright (c) 2020 The DAML Authors. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package com.digitalasset.resources
+package com.digitalasset.resources.akka
 
 import akka.stream.Materializer
+import com.digitalasset.resources.{Resource, ResourceOwner}
 
 import scala.concurrent.{ExecutionContext, Future}
 

diff --git a/.../resources/ActorSystemResourceOwner.scala → ...urces/akka/ActorSystemResourceOwner.scala b/.../resources/ActorSystemResourceOwner.scala → ...urces/akka/ActorSystemResourceOwner.scala
@@ -1,9 +1,10 @@
 // Copyright (c) 2020 The DAML Authors. All rights reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-package com.digitalasset.resources
+package com.digitalasset.resources.akka
 
 import akka.actor.ActorSystem
+import com.digitalasset.resources.{Resource, ResourceOwner}
 
 import scala.concurrent.{ExecutionContext, Future}
 

diff --git a/...ala/resources-akka/src/main/scala/com/digitalasset/resources/akka/AkkaResourceOwner.scala b/...ala/resources-akka/src/main/scala/com/digitalasset/resources/akka/AkkaResourceOwner.scala
@@ -0,0 +1,16 @@
+// Copyright (c) 2020 The DAML Authors. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package com.digitalasset.resources.akka
+
+import akka.actor.ActorSystem
+import akka.stream.Materializer
+import com.digitalasset.resources.ResourceOwner
+
+object AkkaResourceOwner {
+  def forActorSystem(acquire: () => ActorSystem): ResourceOwner[ActorSystem] =
+    new ActorSystemResourceOwner(acquire)
+
+  def forMaterializer(acquire: () => Materializer): ResourceOwner[Materializer] =
+    new ActorMaterializerResourceOwner(acquire)
+}
diff --git a/...ces-akka/src/test/suite/scala/com/digitalasset/resources/akka/AkkaResourceOwnerSpec.scala b/...ces-akka/src/test/suite/scala/com/digitalasset/resources/akka/AkkaResourceOwnerSpec.scala
@@ -0,0 +1,73 @@
+// Copyright (c) 2020 The DAML Authors. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package com.digitalasset.resources.akka
+
+import akka.actor.{Actor, ActorSystem, Props}
+import akka.stream.Materializer
+import akka.stream.scaladsl.{Keep, Sink, Source}
+import akka.{Done, NotUsed}
+import com.digitalasset.resources.ResourceOwner
+import org.scalatest.{AsyncWordSpec, Matchers}
+
+import scala.concurrent.{Future, Promise}
+
+class AkkaResourceOwnerSpec extends AsyncWordSpec with Matchers {
+  "a function returning an ActorSystem" should {
+    "convert to a ResourceOwner" in {
+      val testPromise = Promise[Int]()
+      class TestActor extends Actor {
+        @SuppressWarnings(Array("org.wartremover.warts.Any"))
+        override def receive: Receive = {
+          case value: Int => testPromise.success(value)
+          case value => testPromise.failure(new IllegalArgumentException(s"$value"))
+        }
+      }
+
+      val resource = for {
+        actorSystem <- AkkaResourceOwner
+          .forActorSystem(() => ActorSystem("TestActorSystem"))
+          .acquire()
+        actor <- ResourceOwner
+          .successful(actorSystem.actorOf(Props(new TestActor)))
+          .acquire()
+      } yield (actorSystem, actor)
+
+      for {
+        resourceFuture <- resource.asFuture
+        (actorSystem, actor) = resourceFuture
+        _ = actor ! 7
+        result <- testPromise.future
+        _ <- resource.release()
+      } yield {
+        result should be(7)
+        an[IllegalStateException] should be thrownBy actorSystem.actorOf(Props(new TestActor))
+      }
+    }
+  }
+
+  "a function returning a Materializer" should {
+    "convert to a ResourceOwner" in {
+      val resource = for {
+        actorSystem <- AkkaResourceOwner
+          .forActorSystem(() => ActorSystem("TestActorSystem"))
+          .acquire()
+        materializer <- AkkaResourceOwner.forMaterializer(() => Materializer(actorSystem)).acquire()
+      } yield materializer
+
+      for {
+        materializer <- resource.asFuture
+        numbers <- Source(1 to 10)
+          .toMat(Sink.seq)(Keep.right[NotUsed, Future[Seq[Int]]])
+          .run()(materializer)
+        _ <- resource.release()
+      } yield {
+        numbers should be(1 to 10)
+        an[IllegalStateException] should be thrownBy Source
+          .single(0)
+          .toMat(Sink.ignore)(Keep.right[NotUsed, Future[Done]])
+          .run()(materializer)
+      }
+    }
+  }
+}
diff --git a/libs-scala/resources/BUILD.bazel b/libs-scala/resources/BUILD.bazel
@@ -11,8 +11,6 @@ da_scala_library(
         "//visibility:public",
     ],
     deps = [
-        "@maven//:com_typesafe_akka_akka_actor_2_12",
-        "@maven//:com_typesafe_akka_akka_stream_2_12",
         "@maven//:org_scala_lang_modules_scala_java8_compat_2_12",
     ],
 )
@@ -34,7 +32,5 @@ da_scala_test_suite(
     deps = [
         ":resources",
         ":resources-test-lib",
-        "@maven//:com_typesafe_akka_akka_actor_2_12",
-        "@maven//:com_typesafe_akka_akka_stream_2_12",
     ],
 )
diff --git a/libs-scala/resources/src/main/scala/com/digitalasset/resources/ResourceOwner.scala b/libs-scala/resources/src/main/scala/com/digitalasset/resources/ResourceOwner.scala
@@ -6,9 +6,6 @@ package com.digitalasset.resources
 import java.util.Timer
 import java.util.concurrent.{CompletionStage, ExecutorService}
 
-import akka.actor.ActorSystem
-import akka.stream.Materializer
-
 import scala.compat.java8.FutureConverters._
 import scala.concurrent.{ExecutionContext, Future}
 import scala.util.{Failure, Success, Try}
@@ -63,10 +60,4 @@ object ResourceOwner {
 
   def forTimer(acquire: () => Timer): ResourceOwner[Timer] =
     new TimerResourceOwner(acquire)
-
-  def forActorSystem(acquire: () => ActorSystem): ResourceOwner[ActorSystem] =
-    new ActorSystemResourceOwner(acquire)
-
-  def forMaterializer(acquire: () => Materializer): ResourceOwner[Materializer] =
-    new ActorMaterializerResourceOwner(acquire)
 }
diff --git a/libs-scala/resources/src/test/suite/scala/com/digitalasset/resources/ResourceOwnerSpec.scala b/libs-scala/resources/src/test/suite/scala/com/digitalasset/resources/ResourceOwnerSpec.scala
@@ -7,10 +7,6 @@ import java.util.concurrent.CompletableFuture.completedFuture
 import java.util.concurrent.{Executors, RejectedExecutionException}
 import java.util.{Timer, TimerTask}
 
-import akka.actor.{Actor, ActorSystem, Props}
-import akka.stream.Materializer
-import akka.stream.scaladsl.{Keep, Sink, Source}
-import akka.{Done, NotUsed}
 import org.scalatest.{AsyncWordSpec, Matchers}
 
 import scala.collection.mutable
@@ -498,60 +494,6 @@ class ResourceOwnerSpec extends AsyncWordSpec with Matchers {
     }
   }
 
-  "a function returning an ActorSystem" should {
-    "convert to a ResourceOwner" in {
-      val testPromise = Promise[Int]()
-      class TestActor extends Actor {
-        @SuppressWarnings(Array("org.wartremover.warts.Any"))
-        override def receive: Receive = {
-          case value: Int => testPromise.success(value)
-          case value => testPromise.failure(new IllegalArgumentException(s"$value"))
-        }
-      }
-
-      val resource = for {
-        actorSystem <- ResourceOwner.forActorSystem(() => ActorSystem("TestActorSystem")).acquire()
-        actor <- ResourceOwner
-          .successful(actorSystem.actorOf(Props(new TestActor)))
-          .acquire()
-      } yield (actorSystem, actor)
-
-      for {
-        resourceFuture <- resource.asFuture
-        (actorSystem, actor) = resourceFuture
-        _ = actor ! 7
-        result <- testPromise.future
-        _ <- resource.release()
-      } yield {
-        result should be(7)
-        an[IllegalStateException] should be thrownBy actorSystem.actorOf(Props(new TestActor))
-      }
-    }
-  }
-
-  "a function returning a Materializer" should {
-    "convert to a ResourceOwner" in {
-      val resource = for {
-        actorSystem <- ResourceOwner.forActorSystem(() => ActorSystem("TestActorSystem")).acquire()
-        materializer <- ResourceOwner.forMaterializer(() => Materializer(actorSystem)).acquire()
-      } yield materializer
-
-      for {
-        materializer <- resource.asFuture
-        numbers <- Source(1 to 10)
-          .toMat(Sink.seq)(Keep.right[NotUsed, Future[Seq[Int]]])
-          .run()(materializer)
-        _ <- resource.release()
-      } yield {
-        numbers should be(1 to 10)
-        an[IllegalStateException] should be thrownBy Source
-          .single(0)
-          .toMat(Sink.ignore)(Keep.right[NotUsed, Future[Done]])
-          .run()(materializer)
-      }
-    }
-  }
-
   "many resources in a sequence" should {
     "be able to be sequenced" in {
       val acquireOrder = mutable.Buffer[Int]()

diff --git a/release/artifacts.yaml b/release/artifacts.yaml
@@ -231,6 +231,9 @@
 - target: //libs-scala/resources:resources
   type: jar-scala
   mavenUpload: true
+- target: //libs-scala/resources-akka:resources-akka
+  type: jar-scala
+  mavenUpload: true
 - target: //libs-scala/timer-utils:timer-utils
   type: jar-scala
   mavenUpload: true