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

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.34"
+  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.34",
+    "@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.34",
+    "@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.34"
+  "version": "3.8.0-next.35"
 }

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/meeting/index.js

@@ -115,9 +115,9 @@ import {ERROR_DESCRIPTIONS} from '@webex/internal-plugin-metrics/src/call-diagno
 import MeetingCollection from '@webex/plugin-meetings/src/meetings/collection';
 
 import {EVENT_TRIGGERS as VOICEAEVENTS} from '@webex/internal-plugin-voicea';
-import { createBrbState } from '@webex/plugin-meetings/src/meeting/brbState';
+import {createBrbState} from '@webex/plugin-meetings/src/meeting/brbState';
 import JoinForbiddenError from '../../../../src/common/errors/join-forbidden-error';
-import { EventEmitter } from 'stream';
+import {EventEmitter} from 'stream';
 
 describe('plugin-meetings', () => {
   const logger = {
@@ -282,7 +282,7 @@ describe('plugin-meetings', () => {
     testDestination = `testDestination-${uuid.v4()}`;
     correlationId = uuid.v4();
     uploadEvent = new EventEmitter();
-    uploadEvent.addListener('progress', () => {})
+    uploadEvent.addListener('progress', () => {});
 
     meeting = new Meeting(
       {
@@ -3436,6 +3436,40 @@ describe('plugin-meetings', () => {
             });
           });
 
+          it('LOCAL_MEDIA_STARTED triggers "meeting:media:local:start" event and does not send metric because we already have', async () => {
+            meeting.shareCAEventSentStatus = {
+              transmitStart: true,
+              transmitStop: false,
+              receiveStart: false,
+              receiveStop: false,
+            };
+            statsAnalyzerStub.emit(
+              {file: 'test', function: 'test'},
+              StatsAnalyzerEventNames.LOCAL_MEDIA_STARTED,
+              {mediaType: 'share'}
+            );
+
+            assert.calledWith(
+              TriggerProxy.trigger,
+              sinon.match.instanceOf(Meeting),
+              {
+                file: 'meeting/index',
+                function: 'addMedia',
+              },
+              EVENT_TRIGGERS.MEETING_MEDIA_LOCAL_STARTED,
+              {
+                mediaType: 'share',
+              }
+            );
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.tx.start',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+          });
+
           it('LOCAL_MEDIA_STOPPED triggers the right metrics', async () => {
             statsAnalyzerStub.emit(
               {file: 'test', function: 'test'},
@@ -3452,6 +3486,28 @@ describe('plugin-meetings', () => {
             });
           });
 
+          it('LOCAL_MEDIA_STOPPED does not send metric because we already have', async () => {
+            meeting.shareCAEventSentStatus = {
+              transmitStart: false,
+              transmitStop: true,
+              receiveStart: false,
+              receiveStop: false,
+            };
+            statsAnalyzerStub.emit(
+              {file: 'test', function: 'test'},
+              StatsAnalyzerEventNames.LOCAL_MEDIA_STOPPED,
+              {mediaType: 'share'}
+            );
+
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.tx.stop',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+          });
+
           it('REMOTE_MEDIA_STARTED triggers "meeting:media:remote:start" event and sends metrics', async () => {
             statsAnalyzerStub.emit(
               {file: 'test', function: 'test'},
@@ -3532,6 +3588,47 @@ describe('plugin-meetings', () => {
             });
           });
 
+          it('REMOTE_MEDIA_STARTED triggers "meeting:media:remote:start" event and does not send metric because we already have', async () => {
+            meeting.shareCAEventSentStatus = {
+              transmitStart: false,
+              transmitStop: false,
+              receiveStart: true,
+              receiveStop: false,
+            };
+            statsAnalyzerStub.emit(
+              {file: 'test', function: 'test'},
+              StatsAnalyzerEventNames.REMOTE_MEDIA_STARTED,
+              {mediaType: 'share'}
+            );
+
+            assert.calledWith(
+              TriggerProxy.trigger,
+              sinon.match.instanceOf(Meeting),
+              {
+                file: 'meeting/index',
+                function: 'addMedia',
+              },
+              EVENT_TRIGGERS.MEETING_MEDIA_REMOTE_STARTED,
+              {
+                mediaType: 'share',
+              }
+            );
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.render.start',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.rx.start',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+          });
+
           it('REMOTE_MEDIA_STOPPED triggers the right metrics for share', async () => {
             statsAnalyzerStub.emit(
               {file: 'test', function: 'test'},
@@ -3556,6 +3653,34 @@ describe('plugin-meetings', () => {
             });
           });
 
+          it('REMOTE_MEDIA_STOPPED does not send metric because we already have', async () => {
+            meeting.shareCAEventSentStatus = {
+              transmitStart: false,
+              transmitStop: false,
+              receiveStart: true,
+              receiveStop: true,
+            };
+            statsAnalyzerStub.emit(
+              {file: 'test', function: 'test'},
+              StatsAnalyzerEventNames.REMOTE_MEDIA_STOPPED,
+              {mediaType: 'share'}
+            );
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.render.stop',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+            assert.neverCalledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.media.rx.stop',
+              payload: {mediaType: 'share', shareInstanceId: meeting.remoteShareInstanceId},
+              options: {
+                meetingId: meeting.id,
+              },
+            });
+          });
+
           it('counts the number of members that are in the meeting for MEDIA_QUALITY event', async () => {
             let fakeMembersCollection = {
               members: {
@@ -3884,20 +4009,24 @@ describe('plugin-meetings', () => {
             } catch (err) {
               assert.instanceOf(err, Error);
               assert.equal(err.message, 'setBrb failed');
-              assert.isRejected((Promise.reject()));
+              assert.isRejected(Promise.reject());
             }
           });
 
           it('updates remote mute state when brb is enabled', async () => {
-            meeting.audio = { handleServerRemoteMuteUpdate: sinon.stub() };
+            meeting.audio = {handleServerRemoteMuteUpdate: sinon.stub()};
 
             await meeting.beRightBack(true);
 
-            sinon.assert.calledOnceWithExactly(meeting.audio.handleServerRemoteMuteUpdate, meeting, true);
+            sinon.assert.calledOnceWithExactly(
+              meeting.audio.handleServerRemoteMuteUpdate,
+              meeting,
+              true
+            );
           });
 
           it('does not update remote mute state when brb is disabled', async () => {
-            meeting.audio = { handleServerRemoteMuteUpdate: sinon.stub() };
+            meeting.audio = {handleServerRemoteMuteUpdate: sinon.stub()};
 
             await meeting.beRightBack(false);
 
@@ -3956,7 +4085,10 @@ describe('plugin-meetings', () => {
               .resolves({id: 'fake clientMediaPreferences'});
             meeting.roap.doTurnDiscovery = sinon.stub().resolves({
               turnServerInfo: {
-                urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
+                urls: [
+                  'turns:turn-server-url1:443?transport=tcp',
+                  'turns:turn-server-url2:443?transport=tcp',
+                ],
                 username: 'turn user',
                 password: 'turn password',
               },
@@ -3974,7 +4106,10 @@ describe('plugin-meetings', () => {
             expectedMediaConnectionConfig = {
               iceServers: [
                 {
-                  urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
+                  urls: [
+                    'turns:turn-server-url1:443?transport=tcp',
+                    'turns:turn-server-url2:443?transport=tcp',
+                  ],
                   username: 'turn user',
                   credential: 'turn password',
                 },
@@ -4056,9 +4191,11 @@ describe('plugin-meetings', () => {
               .stub(InternalMediaCoreModule, 'MultistreamRoapMediaConnection')
               .returns(fakeMultistreamRoapMediaConnection);
 
-            locusMediaRequestStub = sinon
-              .stub(WebexPlugin.prototype, 'request')
-              .resolves({body: {locus: {fullState: {}}}, upload: sinon.match.instanceOf(EventEmitter), download: sinon.match.instanceOf(EventEmitter)});
+            locusMediaRequestStub = sinon.stub(WebexPlugin.prototype, 'request').resolves({
+              body: {locus: {fullState: {}}},
+              upload: sinon.match.instanceOf(EventEmitter),
+              download: sinon.match.instanceOf(EventEmitter),
+            });
 
             // setup some things and mocks so that the call to join() works
             // (we need to call join() because it creates the LocusMediaRequest instance
@@ -5242,7 +5379,10 @@ describe('plugin-meetings', () => {
                 // and check that when we fallback to transcoded we still do another TURN discovery
                 await runCheck(
                   {
-                    urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
+                    urls: [
+                      'turns:turn-server-url1:443?transport=tcp',
+                      'turns:turn-server-url2:443?transport=tcp',
+                    ],
                     username: 'turn user',
                     password: 'turn password',
                   },
@@ -5256,7 +5396,10 @@ describe('plugin-meetings', () => {
                 // but doing it just for completeness
                 await runCheck(
                   {
-                    urls: ['turns:turn-server-url1:443?transport=tcp', 'turns:turn-server-url2:443?transport=tcp'],
+                    urls: [
+                      'turns:turn-server-url1:443?transport=tcp',
+                      'turns:turn-server-url2:443?transport=tcp',
+                    ],
                     username: 'turn user',
                     password: 'turn password',
                   },
@@ -7640,6 +7783,12 @@ describe('plugin-meetings', () => {
           meeting.audio = {handleLocalStreamChange: sinon.stub()};
           meeting.video = {handleLocalStreamChange: sinon.stub()};
           meeting.statsAnalyzer = {updateMediaStatus: sinon.stub()};
+          meeting.shareCAEventSentStatus = {
+            transmitStart: false,
+            transmitStop: false,
+            receiveStart: false,
+            receiveStop: false,
+          };
           fakeMultistreamRoapMediaConnection = {
             createSendSlot: () => {
               return {
@@ -7707,6 +7856,9 @@ describe('plugin-meetings', () => {
             });
             assert.equal(meeting.mediaProperties.mediaDirection.sendShare, true);
 
+            assert.equal(meeting.shareCAEventSentStatus.transmitStart, false);
+            assert.equal(meeting.shareCAEventSentStatus.transmitStop, false);
+
             assert.calledWith(meeting.statsAnalyzer.updateMediaStatus, {
               expected: {sendShare: true},
             });
@@ -7727,18 +7879,23 @@ describe('plugin-meetings', () => {
             assert.equal(meeting.mediaProperties.shareAudioStream, stream);
             assert.equal(meeting.mediaProperties.mediaDirection.sendShare, true);
 
+            assert.equal(meeting.shareCAEventSentStatus.transmitStart, false);
+            assert.equal(meeting.shareCAEventSentStatus.transmitStop, false);
+
             assert.calledWith(meeting.statsAnalyzer.updateMediaStatus, {
               expected: {sendShare: true},
             });
           };
 
           it('requests screen share floor and publishes the screen share video stream', async () => {
+            meeting.shareCAEventSentStatus.transmitStart = true;
             await meeting.publishStreams({screenShare: {video: videoShareStream}});
 
             checkScreenShareVideoPublished(videoShareStream);
           });
 
           it('requests screen share floor and publishes the screen share audio stream', async () => {
+            meeting.shareCAEventSentStatus.transmitStart = true;
             await meeting.publishStreams({screenShare: {audio: audioShareStream}});
 
             checkScreenShareAudioPublished(audioShareStream);
@@ -12032,6 +12189,8 @@ describe('plugin-meetings', () => {
               // Set the webinar attendee flag
               meeting.webinar = {selfIsAttendee: true};
               meeting.locusInfo.info.isWebinar = true;
+              meeting.shareCAEventSentStatus.receiveStart = true;
+              meeting.shareCAEventSentStatus.receiveStop = true;
 
               // Step 1: Start sharing whiteboard A
               const data1 = generateData(
@@ -12055,6 +12214,8 @@ describe('plugin-meetings', () => {
 
               // Specific assertions for webinar attendee status
               assert.equal(meeting.shareStatus, SHARE_STATUS.REMOTE_SHARE_ACTIVE);
+              assert.equal(meeting.shareCAEventSentStatus.receiveStart, false);
+              assert.equal(meeting.shareCAEventSentStatus.receiveStop, false);
             });
           });