Pass initial configuration to additional configuration override. Fixes …

…lagom#2448.
kflorence · Dec 9, 2019 · 76d4fe9 · 76d4fe9
1 parent 4a51959
commit 76d4fe9
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 13 deletions.
diff --git a/...caladsl/api/src/main/scala/com/lightbend/lagom/scaladsl/api/AdditionalConfiguration.scala b/...caladsl/api/src/main/scala/com/lightbend/lagom/scaladsl/api/AdditionalConfiguration.scala
@@ -15,6 +15,9 @@ import play.api.Configuration
  * can control which order this configuration gets applied by changing the order in which traits are mixed together.
  */
 trait ProvidesAdditionalConfiguration {
+  @deprecated(message = "prefer `additionalConfiguration(initialConfiguration: Configuration)`", since = "1.6.0")
+  def additionalConfiguration: AdditionalConfiguration = AdditionalConfiguration.empty
+
   /**
    * Define the additional configuration to add to the application.
    *
@@ -23,8 +26,11 @@ trait ProvidesAdditionalConfiguration {
    *
    * When overriding, the overridden file should be a def, so as to ensure multiple components can all override it.
    * Lagom will only invoke this method once from a lazy val, so it will effectively be calculated once.
+   *
+   * @param initialConfiguration A reference to the application configuration prior to override.
    */
-  def additionalConfiguration: AdditionalConfiguration = AdditionalConfiguration.empty
+  def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration =
+    AdditionalConfiguration.empty
 }
 
 /**

diff --git a/...tion-tests/src/test/scala/com/lightbend/lagom/scaladsl/it/ScaladslErrorHandlingSpec.scala b/...tion-tests/src/test/scala/com/lightbend/lagom/scaladsl/it/ScaladslErrorHandlingSpec.scala
@@ -248,9 +248,9 @@ class ScaladslErrorHandlingSpec extends WordSpec with Matchers {
         override lazy val lagomServer = serverFor[MockService](new MockServiceImpl)
         override lazy val environment = Environment.simple(mode = mode)
 
-        override def additionalConfiguration: AdditionalConfiguration = {
+        override def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration = {
           import scala.collection.JavaConverters._
-          super.additionalConfiguration ++ ConfigFactory.parseMap(
+          super.additionalConfiguration(initialConfiguration) ++ ConfigFactory.parseMap(
             Map(
               "play.server.provider" -> httpBackend.provider
             ).asJava

diff --git a/...ration-tests/src/test/scala/com/lightbend/lagom/scaladsl/it/ScaladslMockServiceSpec.scala b/...ration-tests/src/test/scala/com/lightbend/lagom/scaladsl/it/ScaladslMockServiceSpec.scala
@@ -223,9 +223,9 @@ class ScaladslMockServiceSpec extends WordSpec with Matchers {
       new LagomApplication(LagomApplicationContext.Test) with AhcWSComponents with LocalServiceLocator {
         override lazy val lagomServer = serverFor[MockService](new MockServiceImpl)
 
-        override def additionalConfiguration: AdditionalConfiguration = {
+        override def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration = {
           import scala.collection.JavaConverters._
-          super.additionalConfiguration ++ ConfigFactory.parseMap(
+          super.additionalConfiguration(initialConfiguration) ++ ConfigFactory.parseMap(
             Map(
               "play.server.provider" -> httpBackend.provider
             ).asJava

diff --git a/...erver/src/test/scala/com/lightbend/lagom/scaladsl/kafka/broker/ScaladslKafkaApiSpec.scala b/...erver/src/test/scala/com/lightbend/lagom/scaladsl/kafka/broker/ScaladslKafkaApiSpec.scala
@@ -27,6 +27,7 @@ import com.lightbend.lagom.scaladsl.api.broker.Message
 import com.lightbend.lagom.scaladsl.api.broker.Topic
 import com.lightbend.lagom.scaladsl.api.broker.kafka.KafkaProperties
 import com.lightbend.lagom.scaladsl.api.broker.kafka.PartitionKeyStrategy
+import com.lightbend.lagom.scaladsl.api.AdditionalConfiguration
 import com.lightbend.lagom.scaladsl.api.Descriptor
 import com.lightbend.lagom.scaladsl.api.Service
 import com.lightbend.lagom.scaladsl.broker.TopicProducer
@@ -43,6 +44,7 @@ import org.scalatest.concurrent.ScalaFutures
 import org.scalatest._
 import org.slf4j.LoggerFactory
 import play.api.libs.ws.ahc.AhcWSComponents
+import play.api.Configuration
 
 import scala.collection.mutable
 import scala.concurrent.Await
@@ -76,9 +78,9 @@ class ScaladslKafkaApiSpec
       override lazy val jsonSerializerRegistry = EmptyJsonSerializerRegistry
       override lazy val lagomServer            = serverFor[TestService](new TestServiceImpl)
 
-      override def additionalConfiguration = {
+      override def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration = {
         import scala.collection.JavaConverters._
-        super.additionalConfiguration ++ ConfigFactory.parseMap(
+        super.additionalConfiguration(initialConfiguration) ++ ConfigFactory.parseMap(
           Map(
             "akka.remote.artery.canonical.port"             -> "0",
             "akka.remote.artery.canonical.hostname"         -> "127.0.0.1",

diff --git a/...sl/server/src/main/scala/com/lightbend/lagom/scaladsl/server/LagomApplicationLoader.scala b/...sl/server/src/main/scala/com/lightbend/lagom/scaladsl/server/LagomApplicationLoader.scala
@@ -213,8 +213,9 @@ abstract class LagomApplication(context: LagomApplicationContext)
 
   @deprecated(message = "prefer `config` using typesafe Config instead", since = "1.4.0")
   override lazy val configuration: Configuration = {
-    val additionalConfig = new Configuration(additionalConfiguration.configuration)
-    Configuration.load(environment) ++ context.playContext.initialConfiguration ++ additionalConfig
+    val initialConfiguration = Configuration.load(environment) ++ context.playContext.initialConfiguration
+    val additionalConfig     = new Configuration(additionalConfiguration(initialConfiguration).configuration)
+    initialConfiguration ++ additionalConfig
   }
 
   override lazy val actorSystem: ActorSystem =

diff --git a/...adsl/server/src/test/scala/com/lightbend/lagom/scaladsl/server/LagomApplicationSpec.scala b/...adsl/server/src/test/scala/com/lightbend/lagom/scaladsl/server/LagomApplicationSpec.scala
@@ -17,6 +17,7 @@ import com.typesafe.config.ConfigFactory
 import org.scalatest.Matchers
 import org.scalatest.WordSpec
 import play.api.ApplicationLoader.Context
+import play.api.Configuration
 import play.api.Environment
 import play.api.inject.DefaultApplicationLifecycle
 import play.api.libs.ws.ahc.AhcWSComponents
@@ -67,8 +68,8 @@ class LagomApplicationSpec extends WordSpec with Matchers {
   private val configKey = "akka.cluster.seed-nodes"
 
   trait FakeComponent extends ProvidesAdditionalConfiguration {
-    override def additionalConfiguration: AdditionalConfiguration =
-      super.additionalConfiguration ++
+    override def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration =
+      super.additionalConfiguration(initialConfiguration) ++
         ConfigFactory.parseString(configKey + "=\"via additional\"")
   }
 

diff --git a/.../scaladsl/src/test/scala/com/lightbend/lagom/scaladsl/testkit/services/FakeServices.scala b/.../scaladsl/src/test/scala/com/lightbend/lagom/scaladsl/testkit/services/FakeServices.scala
@@ -63,9 +63,9 @@ abstract class DownstreamApplication(context: LagomApplicationContext)
     with AhcWSComponents {
   // This is a hack so C* persistence in this Applicaiton doesn't complain. C* Persistence is only used
   // so intances of this Application can mix-in a TopicComponents implementation (Test or Kafka)
-  override def additionalConfiguration: AdditionalConfiguration = {
+  override def additionalConfiguration(initialConfiguration: Configuration): AdditionalConfiguration = {
     import scala.collection.JavaConverters._
-    super.additionalConfiguration ++ ConfigFactory.parseMap(
+    super.additionalConfiguration(initialConfiguration) ++ ConfigFactory.parseMap(
       Map(
         "cassandra-journal.keyspace"                     -> "asdf",
         "cassandra-snapshot-store.keyspace"              -> "asdf",