@webex/plugin-meetings 3.8.0-next.33 → 3.8.0-next.35

package/dist/types/locus-info/index.d.ts

@@ -37,6 +37,7 @@ export default class LocusInfo extends EventsScope {
     services: any;
     resources: any;
     mainSessionLocusCache: any;
+    self: any;
     /**
      * Constructor
      * @param {function} updateMeeting callback to update the meeting object from an object

package/dist/types/meeting/index.d.ts

@@ -450,6 +450,12 @@ export default class Meeting extends StatelessWebexPlugin {
     allowMediaInLobby: boolean;
     localShareInstanceId: string;
     remoteShareInstanceId: string;
+    shareCAEventSentStatus: {
+        transmitStart: boolean;
+        transmitStop: boolean;
+        receiveStart: boolean;
+        receiveStop: boolean;
+    };
     turnDiscoverySkippedReason: TurnDiscoverySkipReason;
     turnServerUsed: boolean;
     areVoiceaEventsSetup: boolean;

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.33"
+  version: "3.8.0-next.35"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.8.0-next.33",
+    "@webex/plugin-meetings": "3.8.0-next.35",
     "@webex/plugin-rooms": "3.8.0-next.13",
     "@webex/test-helper-chai": "3.8.0-next.11",
     "@webex/test-helper-mocha": "3.8.0-next.11",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.0-next.11",
     "@webex/internal-plugin-support": "3.8.0-next.13",
     "@webex/internal-plugin-user": "3.8.0-next.11",
-    "@webex/internal-plugin-voicea": "3.8.0-next.33",
+    "@webex/internal-plugin-voicea": "3.8.0-next.35",
     "@webex/media-helpers": "3.8.0-next.12",
     "@webex/plugin-people": "3.8.0-next.13",
     "@webex/plugin-rooms": "3.8.0-next.13",
@@ -92,5 +92,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.33"
+  "version": "3.8.0-next.35"
 }

package/src/locus-info/controlsUtils.ts

@@ -1,5 +1,5 @@
 import {isEqual} from 'lodash';
-import {BREAKOUTS} from '../constants';
+import {BREAKOUTS, MEETING_STATE} from '../constants';
 
 const ControlsUtils: any = {};
 
@@ -242,30 +242,42 @@ ControlsUtils.isNeedReplaceMembers = (oldControls: any, controls: any) => {
   }
 
   return (
-    oldControls.breakout.groupId !== controls.breakout.groupId ||
-    oldControls.breakout.sessionId !== controls.breakout.sessionId
+    oldControls?.breakout?.groupId !== controls?.breakout?.groupId ||
+    oldControls?.breakout?.sessionId !== controls?.breakout?.sessionId
   );
 };
 
 /**
  * determine the switch status between breakout session and main session.
- * @param {LocusControls} oldControls
- * @param {LocusControls} controls
+ * @param {LocusInfo} oldLocus
+ * @param {LocusInfo} newLocus
  * @returns {Object}
  */
-ControlsUtils.getSessionSwitchStatus = (oldControls: any, controls: any) => {
+ControlsUtils.getSessionSwitchStatus = (oldLocus: any, newLocus: any) => {
   const status = {isReturnToMain: false, isJoinToBreakout: false};
   // no breakout case
-  if (!oldControls?.breakout || !controls?.breakout) {
+  if (!oldLocus.controls?.breakout || !newLocus.controls?.breakout) {
     return status;
   }
 
-  status.isReturnToMain =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+  // It is used to fix the timing issue triggered when the creator leaves session to ensure that the member list is complete
+  const needUseCache = !!(
+    oldLocus.self?.isCreator &&
+    newLocus.participants?.length === 1 &&
+    newLocus.participants?.[0].isCreator &&
+    newLocus.participants?.[0].state === MEETING_STATE.STATES.JOINED &&
+    newLocus.controls?.breakout?.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls?.breakout?.groups?.length
+  );
+
+  const isReturnToMain =
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+
+  status.isReturnToMain = needUseCache || isReturnToMain;
   status.isJoinToBreakout =
-    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
-    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+    oldLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    newLocus.controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
 
   return status;
 };

package/src/locus-info/index.ts

@@ -17,7 +17,9 @@ import {
   MEETING_REMOVED_REASON,
   CALL_REMOVED_REASON,
   RECORDING_STATE,
+  BREAKOUTS,
 } from '../constants';
+
 import InfoUtils from './infoUtils';
 import FullState from './fullState';
 import SelfUtils from './selfUtils';
@@ -67,6 +69,7 @@ export default class LocusInfo extends EventsScope {
   services: any;
   resources: any;
   mainSessionLocusCache: any;
+  self: any;
   /**
    * Constructor
    * @param {function} updateMeeting callback to update the meeting object from an object
@@ -1706,7 +1709,8 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   getTheLocusToUpdate(newLocus: any) {
-    const switchStatus = ControlsUtils.getSessionSwitchStatus(this.controls, newLocus?.controls);
+    const switchStatus = ControlsUtils.getSessionSwitchStatus(this, newLocus);
+
     if (switchStatus.isReturnToMain && this.mainSessionLocusCache) {
       return cloneDeep(this.mainSessionLocusCache);
     }

package/src/meeting/index.ts

@@ -647,6 +647,13 @@ export default class Meeting extends StatelessWebexPlugin {
   allowMediaInLobby: boolean;
   localShareInstanceId: string;
   remoteShareInstanceId: string;
+  shareCAEventSentStatus: {
+    transmitStart: boolean;
+    transmitStop: boolean;
+    receiveStart: boolean;
+    receiveStop: boolean;
+  };
+
   turnDiscoverySkippedReason: TurnDiscoverySkipReason;
   turnServerUsed: boolean;
   areVoiceaEventsSetup = false;
@@ -1419,6 +1426,19 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     this.remoteShareInstanceId = null;
 
+    /**
+     * Status used for ensuring we do not oversend metrics
+     * @instance
+     * @private
+     * @memberof Meeting
+     */
+    this.shareCAEventSentStatus = {
+      transmitStart: false,
+      transmitStop: false,
+      receiveStart: false,
+      receiveStop: false,
+    };
+
     /**
      * The class that helps to control recording functions: start, stop, pause, resume, etc
      * @instance
@@ -3023,6 +3043,8 @@ export default class Meeting extends StatelessWebexPlugin {
           case SHARE_STATUS.REMOTE_SHARE_ACTIVE: {
             const sendStartedSharingRemote = () => {
               this.remoteShareInstanceId = contentShare.shareInstanceId;
+              this.shareCAEventSentStatus.receiveStart = false;
+              this.shareCAEventSentStatus.receiveStop = false;
 
               Trigger.trigger(
                 this,
@@ -3076,6 +3098,7 @@ export default class Meeting extends StatelessWebexPlugin {
               },
               options: {meetingId: this.id},
             });
+
             break;
 
           case SHARE_STATUS.WHITEBOARD_SHARE_ACTIVE:
@@ -3116,6 +3139,8 @@ export default class Meeting extends StatelessWebexPlugin {
         // if we got here, then some remote participant has stolen
         // the presentation from another remote participant
         this.remoteShareInstanceId = contentShare.shareInstanceId;
+        this.shareCAEventSentStatus.receiveStart = false;
+        this.shareCAEventSentStatus.receiveStop = false;
 
         Trigger.trigger(
           this,
@@ -6771,30 +6796,42 @@ export default class Meeting extends StatelessWebexPlugin {
         EVENT_TRIGGERS.MEETING_MEDIA_LOCAL_STARTED,
         data
       );
-      // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent({
-        name: 'client.media.tx.start',
-        payload: {
-          mediaType: data.mediaType,
-          shareInstanceId: data.mediaType === 'share' ? this.localShareInstanceId : undefined,
-        },
-        options: {
-          meetingId: this.id,
-        },
-      });
+      if (data.mediaType !== 'share' || !this.shareCAEventSentStatus.transmitStart) {
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.media.tx.start',
+          payload: {
+            mediaType: data.mediaType,
+            shareInstanceId: data.mediaType === 'share' ? this.localShareInstanceId : undefined,
+          },
+          options: {
+            meetingId: this.id,
+          },
+        });
+
+        if (data.mediaType === 'share') {
+          this.shareCAEventSentStatus.transmitStart = true;
+        }
+      }
     });
     this.statsAnalyzer.on(StatsAnalyzerEventNames.LOCAL_MEDIA_STOPPED, (data) => {
-      // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent({
-        name: 'client.media.tx.stop',
-        payload: {
-          mediaType: data.mediaType,
-          shareInstanceId: data.mediaType === 'share' ? this.localShareInstanceId : undefined,
-        },
-        options: {
-          meetingId: this.id,
-        },
-      });
+      if (data.mediaType !== 'share' || !this.shareCAEventSentStatus.transmitStop) {
+        // @ts-ignore
+        this.webex.internal.newMetrics.submitClientEvent({
+          name: 'client.media.tx.stop',
+          payload: {
+            mediaType: data.mediaType,
+            shareInstanceId: data.mediaType === 'share' ? this.localShareInstanceId : undefined,
+          },
+          options: {
+            meetingId: this.id,
+          },
+        });
+
+        if (data.mediaType === 'share') {
+          this.shareCAEventSentStatus.transmitStop = true;
+        }
+      }
     });
     this.statsAnalyzer.on(StatsAnalyzerEventNames.REMOTE_MEDIA_STARTED, (data) => {
       Trigger.trigger(
@@ -6806,57 +6843,65 @@ export default class Meeting extends StatelessWebexPlugin {
         EVENT_TRIGGERS.MEETING_MEDIA_REMOTE_STARTED,
         data
       );
-      // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent({
-        name: 'client.media.rx.start',
-        payload: {
-          mediaType: data.mediaType,
-          shareInstanceId: data.mediaType === 'share' ? this.remoteShareInstanceId : undefined,
-        },
-        options: {
-          meetingId: this.id,
-        },
-      });
-
-      if (data.mediaType === 'share') {
+      if (data.mediaType !== 'share' || !this.shareCAEventSentStatus.receiveStart) {
         // @ts-ignore
         this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.media.render.start',
+          name: 'client.media.rx.start',
           payload: {
-            mediaType: 'share',
-            shareInstanceId: this.remoteShareInstanceId,
+            mediaType: data.mediaType,
+            shareInstanceId: data.mediaType === 'share' ? this.remoteShareInstanceId : undefined,
           },
           options: {
             meetingId: this.id,
           },
         });
+
+        if (data.mediaType === 'share') {
+          // @ts-ignore
+          this.webex.internal.newMetrics.submitClientEvent({
+            name: 'client.media.render.start',
+            payload: {
+              mediaType: 'share',
+              shareInstanceId: this.remoteShareInstanceId,
+            },
+            options: {
+              meetingId: this.id,
+            },
+          });
+
+          this.shareCAEventSentStatus.receiveStart = true;
+        }
       }
     });
     this.statsAnalyzer.on(StatsAnalyzerEventNames.REMOTE_MEDIA_STOPPED, (data) => {
-      // @ts-ignore
-      this.webex.internal.newMetrics.submitClientEvent({
-        name: 'client.media.rx.stop',
-        payload: {
-          mediaType: data.mediaType,
-          shareInstanceId: data.mediaType === 'share' ? this.remoteShareInstanceId : undefined,
-        },
-        options: {
-          meetingId: this.id,
-        },
-      });
-
-      if (data.mediaType === 'share') {
+      if (data.mediaType !== 'share' || !this.shareCAEventSentStatus.receiveStop) {
         // @ts-ignore
         this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.media.render.stop',
+          name: 'client.media.rx.stop',
           payload: {
-            mediaType: 'share',
-            shareInstanceId: this.remoteShareInstanceId,
+            mediaType: data.mediaType,
+            shareInstanceId: data.mediaType === 'share' ? this.remoteShareInstanceId : undefined,
           },
           options: {
             meetingId: this.id,
           },
         });
+
+        if (data.mediaType === 'share') {
+          // @ts-ignore
+          this.webex.internal.newMetrics.submitClientEvent({
+            name: 'client.media.render.stop',
+            payload: {
+              mediaType: 'share',
+              shareInstanceId: this.remoteShareInstanceId,
+            },
+            options: {
+              meetingId: this.id,
+            },
+          });
+
+          this.shareCAEventSentStatus.receiveStop = true;
+        }
       }
     });
   };
@@ -7077,6 +7122,12 @@ export default class Meeting extends StatelessWebexPlugin {
         networkQualityMonitor: this.networkQualityMonitor,
         isMultistream: this.isMultistream,
       });
+      this.shareCAEventSentStatus = {
+        transmitStart: false,
+        transmitStop: false,
+        receiveStart: false,
+        receiveStop: false,
+      };
       this.setupStatsAnalyzerEventHandlers();
       this.networkQualityMonitor.on(
         NetworkQualityEventNames.NETWORK_QUALITY,
@@ -9341,6 +9392,8 @@ export default class Meeting extends StatelessWebexPlugin {
 
     if (floorRequestNeeded) {
       this.localShareInstanceId = uuid.v4();
+      this.shareCAEventSentStatus.transmitStart = false;
+      this.shareCAEventSentStatus.transmitStop = false;
 
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({

package/test/unit/spec/locus-info/controlsUtils.js

@@ -1,6 +1,10 @@
 import {assert} from '@webex/test-helper-chai';
 import ControlsUtils from '@webex/plugin-meetings/src/locus-info/controlsUtils';
 import controlsUtils from "@webex/plugin-meetings/src/locus-info/controlsUtils";
+import {
+  MEETING_STATE,
+  BREAKOUTS,
+} from '../../../../src/constants';
 
 const defaultControls = {
   entryExitTone: {
@@ -432,28 +436,76 @@ describe('plugin-meetings', () => {
 
     describe('getSessionSwitchStatus', () => {
       it('if no breakout control, return switch status both false', () => {
-        const oldControls = {};
-        const newControls = {};
-        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldControls, newControls), {
+        const oldLocus = {};
+        const newLocus = {};
+        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
           isReturnToMain: false, isJoinToBreakout: false
         });
       });
 
       it('if switch session from breakout to main, return isReturnToMain as true', () => {
-        const oldControls = {breakout: {sessionType: 'BREAKOUT'}};
-        const newControls = {breakout: {sessionType: 'MAIN'}};
-        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldControls, newControls), {
+        const oldLocus = {controls: {breakout: {sessionType: 'BREAKOUT'}}};
+        const newLocus = {controls: {breakout: {sessionType: 'MAIN'}}};
+        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
           isReturnToMain: true, isJoinToBreakout: false
         });
       });
 
       it('if switch session from main to breakout, return isJoinToBreakout as true', () => {
-        const oldControls = {breakout: {sessionType: 'MAIN'}};
-        const newControls = {breakout: {sessionType: 'BREAKOUT'}};
-        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldControls, newControls), {
+        const oldLocus = {controls: {breakout: {sessionType: 'MAIN'}}};
+        const newLocus = {controls: {breakout: {sessionType: 'BREAKOUT'}}};
+        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
           isReturnToMain: false, isJoinToBreakout: true
         });
       });
+
+      it('if needUseCache conditions are met, return isJoinToBreakout as true', () => {
+        const oldLocus = {
+          self: { isCreator: true },
+          controls: { breakout: { sessionType: BREAKOUTS.SESSION_TYPES.MAIN} },
+        };
+    
+        const newLocus = {
+          participants: [
+            { isCreator: true, state: MEETING_STATE.STATES.JOINED }, 
+          ],
+          controls: {
+            breakout: {
+              sessionType: BREAKOUTS.SESSION_TYPES.MAIN, 
+              groups: [{ id: 'group1' }] 
+            },
+          },
+        };
+    
+        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
+          isReturnToMain: true, 
+          isJoinToBreakout: false
+        });
+      });
+    
+      it('if needUseCache conditions are not met, return newLocus and isReturnToMain as false', () => {
+        const oldLocus = {
+          self: { isCreator: false }, 
+          controls: { breakout: { sessionType: BREAKOUTS.SESSION_TYPES.BREAKOUT} },
+        };
+    
+        const newLocus = {
+          participants: [
+            { isCreator: true, state: MEETING_STATE.STATES.JOINED },
+          ],
+          controls: {
+            breakout: {
+              sessionType: BREAKOUTS.SESSION_TYPES.BREAKOUT,
+              groups: [] 
+            },
+          },
+        };
+    
+        assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
+          isReturnToMain: false, 
+          isJoinToBreakout: false
+        });
+      });
     });
 
     describe('#isMainSessionDTO', () => {