@webex/plugin-meetings 3.7.0-web-workers-keepalive.1 → 3.7.0-wxcc.1

package/src/meetings/index.ts

@@ -1,5 +1,5 @@
 /* eslint no-shadow: ["error", { "allow": ["eventType"] }] */
-import {cloneDeep} from 'lodash';
+import {cloneDeep, clone} from 'lodash';
 import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 import '@webex/internal-plugin-metrics';
@@ -42,6 +42,7 @@ import {
   _ON_HOLD_LOBBY_,
   _WAIT_,
   DESTINATION_TYPE,
+  INITIAL_REGISTRATION_STATUS,
 } from '../constants';
 import BEHAVIORAL_METRICS from '../metrics/constants';
 import MeetingInfo from '../meeting-info';
@@ -53,12 +54,18 @@ import Request from './request';
 import PasswordError from '../common/errors/password-error';
 import CaptchaError from '../common/errors/captcha-error';
 import MeetingCollection from './collection';
-import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
+import {
+  MEETING_KEY,
+  INoiseReductionEffect,
+  IVirtualBackgroundEffect,
+  MeetingRegistrationStatus,
+} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
 import JoinWebinarError from '../common/errors/join-webinar-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
+import JoinForbiddenError from '../common/errors/join-forbidden-error';
 
 let mediaLogger;
 
@@ -179,6 +186,7 @@ export default class Meetings extends WebexPlugin {
   mediaHelpers: any;
   breakoutLocusForHandleLater: any;
   namespace = MEETINGS;
+  registrationStatus: MeetingRegistrationStatus;
 
   /**
    * Initializes the Meetings Plugin
@@ -692,6 +700,20 @@ export default class Meetings extends WebexPlugin {
     });
   }
 
+  /**
+   * API to change log upload interval. Setting the factor to 0 will disable periodic log uploads.
+   *
+   * @param {number} factor new factor value
+   * @returns {void}
+   */
+  private _setLogUploadIntervalMultiplicationFactor(factor: number) {
+    if (typeof factor !== 'number') {
+      return;
+    }
+    // @ts-ignore
+    this.config.logUploadIntervalMultiplicationFactor = factor;
+  }
+
   /**
    * API to toggle unified meetings
    * @param {Boolean} changeState
@@ -785,6 +807,18 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * Executes a registration step and updates the registration status.
+   * @param {Function} step - The registration step to execute.
+   * @param {string} stepName - The name of the registration step.
+   * @returns {Promise} A promise that resolves when the step is completed.
+   */
+  executeRegistrationStep(step: () => Promise<any>, stepName: string) {
+    return step().then(() => {
+      this.registrationStatus[stepName] = true;
+    });
+  }
+
   /**
    * Explicitly sets up the meetings plugin by registering
    * the device, connecting to mercury, and listening for locus events.
@@ -795,6 +829,8 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   public register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any> {
+    this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
+
     // @ts-ignore
     if (!this.webex.canAuthorize) {
       LoggerProxy.logger.error(
@@ -813,24 +849,39 @@ export default class Meetings extends WebexPlugin {
     }
 
     return Promise.all([
-      this.fetchUserPreferredWebexSite(),
-      this.getGeoHint(),
-      this.startReachability('registration').catch((error) => {
-        LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
-      }),
-      // @ts-ignore
-      this.webex.internal.device
-        .register(deviceRegistrationOptions)
-        // @ts-ignore
-        .then(() =>
-          LoggerProxy.logger.info(
+      this.executeRegistrationStep(() => this.fetchUserPreferredWebexSite(), 'fetchWebexSite'),
+      this.executeRegistrationStep(() => this.getGeoHint(), 'getGeoHint'),
+      this.executeRegistrationStep(
+        () =>
+          this.startReachability('registration').catch((error) => {
+            LoggerProxy.logger.error(`Meetings:index#register --> GDM error, ${error.message}`);
+          }),
+        'startReachability'
+      ),
+      this.executeRegistrationStep(
+        () =>
+          // @ts-ignore
+          this.webex.internal.device
+            .register(deviceRegistrationOptions)
             // @ts-ignore
-            `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
-          )
+            .then(() => {
+              LoggerProxy.logger.info(
+                // @ts-ignore
+                `Meetings:index#register --> INFO, Device registered ${this.webex.internal.device.url}`
+              );
+            }),
+        'deviceRegister'
+      ).then(() =>
+        this.executeRegistrationStep(
+          // @ts-ignore
+          () => this.webex.internal.mercury.connect(),
+          'mercuryConnect'
         )
-        // @ts-ignore
-        .then(() => this.webex.internal.mercury.connect()),
-      MeetingsUtil.checkH264Support.call(this),
+      ),
+      this.executeRegistrationStep(
+        () => Promise.resolve(MeetingsUtil.checkH264Support.call(this)),
+        'checkH264Support'
+      ),
     ])
       .then(() => {
         this.listenForEvents();
@@ -894,6 +945,7 @@ export default class Meetings extends WebexPlugin {
             EVENT_TRIGGERS.MEETINGS_UNREGISTERED
           );
           this.registered = false;
+          this.registrationStatus = clone(INITIAL_REGISTRATION_STATUS);
         })
     );
   }
@@ -1412,7 +1464,8 @@ export default class Meetings extends WebexPlugin {
         !(err instanceof CaptchaError) &&
         !(err instanceof PasswordError) &&
         !(err instanceof PermissionError) &&
-        !(err instanceof JoinWebinarError)
+        !(err instanceof JoinWebinarError) &&
+        !(err instanceof JoinForbiddenError)
       ) {
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`

package/src/meetings/meetings.types.ts

@@ -21,3 +21,13 @@ export const MEETING_KEY = {
 } as const;
 
 export type MEETING_KEY = Enum<typeof MEETING_KEY>;
+
+// finer grained status for registration steps
+export type MeetingRegistrationStatus = {
+  fetchWebexSite: boolean;
+  getGeoHint: boolean;
+  startReachability: boolean;
+  deviceRegister: boolean;
+  mercuryConnect: boolean;
+  checkH264Support: boolean;
+};

package/src/metrics/constants.ts

@@ -73,6 +73,7 @@ const BEHAVIORAL_METRICS = {
   JOIN_WEBINAR_ERROR: 'js_sdk_join_webinar_error',
   GUEST_ENTERED_LOBBY: 'js_sdk_guest_entered_lobby',
   GUEST_EXITED_LOBBY: 'js_sdk_guest_exited_lobby',
+  JOIN_FORBIDDEN_ERROR: 'js_sdk_join_forbidden_error',
 };
 
 export {BEHAVIORAL_METRICS as default};

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

@@ -1,6 +1,6 @@
 import 'jsdom-global/register';
 import sinon from 'sinon';
-import {cloneDeep} from 'lodash';
+import {cloneDeep, forEach} from 'lodash';
 import {assert} from '@webex/test-helper-chai';
 import MockWebex from '@webex/test-helper-mock-webex';
 import testUtils from '../../../utils/testUtils';
@@ -23,6 +23,8 @@ import {
   LOCUS,
   MEETING_STATE,
   _MEETING_,
+  _SIP_BRIDGE_,
+  _SPACE_SHARE_,
 } from '../../../../src/constants';
 
 import {self, selfWithInactivity} from './selfConstant';
@@ -102,7 +104,11 @@ describe('plugin-meetings', () => {
           },
           entryExitTone: {enabled: true, mode: 'foo'},
           video: {enabled: true},
-          videoLayout: {overrideDefault: true, lockAttendeeViewOnStageOnly:false, stageParameters: {}},
+          videoLayout: {
+            overrideDefault: true,
+            lockAttendeeViewOnStageOnly: false,
+            stageParameters: {},
+          },
           webcastControl: {streaming: false},
           practiceSession: {enabled: true},
         };
@@ -529,7 +535,7 @@ describe('plugin-meetings', () => {
           manualCaptionControl: {enabled: false},
         };
 
-        locusInfo.updateControls({manualCaptionControl: { enabled: true, }});
+        locusInfo.updateControls({manualCaptionControl: {enabled: true}});
 
         assert.calledWith(
           locusInfo.emitScoped,
@@ -2636,65 +2642,69 @@ describe('plugin-meetings', () => {
     });
 
     describe('#isMeetingActive', () => {
-      it('sends client event correctly for state = inactive', () => {
-        locusInfo.parsedLocus = {
-          fullState: {
-            type: _CALL_,
-          },
-        };
-
-        locusInfo.fullState = {
-          state: LOCUS.STATE.INACTIVE,
-        };
-
-        locusInfo.isMeetingActive();
-
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.call.remote-ended',
-          options: {
-            meetingId: locusInfo.meetingId,
-          },
-        });
-      });
-
-      it('sends client event correctly for state = PARTNER_LEFT', () => {
-        locusInfo.getLocusPartner = sinon.stub().returns({state: MEETING_STATE.STATES.LEFT});
-        locusInfo.parsedLocus = {
-          fullState: {
-            type: _CALL_,
-          },
-          self: {
-            state: MEETING_STATE.STATES.DECLINED,
-          },
-        };
-        locusInfo.isMeetingActive();
-
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.call.remote-ended',
-          options: {
-            meetingId: locusInfo.meetingId,
-          },
-        });
-      });
-
-      it('sends client event correctly for state = SELF_LEFT', () => {
-        locusInfo.getLocusPartner = sinon.stub().returns({state: MEETING_STATE.STATES.LEFT});
-        locusInfo.parsedLocus = {
-          fullState: {
-            type: _CALL_,
-          },
-          self: {
-            state: MEETING_STATE.STATES.LEFT,
-          },
-        };
+      forEach([_CALL_, _SIP_BRIDGE_, _SPACE_SHARE_], (type) => {
+        describe(`type = ${type}`, () => {
+          it('sends client event correctly for state = inactive', () => {
+            locusInfo.parsedLocus = {
+              fullState: {
+                type: type,
+              },
+            };
+
+            locusInfo.fullState = {
+              state: LOCUS.STATE.INACTIVE,
+            };
+
+            locusInfo.isMeetingActive();
+
+            assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.remote-ended',
+              options: {
+                meetingId: locusInfo.meetingId,
+              },
+            });
+          });
 
-        locusInfo.isMeetingActive();
+          it('sends client event correctly for state = PARTNER_LEFT', () => {
+            locusInfo.getLocusPartner = sinon.stub().returns({state: MEETING_STATE.STATES.LEFT});
+            locusInfo.parsedLocus = {
+              fullState: {
+                type: type,
+              },
+              self: {
+                state: MEETING_STATE.STATES.DECLINED,
+              },
+            };
+            locusInfo.isMeetingActive();
+
+            assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.remote-ended',
+              options: {
+                meetingId: locusInfo.meetingId,
+              },
+            });
+          });
 
-        assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
-          name: 'client.call.remote-ended',
-          options: {
-            meetingId: locusInfo.meetingId,
-          },
+          it('sends client event correctly for state = SELF_LEFT', () => {
+            locusInfo.getLocusPartner = sinon.stub().returns({state: MEETING_STATE.STATES.LEFT});
+            locusInfo.parsedLocus = {
+              fullState: {
+                type: type,
+              },
+              self: {
+                state: MEETING_STATE.STATES.LEFT,
+              },
+            };
+
+            locusInfo.isMeetingActive();
+
+            assert.calledWith(webex.internal.newMetrics.submitClientEvent, {
+              name: 'client.call.remote-ended',
+              options: {
+                meetingId: locusInfo.meetingId,
+              },
+            });
+          });
         });
       });
 

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -42,6 +42,7 @@ describe('plugin-meetings', () => {
         waitingForOthersToJoin: null,
         canSendReactions: null,
         canManageBreakout: null,
+        canStartBreakout: null,
         canBroadcastMessageToBreakout: null,
         canAdmitLobbyToBreakout: null,
         canUserAskForHelp: null,
@@ -141,6 +142,7 @@ describe('plugin-meetings', () => {
       'waitingForOthersToJoin',
       'canSendReactions',
       'canManageBreakout',
+      'canStartBreakout',
       'canBroadcastMessageToBreakout',
       'canAdmitLobbyToBreakout',
       'canUserAskForHelp',

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

@@ -99,7 +99,7 @@ import {
   MeetingInfoV2CaptchaError,
   MeetingInfoV2PasswordError,
   MeetingInfoV2PolicyError,
-  MeetingInfoV2JoinWebinarError,
+  MeetingInfoV2JoinWebinarError, MeetingInfoV2JoinForbiddenError,
 } from '../../../../src/meeting-info/meeting-info-v2';
 import {
   DTLS_HANDSHAKE_FAILED_CLIENT_CODE,
@@ -114,6 +114,7 @@ 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 JoinForbiddenError               from '../../../../src/common/errors/join-forbidden-error';
 
 describe('plugin-meetings', () => {
   const logger = {
@@ -6339,6 +6340,38 @@ describe('plugin-meetings', () => {
           assert.equal(meeting.passwordStatus, PASSWORD_STATUS.REQUIRED);
         });
 
+        it('handles meetingInfoProvider not reach JBH', async () => {
+          meeting.destination = FAKE_DESTINATION;
+          meeting.destinationType = FAKE_TYPE;
+          meeting.attrs.meetingInfoProvider = {
+            fetchMeetingInfo: sinon
+              .stub()
+              .throws(new MeetingInfoV2JoinForbiddenError(403003, FAKE_MEETING_INFO)),
+          };
+
+          await assert.isRejected(meeting.fetchMeetingInfo({sendCAevents: true}), JoinForbiddenError);
+
+          assert.calledWith(
+            meeting.attrs.meetingInfoProvider.fetchMeetingInfo,
+            FAKE_DESTINATION,
+            FAKE_TYPE,
+            null,
+            null,
+            undefined,
+            'locus-id',
+            {},
+            {meetingId: meeting.id, sendCAevents: true}
+          );
+
+          assert.deepEqual(meeting.meetingInfo, FAKE_MEETING_INFO);
+          assert.equal(meeting.meetingInfoFailureCode, 403003);
+          assert.equal(
+            meeting.meetingInfoFailureReason,
+            MEETING_INFO_FAILURE_REASON.NOT_REACH_JBH
+          );
+          assert.equal(meeting.requiredCaptcha, null);
+        });
+
         it('handles meetingInfoProvider policy error', async () => {
           meeting.destination = FAKE_DESTINATION;
           meeting.destinationType = FAKE_TYPE;
@@ -9996,7 +10029,8 @@ describe('plugin-meetings', () => {
       describe('#closePeerConnections', () => {
         it('should close the webrtc media connection, and return a promise', async () => {
           const setNetworkStatusSpy = sinon.spy(meeting, 'setNetworkStatus');
-          meeting.mediaProperties.webrtcMediaConnection = {close: sinon.stub()};
+          const fakeWebrtcMediaConnection = {close: sinon.stub()};
+          meeting.mediaProperties.webrtcMediaConnection = fakeWebrtcMediaConnection;
 
           meeting.audio = {id: 'fakeAudioMuteState'};
           meeting.video = {id: 'fakeVideoMuteState'};
@@ -10005,15 +10039,17 @@ describe('plugin-meetings', () => {
 
           assert.exists(pcs.then);
           await pcs;
-          assert.calledOnce(meeting.mediaProperties.webrtcMediaConnection.close);
+          assert.calledOnce(fakeWebrtcMediaConnection.close);
           assert.calledOnceWithExactly(setNetworkStatusSpy, undefined);
           assert.equal(meeting.audio, null);
           assert.equal(meeting.video, null);
+          assert.equal(meeting.mediaProperties.webrtcMediaConnection, null);
         });
 
         it('should close the webrtc media connection, but keep audio and video props unchanged if called with resetMuteStates=false', async () => {
           const setNetworkStatusSpy = sinon.spy(meeting, 'setNetworkStatus');
-          meeting.mediaProperties.webrtcMediaConnection = {close: sinon.stub()};
+          const fakeWebrtcMediaConnection = {close: sinon.stub()};
+          meeting.mediaProperties.webrtcMediaConnection = fakeWebrtcMediaConnection;
 
           const fakeAudio = {id: 'fakeAudioMuteState'};
           const fakeVideo = {id: 'fakeVideoMuteState'};
@@ -10023,10 +10059,11 @@ describe('plugin-meetings', () => {
 
           await meeting.closePeerConnections(false);
 
-          assert.calledOnce(meeting.mediaProperties.webrtcMediaConnection.close);
+          assert.calledOnce(fakeWebrtcMediaConnection.close);
           assert.calledOnceWithExactly(setNetworkStatusSpy, undefined);
           assert.equal(meeting.audio, fakeAudio);
           assert.equal(meeting.video, fakeVideo);
+          assert.equal(meeting.mediaProperties.webrtcMediaConnection, null);
         });
       });
 

package/test/unit/spec/meeting-info/meetinginfov2.js

@@ -19,6 +19,7 @@ import MeetingInfo, {
   MeetingInfoV2AdhocMeetingError,
   MeetingInfoV2PolicyError,
   MeetingInfoV2JoinWebinarError,
+  MeetingInfoV2JoinForbiddenError,
 } from '@webex/plugin-meetings/src/meeting-info/meeting-info-v2';
 import MeetingInfoUtil from '@webex/plugin-meetings/src/meeting-info/utilv2';
 import Metrics from '@webex/plugin-meetings/src/metrics';
@@ -930,6 +931,42 @@ describe('plugin-meetings', () => {
           });
         }
       );
+
+      forEach(
+        [
+          {errorCode: 403003},
+        ],
+        ({errorCode}) => {
+          it(`should throw a MeetingInfoV2JoinForbiddenError for error code ${errorCode}`, async () => {
+            const message = 'a message';
+            const meetingInfoData = 'meeting info';
+
+            webex.request = sinon.stub().rejects({
+              statusCode: 403,
+              body: {message, code: errorCode, data: {meetingInfo: meetingInfoData}},
+            });
+            try {
+              await meetingInfo.fetchMeetingInfo('1234323', DESTINATION_TYPE.MEETING_ID, 'abc', {
+                id: '999',
+                code: 'aabbcc11',
+              });
+            } catch (err) {
+              assert.instanceOf(err, MeetingInfoV2JoinForbiddenError);
+              assert.deepEqual(err.message, `${message}, code=${errorCode}`);
+              assert.equal(err.wbxAppApiCode, errorCode);
+              assert.deepEqual(err.meetingInfo, meetingInfoData);
+
+              assert(Metrics.sendBehavioralMetric.calledOnce);
+              assert.calledWith(
+                Metrics.sendBehavioralMetric,
+                BEHAVIORAL_METRICS.JOIN_FORBIDDEN_ERROR,
+                {code: errorCode}
+              );
+
+            }
+          });
+        }
+      );
     });
   });
 });

package/test/unit/spec/meeting-info/utilv2.js

@@ -345,5 +345,22 @@ describe('plugin-meetings', () => {
         );
       });
     });
+
+    describe('#isMeetingLink', () => {
+      it('should return true for valid join meeting link with MTID', () => {
+        const result = MeetingInfoUtil.isMeetingLink('https://cisco.webex.com/cisco/j.php?MTID=m9fe0afd8c435e892afcce9ea25b97046');
+        expect(result).to.be.true;
+      });
+
+      it('should return true for valid join meeting link without cisco domain', () => {
+        const result = MeetingInfoUtil.isMeetingLink('https://test.webex.com/test/j.php?MTID=m9fe0afd8c435e892afcce9ea25b97046');
+        expect(result).to.be.true;
+      });
+
+      it('should return false for an invalid meeting link', () => {
+        const result = MeetingInfoUtil.isMeetingLink('https://test.webex.com/test/j.php?MiD=m9fe0afd8c435e892afcce9ea25b97046');
+        expect(result).to.be.false;
+      });
+    });
   });
 });