feat(plugin-meetings): Introduce SDK changes to call WCME and Locus APIs when current user steps away or returns

docs/samples/browser-plugin-meetings/app.js

@@ -3337,9 +3337,9 @@ async function toggleBrb() {
     const enabled = document.getElementById('brb').checked;
     try {
       const result = await meeting.beRightBack(enabled);
-      console.log(`meeting.beRightBack(${enabled}): SUCCESS | result: ${result}`);
+      console.log(`meeting.beRightBack(${enabled}): success. Result: ${result}`);
     } catch (error) {
-      console.error(`meeting.beRightBack({${enabled}): ERROR`, error);
+      console.error(`meeting.beRightBack({${enabled}): error: `, error);
     } finally {
       localMedia?.microphoneStream?.setUserMuted(enabled);
       localMedia?.cameraStream?.setUserMuted(enabled);

packages/@webex/plugin-meetings/src/meeting/index.ts

@@ -3509,30 +3509,31 @@ export default class Meeting extends StatelessWebexPlugin {
   /**
    * Manages be right back status updates for the current participant.
    *
-   * @param {boolean} enabled - Indicates whether the use is brb or not.
-   * @returns {Promise<void>} - A promise that resolves when the request is complete.
+   * @param {boolean} enabled - Indicates whether the user enabled brb or not.
+   * @returns {Promise<void>} resolves when the brb status is updated or does nothing if not in a multistream meeting.
    * @throws {Error} - Throws an error if the request fails.
-   *
-   * @todo non-multistream support https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-578667
    */
-  public beRightBack(enabled: boolean) {
-    return this.meetingRequest
-      .sendBrb({
-        enabled,
-        locusUrl: this.locusUrl,
-        deviceUrl: this.deviceUrl,
-        selfId: this.selfId,
-      })
-      .then(() => {
-        if (this.isMultistream && this.mediaProperties.webrtcMediaConnection) {
+  public beRightBack(enabled: boolean): Promise<void> {
+    // this logic should be applied only to multistream meetings
+    if (this.isMultistream && this.mediaProperties.webrtcMediaConnection) {
+      return this.meetingRequest
+        .sendBrb({
+          enabled,
+          locusUrl: this.locusUrl,
+          deviceUrl: this.deviceUrl,
+          selfId: this.selfId,
+        })
+        .then(() => {
           this.sendSlotManager.setSourceStateOverride(MediaType.VideoMain, enabled ? 'away' : null);
-        }
-      })
-      .catch((error) => {
-        LoggerProxy.logger.error('Meeting:index#beRightBack --> Error ', error);
+        })
+        .catch((error) => {
+          LoggerProxy.logger.error('Meeting:index#beRightBack --> Error ', error);
 
-        return Promise.reject(error);
-      });
+          return Promise.reject(error);
+        });
+    }
+
+    return undefined;
   }
 
   /**

packages/@webex/plugin-meetings/src/multistream/sendSlotManager.ts

@@ -110,7 +110,7 @@ export default class SendSlotManager {
     }
 
     this.LoggerProxy.logger.info(
-      `SendSlotsManager->setSourceStateOverride#set source state override to ${state}`
+      `SendSlotsManager->setSourceStateOverride#set source state override for ${mediaType} to ${state}`
     );
   }
 

packages/@webex/plugin-meetings/test/unit/spec/locus-info/index.js

@@ -739,46 +739,44 @@ describe('plugin-meetings', () => {
 
     describe('#updateSelf', () => {
       it('should trigger SELF_MEETING_BRB_CHANGED when brb state changed', () => {
-        locusInfo.self = undefined
+        locusInfo.self = undefined;
 
         const assertBrb = (enabled) => {
           const selfWithBrbChanged = cloneDeep(self);
-          selfWithBrbChanged.controls.brb = enabled
+          selfWithBrbChanged.controls.brb = enabled;
 
           locusInfo.emitScoped = sinon.stub();
-          locusInfo.updateSelf(selfWithBrbChanged, [])
+          locusInfo.updateSelf(selfWithBrbChanged, []);
 
           assert.calledWith(
             locusInfo.emitScoped,
             { file: 'locus-info', function: 'updateSelf' },
             LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
             { brb: enabled }
           )
-        }
+        };
 
-        assertBrb(true)
-        assertBrb(false)
+        assertBrb(true);
+        assertBrb(false);
       })
 
-      it('should not trigger SELF_MEETING_BRB_CHANGED when brb state changed', () => {
+      it('should not trigger SELF_MEETING_BRB_CHANGED when brb state did not change', () => {
         const assertBrb = (enabled) => {
-          const selfWithBrbChanged = cloneDeep(self);
-          selfWithBrbChanged.controls.brb = enabled
 
-          locusInfo.self = selfWithBrbChanged
+          locusInfo.self = undefined;
           locusInfo.emitScoped = sinon.stub();
-          locusInfo.updateSelf(selfWithBrbChanged, [])
+          locusInfo.updateSelf(undefined, []);
 
           assert.neverCalledWith(
             locusInfo.emitScoped,
             { file: 'locus-info', function: 'updateSelf' },
             LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
             { brb: enabled }
           )
-        }
+        };
 
-        assertBrb(true)
-        assertBrb(false)
+        assertBrb(true);
+        assertBrb(false);
       })
 
       it('should trigger CONTROLS_MEETING_LAYOUT_UPDATED when the meeting layout controls change', () => {

packages/@webex/plugin-meetings/test/unit/spec/meeting/index.js

@@ -3632,6 +3632,82 @@ describe('plugin-meetings', () => {
         });
       });
 
+      describe(`#beRightBack`, () => {
+        const fakeMultistreamRoapMediaConnection = {
+          createSendSlot: sinon.stub().returns({
+            setSourceStateOverride: sinon.stub().resolves(),
+            clearSourceStateOverride: sinon.stub().resolves(),
+          }),
+        };
+
+        beforeEach(() => {
+          meeting.meetingRequest.sendBrb = sinon.stub().resolves({body: 'test'});
+          meeting.mediaProperties.webrtcMediaConnection = {createSendSlot: sinon.stub()};
+          meeting.sendSlotManager.createSlot(
+            fakeMultistreamRoapMediaConnection,
+            MediaType.VideoMain
+          );
+
+          meeting.locusUrl = 'locus url';
+          meeting.deviceUrl = 'device url';
+          meeting.selfId = 'self id';
+        });
+
+        describe('when multistream meeting', () => {
+
+          beforeEach(() => {
+            meeting.isMultistream = true;
+          });
+
+          it('should have #beRightBack', () => {
+            assert.exists(meeting.beRightBack);
+          });
+
+          it('should enable #beRightBack and return a promise', async () => {
+            const brbResult = meeting.beRightBack(true);
+
+            await brbResult;
+            assert.exists(brbResult.then);
+            assert.calledOnce(meeting.meetingRequest.sendBrb);
+          })
+
+          it('should disable #beRightBack and return a promise', async () => {
+            const brbResult = meeting.beRightBack(false);
+
+            await brbResult;
+            assert.exists(brbResult.then);
+            assert.calledOnce(meeting.meetingRequest.sendBrb);
+          })
+        });
+
+        describe('when transcoded meeting', () => {
+
+          beforeEach(() => {
+            meeting.isMultistream = false;
+          });
+
+          it('should have #beRightBack', () => {
+            assert.exists(meeting.beRightBack);
+          });
+
+          it('should ignore enabling #beRightBack', async () => {
+            const brbResult = meeting.beRightBack(true);
+
+            await brbResult;
+            assert.isUndefined();
+            assert.notCalled(meeting.meetingRequest.sendBrb);
+          })
+
+          it('should ignore disabling #beRightBack', async () => {
+            const brbResult = meeting.beRightBack(false);
+
+            await brbResult;
+            assert.isUndefined();
+            assert.notCalled(meeting.meetingRequest.sendBrb);
+          })
+        });
+      });
+
       /* This set of tests are like semi-integration tests, they use real MuteState, Media, LocusMediaRequest and Roap classes.
          They mock the @webex/internal-media-core and sending of /media http requests to Locus.
          Their main purpose is to test that we send the right http requests to Locus and make right calls
@@ -4714,6 +4790,7 @@ describe('plugin-meetings', () => {
             });
           });
 
+
           [
             {mute: true, title: 'user muting a track before confluence is created'},
             {mute: false, title: 'user unmuting a track before confluence is created'},
@@ -8532,32 +8609,6 @@ describe('plugin-meetings', () => {
         });
       });
 
-      describe('#brb', () => {
-        it('send brb request', () => {
-          meeting.meetingRequest.locusDeltaRequest = sinon.stub().resolves();
-          meeting.locusUrl = 'locus url'
-          meeting.deviceUrl = 'device url'
-          meeting.selfId = 'self id'
-
-          const assertBrb = (enabled) => {
-            meeting.beRightBack(enabled)
-            assert.calledWithExactly(meeting.meetingRequest.locusDeltaRequest, {
-              method: HTTP_VERBS.PATCH,
-              uri: `${meeting.locusUrl}/${PARTICIPANT}/${meeting.selfId}/${CONTROLS}`,
-              body: {
-                brb: {
-                  enabled,
-                  deviceUrl: meeting.deviceUrl,
-                }
-              }
-            })
-          }
-
-          assertBrb(true)
-          assertBrb(false)
-        })
-      })
-
       describe('#setUpLocusInfoSelfListener', () => {
         it('listens to the self unadmitted guest event', (done) => {
           meeting.startKeepAlive = sinon.stub();
@@ -8639,12 +8690,9 @@ describe('plugin-meetings', () => {
         });
 
         it('listens to the brb state changed event', () => {
-          meeting.sendSlotManager.setSourceStateOverride = sinon.stub()
-          meeting.mediaProperties.webrtcMediaConnection = true
-
           const assertBrb = (enabled) => {
             meeting.locusInfo.emit(
-              { file: 'locus-info', function: 'updateSelf' },
+              { function: 'test', file: 'test' },
               LOCUSINFO.EVENTS.SELF_MEETING_BRB_CHANGED,
               { brb: { enabled } },
             )
@@ -8657,8 +8705,8 @@ describe('plugin-meetings', () => {
             );
           }
 
-          assertBrb(true)
-          assertBrb(false)
+          assertBrb(true);
+          assertBrb(false);
         })
 
         it('listens to the interpretation changed event', () => {