Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove user-management error cases from scenario-service proto. #12460

Merged
merged 5 commits into from
Jan 19, 2022
+70 −129
Merged

Remove user-management error cases from scenario-service proto. #12460

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
58c5af8
Remove user-management error cases from scenario-service proto.
nickchapman-da Jan 18, 2022
aac12a1
remove Error.UserManagement
nickchapman-da Jan 18, 2022
e9a0d16
remove UserManagememtError
nickchapman-da Jan 18, 2022
195c32b
simp
nickchapman-da Jan 18, 2022
35ef23c
meh... done over by scala's poor excuse for a type system
nickchapman-da Jan 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove UserManagememtError
  • Loading branch information
@nickchapman-da
nickchapman-da committed Jan 18, 2022
commit e9a0d166cc0132ec34e9e472bdc013aeb9caf15b
9 changes: 1 addition & 8 deletions daml-lf/scenario-interpreter/src/main/scala/com/digitalasset/daml/lf/Error.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package com.daml.lf
package scenario

import com.daml.lf.data.Ref.{Identifier, Party, UserId}
import com.daml.lf.data.Ref.{Identifier, Party}
import com.daml.lf.data.Time
import com.daml.lf.ledger.EventId
import com.daml.lf.speedy.SError.SError
Expand Down Expand Up @@ -74,11 +74,4 @@ object Error {

/** Tried to allocate a party that already exists. */
final case class PartyAlreadyExists(name: String) extends Error

sealed abstract class UserManagementError extends Product with Serializable

object UserManagementError {
final case class UserNotFound(userId: UserId) extends UserManagementError
final case class UserExists(userId: UserId) extends UserManagementError
}
}
1 change: 0 additions & 1 deletion daml-script/runner/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,6 @@ da_scala_test(
deps = [
":script-runner-lib",
"//daml-lf/data",
"//daml-lf/scenario-interpreter",
"//language-support/scala/bindings",
"//language-support/scala/bindings-akka",
],
Expand Down
32 changes: 10 additions & 22 deletions ...main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/IdeLedgerClient.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,6 @@ class IdeLedgerClient(

private val userManagementStore = new ide.UserManagementStore()

private def handleUserManagement[T](r: ide.UserManagementStore.Result[T]): Future[T] =
r.fold(err => sys.error(s"handleUserManagement, unexpected: $err"), Future.successful(_))

override def query(parties: OneAnd[Set, Ref.Party], templateId: Identifier)(implicit
ec: ExecutionContext,
mat: Materializer,
Expand Down Expand Up @@ -323,37 +320,28 @@ class IdeLedgerClient(
esf: ExecutionSequencerFactory,
mat: Materializer,
): Future[Option[Unit]] =
userManagementStore.createUser(user, rights.toSet) match {
case Left(scenario.Error.UserManagementError.UserExists(_)) => Future.successful(None)
case a => handleUserManagement(a).map(Some(_))
}
Future.successful(userManagementStore.createUser(user, rights.toSet))

override def getUser(id: UserId)(implicit
ec: ExecutionContext,
esf: ExecutionSequencerFactory,
mat: Materializer,
): Future[Option[User]] =
userManagementStore.getUser(id) match {
case Left(scenario.Error.UserManagementError.UserNotFound(_)) => Future.successful(None)
case a => handleUserManagement(a).map(Some(_))
}
Future.successful(userManagementStore.getUser(id))

override def deleteUser(id: UserId)(implicit
ec: ExecutionContext,
esf: ExecutionSequencerFactory,
mat: Materializer,
): Future[Option[Unit]] =
userManagementStore.deleteUser(id) match {
case Left(scenario.Error.UserManagementError.UserNotFound(_)) => Future.successful(None)
case a => handleUserManagement(a).map(Some(_))
}
Future.successful(userManagementStore.deleteUser(id))

override def listUsers()(implicit
ec: ExecutionContext,
esf: ExecutionSequencerFactory,
mat: Materializer,
): Future[List[User]] =
handleUserManagement(userManagementStore.listUsers())
Future.successful(userManagementStore.listUsers())

override def grantUserRights(
id: UserId,
Expand All @@ -364,8 +352,8 @@ class IdeLedgerClient(
mat: Materializer,
): Future[Option[List[UserRight]]] =
userManagementStore.grantRights(id, rights.toSet) match {
case Left(scenario.Error.UserManagementError.UserNotFound(_)) => Future.successful(None)
case a => handleUserManagement(a).map(_.toList).map(Some(_))
case None => Future.successful(None)
case Some(a) => Future.successful(a).map(_.toList).map(Some(_))
}

override def revokeUserRights(
Expand All @@ -377,8 +365,8 @@ class IdeLedgerClient(
mat: Materializer,
): Future[Option[List[UserRight]]] =
userManagementStore.revokeRights(id, rights.toSet) match {
case Left(scenario.Error.UserManagementError.UserNotFound(_)) => Future.successful(None)
case a => handleUserManagement(a).map(_.toList).map(Some(_))
case None => Future.successful(None)
case Some(a) => Future.successful(a).map(_.toList).map(Some(_))
}

override def listUserRights(id: UserId)(implicit
Expand All @@ -387,7 +375,7 @@ class IdeLedgerClient(
mat: Materializer,
): Future[Option[List[UserRight]]] =
userManagementStore.listUserRights(id) match {
case Left(scenario.Error.UserManagementError.UserNotFound(_)) => Future.successful(None)
case a => handleUserManagement(a).map(_.toList).map(Some(_))
case None => Future.successful(None)
case Some(a) => Future.successful(a).map(_.toList).map(Some(_))
}
}
43 changes: 20 additions & 23 deletions ...la/com/digitalasset/daml/lf/engine/script/ledgerinteraction/ide/UserManagementStore.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
package com.daml.lf.engine.script.ledgerinteraction.ide

import com.daml.lf.data.Ref.UserId
import com.daml.lf.scenario.Error.UserManagementError
import com.daml.ledger.api.domain.{User, UserRight}

import scala.collection.mutable
Expand All @@ -15,55 +14,54 @@ import scala.collection.mutable
// #11896. While it would be nice to not have to duplicate this for now this seems like the
// simpler option than trying to reuse participant code in the script service.
private[ledgerinteraction] class UserManagementStore {
import UserManagementError._
import UserManagementStore._

def createUser(user: User, rights: Set[UserRight]): Result[Unit] =
def createUser(user: User, rights: Set[UserRight]): Option[Unit] =
putIfAbsent(UserInfo(user, rights)) match {
case Some(_) => Left(UserExists(user.id))
case None => Right(())
case Some(_) => None
case None => Some(())
}

def getUser(id: UserId): Result[User] =
def getUser(id: UserId): Option[User] =
lookup(id) match {
case Some(userInfo) => Right(userInfo.user)
case None => Left(UserNotFound(id))
case Some(userInfo) => Some(userInfo.user)
case None => None
}

def deleteUser(id: UserId): Result[Unit] =
def deleteUser(id: UserId): Option[Unit] =
dropExisting(id) match {
case Some(_) => Right(())
case None => Left(UserNotFound(id))
case Some(_) => Some(())
case None => None
}

def grantRights(id: UserId, granted: Set[UserRight]): Result[Set[UserRight]] =
def grantRights(id: UserId, granted: Set[UserRight]): Option[Set[UserRight]] =
lookup(id) match {
case Some(userInfo) =>
val newlyGranted = granted.diff(userInfo.rights)
replaceInfo(userInfo, userInfo.copy(rights = userInfo.rights ++ newlyGranted))
Right(newlyGranted)
Some(newlyGranted)
case None =>
Left(UserNotFound(id))
None
}

def revokeRights(id: UserId, revoked: Set[UserRight]): Result[Set[UserRight]] =
def revokeRights(id: UserId, revoked: Set[UserRight]): Option[Set[UserRight]] =
lookup(id) match {
case Some(userInfo) =>
val effectivelyRevoked = revoked.intersect(userInfo.rights)
replaceInfo(userInfo, userInfo.copy(rights = userInfo.rights -- effectivelyRevoked))
Right(effectivelyRevoked)
Some(effectivelyRevoked)
case None =>
Left(UserNotFound(id))
None
}

def listUserRights(id: UserId): Result[Set[UserRight]] =
def listUserRights(id: UserId): Option[Set[UserRight]] =
lookup(id) match {
case Some(userInfo) => Right(userInfo.rights)
case None => Left(UserNotFound(id))
case Some(userInfo) => Some(userInfo.rights)
case None => None
}

def listUsers(): Result[List[User]] =
Right(state.values.map(_.user).toList)
def listUsers(): List[User] =
state.values.map(_.user).toList

private val state: mutable.Map[UserId, UserInfo] = mutable.Map()
private def lookup(id: UserId) = state.get(id)
Expand All @@ -89,5 +87,4 @@ object UserManagementStore {
case class UserInfo(user: User, rights: Set[UserRight]) {
def toStateEntry: (UserId, UserInfo) = user.id -> this
}
type Result[T] = Either[UserManagementError, T]
}
15 changes: 7 additions & 8 deletions ...er/src/test/com/daml/lf/engine/script/ledgerinteraction/ide/UserManagementStoreSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ package com.daml.lf.engine.script.ledgerinteraction.ide

import com.daml.ledger.api.domain.{User, UserRight}
import com.daml.lf.data.Ref.{Party, UserId}
import com.daml.lf.scenario.Error.UserManagementError._
import org.scalatest.matchers.should.Matchers
import org.scalatest.freespec.AnyFreeSpec
import scala.language.implicitConversions
Expand Down Expand Up @@ -34,7 +33,7 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {
val mgmt = new UserManagementStore()
val user = User("user1", None)
mgmt.createUser(user, Set.empty) shouldBe Right(())
mgmt.createUser(user, Set.empty) shouldBe Left(UserExists("user1"))
mgmt.createUser(user, Set.empty) shouldBe Left(())
}

"find a freshly created user" in {
Expand All @@ -46,15 +45,15 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {

"not find a non-existent user" in {
val mgmt = new UserManagementStore()
mgmt.getUser("user1") shouldBe Left(UserNotFound("user1"))
mgmt.getUser("user1") shouldBe Left(())
}
"not find a deleted user" in {
val mgmt = new UserManagementStore()
val user = User("user1", None)
mgmt.createUser(user, Set.empty) shouldBe Right(())
mgmt.getUser("user1") shouldBe Right(user)
mgmt.deleteUser("user1") shouldBe Right(())
mgmt.getUser("user1") shouldBe Left(UserNotFound("user1"))
mgmt.getUser("user1") shouldBe Left(())
}
"allow recreating a deleted user" in {
val mgmt = new UserManagementStore()
Expand All @@ -65,7 +64,7 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {
}
"fail to delete a non-existent user" in {
val mgmt = new UserManagementStore()
mgmt.deleteUser("user1") shouldBe Left(UserNotFound("user1"))
mgmt.deleteUser("user1") shouldBe Left(())
}
"list created users" in {
val mgmt = new UserManagementStore()
Expand Down Expand Up @@ -103,7 +102,7 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {
}
"listUserRights should fail on non-existent user" in {
val mgmt = new UserManagementStore()
mgmt.listUserRights("user1") shouldBe Left(UserNotFound("user1"))
mgmt.listUserRights("user1") shouldBe Left(())
}
"grantUserRights should add new rights" in {
val mgmt = new UserManagementStore()
Expand All @@ -119,7 +118,7 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {
}
"grantRights should fail on non-existent user" in {
val mgmt = new UserManagementStore()
mgmt.grantRights("user1", Set.empty) shouldBe Left(UserNotFound("user1"))
mgmt.grantRights("user1", Set.empty) shouldBe Left(())
}
"revokeRights should revoke rights" in {
val mgmt = new UserManagementStore()
Expand All @@ -140,7 +139,7 @@ final class InMemoryUserManagementStoreSpec extends AnyFreeSpec with Matchers {
}
"revokeRights should fail on non-existent user" in {
val mgmt = new UserManagementStore()
mgmt.revokeRights("user1", Set.empty) shouldBe Left(UserNotFound("user1"))
mgmt.revokeRights("user1", Set.empty) shouldBe Left(())
}
}
}