[Communication] - Identity - Redesign Fixes and Address Comments (Azure#18885)

* Address previous code review comments

* Fix ubild

* Update exception message

* Address review comments

* Update README

Co-authored-by: Minnie Liu <peiliu@microsoft.com>

Author: minnieliu

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatAsyncClientTest.java

@@ -58,7 +58,7 @@ private void setupTest(HttpClient httpClient, String testName) {
         firstThreadMember = communicationClient.createUser();
         secondThreadMember = communicationClient.createUser();
 
-        List<CommunicationTokenScope> scopes = new ArrayList<CommunicationTokenScope>(Arrays.asList(CommunicationTokenScope.fromString("chat")));
+        List<CommunicationTokenScope> scopes = Arrays.asList(CommunicationTokenScope.CHAT);
         AccessToken response = communicationClient.issueToken(firstThreadMember, scopes);
 
         ChatClientBuilder chatBuilder = getChatClientBuilder(response.getToken(), httpClient);

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatClientTest.java

@@ -53,7 +53,7 @@ private void setupTest(HttpClient httpClient, String testName) {
         firstThreadMember = communicationClient.createUser();
         secondThreadMember = communicationClient.createUser();
 
-        List<CommunicationTokenScope> scopes = new ArrayList<CommunicationTokenScope>(Arrays.asList(CommunicationTokenScope.fromString("chat")));
+        List<CommunicationTokenScope> scopes = Arrays.asList(CommunicationTokenScope.CHAT);
         AccessToken response = communicationClient.issueToken(firstThreadMember, scopes);
 
         ChatClientBuilder chatBuilder = getChatClientBuilder(response.getToken(), httpClient);

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatThreadAsyncClientTest.java

@@ -71,7 +71,7 @@ private void setupTest(HttpClient httpClient, String testName) {
         firstThreadMember = communicationClient.createUser();
         secondThreadMember = communicationClient.createUser();
 
-        List<CommunicationTokenScope> scopes = new ArrayList<CommunicationTokenScope>(Arrays.asList(CommunicationTokenScope.fromString("chat")));
+        List<CommunicationTokenScope> scopes = Arrays.asList(CommunicationTokenScope.CHAT);
         AccessToken response = communicationClient.issueToken(firstThreadMember, scopes);
 
         ChatClientBuilder chatBuilder = getChatClientBuilder(response.getToken(), httpClient);

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatThreadClientTest.java

@@ -68,7 +68,7 @@ private void setupTest(HttpClient httpClient, String testName) {
         firstAddedThreadMember = communicationClient.createUser();
         secondAddedThreadMember = communicationClient.createUser();
 
-        List<CommunicationTokenScope> scopes = new ArrayList<CommunicationTokenScope>(Arrays.asList(CommunicationTokenScope.fromString("chat")));
+        List<CommunicationTokenScope> scopes = Arrays.asList(CommunicationTokenScope.CHAT);
         AccessToken response = communicationClient.issueToken(firstThreadMember, scopes);
 
         ChatClientBuilder chatBuilder = getChatClientBuilder(response.getToken(), httpClient);

sdk/communication/azure-communication-identity/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 1.0.0-beta.4 (Unreleased)
 ### Added
-- Added CommunicationIdentityClient and CommunicationIdentityClientAsync (originally was part of the azure-communication-aministration package).
+- Added CommunicationIdentityClient and CommunicationIdentityAsyncClient (originally was part of the azure-communication-aministration package).
 - Added support for Azure Active Directory Authentication.
 - Added ability to create a user and issue token for it at the same time.
 

sdk/communication/azure-communication-identity/README.md

@@ -10,10 +10,10 @@ The identity package is used for managing users and tokens for Azure Communicati
 
 ### Prerequisites
 
-- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
+- An Azure subscription. [Create an account for free](https://azure.microsoft.com/free/?WT.mc_id=A261C142F).
 - [Java Development Kit (JDK)](https://docs.microsoft.com/java/azure/jdk/?view=azure-java-stable) version 8 or above.
 - [Apache Maven](https://maven.apache.org/download.cgi).
-- A deployed Communication Services resource. You can use the [Azure Portal](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
+- A Communication Services resource. You can use the [Azure Portal](https://docs.microsoft.com/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp) or the [Azure PowerShell](https://docs.microsoft.com/powershell/module/az.communication/new-azcommunicationservice) to set it up.
 
 ### Include the package
 
@@ -26,7 +26,7 @@ The identity package is used for managing users and tokens for Azure Communicati
 </dependency>
 ```
 
-## Key concepts
+## Authenticate the client
 
 There are two forms of authentication to use the Identity SDK:
 
@@ -82,6 +82,9 @@ CommunicationIdentityClient communicationIdentityClient = new CommunicationIdent
     .buildClient();
 ```
 
+## Key concepts
+`CommunicationIdentityClient` and `CommunicationIdentityAsyncClient` provide the functionalities to manage users and user tokens.
+
 ## Examples
 
 ### Creating a new user
@@ -113,7 +116,7 @@ also takes in a list of `CommunicationIdentityTokenScope`. Scope options include
 - `chat` (Chat)
 - `voip` (Voice over IP)
 
-<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L120-L125 -->
+<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L119-L124 -->
 ```java
 List<CommunicationTokenScope> scopes = 
     new ArrayList<>(Arrays.asList(CommunicationTokenScope.CHAT));
@@ -126,7 +129,7 @@ System.out.println("Expires at: " + userToken.getExpiresAt());
 ### Revoking all tokens for an existing user
 Use the `revokeTokens` function to revoke all the issued tokens of a user.
 
-<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L139-L140 -->
+<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L137-L138 -->
 ```java
 // revoke tokens issued for the specified user
 communicationIdentityClient.revokeTokens(user);
@@ -135,37 +138,44 @@ communicationIdentityClient.revokeTokens(user);
 ### Deleting a user
 Use the `deleteUser` function to delete a user.
 
-<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L149-L150 -->
+<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L147-L148 -->
 ```java
 // delete a previously created user
 communicationIdentityClient.deleteUser(user);
 ```
 
-## Contributing
-
-This project welcomes contributions and suggestions. Most contributions require you to agree to a [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
+## Troubleshooting
 
-When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
+All user token service operations will throw an exception on failure.
+<!-- embedme ./src/samples/java/com/azure/communication/identity/ReadmeSamples.java#L156-L160 -->
+```java
+try {
+    CommunicationUserIdentifier user = communicationIdentityClient.createUser();
+} catch (RuntimeException ex) {
+    System.out.println(ex.getMessage());
+}
+```
 
-This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
+## Next steps
 
+Check out other client libraries for Azure communication service
 
-## Troubleshooting
+## Contributing
 
-In progress.
+This project welcomes contributions and suggestions. Most contributions require you to agree to a [Contributor License Agreement (CLA)][cla] declaring that you have the right to, and actually do, grant us the rights to use your contribution.
 
-## Next steps
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
 
-Check out other client libraries for Azure communication service
+This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments.
 
 <!-- LINKS -->
 [cla]: https://cla.microsoft.com
 [coc]: https://opensource.microsoft.com/codeofconduct/
 [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
 [coc_contact]: mailto:opencode@microsoft.com
 [product_docs]: https://docs.microsoft.com/azure/communication-services/
-[package]: https://search.maven.org/artifact/com.azure/azure-communication-administration
+[package]: https://search.maven.org/artifact/com.azure/azure-communication-identity
 [api_documentation]: https://aka.ms/java-docs
-[source]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/communication/azure-communication-administration/src
+[source]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/communication/azure-communication-identity/src
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fcommunication%2Fazure-communication-administration%2FREADME.png)
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fcommunication%2Fazure-communication-identity%2FREADME.png)

sdk/communication/azure-communication-identity/pom.xml

@@ -18,7 +18,7 @@
   <packaging>jar</packaging>
   <version>1.0.0-beta.4</version> <!-- {x-version-update;com.azure:azure-communication-identity;current} -->
 
-  <name>Microsoft Azure client identity library for communication</name>
+  <name>Microsoft Azure identity client library for communication</name>
   <description>
     This package contains APIs for application identity in Microsoft Azure Communication Services. 
     For this release, see notes - https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-identity/README.md and https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-identity/CHANGELOG.md. 

sdk/communication/azure-communication-identity/src/main/java/com/azure/communication/identity/CommunicationIdentityAsyncClient.java

@@ -22,6 +22,8 @@
 
 import java.util.List;
 import java.util.Objects;
+import java.util.stream.Collectors;
+import java.util.stream.StreamSupport;
 
 import reactor.core.publisher.Mono;
 
@@ -52,10 +54,7 @@ public Mono<CommunicationUserIdentifier> createUser() {
             return client.createAsync(new CommunicationIdentityCreateRequest())
                 .flatMap(
                     (CommunicationIdentityAccessTokenResult result) -> {
-                        if (result.getIdentity() != null) {
-                            return Mono.just(new CommunicationUserIdentifier(result.getIdentity().getId()));
-                        }
-                        return Mono.empty();
+                        return Mono.just(new CommunicationUserIdentifier(result.getIdentity().getId()));
                     });
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
@@ -73,14 +72,11 @@ public Mono<Response<CommunicationUserIdentifier>> createUserWithResponse() {
             return client.createWithResponseAsync(new CommunicationIdentityCreateRequest())
                 .flatMap(
                     (Response<CommunicationIdentityAccessTokenResult> response) -> {
-                        if (response != null && response.getValue() != null && response.getValue().getIdentity() != null) {
-                            String id = response.getValue().getIdentity().getId();
-                            return Mono.just(
-                                new SimpleResponse<CommunicationUserIdentifier>(
-                                    response,
-                                    new CommunicationUserIdentifier(id)));
-                        }
-                        return Mono.empty();
+                        String id = response.getValue().getIdentity().getId();
+                        return Mono.just(
+                            new SimpleResponse<CommunicationUserIdentifier>(
+                                response,
+                                new CommunicationUserIdentifier(id)));
                     });
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
@@ -95,21 +91,14 @@ public Mono<Response<CommunicationUserIdentifier>> createUserWithResponse() {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<CommunicationUserIdentifierWithTokenResult> 
-        createUserWithToken(List<CommunicationTokenScope> scopes) {
+        createUserWithToken(Iterable<CommunicationTokenScope> scopes) {
         try {
             Objects.requireNonNull(scopes);
-            return client.createAsync(new CommunicationIdentityCreateRequest().setCreateTokenWithScopes(scopes))
+            final List<CommunicationTokenScope> scopesInput = StreamSupport.stream(scopes.spliterator(), false).collect(Collectors.toList());
+            return client.createAsync(new CommunicationIdentityCreateRequest().setCreateTokenWithScopes(scopesInput))
                 .flatMap(
                     (CommunicationIdentityAccessTokenResult result) -> {
-                        if (result != null && result.getIdentity() != null && result.getAccessToken() != null) {
-                            CommunicationUserIdentifier user = 
-                                new CommunicationUserIdentifier(result.getIdentity().getId());
-                            AccessToken token = 
-                                new AccessToken(result.getAccessToken().getToken(), result.getAccessToken().getExpiresOn());
-                            return Mono.just(
-                                new CommunicationUserIdentifierWithTokenResult(user, token));
-                        }
-                        return Mono.empty();
+                        return Mono.just(userWithAccessTokenResultConverter(result));
                     });
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
@@ -124,23 +113,16 @@ public Mono<Response<CommunicationUserIdentifier>> createUserWithResponse() {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<CommunicationUserIdentifierWithTokenResult>> 
-        createUserWithTokenWithResponse(List<CommunicationTokenScope> scopes) {
+        createUserWithTokenWithResponse(Iterable<CommunicationTokenScope> scopes) {
         try {
             Objects.requireNonNull(scopes);
+            final List<CommunicationTokenScope> scopesInput = StreamSupport.stream(scopes.spliterator(), false).collect(Collectors.toList());
             return client.createWithResponseAsync(
-                new CommunicationIdentityCreateRequest().setCreateTokenWithScopes(scopes))
+                new CommunicationIdentityCreateRequest().setCreateTokenWithScopes(scopesInput))
                 .flatMap(
                     (Response<CommunicationIdentityAccessTokenResult> response) -> {
-                        if (response != null && response.getValue() != null
-                            && response.getValue().getIdentity() != null && response.getValue().getAccessToken() != null) {
-                            String id = response.getValue().getIdentity().getId();
-                            CommunicationUserIdentifier user = new CommunicationUserIdentifier(id);
-                            CommunicationIdentityAccessToken rawToken = response.getValue().getAccessToken();
-                            AccessToken token = new AccessToken(rawToken.getToken(), rawToken.getExpiresOn());
-                            return Mono.just(new SimpleResponse<CommunicationUserIdentifierWithTokenResult>(response, 
-                                new CommunicationUserIdentifierWithTokenResult(user, token)));
-                        }
-                        return Mono.empty();
+                        return Mono.just(new SimpleResponse<CommunicationUserIdentifierWithTokenResult>(response, 
+                            userWithAccessTokenResultConverter(response.getValue())));
                     });
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
@@ -222,12 +204,13 @@ public Mono<Response<Void>> revokeTokensWithResponse(CommunicationUserIdentifier
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<AccessToken> issueToken(CommunicationUserIdentifier communicationUser,
-        List<CommunicationTokenScope> scopes) {
+        Iterable<CommunicationTokenScope> scopes) {
         try {
             Objects.requireNonNull(communicationUser);
             Objects.requireNonNull(scopes);
+            final List<CommunicationTokenScope> scopesInput = StreamSupport.stream(scopes.spliterator(), false).collect(Collectors.toList());
             return client.issueAccessTokenAsync(communicationUser.getId(),
-                new CommunicationIdentityAccessTokenRequest().setScopes(scopes))
+                new CommunicationIdentityAccessTokenRequest().setScopes(scopesInput))
                 .flatMap((CommunicationIdentityAccessToken rawToken) -> {
                     return Mono.just(new AccessToken(rawToken.getToken(), rawToken.getExpiresOn()));
                 });
@@ -245,21 +228,35 @@ public Mono<AccessToken> issueToken(CommunicationUserIdentifier communicationUse
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<AccessToken>> issueTokenWithResponse(CommunicationUserIdentifier communicationUser,
-        List<CommunicationTokenScope> scopes) {
+        Iterable<CommunicationTokenScope> scopes) {
         try {
             Objects.requireNonNull(communicationUser);
             Objects.requireNonNull(scopes);
+            final List<CommunicationTokenScope> scopesInput = StreamSupport.stream(scopes.spliterator(), false).collect(Collectors.toList());
             return client.issueAccessTokenWithResponseAsync(communicationUser.getId(),
-                new CommunicationIdentityAccessTokenRequest().setScopes(scopes))
+                new CommunicationIdentityAccessTokenRequest().setScopes(scopesInput))
                 .flatMap((Response<CommunicationIdentityAccessToken> response) -> {
-                    if (response != null && response.getValue() != null) {
-                        AccessToken token = new AccessToken(response.getValue().getToken(), response.getValue().getExpiresOn());
-                        return Mono.just(new SimpleResponse<AccessToken>(response, token));
-                    }
-                    return Mono.empty();
+                    AccessToken token = new AccessToken(response.getValue().getToken(), response.getValue().getExpiresOn());
+                    return Mono.just(new SimpleResponse<AccessToken>(response, token));
                 });
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
         }
     }
+
+    /**
+     * Converts CommunicationIdentityAccessTokenResult to CommunicationUserIdentifierWithTokenResult
+     *
+     * @param identityAccessTokenResult The result input.
+     * @return the result converted to CommunicationUserIdentifierWithTokenResult type
+     */
+    private CommunicationUserIdentifierWithTokenResult userWithAccessTokenResultConverter(
+        CommunicationIdentityAccessTokenResult identityAccessTokenResult) {
+        CommunicationUserIdentifier user = 
+            new CommunicationUserIdentifier(identityAccessTokenResult.getIdentity().getId());
+        AccessToken token = new AccessToken(
+            identityAccessTokenResult.getAccessToken().getToken(),
+            identityAccessTokenResult.getAccessToken().getExpiresOn());
+        return new CommunicationUserIdentifierWithTokenResult(user, token);
+    }
 }