digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-19 16:57:40 +03:00
Code Issues Projects Releases Wiki Activity

ledger-api-client: More backwards-compatibility. (#6346)

Browse Source 
Let's not break others' code until they've had a chance to migrate.
This changes `LedgerIdRequirement` so that properties don't change
types, and adds `@deprecated` where necessary.

There is one behavior change: `ledgerId` used to return whatever string
was passed in (typically `""`) if the requirement was not enabled. It
now throws an exception.

In the future, we will change the type of `ledgerId` to be
`Option[String]`, and make `optionalLedgerId` an alias for that
property.

CHANGELOG_BEGIN
CHANGELOG_END
This commit is contained in:
Samir Talwar 2020-06-15 16:26:13 +02:00 committed by GitHub
parent 0b861fe376
commit 5399f3ff44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
ledger/ledger-api-client/src/main/scala/com/digitalasset/ledger/client/configuration/LedgerIdRequirement.scala
View File

@ -4,20 +4,26 @@
package com.daml.ledger.client.configuration
/**
* @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.
* @param optionalLedgerId 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: Option[String]) {
final case class LedgerIdRequirement(optionalLedgerId: Option[String]) {
@deprecated("This function will return `Option[String]` in a future release.", "1.3.0")
def ledgerId: String = optionalLedgerId.get
def enabled: Boolean = optionalLedgerId.isDefined
def isAccepted(checkedLedgerId: String): Boolean =
ledgerId.fold(true)(checkedLedgerId.equals)
optionalLedgerId.fold(true)(checkedLedgerId.equals)
def copy(ledgerId: Option[String]): LedgerIdRequirement =
LedgerIdRequirement(ledgerId = ledgerId)
LedgerIdRequirement(optionalLedgerId = ledgerId)
@deprecated("Use Option-based copy", "1.3.0")
def copy(ledgerId: String): LedgerIdRequirement =
LedgerIdRequirement(this.ledgerId.map(_ => ledgerId))
LedgerIdRequirement(this.optionalLedgerId.map(_ => ledgerId))
}
object LedgerIdRequirement {

2
ledger/ledger-api-client/src/main/scala/com/digitalasset/ledger/client/services/identity/LedgerIdentityClient.scala
View File

@ -25,7 +25,7 @@ final class LedgerIdentityClient(service: LedgerIdentityServiceStub) {
val requirement = ledgerIdRequirement
require(
requirement.isAccepted(ledgerId),
s"Required Ledger ID ${requirement.ledgerId} does not match received Ledger ID $ledgerId"
s"Required Ledger ID ${requirement.optionalLedgerId.get} does not match received Ledger ID $ledgerId"
)
LedgerId(ledgerId)
}