Rename: listUsers --> listAllUsers (within daml-script) (#12734)

* Rename: listUsers --> listAllUsers (within daml-script) changelog_begin changelog_end * fix/rename in newly add def: clearUsers * improve comment doc
2024-09-20 09:17:43 +03:00 · 2022-02-03 13:07:09 +00:00 · 2022-02-03 13:07:09 +00:00 · cd16eb740e
commit cd16eb740e
parent 810554bee5
8 changed files with 33 additions and 33 deletions
--- a/compiler/damlc/tests/src/DA/Test/ScriptService.hs
+++ b/compiler/damlc/tests/src/DA/Test/ScriptService.hs
@ -948,7 +948,7 @@ main =
                  , "  let user2 = User u2 None"
                  , "  userIdToText u1 === \"user1\""
                  , "  userIdToText u2 === \"user2\""
-                  , "  users <- listUsers"
+                  , "  users <- listAllUsers"
                  , "  users === []"
                  , "  createUser user1 []"
                  , "  True <- userExists u1"
@ -961,13 +961,13 @@ main =
                  , "  u === user1"
                  , "  u <- getUser u2"
                  , "  u === user2"
-                  , "  users <- listUsers"
+                  , "  users <- listAllUsers"
                  , "  sort users === [user1, user2]"
                  , "  deleteUser u1"
-                  , "  users <- listUsers"
+                  , "  users <- listAllUsers"
                  , "  users === [user2]"
                  , "  deleteUser u2"
-                  , "  users <- listUsers"
+                  , "  users <- listAllUsers"
                  , "  users === []"
                  , "  nonexistent <- validateUserId \"nonexistent\""
                  , "  expectUserNotFound (getUser nonexistent)"
--- a/daml-script/daml/Daml/Script.daml
+++ b/daml-script/daml/Daml/Script.daml
@ -66,8 +66,8 @@ module Daml.Script
  , getUserOn
  , deleteUser
  , deleteUserOn
-  , listUsers
-  , listUsersOn
+  , listAllUsers
+  , listAllUsersOn
  , grantUserRights
  , grantUserRightsOn
  , revokeUserRights
@ -137,7 +137,7 @@ data ScriptF a
  | CreateUser (CreateUserPayload a)
  | GetUser (GetUserPayload a)
  | DeleteUser (DeleteUserPayload a)
-  | ListUsers (ListUsersPayload a)
+  | ListAllUsers (ListAllUsersPayload a)
  | GrantUserRights (GrantUserRightsPayload a)
  | RevokeUserRights (RevokeUserRightsPayload a)
  | ListUserRights (ListUserRightsPayload a)
@ -866,16 +866,16 @@ getUser' userId participant = checkUserNotFound userId $ lift $ Free $ GetUser G
  locations = getCallStack callStack
  userId

-- | List all users.
-listUsers : Script [User]
-listUsers = listUsers' None
+-- | List all users. This function may make multiple calls to underlying paginated ledger API.
+listAllUsers : Script [User]
+listAllUsers = listAllUsers' None

-- | List all users on the given participant.
-listUsersOn : ParticipantName -> Script [User]
-listUsersOn participant = listUsers' (Some participant)
+-- | List all users on the given participant. This function may make multiple calls to underlying paginated ledger API.
+listAllUsersOn : ParticipantName -> Script [User]
+listAllUsersOn participant = listAllUsers' (Some participant)

-listUsers' : Optional ParticipantName -> Script [User]
-listUsers' participant = lift $ Free $ ListUsers ListUsersPayload with
+listAllUsers' : Optional ParticipantName -> Script [User]
+listAllUsers' participant = lift $ Free $ ListAllUsers ListAllUsersPayload with
  participant = fmap participantName participant
  continue = pure
  locations = getCallStack callStack
@ -989,7 +989,7 @@ data DeleteUserPayload a = DeleteUserPayload
    locations : [(Text, SrcLoc)]
  deriving Functor

-data ListUsersPayload a = ListUsersPayload
+data ListAllUsersPayload a = ListAllUsersPayload
  with
    participant : Optional Text
    continue : [User] -> a
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ScriptF.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ScriptF.scala
@ -495,12 +495,12 @@ object ScriptF {
      } yield SEApp(SEValue(continue), Array(SEValue(res)))
  }

-  final case class ListUsers(
+  final case class ListAllUsers(
      participant: Option[Participant],
      stackTrace: StackTrace,
      continue: SValue,
  ) extends Cmd {
-    override def description = "listUsers"
+    override def description = "listAllUsers"
    override def execute(env: Env)(implicit
        ec: ExecutionContext,
        mat: Materializer,
@ -508,7 +508,7 @@ object ScriptF {
    ): Future[SExpr] =
      for {
        client <- Converter.toFuture(env.clients.getParticipant(participant))
-        users <- client.listUsers()
+        users <- client.listAllUsers()
        users <- Converter.toFuture(
          users.to(FrontStack).traverse(Converter.fromUser(env.scriptIds, _))
        )
@ -873,14 +873,14 @@ object ScriptF {
      case _ => Left(s"Expected DeleteUser payload but got $v")
    }

-  private def parseListUsers(ctx: Ctx, v: SValue): Either[String, ListUsers] =
+  private def parseListAllUsers(ctx: Ctx, v: SValue): Either[String, ListAllUsers] =
    v match {
      case SRecord(_, _, JavaList(participant, continue, stackTrace)) =>
        for {
          participant <- Converter.toParticipantName(participant)
          stackTrace <- toStackTrace(ctx, Some(stackTrace))
-        } yield ListUsers(participant, stackTrace, continue)
-      case _ => Left(s"Expected ListUsers payload but got $v")
+        } yield ListAllUsers(participant, stackTrace, continue)
+      case _ => Left(s"Expected ListAllUsers payload but got $v")
    }

  private def parseGrantUserRights(ctx: Ctx, v: SValue): Either[String, GrantUserRights] =
@ -937,7 +937,7 @@ object ScriptF {
      case "CreateUser" => parseCreateUser(ctx, v)
      case "GetUser" => parseGetUser(ctx, v)
      case "DeleteUser" => parseDeleteUser(ctx, v)
-      case "ListUsers" => parseListUsers(ctx, v)
+      case "ListAllUsers" => parseListAllUsers(ctx, v)
      case "GrantUserRights" => parseGrantUserRights(ctx, v)
      case "RevokeUserRights" => parseRevokeUserRights(ctx, v)
      case "ListUserRights" => parseListUserRights(ctx, v)
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/GrpcLedgerClient.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/GrpcLedgerClient.scala
@ -372,7 +372,7 @@ class GrpcLedgerClient(val grpcClient: LedgerClient, val applicationId: Applicat
      case e: StatusRuntimeException if e.getStatus.getCode == Status.Code.NOT_FOUND => None
    }

-  override def listUsers()(implicit
+  override def listAllUsers()(implicit
      ec: ExecutionContext,
      esf: ExecutionSequencerFactory,
      mat: Materializer,
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/IdeLedgerClient.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/IdeLedgerClient.scala
@ -334,7 +334,7 @@ class IdeLedgerClient(
  ): Future[Option[Unit]] =
    Future.successful(userManagementStore.deleteUser(id))

-  override def listUsers()(implicit
+  override def listAllUsers()(implicit
      ec: ExecutionContext,
      esf: ExecutionSequencerFactory,
      mat: Materializer,
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/JsonLedgerClient.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/JsonLedgerClient.scala
@ -558,7 +558,7 @@ class JsonLedgerClient(
      ).map(_ => ())
    }

-  override def listUsers()(implicit
+  override def listAllUsers()(implicit
      ec: ExecutionContext,
      esf: ExecutionSequencerFactory,
      mat: Materializer,
--- a/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/ScriptLedgerClient.scala
+++ b/daml-script/runner/src/main/scala/com/digitalasset/daml/lf/engine/script/ledgerinteraction/ScriptLedgerClient.scala
@ -154,7 +154,7 @@ trait ScriptLedgerClient {
      mat: Materializer,
  ): Future[Option[Unit]]

-  def listUsers()(implicit
+  def listAllUsers()(implicit
      ec: ExecutionContext,
      esf: ExecutionSequencerFactory,
      mat: Materializer,
--- a/daml-script/test/daml/ScriptTest.daml
+++ b/daml-script/test/daml/ScriptTest.daml
@ -460,7 +460,7 @@ testUserManagementForParty p1 = do
  True <- isValidUserId "good"
  False <- isValidUserId "BAD"
  participantAdmin <- getParticipantAdmin ()
-  users <- listUsers
+  users <- listAllUsers
  users === [participantAdmin]
  u1 <- validateUserId "u1"
  u2 <- validateUserId "u2"
@ -468,7 +468,7 @@ testUserManagementForParty p1 = do
  let user2 = User u2 None
  userIdToText u1 === "u1"
  userIdToText u2 === "u2"
-  users <- listUsers
+  users <- listAllUsers
  users === [participantAdmin]
  False <- userExists u1
  createUser user1 []
@ -485,13 +485,13 @@ testUserManagementForParty p1 = do
  nonexistent <- validateUserId "nonexistent"
  expectUserNotFound (getUser nonexistent)
  expectUserNotFound (deleteUser nonexistent)
-  users <- listUsers
+  users <- listAllUsers
  sort users === [participantAdmin, user1, user2]
  deleteUser u1
-  users <- listUsers
+  users <- listAllUsers
  sort users === [participantAdmin, user2]
  deleteUser u2
-  users <- listUsers
+  users <- listAllUsers
  users === [participantAdmin]
  pure ()

@ -553,6 +553,6 @@ jsonUserRightManagement p1 = do
 clearUsers : Script ()
 clearUsers = do
  admin <- validateUserId "participant_admin"
-  users <- listUsers
+  users <- listAllUsers
  forA_ users $ \u ->
    when (u.userId /= admin) $ deleteUser u.userId