[Communication][Rooms] Introduce Collaborator role feature (Azure#44275)

allchiang-msft · web-flow · commit d786f8380820 · 2025-03-06T13:41:20.000-08:00
* update version and api spec generation

* increment version in version_client.txt

* update changelog

* push file from autorest generation

* manual changes to model and converters

* run mvn spotless to fix checkstyle

* remove autorest comment as the code is not generated

* update assets.json for test recording

* refresh with 2025-03-13 api spec

* add versino

* add collaborator tests

* remove print statement

* update assets.json

* update changelog

* push assets.json

* fix typo

* make changelog updates according to CI check

* update assets.json
diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
@@ -75,7 +75,7 @@ com.azure:azure-communication-identity;1.6.3;1.7.0-beta.1
 com.azure:azure-communication-jobrouter;1.1.11;2.0.0-beta.1
 com.azure:azure-communication-messages;1.1.2;1.2.0-beta.2
 com.azure:azure-communication-phonenumbers;1.2.1;1.3.0-beta.1
-com.azure:azure-communication-rooms;1.1.9;1.2.0-beta.1
+com.azure:azure-communication-rooms;1.1.8;1.2.0
 com.azure:azure-communication-sms;1.1.31;1.2.0-beta.1
 com.azure:azure-compute-batch;1.0.0-beta.3;1.0.0-beta.4
 com.azure:azure-containers-containerregistry;1.2.15;1.3.0-beta.1
diff --git a/sdk/communication/azure-communication-rooms/CHANGELOG.md b/sdk/communication/azure-communication-rooms/CHANGELOG.md
@@ -1,14 +1,16 @@
 # Release History
 
-## 1.2.0-beta.1 (Unreleased)
+## 1.2.0 (2025-03-13)
 
 ### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
+- General Availability version of Collaborator role.
 
 ### Other Changes
+#### Dependency Updates
+- Upgraded `azure-identity` from `1.14.2` to version `1.15.2`
+- Upgraded `azure-core` from `1.54.1` to version `1.55.1`.
+- Upgraded `azure-core-http-netty` from `1.15.7` to version `1.15.9`.
+- Upgraded `azure-core-test` from `1.27.0-beta.4` to version `1.27.0-beta.6`.
 
 ## 1.1.9 (2025-03-03)
 
diff --git a/sdk/communication/azure-communication-rooms/assets.json b/sdk/communication/azure-communication-rooms/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "java",
   "TagPrefix": "java/communication/azure-communication-rooms",
-  "Tag": "java/communication/azure-communication-rooms_5116842cd0"
+  "Tag": "java/communication/azure-communication-rooms_0569c759b4"
 }
diff --git a/sdk/communication/azure-communication-rooms/pom.xml b/sdk/communication/azure-communication-rooms/pom.xml
@@ -15,7 +15,7 @@
   <groupId>com.azure</groupId>
   <artifactId>azure-communication-rooms</artifactId>
   <packaging>jar</packaging>
-  <version>1.2.0-beta.1</version> <!-- {x-version-update;com.azure:azure-communication-rooms;current} -->
+  <version>1.2.0</version> <!-- {x-version-update;com.azure:azure-communication-rooms;current} -->
   <name>Microsoft Azure library for ACS Room Service</name>
   <description>
     This package contains clients and data structures used to create, update, get, delete the Azure Communication Room Service.
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/RoomsServiceVersion.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/RoomsServiceVersion.java
@@ -17,7 +17,12 @@ public enum RoomsServiceVersion implements ServiceVersion {
     /**
      * Service version {@code 2024-04-15}
      */
-    V2024_04_15("2024-04-15");
+    V2024_04_15("2024-04-15"),
+
+    /**
+     * Service version {@code 2025-03-13}
+     */
+    V2025_03_13("2025-03-13");
 
     private final String version;
 
@@ -39,6 +44,6 @@ public String getVersion() {
      * @return the latest {@link RoomsServiceVersion}
      */
     public static RoomsServiceVersion getLatest() {
-        return V2024_04_15;
+        return V2025_03_13;
     }
 }
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/AzureCommunicationRoomServiceImplBuilder.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/AzureCommunicationRoomServiceImplBuilder.java
@@ -270,7 +270,7 @@ public AzureCommunicationRoomServiceImplBuilder retryPolicy(RetryPolicy retryPol
     @Generated
     public AzureCommunicationRoomServiceImpl buildClient() {
         HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
-        String localApiVersion = (apiVersion != null) ? apiVersion : "2024-04-15";
+        String localApiVersion = (apiVersion != null) ? apiVersion : "2025-03-13";
         SerializerAdapter localSerializerAdapter
             = (serializerAdapter != null) ? serializerAdapter : JacksonAdapter.createDefaultSerializerAdapter();
         AzureCommunicationRoomServiceImpl client = new AzureCommunicationRoomServiceImpl(localPipeline,
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/converters/ParticipantRoleConverter.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/converters/ParticipantRoleConverter.java
@@ -34,6 +34,10 @@ public final class ParticipantRoleConverter {
                 role = ParticipantRole.PRESENTER;
                 break;
 
+            case "Collaborator":
+                role = ParticipantRole.COLLABORATOR;
+                break;
+
             default:
                 role = ParticipantRole.ATTENDEE;
                 break;
@@ -66,6 +70,10 @@ public final class ParticipantRoleConverter {
                 role = com.azure.communication.rooms.implementation.models.ParticipantRole.PRESENTER;
                 break;
 
+            case "Collaborator":
+                role = com.azure.communication.rooms.implementation.models.ParticipantRole.COLLABORATOR;
+                break;
+
             default:
                 role = com.azure.communication.rooms.implementation.models.ParticipantRole.ATTENDEE;
                 break;
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/ParticipantRole.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/ParticipantRole.java
@@ -26,6 +26,11 @@ public final class ParticipantRole extends ExpandableStringEnum<ParticipantRole>
      */
     public static final ParticipantRole CONSUMER = fromString("Consumer");
 
+    /**
+     * Static value Collaborator for ParticipantRole.
+     */
+    public static final ParticipantRole COLLABORATOR = fromString("Collaborator");
+
     /**
      * Creates a new instance of ParticipantRole value.
      * 
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/RoomsCollection.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/RoomsCollection.java
@@ -18,7 +18,7 @@
 @Fluent
 public final class RoomsCollection implements JsonSerializable<RoomsCollection> {
     /*
-     * A collection of rooms
+     * A collection of rooms.
      */
     private List<RoomModel> value;
 
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/UpdateRoomRequest.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/implementation/models/UpdateRoomRequest.java
@@ -31,8 +31,8 @@ public final class UpdateRoomRequest implements JsonSerializable<UpdateRoomReque
     private OffsetDateTime validUntil;
 
     /*
-     * Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a particular room. By
-     * default, this flag is set to false.
+     * (Optional) Set this flag to true if, at the time of the call, dial out to a PSTN number is enabled in a
+     * particular room. By default, this flag is set to false.
      */
     private Boolean pstnDialOutEnabled;
 
@@ -87,8 +87,8 @@ public UpdateRoomRequest setValidUntil(OffsetDateTime validUntil) {
     }
 
     /**
-     * Get the pstnDialOutEnabled property: Set this flag to true if, at the time of the call, dial out to a PSTN
-     * number is enabled in a particular room. By default, this flag is set to false.
+     * Get the pstnDialOutEnabled property: (Optional) Set this flag to true if, at the time of the call, dial out to a
+     * PSTN number is enabled in a particular room. By default, this flag is set to false.
      * 
      * @return the pstnDialOutEnabled value.
      */
@@ -97,8 +97,8 @@ public Boolean isPstnDialOutEnabled() {
     }
 
     /**
-     * Set the pstnDialOutEnabled property: Set this flag to true if, at the time of the call, dial out to a PSTN
-     * number is enabled in a particular room. By default, this flag is set to false.
+     * Set the pstnDialOutEnabled property: (Optional) Set this flag to true if, at the time of the call, dial out to a
+     * PSTN number is enabled in a particular room. By default, this flag is set to false.
      * 
      * @param pstnDialOutEnabled the pstnDialOutEnabled value to set.
      * @return the UpdateRoomRequest object itself.
diff --git a/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/models/ParticipantRole.java b/sdk/communication/azure-communication-rooms/src/main/java/com/azure/communication/rooms/models/ParticipantRole.java
@@ -1,6 +1,5 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-// Code generated by Microsoft (R) AutoRest Code Generator.
 
 package com.azure.communication.rooms.models;
 
@@ -19,6 +18,9 @@ public final class ParticipantRole extends ExpandableStringEnum<ParticipantRole>
     /** Static value Consumer for ParticipantRole. */
     public static final ParticipantRole CONSUMER = fromString("Consumer");
 
+    /** Static value Collaborator for ParticipantRole. */
+    public static final ParticipantRole COLLABORATOR = fromString("Collaborator");
+
     /**
      * Creates a new instance of {@link ParticipantRole} with no string value.
      *
diff --git a/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsAsyncClientTests.java b/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsAsyncClientTests.java
@@ -865,7 +865,7 @@ private HttpClient buildAsyncAssertingClient(HttpClient httpClient) {
     private RoomsAsyncClient setupAsyncClient(HttpClient httpClient, String testName) {
         RoomsClientBuilder builder = getRoomsClientWithConnectionString(
             buildAsyncAssertingClient(httpClient == null ? interceptorManager.getPlaybackClient() : httpClient),
-            RoomsServiceVersion.V2024_04_15);
+            RoomsServiceVersion.V2025_03_13);
         communicationClient = getCommunicationIdentityClientBuilder(httpClient).buildClient();
         return addLoggingPolicy(builder, testName).buildAsyncClient();
     }
diff --git a/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsClientTest.java b/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsClientTest.java
@@ -123,6 +123,38 @@ public void createRoomSyncWithFullOperationWithResponse(HttpClient httpClient) {
         assertEquals(deleteResponse.getStatusCode(), 204);
     }
 
+    @ParameterizedTest
+    @MethodSource("com.azure.core.test.TestBase#getHttpClients")
+    public void createRoomSyncWithParticipants(HttpClient httpClient) {
+        roomsClient = setupSyncClient(httpClient, "createRoomSyncWithParticipants");
+        assertNotNull(roomsClient);
+
+        // Create 4 participants
+        RoomParticipant firstParticipant
+            = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.PRESENTER);
+        RoomParticipant secondParticipant
+            = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.COLLABORATOR);
+        RoomParticipant thirdParticipant
+            = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.CONSUMER);
+        RoomParticipant fourthParticipant
+            = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.ATTENDEE);
+
+        List<RoomParticipant> participants
+            = Arrays.asList(firstParticipant, secondParticipant, thirdParticipant, fourthParticipant);
+
+        CreateRoomOptions createRoomOptions = new CreateRoomOptions().setParticipants(participants);
+
+        Response<CommunicationRoom> createdRoomResponse = roomsClient.createRoomWithResponse(createRoomOptions, null);
+        String roomId = createdRoomResponse.getValue().getRoomId();
+
+        // Check participant count, expected 3
+        PagedIterable<RoomParticipant> listParticipantsResponse = roomsClient.listParticipants(roomId);
+        assertEquals(4, listParticipantsResponse.stream().count());
+
+        Response<Void> deleteResponse = roomsClient.deleteRoomWithResponse(roomId, Context.NONE);
+        assertEquals(deleteResponse.getStatusCode(), 204);
+    }
+
     @ParameterizedTest
     @MethodSource("com.azure.core.test.TestBase#getHttpClients")
     public void listRoomTestFirstRoomIsNotNullThenDeleteRoomWithOutResponse(HttpClient httpClient) {
@@ -170,7 +202,8 @@ public void addUpdateAndRemoveParticipantsOperationsSyncWithFullFlow(HttpClient
 
         // Create 3 participants
         RoomParticipant firstParticipant = new RoomParticipant(communicationClient.createUser());
-        RoomParticipant secondParticipant = new RoomParticipant(communicationClient.createUser());
+        RoomParticipant secondParticipant
+            = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.COLLABORATOR);
         RoomParticipant thirdParticipant
             = new RoomParticipant(communicationClient.createUser()).setRole(ParticipantRole.CONSUMER);
 
@@ -192,7 +225,7 @@ public void addUpdateAndRemoveParticipantsOperationsSyncWithFullFlow(HttpClient
 
         List<RoomParticipant> participantsToUpdate = Arrays.asList(firstParticipantUpdated, secondParticipantUpdated);
 
-        // Update 2 participants roles, ATTENDEE -> CONSUMER
+        // Update 2 participants roles, ATTENDEE or COLLABORATOR -> CONSUMER
         AddOrUpdateParticipantsResult updateParticipantResponse
             = roomsClient.addOrUpdateParticipants(roomId, participantsToUpdate);
         assertEquals(true, updateParticipantResponse instanceof AddOrUpdateParticipantsResult);
@@ -297,23 +330,42 @@ public void updateParticipantsSyncWithFullOperation(HttpClient httpClient) {
 
         String roomId = createCommunicationRoom.getRoomId();
 
-        RoomParticipant firstParticipantToUpdate
+        RoomParticipant firstParticipantToUpdateToPresenter
             = new RoomParticipant(firstParticipant.getCommunicationIdentifier()).setRole(ParticipantRole.PRESENTER);
-        RoomParticipant secondParticipantToUpdate
+        RoomParticipant secondParticipantToUpdateToPresenter
             = new RoomParticipant(secondParticipant.getCommunicationIdentifier()).setRole(ParticipantRole.PRESENTER);
 
-        List<RoomParticipant> participantsToUpdate = Arrays.asList(firstParticipantToUpdate, secondParticipantToUpdate);
+        List<RoomParticipant> participantsToUpdateToPresenter
+            = Arrays.asList(firstParticipantToUpdateToPresenter, secondParticipantToUpdateToPresenter);
 
-        // Update 2 participants.
-        AddOrUpdateParticipantsResult addPartcipantResponse
-            = roomsClient.addOrUpdateParticipants(roomId, participantsToUpdate);
+        // Update 2 participants, both to presenter
+        AddOrUpdateParticipantsResult addParticipantsAsPresenterResponse
+            = roomsClient.addOrUpdateParticipants(roomId, participantsToUpdateToPresenter);
 
-        PagedIterable<RoomParticipant> listResponse = roomsClient.listParticipants(roomId);
+        PagedIterable<RoomParticipant> listPresentersResponse = roomsClient.listParticipants(roomId);
 
-        for (RoomParticipant participant : listResponse) {
+        for (RoomParticipant participant : listPresentersResponse) {
             assertEquals(ParticipantRole.PRESENTER, participant.getRole());
         }
 
+        RoomParticipant firstParticipantToUpdateToCollaborator
+            = new RoomParticipant(firstParticipant.getCommunicationIdentifier()).setRole(ParticipantRole.COLLABORATOR);
+        RoomParticipant secondParticipantToUpdateToCollaborator
+            = new RoomParticipant(secondParticipant.getCommunicationIdentifier()).setRole(ParticipantRole.COLLABORATOR);
+
+        List<RoomParticipant> participantsToUpdateToCollaborator
+            = Arrays.asList(firstParticipantToUpdateToCollaborator, secondParticipantToUpdateToCollaborator);
+
+        // Update 2 participants, to collaborator
+        AddOrUpdateParticipantsResult addParticipantsAsNonPresentersResponse
+            = roomsClient.addOrUpdateParticipants(roomId, participantsToUpdateToCollaborator);
+
+        PagedIterable<RoomParticipant> listNonPresentersResponse = roomsClient.listParticipants(roomId);
+
+        for (RoomParticipant participant : listNonPresentersResponse) {
+            assertEquals(ParticipantRole.COLLABORATOR, participant.getRole());
+        }
+
         Response<Void> deleteResponse = roomsClient.deleteRoomWithResponse(roomId, Context.NONE);
         assertEquals(deleteResponse.getStatusCode(), 204);
     }
@@ -919,7 +971,7 @@ private HttpClient buildSyncAssertingClient(HttpClient httpClient) {
     private RoomsClient setupSyncClient(HttpClient httpClient, String testName) {
         RoomsClientBuilder builder = getRoomsClientWithConnectionString(
             buildSyncAssertingClient(httpClient == null ? interceptorManager.getPlaybackClient() : httpClient),
-            RoomsServiceVersion.V2024_04_15);
+            RoomsServiceVersion.V2025_03_13);
 
         communicationClient = getCommunicationIdentityClientBuilder(httpClient).buildClient();
 
diff --git a/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsTestBase.java b/sdk/communication/azure-communication-rooms/src/test/java/com/azure/communication/rooms/RoomsTestBase.java
@@ -24,6 +24,7 @@
 import reactor.core.publisher.Mono;
 
 import java.time.OffsetDateTime;
+import java.time.ZoneId;
 import java.util.Arrays;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -36,7 +37,7 @@ public class RoomsTestBase extends TestProxyTestBase {
         .get("COMMUNICATION_CONNECTION_STRING_ROOMS",
             "endpoint=https://REDACTED.communication.azure.com/;accesskey=P2tP5RwZVFcJa3sfJvHEmGaKbemSAw2e");
 
-    protected static final OffsetDateTime VALID_FROM = OffsetDateTime.now();
+    protected static final OffsetDateTime VALID_FROM = OffsetDateTime.now(ZoneId.of("Z")); // UTC
     protected static final OffsetDateTime VALID_UNTIL = VALID_FROM.plusDays(30);
 
     protected RoomsClientBuilder getRoomsClient(HttpClient httpClient) {
diff --git a/sdk/communication/azure-communication-rooms/swagger/README.md b/sdk/communication/azure-communication-rooms/swagger/README.md
@@ -21,7 +21,7 @@ To update generated files for rooms service, run the following command
 ### Code generation settings
 ``` yaml
 require:
-    - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/91813ca7a287fe944262e992413ce4d51d987276/specification/communication/data-plane/Rooms/readme.md
+    - https://raw.githubusercontent.com/Azure/azure-rest-api-specs/538040a7bbb466baf361e98d6d36faec417cff7a/specification/communication/data-plane/Rooms/readme.md
 use: '@autorest/java@4.1.27'
 java: true
 title: AzureCommunicationRoomService

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"AssetsRepo": "Azure/azure-sdk-assets",`
`3`	`3`	`"AssetsRepoPrefixPath": "java",`
`4`	`4`	`"TagPrefix": "java/communication/azure-communication-rooms",`
`5`		`- "Tag": "java/communication/azure-communication-rooms_5116842cd0"`
	`5`	`+ "Tag": "java/communication/azure-communication-rooms_0569c759b4"`
`6`	`6`	`}`