@webex/plugin-meetings 3.0.0-beta.26 → 3.0.0-beta.28

package/src/breakouts/index.ts

@@ -5,7 +5,7 @@ import {WebexPlugin} from '@webex/webex-core';
 import {debounce, forEach} from 'lodash';
 import LoggerProxy from '../common/logs/logger-proxy';
 
-import {BREAKOUTS, MEETINGS} from '../constants';
+import {BREAKOUTS, MEETINGS, HTTP_VERBS} from '../constants';
 
 import Breakout from './breakout';
 import BreakoutCollection from './collection';
@@ -32,6 +32,7 @@ const Breakouts = WebexPlugin.extend({
     status: 'string', // only present when in a breakout session
     url: 'string', // appears from the moment you enable breakouts
     locusUrl: 'string', // the current locus url
+    breakoutServiceUrl: 'string', // the current breakout resouce url
   },
 
   children: {
@@ -89,6 +90,15 @@ const Breakouts = WebexPlugin.extend({
     this.set('locusUrl', locusUrl);
   },
 
+  /**
+   * Update the current breakout resouce url
+   * @param {string} breakoutServiceUrl
+   * @returns {void}
+   */
+  breakoutServiceUrlUpdate(breakoutServiceUrl) {
+    this.set('breakoutServiceUrl', `${breakoutServiceUrl}/breakout/`);
+  },
+
   /**
    * The initial roster lists need to be queried because you don't
    * get a breakout.roster event when you join the meeting
@@ -184,6 +194,8 @@ const Breakouts = WebexPlugin.extend({
       [BREAKOUTS.SESSION_STATES.ASSIGNED_CURRENT]: false,
       [BREAKOUTS.SESSION_STATES.REQUESTED]: false,
     });
+
+    this.set('enableBreakoutSession', params.enableBreakoutSession);
   },
 
   /**
@@ -220,6 +232,66 @@ const Breakouts = WebexPlugin.extend({
 
     this.breakouts.set(Object.values(breakouts));
   },
+
+  /**
+   * Make enable breakout resource
+   * @returns {Promise}
+   */
+  enableBreakouts() {
+    if (this.breakoutServiceUrl) {
+      // @ts-ignore
+      return this.webex
+        .request({
+          method: HTTP_VERBS.POST,
+          uri: this.breakoutServiceUrl,
+          body: {
+            locusUrl: this.locusUrl,
+          },
+        })
+        .catch((err) => {
+          LoggerProxy.logger.error(
+            `Meeting:request#touchBreakout --> Error provisioning error ${err}`
+          );
+          throw err;
+        });
+    }
+
+    return Promise.reject(new Error(`enableBreakouts: the breakoutServiceUrl is empty`));
+  },
+
+  /**
+   * Make the meeting enbale or disable breakout session
+   * @param {boolean} enable
+   * @returns {Promise}
+   */
+  async toggleBreakout(enable) {
+    if (this.enableBreakoutSession === undefined) {
+      const info = await this.enableBreakouts();
+      if (!enable) {
+        // if enable is false, updateBreakout set the param then set enableBreakoutSession as false
+        this.updateBreakout(info.body);
+        await this.doToggleBreakout(enable);
+      }
+    } else {
+      await this.doToggleBreakout(enable);
+    }
+  },
+
+  /**
+   * do toggle meeting breakout session enable or disable
+   * @param {boolean} enable
+   * @returns {Promise}
+   */
+  doToggleBreakout(enable) {
+    // @ts-ignore
+    return this.webex.request({
+      method: HTTP_VERBS.PUT,
+      uri: this.url,
+      body: {
+        enableBreakoutSession: enable,
+      },
+    });
+  },
 });
 
 export default Breakouts;

package/src/meeting/index.ts

@@ -2219,6 +2219,7 @@ export default class Meeting extends StatelessWebexPlugin {
     this.locusInfo.on(LOCUSINFO.EVENTS.LINKS_SERVICES, (payload) => {
       this.recordingController.setServiceUrl(payload?.services?.record?.url);
       this.recordingController.setSessionId(this.locusInfo?.fullState?.sessionId);
+      this.breakouts.breakoutServiceUrlUpdate(payload?.services?.breakout?.url);
     });
   }
 

package/src/meetings/util.ts

@@ -58,12 +58,36 @@ MeetingsUtil.handleRoapMercury = (envelope, meetingCollection) => {
           errorCause,
         };
 
+        const mediaServer = MeetingsUtil.getMediaServer(roapMessage.sdp);
+
         meeting.mediaProperties.webrtcMediaConnection.roapMessageReceived(roapMessage);
+
+        if (mediaServer) {
+          meeting.mediaProperties.webrtcMediaConnection.mediaServer = mediaServer;
+        }
       }
     }
   }
 };
 
+MeetingsUtil.getMediaServer = (sdp) => {
+  let mediaServer;
+
+  // Attempt to collect the media server from the roap message.
+  try {
+    mediaServer = sdp
+      .split('\r\n')
+      .find((line) => line.startsWith('o='))
+      .split(' ')
+      .shift()
+      .replace('o=', '');
+  } catch {
+    mediaServer = undefined;
+  }
+
+  return mediaServer;
+};
+
 MeetingsUtil.checkForCorrelationId = (deviceUrl, locus) => {
   let devices = [];
 

package/src/members/index.ts

@@ -296,6 +296,8 @@ export default class Members extends StatelessWebexPlugin {
       const delta = this.handleLocusInfoUpdatedParticipants(payload);
       const full = this.handleMembersUpdate(delta); // SDK should propagate the full list for both delta and non delta updates
 
+      this.receiveSlotManager.updateMemberIds();
+
       Trigger.trigger(
         this,
         {

package/src/multistream/receiveSlot.ts

@@ -91,7 +91,7 @@ export class ReceiveSlot extends EventsScope {
   /**
    * registers event handlers with the underlying ReceiveSlot
    */
-  setupEventListeners() {
+  private setupEventListeners() {
     const scope = {
       file: 'meeting/receiveSlot',
       function: 'setupEventListeners',
@@ -116,6 +116,13 @@ export class ReceiveSlot extends EventsScope {
     );
   }
 
+  /** Tries to find the member id for this receive slot if it hasn't got one */
+  public findMemberId() {
+    if (this.#memberId === undefined && this.#csi) {
+      this.#memberId = this.findMemberIdCallback(this.#csi);
+    }
+  }
+
   /**
    * The MediaStream object associated with this slot.
    *

package/src/multistream/receiveSlotManager.ts

@@ -141,4 +141,16 @@ export class ReceiveSlotManager {
       numFreeSlots,
     };
   }
+
+  /**
+   * Tries to find the member id on all allocated receive slots
+   * This function should be called when new members are added to the meeting.
+   */
+  updateMemberIds() {
+    Object.keys(this.allocatedSlots).forEach((key) => {
+      this.allocatedSlots[key].forEach((slot: ReceiveSlot) => {
+        slot.findMemberId();
+      });
+    });
+  }
 }

package/test/integration/spec/converged-space-meetings.js

@@ -0,0 +1,176 @@
+import { config } from 'dotenv';
+import 'jsdom-global/register';
+import {assert} from '@webex/test-helper-chai';
+import {skipInNode} from '@webex/test-helper-mocha';
+import BrowserDetection from '@webex/plugin-meetings/dist/common/browser-detection';
+
+import {MEDIA_SERVERS} from '../../utils/constants';
+import testUtils from '../../utils/testUtils';
+import webexTestUsers from '../../utils/webex-test-users';
+
+config();
+
+skipInNode(describe)('plugin-meetings', () => {
+  const {isBrowser} = BrowserDetection();
+
+  // `addMedia()` fails on FF, this needs to be debuged and fixed in a later change
+  if (!isBrowser('firefox')) {
+    describe('converged-space-meeting', () => {
+      let shouldSkip = false;
+      let users, alice, bob, chris;
+      let meeting = null;
+      let space = null;
+      let mediaReadyListener = null;
+
+      before('setup users', async () => {
+        const userSet = await webexTestUsers.generateTestUsers({
+          count: 3,
+          whistler: process.env.WHISTLER || process.env.JENKINS,
+          config
+        });
+
+        users = userSet;
+        alice = users[0];
+        bob = users[1];
+        chris = users[2];
+        alice.name = 'alice';
+        bob.name = 'bob';
+        chris.name = 'chris';
+
+        const aliceSync = testUtils.syncAndEndMeeting(alice);
+        const bobSync = testUtils.syncAndEndMeeting(bob);
+        const chrisSync = testUtils.syncAndEndMeeting(chris);
+
+        await aliceSync;
+        await bobSync;
+        await chrisSync;
+      });
+
+      // Skip a test in this series if one failed.
+      // This beforeEach() instance function must use the `function` declaration to preserve the
+      // `this` context. `() => {}` will not generate the correct `this` context
+      beforeEach('check if should skip test', function() {
+        if (shouldSkip) {
+          this.skip();
+        }
+      });
+
+      // Store to the describe scope if a test has failed for skipping.
+      // This beforeEach() instance function must use the `function` declaration to preserve the
+      // `this` context. `() => {}` will not generate the correct `this` context
+      afterEach('check if test failed', function() {
+        if (this.currentTest.state === 'failed') {
+          shouldSkip = true;
+        }
+      });
+
+      it('user "alice" starts a space', async () => {
+        const conversation = await alice.webex.internal.conversation.create({
+          participants: [bob, chris],
+        });
+
+        assert.lengthOf(conversation.participants.items, 3);
+        assert.lengthOf(conversation.activities.items, 1);
+
+        space = conversation;
+
+        const destinationWithType = await alice.webex.meetings.meetingInfo.fetchMeetingInfo(space.url, 'CONVERSATION_URL');
+        const destinationWithoutType = await alice.webex.meetings.meetingInfo.fetchMeetingInfo(space.url);
+
+        assert.exists(destinationWithoutType);
+        assert.exists(destinationWithType);
+        assert.exists(destinationWithoutType.body.meetingNumber);
+        assert.exists(destinationWithType.body.meetingNumber);
+      });
+
+      it('user "alice" starts a meeting', async () => {
+        const wait = testUtils.waitForEvents([{
+          scope: alice.webex.meetings,
+          event: 'meeting:added',
+          user: alice,
+        }]);
+
+        const createdMeeting = await testUtils.delayedPromise(alice.webex.meetings.create(space.url));
+
+        await wait;
+
+        assert.exists(createdMeeting);
+
+        meeting = createdMeeting;
+      });
+
+      it('user "alice" joins the meeting', async () => {
+        const wait = testUtils.waitForEvents([
+          {scope: bob.webex.meetings, event: 'meeting:added', user: bob},
+          {scope: chris.webex.meetings, event: 'meeting:added', user: chris},
+        ]);
+
+        await testUtils.delayedPromise(alice.meeting.join({enableMultistream: true}));
+
+        await wait;
+
+        assert.isTrue(!!alice.webex.meetings.meetingCollection.meetings[meeting.id].joinedWith);
+      });
+
+      it('users "bob" and "chris" join the meeting', async () => {
+        await testUtils.waitForStateChange(alice.meeting, 'JOINED');
+
+        const bobIdle = testUtils.waitForStateChange(bob.meeting, 'IDLE');
+        const chrisIdle =  testUtils.waitForStateChange(chris.meeting, 'IDLE');
+
+        await bobIdle;
+        await chrisIdle;
+
+        const bobJoined = testUtils.waitForStateChange(bob.meeting, 'JOINED');
+        const chrisJoined =  testUtils.waitForStateChange(chris.meeting, 'JOINED');
+        const bobJoin = bob.meeting.join({enableMultistream: true});
+        const chrisJoin = chris.meeting.join({enableMultistream: true});
+
+        await bobJoin;
+        await chrisJoin;
+        await bobJoined;
+        await chrisJoined;
+
+        assert.exists(bob.meeting.joinedWith);
+        assert.exists(chris.meeting.joinedWith);
+      });
+
+      it('users "alice", "bob", and "chris" add media', async () => {
+        mediaReadyListener = testUtils.waitForEvents([
+          {scope: alice.meeting, event: 'media:negotiated'},
+          {scope: bob.meeting, event: 'media:negotiated'},
+          {scope: chris.meeting, event: 'media:negotiated'},
+        ]);
+
+        const addMediaAlice = testUtils.addMedia(alice, {expectedMediaReadyTypes: ['local']});
+        const addMediaBob = testUtils.addMedia(bob, {expectedMediaReadyTypes: ['local']});
+        const addMediaChris = testUtils.addMedia(chris, {expectedMediaReadyTypes: ['local']});
+
+        await addMediaAlice;
+        await addMediaBob;
+        await addMediaChris;
+
+        assert.isTrue(alice.meeting.mediaProperties.mediaDirection.sendAudio);
+        assert.isTrue(alice.meeting.mediaProperties.mediaDirection.sendVideo);
+        assert.isTrue(alice.meeting.mediaProperties.mediaDirection.receiveAudio);
+        assert.isTrue(alice.meeting.mediaProperties.mediaDirection.receiveVideo);
+        assert.isTrue(bob.meeting.mediaProperties.mediaDirection.sendAudio);
+        assert.isTrue(bob.meeting.mediaProperties.mediaDirection.sendVideo);
+        assert.isTrue(bob.meeting.mediaProperties.mediaDirection.receiveAudio);
+        assert.isTrue(bob.meeting.mediaProperties.mediaDirection.receiveVideo);
+        assert.isTrue(chris.meeting.mediaProperties.mediaDirection.sendAudio);
+        assert.isTrue(chris.meeting.mediaProperties.mediaDirection.sendVideo);
+        assert.isTrue(chris.meeting.mediaProperties.mediaDirection.receiveAudio);
+        assert.isTrue(chris.meeting.mediaProperties.mediaDirection.receiveVideo);
+      });
+
+      it(`users "alice", "bob", and "chris" should be using the "${MEDIA_SERVERS.HOMER}" media server`, async () => {
+        await mediaReadyListener;
+
+        assert.equal(alice.meeting.mediaProperties.webrtcMediaConnection.mediaServer, MEDIA_SERVERS.HOMER);
+        assert.equal(bob.meeting.mediaProperties.webrtcMediaConnection.mediaServer, MEDIA_SERVERS.HOMER);
+        assert.equal(chris.meeting.mediaProperties.webrtcMediaConnection.mediaServer, MEDIA_SERVERS.HOMER);
+      });
+    });
+  }
+});

package/test/unit/spec/breakouts/index.ts

@@ -20,6 +20,9 @@ describe('plugin-meetings', () => {
       webex.internal.llm.on = sinon.stub();
       webex.internal.mercury.on = sinon.stub();
       breakouts = new Breakouts({}, {parent: webex});
+      breakouts.locusUrl = 'locusUrl';
+      breakouts.breakoutServiceUrl = 'breakoutServiceUrl';
+      breakouts.url = 'url';
       webex.request = sinon.stub().returns(Promise.resolve('REQUEST_RETURN_VALUE'));
     });
 
@@ -289,5 +292,78 @@ describe('plugin-meetings', () => {
         assert.equal(breakouts.isInMainSession, true);
       });
     });
+
+    describe('#breakoutServiceUrlUpdate', () => {
+      it('sets the breakoutService url', () => {
+        breakouts.breakoutServiceUrlUpdate('newBreakoutServiceUrl');
+        assert.equal(breakouts.breakoutServiceUrl, 'newBreakoutServiceUrl/breakout/');
+      });
+    });
+
+    describe('#toggleBreakout', () => {
+      it('enableBreakoutSession is undefined, run enableBreakouts then toggleBreakout', async() => {
+        breakouts.enableBreakoutSession = undefined;
+        breakouts.enableBreakouts = sinon.stub().resolves(({body: {
+          sessionId: 'sessionId',
+          groupId: 'groupId',
+          name: 'name',
+          current: true,
+          sessionType: 'sessionType',
+          url: 'url'
+        }}))
+        breakouts.updateBreakout = sinon.stub().resolves();
+        breakouts.doToggleBreakout = sinon.stub().resolves();
+        
+        await breakouts.toggleBreakout(false);
+        assert.calledOnceWithExactly(breakouts.enableBreakouts);
+        assert.calledOnceWithExactly(breakouts.updateBreakout, {
+          sessionId: 'sessionId',
+          groupId: 'groupId',
+          name: 'name',
+          current: true,
+          sessionType: 'sessionType',
+          url: 'url'
+        });
+        assert.calledOnceWithExactly(breakouts.doToggleBreakout, false);
+      });
+
+      it('enableBreakoutSession is exist, run toggleBreakout', async() => {
+        breakouts.enableBreakoutSession = true;
+        breakouts.doToggleBreakout = sinon.stub().resolves();
+        await breakouts.toggleBreakout(true);
+        assert.calledOnceWithExactly(breakouts.doToggleBreakout, true);
+      });
+    });
+
+    describe('enableBreakouts', () => {
+      it('makes the request as expected', async () => {
+        const result = await breakouts.enableBreakouts();
+        breakouts.set('breakoutServiceUrl', 'breakoutServiceUrl');
+        assert.calledOnceWithExactly(webex.request, {
+          method: 'POST',
+          uri: 'breakoutServiceUrl',
+          body: {
+            locusUrl: 'locusUrl'
+          }
+        });
+
+        assert.equal(result, 'REQUEST_RETURN_VALUE');
+      });
+    });
+
+    describe('doToggleBreakout', () => {
+      it('makes the request as expected', async () => {
+        const result = await breakouts.doToggleBreakout(true);
+        assert.calledOnceWithExactly(webex.request, {
+          method: 'PUT',
+          uri: 'url',
+          body: {
+            enableBreakoutSession: true
+          }
+        });
+
+        assert.equal(result, 'REQUEST_RETURN_VALUE');
+      });
+    });
   });
 });

package/test/unit/spec/multistream/receiveSlot.ts

@@ -101,4 +101,40 @@ describe('ReceiveSlot', () => {
     assert.strictEqual(receiveSlot.csi, undefined);
     assert.strictEqual(receiveSlot.sourceState, 'no source');
   });
+
+  describe('findMemberId()', () => {
+    it('doesn\'t do anything if csi is not set', () => {
+      // by default the receiveSlot does not have any csi or member id
+      receiveSlot.findMemberId();
+
+      assert.notCalled(findMemberIdCallbackStub);
+    });
+
+    it('finds a member id if member id is undefined and CSI is known', () => {
+      // setup receiveSlot to have a csi without a member id
+      const csi = 12345;
+      fakeWcmeSlot.emit(WcmeReceiveSlotEvents.SourceUpdate, 'live', csi);
+      findMemberIdCallbackStub.reset();
+
+      receiveSlot.findMemberId();
+
+      assert.calledOnce(findMemberIdCallbackStub);
+      assert.calledWith(findMemberIdCallbackStub, csi);
+    });
+
+    it('doesn\'t do anything if member id already set', () => {
+      // setup receiveSlot to have a csi and a member id
+      const csi = 12345;
+      const memberId = '12345678-1234-5678-9012-345678901234';
+
+      findMemberIdCallbackStub.returns(memberId);
+
+      fakeWcmeSlot.emit(WcmeReceiveSlotEvents.SourceUpdate, 'live', csi);
+      findMemberIdCallbackStub.reset();
+
+      receiveSlot.findMemberId();
+
+      assert.notCalled(findMemberIdCallbackStub);
+    });
+  });
 });

package/test/unit/spec/multistream/receiveSlotManager.ts

@@ -1,6 +1,7 @@
 import sinon from 'sinon';
 import {assert} from '@webex/test-helper-chai';
 import {MediaType} from '@webex/internal-media-core';
+import {ReceiveSlot} from '@webex/plugin-meetings/src/multistream/receiveSlot';
 import {ReceiveSlotManager} from '@webex/plugin-meetings/src/multistream/receiveSlotManager';
 import * as ReceiveSlotModule from '@webex/plugin-meetings/src/multistream/receiveSlot';
 
@@ -30,6 +31,7 @@ describe('ReceiveSlotManager', () => {
       const fakeReceiveSlot = {
         id: `fake sdk receive slot ${fakeReceiveSlots.length + 1}`,
         mediaType,
+        findMemberId: sinon.stub(),
       };
 
       fakeReceiveSlots.push(fakeReceiveSlot);
@@ -170,4 +172,30 @@ describe('ReceiveSlotManager', () => {
       numFreeSlots: {'VIDEO-MAIN': 1},
     });
   });
+
+  describe('updateMemberIds', () => {
+
+    it('calls findMemberId() on all allocated receive slots', async () => {
+      const audioSlots: ReceiveSlot[] = [];
+      const videoSlots: ReceiveSlot[] = [];
+
+      // allocate a bunch of receive slots
+      audioSlots.push(await receiveSlotManager.allocateSlot(MediaType.AudioMain));
+      audioSlots.push(await receiveSlotManager.allocateSlot(MediaType.AudioMain));
+      videoSlots.push(await receiveSlotManager.allocateSlot(MediaType.VideoMain));
+      videoSlots.push(await receiveSlotManager.allocateSlot(MediaType.VideoMain));
+      videoSlots.push(await receiveSlotManager.allocateSlot(MediaType.VideoMain));
+
+      receiveSlotManager.updateMemberIds();
+
+      assert.strictEqual(audioSlots.length, 2);
+      assert.strictEqual(videoSlots.length, 3);
+
+      assert.strictEqual(fakeReceiveSlots.length, audioSlots.length + videoSlots.length);
+
+      fakeReceiveSlots.forEach(slot => {
+        assert.calledOnce(slot.findMemberId);
+      });
+    });
+  });
 });

package/test/utils/constants.js

@@ -0,0 +1,9 @@
+// MOVE TO TEST CONSTANTS
+export const MEDIA_SERVERS = {
+  // The homer media server for converged multistream meetings.
+  HOMER: 'homer',
+  // The linus media server
+  LINUS: 'linus',
+  // The calliope media server for transcoded meetings
+  CALLIOPE: 'calliope',
+};

package/test/utils/testUtils.js

@@ -195,12 +195,19 @@ const delayedTest = (callback, timeout) =>
     }, timeout);
   });
 
-const addMedia = (user) => {
-  const mediaReadyPromises = {
-    local: new Defer(),
-    remoteAudio: new Defer(),
-    remoteVideo: new Defer(),
-  };
+const addMedia = (user, options = {}) => {
+  const mediaReadyPromises = Array.isArray(options.expectedMediaReadyTypes)
+    ? options.expectedMediaReadyTypes.reduce((output, expectedMediaReadyType) => {
+      if (typeof expectedMediaReadyType !== 'string') {
+        return output;
+      }
+
+      output[expectedMediaReadyType] = new Defer();
+
+      return output;
+    }, {})
+    : {local: new Defer(), remoteAudio: new Defer(), remoteVideo: new Defer()};
+
   const mediaReady = (media) => {
     if (!media) {
       return;

package/test/utils/webex-config.js

@@ -57,6 +57,10 @@ Config.webex = {
       enabled: true,
     },
     enableRtx: true,
+    experimental: {
+      enableMediaNegotiatedEvent: true,
+      enableUnifiedMeetings: true,
+    },
   },
   people: {
     showAllTypes: true,

package/test/utils/webex-test-users.js

@@ -17,9 +17,11 @@ require('@webex/plugin-people');
 require('@webex/plugin-rooms');
 require('@webex/plugin-meetings');
 
-const generateTestUsers = (options) =>
-  testUser
-    .create({count: options.count})
+const generateTestUsers = (options = {}) => {
+  options.config = options.config || {};
+  options.config.orgId = options.config.orgId || process.env.WEBEX_CONVERGED_ORG_ID;
+
+  return testUser.create(options)
     .then(async (userSet) => {
       if (userSet.length !== options.count) {
         return Promise.reject(new Error('Test users not created'));
@@ -52,6 +54,7 @@ const generateTestUsers = (options) =>
     .catch((error) => {
       console.error('#generateTestUsers=>ERROR', error);
     });
+};
 
 const reserveCMR = (user) =>
   user.webex