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

package/src/meeting/util.ts

@@ -575,7 +575,9 @@ const MeetingUtil = {
 
   canUserRenameOthers: (displayHints) => displayHints.includes(DISPLAY_HINTS.CAN_RENAME_OTHERS),
 
-  canShareWhiteBoard: (displayHints) => displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD),
+  canShareWhiteBoard: (displayHints, policies) =>
+    displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD) &&
+    !!policies[SELF_POLICY.SUPPORT_WHITEBOARD],
 
   /**
    * Adds the current locus sequence information to a request body

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);
@@ -10684,6 +10841,11 @@ describe('plugin-meetings', () => {
               requiredDisplayHints: [],
               requiredPolicies: [SELF_POLICY.SUPPORT_POLLING_AND_QA],
             },
+            {
+              actionName: 'canShareWhiteBoard',
+              requiredDisplayHints: [DISPLAY_HINTS.SHARE_WHITEBOARD],
+              requiredPolicies: [SELF_POLICY.SUPPORT_WHITEBOARD],
+            },
           ],
           ({
             actionName,
@@ -11092,7 +11254,7 @@ describe('plugin-meetings', () => {
           assert.calledWith(canSendReactionsSpy, null, userDisplayHints);
           assert.calledWith(canUserRenameSelfAndObservedSpy, userDisplayHints);
           assert.calledWith(canUserRenameOthersSpy, userDisplayHints);
-          assert.calledWith(canShareWhiteBoardSpy, userDisplayHints);
+          assert.calledWith(canShareWhiteBoardSpy, userDisplayHints, selfUserPolicies);
 
           assert.calledWith(ControlsOptionsUtil.hasHints, {
             requiredHints: [DISPLAY_HINTS.MUTE_ALL],
@@ -12032,6 +12194,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 +12219,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);
             });
           });
 

package/test/unit/spec/meeting/utils.js

@@ -66,7 +66,7 @@ describe('plugin-meetings', () => {
 
     describe('#cleanup', () => {
       it('do clean up on meeting object with LLM enabled', async () => {
-        meeting.config = {enableAutomaticLLM : true};
+        meeting.config = {enableAutomaticLLM: true};
         await MeetingUtil.cleanUp(meeting);
         assert.calledOnce(meeting.cleanupLocalStreams);
         assert.calledOnce(meeting.closeRemoteStreams);
@@ -84,7 +84,7 @@ describe('plugin-meetings', () => {
       });
 
       it('do clean up on meeting object with LLM disabled', async () => {
-        meeting.config = {enableAutomaticLLM : false};
+        meeting.config = {enableAutomaticLLM: false};
         await MeetingUtil.cleanUp(meeting);
         assert.calledOnce(meeting.cleanupLocalStreams);
         assert.calledOnce(meeting.closeRemoteStreams);
@@ -392,8 +392,7 @@ describe('plugin-meetings', () => {
           meetingJoinUrl: 'meetingJoinUrl',
           locusUrl: 'locusUrl',
           meetingRequest: {
-            joinMeeting: sinon.stub().returns(
-              Promise.resolve(joinMeetingResponse)),
+            joinMeeting: sinon.stub().returns(Promise.resolve(joinMeetingResponse)),
           },
           getWebexObject: sinon.stub().returns(webex),
           setLocus: sinon.stub(),
@@ -410,23 +409,29 @@ describe('plugin-meetings', () => {
           id: 'fake client media preferences',
         };
 
-        webex.meetings.reachability.getReachabilityReportToAttachToRoap.resolves(FAKE_REACHABILITY_REPORT);
-        webex.meetings.reachability.getClientMediaPreferences.resolves(FAKE_CLIENT_MEDIA_PREFERENCES);
+        webex.meetings.reachability.getReachabilityReportToAttachToRoap.resolves(
+          FAKE_REACHABILITY_REPORT
+        );
+        webex.meetings.reachability.getClientMediaPreferences.resolves(
+          FAKE_CLIENT_MEDIA_PREFERENCES
+        );
 
-        sinon
-          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4')
-          .get(() => true);
-        sinon
-          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6')
-          .get(() => true);
+        sinon.stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4').get(() => true);
+        sinon.stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6').get(() => true);
 
         await MeetingUtil.joinMeeting(meeting, {
           reachability: 'reachability',
           roapMessage: 'roapMessage',
         });
 
-        assert.calledOnceWithExactly(webex.meetings.reachability.getReachabilityReportToAttachToRoap);
-        assert.calledOnceWithExactly(webex.meetings.reachability.getClientMediaPreferences, meeting.isMultistream, IP_VERSION.ipv4_and_ipv6);
+        assert.calledOnceWithExactly(
+          webex.meetings.reachability.getReachabilityReportToAttachToRoap
+        );
+        assert.calledOnceWithExactly(
+          webex.meetings.reachability.getClientMediaPreferences,
+          meeting.isMultistream,
+          IP_VERSION.ipv4_and_ipv6
+        );
 
         assert.calledOnce(meeting.meetingRequest.joinMeeting);
         const parameter = meeting.meetingRequest.joinMeeting.getCall(0).args[0];
@@ -436,9 +441,9 @@ describe('plugin-meetings', () => {
         assert.equal(parameter.clientMediaPreferences, FAKE_CLIENT_MEDIA_PREFERENCES);
         assert.equal(parameter.roapMessage, 'roapMessage');
 
-        assert.calledOnce(meeting.setLocus)
+        assert.calledOnce(meeting.setLocus);
         const setLocusParameter = meeting.setLocus.getCall(0).args[0];
-        assert.deepEqual(setLocusParameter, MeetingUtil.parseLocusJoin(joinMeetingResponse))
+        assert.deepEqual(setLocusParameter, MeetingUtil.parseLocusJoin(joinMeetingResponse));
 
         assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
           name: 'client.locus.join.request',
@@ -460,7 +465,6 @@ describe('plugin-meetings', () => {
         });
       });
 
-
       it('#Should call `meetingRequest.joinMeeting and handle a date header in the response : isoLocalClientMeetingJoinedTime', async () => {
         meeting.isMultistream = true;
 
@@ -471,30 +475,30 @@ describe('plugin-meetings', () => {
           id: 'fake client media preferences',
         };
 
-        webex.meetings.reachability.getReachabilityReportToAttachToRoap.resolves(FAKE_REACHABILITY_REPORT);
-        webex.meetings.reachability.getClientMediaPreferences.resolves(FAKE_CLIENT_MEDIA_PREFERENCES);
+        webex.meetings.reachability.getReachabilityReportToAttachToRoap.resolves(
+          FAKE_REACHABILITY_REPORT
+        );
+        webex.meetings.reachability.getClientMediaPreferences.resolves(
+          FAKE_CLIENT_MEDIA_PREFERENCES
+        );
 
-        sinon
-          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4')
-          .get(() => true);
-        sinon
-          .stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6')
-          .get(() => true);
+        sinon.stub(webex.internal.device.ipNetworkDetector, 'supportsIpV4').get(() => true);
+        sinon.stub(webex.internal.device.ipNetworkDetector, 'supportsIpV6').get(() => true);
 
         meeting.meetingRequest.joinMeeting.resolves({
           headers: {
-            date: 'test'
+            date: 'test',
           },
           body: {
             mediaConnections: [{mediaId: 'test'}],
             locus: {
               url: 'test',
               self: {
-                id: 'test'
-              }
-            }
-          }
-        })
+                id: 'test',
+              },
+            },
+          },
+        });
 
         await MeetingUtil.joinMeeting(meeting, {
           reachability: 'reachability',
@@ -749,8 +753,30 @@ describe('plugin-meetings', () => {
 
     describe('canShareWhiteBoard', () => {
       it('works as expected', () => {
-        assert.deepEqual(MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD']), true);
-        assert.deepEqual(MeetingUtil.canShareWhiteBoard([]), false);
+        assert.deepEqual(
+          MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD'], {
+            [SELF_POLICY.SUPPORT_WHITEBOARD]: true,
+          }),
+          true
+        );
+        assert.deepEqual(
+          MeetingUtil.canShareWhiteBoard([], {
+            [SELF_POLICY.SUPPORT_WHITEBOARD]: true,
+          }),
+          false
+        );
+        assert.deepEqual(
+          MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD'], {
+            [SELF_POLICY.SUPPORT_WHITEBOARD]: false,
+          }),
+          false
+        );
+        assert.deepEqual(
+          MeetingUtil.canShareWhiteBoard([], {
+            [SELF_POLICY.SUPPORT_WHITEBOARD]: false,
+          }),
+          false
+        );
       });
     });