Remove breakoutRoomOriginCallId from BreakoutRoomsState api (#5629)

* Remove breakoutRoomOriginCallId from BreakoutRoomsState in stateful layer * Change files * Update code comments
Azure · Feb 6, 2025 · 47034b4 · 47034b4
1 parent 0c652c4
commit 47034b4
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 25 deletions.
diff --git a/change-beta/@azure-communication-react-851a06da-cc21-46b4-a052-77e7cd619044.json b/change-beta/@azure-communication-react-851a06da-cc21-46b4-a052-77e7cd619044.json
@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "feature",
+  "workstream": "Breakout rooms",
+  "comment": "Remove breakoutRoomOriginCallId from BreakoutRoomsState api",
+  "packageName": "@azure/communication-react",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/calling-stateful-client/src/BreakoutRoomsSubscriber.ts b/packages/calling-stateful-client/src/BreakoutRoomsSubscriber.ts
@@ -132,7 +132,6 @@ export class BreakoutRoomsSubscriber {
   };
 
   private onBreakoutRoomsJoined = (call: Call | TeamsCall): void => {
-    this._context.setBreakoutRoomOriginCallId(this._callIdRef.callId, call.id);
     this._context.deleteLatestNotification('assignedBreakoutRoomOpened', this._callIdRef.callId);
     this._context.deleteLatestNotification('assignedBreakoutRoomOpenedPromptJoin', this._callIdRef.callId);
     this._context.deleteLatestNotification('assignedBreakoutRoomChanged', this._callIdRef.callId);

diff --git a/packages/calling-stateful-client/src/CallClientState.ts b/packages/calling-stateful-client/src/CallClientState.ts
@@ -264,8 +264,6 @@ export interface BreakoutRoomsState {
   assignedBreakoutRoom?: BreakoutRoom;
   /** Breakout room settings of call. This is defined when call is a breakout room. */
   breakoutRoomSettings?: BreakoutRoomsSettings;
-  /** Origin call id of breakout room. This is defined when call is a breakout room. */
-  breakoutRoomOriginCallId?: string;
   /** Display name of breakout room. This is defined when call is a breakout room. */
   breakoutRoomDisplayName?: string;
 }

diff --git a/packages/calling-stateful-client/src/CallContext.ts b/packages/calling-stateful-client/src/CallContext.ts
@@ -252,13 +252,6 @@ export class CallContext {
         delete draft.calls[oldCallId];
         draft.calls[newCallId] = call;
       }
-      /* @conditional-compile-remove(breakout-rooms) */
-      // Update the old origin call id of breakout room calls to the new call id
-      Object.values(draft.calls).forEach((call) => {
-        if (call.breakoutRooms?.breakoutRoomOriginCallId === oldCallId) {
-          call.breakoutRooms?.breakoutRoomOriginCallId === newCallId;
-        }
-      });
 
       /* @conditional-compile-remove(breakout-rooms) */
       // Update call ids in latestCallIdsThatPushedNotifications
@@ -762,16 +755,6 @@ export class CallContext {
     });
   }
 
-  /* @conditional-compile-remove(breakout-rooms) */
-  public setBreakoutRoomOriginCallId(callId: string, breakoutRoomCallId: string): void {
-    this.modifyState((draft: CallClientState) => {
-      const call = draft.calls[this._callIdHistory.latestCallId(breakoutRoomCallId)];
-      if (call) {
-        call.breakoutRooms = { ...call.breakoutRooms, breakoutRoomOriginCallId: callId };
-      }
-    });
-  }
-
   /* @conditional-compile-remove(breakout-rooms) */
   public setBreakoutRoomSettings(callId: string, breakoutRoomSettings: BreakoutRoomsSettings): void {
     this.modifyState((draft: CallClientState) => {

diff --git a/packages/communication-react/review/beta/communication-react.api.md b/packages/communication-react/review/beta/communication-react.api.md
@@ -366,7 +366,6 @@ export interface BlockedMessage extends MessageCommon {
 export interface BreakoutRoomsState {
     assignedBreakoutRoom?: BreakoutRoom;
     breakoutRoomDisplayName?: string;
-    breakoutRoomOriginCallId?: string;
     breakoutRoomSettings?: BreakoutRoomsSettings;
 }
 

diff --git a/packages/communication-react/review/stable/communication-react.api.md b/packages/communication-react/review/stable/communication-react.api.md
@@ -263,7 +263,6 @@ export interface BaseCustomStyles {
 export interface BreakoutRoomsState {
     assignedBreakoutRoom?: BreakoutRoom;
     breakoutRoomDisplayName?: string;
-    breakoutRoomOriginCallId?: string;
     breakoutRoomSettings?: BreakoutRoomsSettings;
 }
 

diff --git a/packages/react-composites/src/composites/CallWithChatComposite/CallWithChatComposite.tsx b/packages/react-composites/src/composites/CallWithChatComposite/CallWithChatComposite.tsx
@@ -614,7 +614,9 @@ const CallWithChatScreen = (props: CallWithChatScreenProps): JSX.Element => {
 
   let chatPaneTitle = callWithChatStrings.chatPaneTitle;
   /* @conditional-compile-remove(breakout-rooms) */
-  if (callAdapter.getState().call?.breakoutRooms?.breakoutRoomOriginCallId) {
+  // If breakout room settings are defined then we know we are in a breakout room so we should
+  // use the breakout room chat pane title.
+  if (callAdapter.getState().call?.breakoutRooms?.breakoutRoomSettings) {
     chatPaneTitle = callWithChatStrings.breakoutRoomChatPaneTitle;
   }
 

diff --git a/...tes/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.ts b/...tes/src/composites/CallWithChatComposite/adapter/AzureCommunicationCallWithChatAdapter.ts
@@ -732,8 +732,10 @@ export class AzureCommunicationCallWithChatAdapter implements CallWithChatAdapte
       this.updateChatAdapter(this.originCallChatAdapter);
     }
 
-    const originCallId = this.callAdapter.getState().call?.breakoutRooms?.breakoutRoomOriginCallId;
-    if (originCallId) {
+    // Check if breakout room settings are defined to verify the user is in a breakout room before
+    // returning to the origin call.
+    const breakoutRoomSettings = this.context.getState().call?.breakoutRooms?.breakoutRoomSettings;
+    if (breakoutRoomSettings) {
       await this.callAdapter.returnFromBreakoutRoom();
     }
   }