Ledger id requirement (#6323)

* Add option based constructor for LedgerIdRequirement changelog_begin changelog_end * Make option based consructor the default, deprecate old constructor * Update with review comments
2024-09-20 01:07:18 +03:00 · 2020-06-12 16:00:32 +01:00 · 2020-06-12 16:00:32 +01:00 · 5329a4f97f
commit 5329a4f97f
parent 3351dd8963
20 changed files with 59 additions and 25 deletions
--- a/compiler/repl-service/server/src/main/scala/com/digitalasset/daml/lf/ReplServiceMain.scala
+++ b/compiler/repl-service/server/src/main/scala/com/digitalasset/daml/lf/ReplServiceMain.scala
@ -141,7 +141,7 @@ object ReplServiceMain extends App {
  val applicationId = ApplicationId("daml repl")
  val clientConfig = LedgerClientConfiguration(
    applicationId = applicationId.unwrap,
-    ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+    ledgerIdRequirement = LedgerIdRequirement.none,
    commandClient = CommandClientConfiguration.default,
    sslContext = config.tlsConfig.flatMap(_.client),
    token = config.accessTokenFile.map(new TokenHolder(_)).flatMap(_.token),
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/RunnerMain.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/RunnerMain.scala
@ -110,7 +110,7 @@ object RunnerMain {
            val tokenHolder = config.accessTokenFile.map(new TokenHolder(_))
            val clientConfig = LedgerClientConfiguration(
              applicationId = ApplicationId.unwrap(applicationId),
-              ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+              ledgerIdRequirement = LedgerIdRequirement.none,
              commandClient = CommandClientConfiguration.default,
              sslContext = config.tlsConfig.flatMap(_.client),
              token = tokenHolder.flatMap(_.token),
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/TestMain.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/TestMain.scala
@ -52,7 +52,7 @@ object TestMain extends StrictLogging {
        val applicationId = ApplicationId("Script Test")
        val clientConfig = LedgerClientConfiguration(
          applicationId = ApplicationId.unwrap(applicationId),
-          ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+          ledgerIdRequirement = LedgerIdRequirement.none,
          commandClient = CommandClientConfiguration.default,
          sslContext = None
        )
--- a/daml-script/test/src/com/digitalasset/daml/lf/engine/script/test/TestRunner.scala
+++ b/daml-script/test/src/com/digitalasset/daml/lf/engine/script/test/TestRunner.scala
@ -76,7 +76,7 @@ class TestRunner(

  val clientConfig = LedgerClientConfiguration(
    applicationId = applicationId.unwrap,
-    ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+    ledgerIdRequirement = LedgerIdRequirement.none,
    commandClient = CommandClientConfiguration.default,
    sslContext = rootCa.flatMap(file =>
      TlsConfiguration.Empty.copy(trustCertCollectionFile = Some(file)).client),
--- a/extractor/src/main/scala/com/digitalasset/extractor/Extractor.scala
+++ b/extractor/src/main/scala/com/digitalasset/extractor/Extractor.scala
@ -256,7 +256,7 @@ class Extractor[T](config: ExtractorConfig, target: T)(
        .maxInboundMessageSize(config.ledgerInboundMessageSizeMax),
      LedgerClientConfiguration(
        config.appId,
-        LedgerIdRequirement(ledgerId = "", enabled = false),
+        LedgerIdRequirement.none,
        CommandClientConfiguration(1, 1, java.time.Duration.ofSeconds(20L)),
        sslContext = config.tlsConfig.client,
        tokenHolder.flatMap(_.token)
--- a/language-support/scala/bindings-akka/src/main/scala/com/digitalasset/ledger/client/binding/config/LedgerClientConfig.scala
+++ b/language-support/scala/bindings-akka/src/main/scala/com/digitalasset/ledger/client/binding/config/LedgerClientConfig.scala
@ -34,8 +34,7 @@ case class LedgerClientConfig(
      ssl.map(_.sslContext)
    )

-  private val ledgerIdRequirement = ledgerId.fold(LedgerIdRequirement("", enabled = false))(lid =>
-    LedgerIdRequirement(lid, enabled = true))
+  private val ledgerIdRequirement = LedgerIdRequirement(ledgerId)
 }

 object LedgerClientConfig {
--- a/language-support/scala/codegen-sample-app/src/test/scala/com/digitalasset/codegen/ScalaCodeGenIT.scala
+++ b/language-support/scala/codegen-sample-app/src/test/scala/com/digitalasset/codegen/ScalaCodeGenIT.scala
@ -86,7 +86,7 @@ class ScalaCodeGenIT

  private val clientConfig = LedgerClientConfiguration(
    applicationId = applicationId,
-    ledgerIdRequirement = LedgerIdRequirement(ledgerId, enabled = true),
+    ledgerIdRequirement = LedgerIdRequirement.matching(ledgerId),
    commandClient = CommandClientConfiguration.default,
    sslContext = None
  )
--- a/language-support/scala/examples/iou-no-codegen/application/src/main/scala/com/digitalasset/quickstart/iou/IouMain.scala
+++ b/language-support/scala/examples/iou-no-codegen/application/src/main/scala/com/digitalasset/quickstart/iou/IouMain.scala
@ -57,7 +57,7 @@ object IouMain extends App with StrictLogging {

  private val clientConfig = LedgerClientConfiguration(
    applicationId = ApplicationId.unwrap(applicationId),
-    ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+    ledgerIdRequirement = LedgerIdRequirement.none,
    commandClient = CommandClientConfiguration.default,
    sslContext = None
  )
--- a/language-support/scala/examples/quickstart-scala/application/src/main/scala/com/digitalasset/quickstart/iou/IouMain.scala
+++ b/language-support/scala/examples/quickstart-scala/application/src/main/scala/com/digitalasset/quickstart/iou/IouMain.scala
@ -63,7 +63,7 @@ object IouMain extends App with StrictLogging {
  // <doc-ref:ledger-client-configuration>
  private val clientConfig = LedgerClientConfiguration(
    applicationId = ApplicationId.unwrap(applicationId),
-    ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+    ledgerIdRequirement = LedgerIdRequirement.none,
    commandClient = CommandClientConfiguration.default,
    sslContext = None,
    token = None
--- a/ledger-service/http-json/src/it/scala/http/HttpServiceTestFixture.scala
+++ b/ledger-service/http-json/src/it/scala/http/HttpServiceTestFixture.scala
@ -183,7 +183,7 @@ object HttpServiceTestFixture {
      useTls: UseTls = UseTls.NoTls): LedgerClientConfiguration =
    LedgerClientConfiguration(
      applicationId = ApplicationId.unwrap(applicationId),
-      ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+      ledgerIdRequirement = LedgerIdRequirement.none,
      commandClient = CommandClientConfiguration.default,
      sslContext = if (useTls) clientTlsConfig.client else None,
      token = token
--- a/ledger-service/http-json/src/main/scala/com/digitalasset/http/HttpService.scala
+++ b/ledger-service/http-json/src/main/scala/com/digitalasset/http/HttpService.scala
@ -100,7 +100,7 @@ object HttpService extends StrictLogging {

    val clientConfig = LedgerClientConfiguration(
      applicationId = ApplicationId.unwrap(applicationId),
-      ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+      ledgerIdRequirement = LedgerIdRequirement.none,
      commandClient = CommandClientConfiguration.default,
      sslContext = tlsConfig.client,
      token = tokenHolder.flatMap(_.token),
--- a/ledger/ledger-api-client/src/it/scala/com/digitalasset/ledger/client/LedgerClientIT.scala
+++ b/ledger/ledger-api-client/src/it/scala/com/digitalasset/ledger/client/LedgerClientIT.scala
@ -24,7 +24,7 @@ final class LedgerClientIT
    "shut down the channel when closed" in {
      val clientConfig = LedgerClientConfiguration(
        applicationId = classOf[LedgerClientIT].getSimpleName,
-        ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+        ledgerIdRequirement = LedgerIdRequirement.none,
        commandClient = CommandClientConfiguration.default,
        sslContext = None,
        token = None,
--- a/ledger/ledger-api-client/src/main/scala/com/digitalasset/ledger/client/configuration/LedgerIdRequirement.scala
+++ b/ledger/ledger-api-client/src/main/scala/com/digitalasset/ledger/client/configuration/LedgerIdRequirement.scala
@ -4,11 +4,20 @@
 package com.daml.ledger.client.configuration

 /**
-  * @param ledgerId The ID of the target ledger.
-  * @param enabled If true, the client will only communicate with ledgers that have the expected LedgerId.
-  *                Note that this setting only affects the binding process, when the ledger ID on the server is checked.
+  * @param ledgerId The ID of the target ledger. If defined, the client will only communicate with ledgers that have the
+  *                 expected LedgerId. Note that this setting only affects the binding process, when the ledger ID
+  *                 on the server is checked.
  */
-final case class LedgerIdRequirement(ledgerId: String, enabled: Boolean) {
-
-  def isAccepted(checkedLedgerId: String): Boolean = !enabled || checkedLedgerId == ledgerId
+final case class LedgerIdRequirement(ledgerId: Option[String]) {
+  def isAccepted(checkedLedgerId: String): Boolean = ledgerId.fold(true)(checkedLedgerId.equals)
+}
+
+object LedgerIdRequirement {
+
+  val none: LedgerIdRequirement = LedgerIdRequirement(None)
+  def matching(ledgerId: String): LedgerIdRequirement = LedgerIdRequirement(Some(ledgerId))
+
+  @deprecated("Use option based constructor", "1.3.0")
+  def apply(ledgerId: String, enabled: Boolean): LedgerIdRequirement =
+    LedgerIdRequirement(if (enabled) Some(ledgerId) else None)
 }
--- a/ledger/ledger-api-client/src/test/suite/scala/com/digitalasset/ledger/client/configuration/LedgerIdRequirementTest.scala
+++ b/ledger/ledger-api-client/src/test/suite/scala/com/digitalasset/ledger/client/configuration/LedgerIdRequirementTest.scala
@ -0,0 +1,26 @@
+// Copyright (c) 2020 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package com.daml.ledger.client.configuration
+
+import org.scalatest.{Matchers, WordSpec}
+
+class LedgerIdRequirementTest extends WordSpec with Matchers {
+
+  "LedgerIdRequirement" should {
+
+    "allow accept matching ledger" in {
+      val expected = "ledger-a"
+      LedgerIdRequirement.matching(expected).isAccepted(expected) shouldBe true
+    }
+
+    "allow not accept non-matching ledger" in {
+      LedgerIdRequirement.matching("ledger-b").isAccepted("not-b") shouldBe false
+    }
+
+    "empty constructor should allow any ledger" in {
+      LedgerIdRequirement.none.isAccepted("any-ledger") shouldBe true
+    }
+
+  }
+}
--- a/ledger/sandbox/src/test/suite/scala/com/digitalasset/platform/sandbox/TlsIT.scala
+++ b/ledger/sandbox/src/test/suite/scala/com/digitalasset/platform/sandbox/TlsIT.scala
@ -37,7 +37,7 @@ class TlsIT extends AsyncWordSpec with SandboxFixture with SuiteResourceManageme

  private lazy val tlsEnabledConfig = LedgerClientConfiguration(
    "appId",
-    LedgerIdRequirement("", enabled = false),
+    LedgerIdRequirement.none,
    CommandClientConfiguration.default,
    TlsConfiguration(
      enabled = true,
--- a/navigator/backend/src/main/scala/com/digitalasset/navigator/store/platform/PlatformStore.scala
+++ b/navigator/backend/src/main/scala/com/digitalasset/navigator/store/platform/PlatformStore.scala
@ -281,7 +281,7 @@ class PlatformStore(

    val configuration = LedgerClientConfiguration(
      applicationId,
-      LedgerIdRequirement("_", enabled = false),
+      LedgerIdRequirement.none,
      CommandClientConfiguration(
        maxCommandsInFlight,
        maxParallelSubmissions,
--- a/triggers/runner/src/main/scala/com/digitalasset/daml/lf/engine/trigger/RunnerMain.scala
+++ b/triggers/runner/src/main/scala/com/digitalasset/daml/lf/engine/trigger/RunnerMain.scala
@ -79,7 +79,7 @@ object RunnerMain {
        val applicationId = ApplicationId("Trigger Runner")
        val clientConfig = LedgerClientConfiguration(
          applicationId = ApplicationId.unwrap(applicationId),
-          ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+          ledgerIdRequirement = LedgerIdRequirement.none,
          commandClient =
            CommandClientConfiguration.default.copy(defaultDeduplicationTime = config.commandTtl),
          sslContext = config.tlsConfig.flatMap(_.client),
--- a/triggers/service/src/main/scala/com/digitalasset/daml/lf/engine/trigger/TriggerRunnerImpl.scala
+++ b/triggers/service/src/main/scala/com/digitalasset/daml/lf/engine/trigger/TriggerRunnerImpl.scala
@ -71,7 +71,7 @@ object TriggerRunnerImpl {
      val appId = ApplicationId(name)
      val clientConfig = LedgerClientConfiguration(
        applicationId = appId.unwrap,
-        ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+        ledgerIdRequirement = LedgerIdRequirement.none,
        commandClient = CommandClientConfiguration.default.copy(
          defaultDeduplicationTime = config.ledgerConfig.commandTtl),
        sslContext = None,
--- a/triggers/service/src/test/scala/com/digitalasset/daml/lf/engine/trigger/TriggerServiceFixture.scala
+++ b/triggers/service/src/test/scala/com/digitalasset/daml/lf/engine/trigger/TriggerServiceFixture.scala
@ -171,7 +171,7 @@ object TriggerServiceFixture {
      token: Option[String] = None): LedgerClientConfiguration =
    LedgerClientConfiguration(
      applicationId = ApplicationId.unwrap(applicationId),
-      ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+      ledgerIdRequirement = LedgerIdRequirement.none,
      commandClient = CommandClientConfiguration.default,
      sslContext = None,
      token = token
--- a/triggers/tests/src/test/scala/com/digitalasset/daml/lf/engine/trigger/test/AbstractTriggerTest.scala
+++ b/triggers/tests/src/test/scala/com/digitalasset/daml/lf/engine/trigger/test/AbstractTriggerTest.scala
@ -41,7 +41,7 @@ trait AbstractTriggerTest extends SandboxFixture with TestCommands {
  protected def ledgerClientConfiguration =
    LedgerClientConfiguration(
      applicationId = MockMessages.applicationId,
-      ledgerIdRequirement = LedgerIdRequirement("", enabled = false),
+      ledgerIdRequirement = LedgerIdRequirement.none,
      commandClient = CommandClientConfiguration.default,
      sslContext = None,
      token = None