@webex/plugin-meetings 3.5.0 → 3.6.0-next.10

package/src/meetings/index.ts

@@ -1,11 +1,12 @@
 /* eslint no-shadow: ["error", { "allow": ["eventType"] }] */
-import {union} from 'lodash';
+import {cloneDeep} from 'lodash';
 import '@webex/internal-plugin-mercury';
 import '@webex/internal-plugin-conversation';
 import '@webex/internal-plugin-metrics';
 // @ts-ignore
 import {WebexPlugin} from '@webex/webex-core';
 import {setLogger} from '@webex/internal-media-core';
+import {DeviceRegistrationOptions} from '@webex/internal-plugin-device';
 
 import * as mediaHelpersModule from '@webex/media-helpers';
 
@@ -55,6 +56,7 @@ import MeetingCollection from './collection';
 import {MEETING_KEY, INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
+import WebinarRegistrationError from '../common/errors/webinar-registration-error';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
 import NoMeetingInfoError from '../common/errors/no-meeting-info';
 
@@ -133,6 +135,28 @@ class MediaLogger {
  * @memberof Meetings
  */
 
+/**
+ * Object containing only the most basic information about a meeting.
+ * This is the information that is kept even after the meeting is deleted from the MeetingCollection
+ */
+export type BasicMeetingInformation = {
+  allowMediaInLobby: boolean;
+  correlationId: string;
+  environment: string;
+  id: string;
+  locusUrl: string;
+  locusInfo: {
+    // it's only a very small subset of the locus info, to avoid using much memory
+    url: string;
+    fullState: {
+      lastActive: string;
+      sessionId: string;
+    };
+  };
+  meetingInfo: any;
+  sessionCorrelationId: string;
+};
+
 /**
  * Maintain a cache of meetings and sync with services.
  * @class
@@ -141,6 +165,7 @@ export default class Meetings extends WebexPlugin {
   loggerRequest: any;
   media: any;
   meetingCollection: any;
+  deletedMeetings: Map<string, BasicMeetingInformation>;
   personalMeetingRoom: any;
   preferredWebexSite: any;
   reachability: Reachability;
@@ -191,6 +216,8 @@ export default class Meetings extends WebexPlugin {
     // @ts-ignore
     this.loggerRequest = new LoggerRequest({webex: this.webex});
     this.meetingCollection = new MeetingCollection();
+    this.deletedMeetings = new Map();
+
     /**
      * The PersonalMeetingRoom object to interact with server
      * @instance
@@ -736,15 +763,35 @@ export default class Meetings extends WebexPlugin {
     }
   }
 
+  /**
+   * API to toggle backend ipv6 native support config, needs to be called before webex.meetings.register()
+   *
+   * @param {Boolean} newValue
+   * @private
+   * @memberof Meetings
+   * @returns {undefined}
+   */
+  private _toggleIpv6BackendNativeSupport(newValue: boolean) {
+    if (typeof newValue !== 'boolean') {
+      return;
+    }
+    // @ts-ignore
+    if (this.config.backendIpv6NativeSupport !== newValue) {
+      // @ts-ignore
+      this.config.backendIpv6NativeSupport = newValue;
+    }
+  }
+
   /**
    * Explicitly sets up the meetings plugin by registering
    * the device, connecting to mercury, and listening for locus events.
    *
+   * @param {DeviceRegistrationOptions} [deviceRegistrationOptions] - The options for registering the device (optional)
    * @returns {Promise}
    * @public
    * @memberof Meetings
    */
-  public register() {
+  public register(deviceRegistrationOptions?: DeviceRegistrationOptions): Promise<any> {
     // @ts-ignore
     if (!this.webex.canAuthorize) {
       LoggerProxy.logger.error(
@@ -770,7 +817,7 @@ export default class Meetings extends WebexPlugin {
       }),
       // @ts-ignore
       this.webex.internal.device
-        .register()
+        .register(deviceRegistrationOptions)
         // @ts-ignore
         .then(() =>
           LoggerProxy.logger.info(
@@ -996,35 +1043,45 @@ export default class Meetings extends WebexPlugin {
    * @memberof Meetings
    */
   fetchUserPreferredWebexSite() {
-    return this.request.getMeetingPreferences().then((res) => {
-      if (res) {
-        const preferredWebexSite = MeetingsUtil.parseDefaultSiteFromMeetingPreferences(res);
-        this.preferredWebexSite = preferredWebexSite;
-        // @ts-ignore
-        this.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
-      }
+    // @ts-ignore
+    return this.webex.people._getMe().then((me) => {
+      const isGuestUser = me.type === 'appuser';
+      if (!isGuestUser) {
+        return this.request.getMeetingPreferences().then((res) => {
+          if (res) {
+            const preferredWebexSite = MeetingsUtil.parseDefaultSiteFromMeetingPreferences(res);
+            this.preferredWebexSite = preferredWebexSite;
+            // @ts-ignore
+            this.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
+          }
 
-      // fall back to getting the preferred site from the user information
-      if (!this.preferredWebexSite) {
-        // @ts-ignore
-        return this.webex.internal.user
-          .get()
-          .then((user) => {
-            const preferredWebexSite =
-              user?.userPreferences?.userPreferencesItems?.preferredWebExSite;
-            if (preferredWebexSite) {
-              this.preferredWebexSite = preferredWebexSite;
-              // @ts-ignore
-              this.webex.internal.services._getCatalog().addAllowedDomains([preferredWebexSite]);
-            } else {
-              throw new Error('site not found');
-            }
-          })
-          .catch(() => {
-            LoggerProxy.logger.error(
-              'Failed to fetch preferred site from user - no site will be set'
-            );
-          });
+          // fall back to getting the preferred site from the user information
+          if (!this.preferredWebexSite) {
+            // @ts-ignore
+            return this.webex.internal.user
+              .get()
+              .then((user) => {
+                const preferredWebexSite =
+                  user?.userPreferences?.userPreferencesItems?.preferredWebExSite;
+                if (preferredWebexSite) {
+                  this.preferredWebexSite = preferredWebexSite;
+                  // @ts-ignore
+                  this.webex.internal.services
+                    ._getCatalog()
+                    .addAllowedDomains([preferredWebexSite]);
+                } else {
+                  throw new Error('site not found');
+                }
+              })
+              .catch(() => {
+                LoggerProxy.logger.error(
+                  'Failed to fetch preferred site from user - no site will be set'
+                );
+              });
+          }
+
+          return Promise.resolve();
+        });
       }
 
       return Promise.resolve();
@@ -1037,11 +1094,21 @@ export default class Meetings extends WebexPlugin {
    * @public
    * @memberof Meetings
    */
-
   getPersonalMeetingRoom() {
     return this.personalMeetingRoom;
   }
 
+  /**
+   * Returns basic information about a meeting that exists or
+   * used to exist in the MeetingCollection
+   *
+   * @param {string} meetingId
+   * @returns {BasicMeetingInformation|undefined}
+   */
+  public getBasicMeetingInformation(meetingId: string): BasicMeetingInformation {
+    return this.meetingCollection.get(meetingId) || this.deletedMeetings.get(meetingId);
+  }
+
   /**
    * @param {Meeting} meeting
    * @param {Object} reason
@@ -1052,6 +1119,24 @@ export default class Meetings extends WebexPlugin {
    */
   private destroy(meeting: Meeting, reason: object) {
     MeetingUtil.cleanUp(meeting);
+    // keep some basic info about the deleted meeting forever
+    this.deletedMeetings.set(meeting.id, {
+      id: meeting.id,
+      allowMediaInLobby: meeting.allowMediaInLobby,
+      correlationId: meeting.correlationId,
+      sessionCorrelationId: meeting.sessionCorrelationId,
+      environment: meeting.environment,
+      locusUrl: meeting.locusUrl,
+      meetingInfo: cloneDeep(meeting.meetingInfo),
+      locusInfo: {
+        // locusInfo can be quite big, so keep just the minimal info
+        url: meeting.locusInfo?.url,
+        fullState: {
+          lastActive: meeting.locusInfo?.fullState?.lastActive,
+          sessionId: meeting.locusInfo?.fullState?.sessionId,
+        },
+      },
+    });
     this.meetingCollection.delete(meeting.id);
     Trigger.trigger(
       this,
@@ -1081,6 +1166,7 @@ export default class Meetings extends WebexPlugin {
    * @param {CallStateForMetrics} callStateForMetrics - information about call state for metrics
    * @param {Object} [meetingInfo] - Pre-fetched complete meeting info
    * @param {String} [meetingLookupUrl] - meeting info prefetch url
+   * @param {string} sessionCorrelationId - the optional specified sessionCorrelationId (callStateForMetrics.sessionCorrelationId) can be provided instead
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1094,7 +1180,8 @@ export default class Meetings extends WebexPlugin {
     failOnMissingMeetingInfo = false,
     callStateForMetrics: CallStateForMetrics = undefined,
     meetingInfo = undefined,
-    meetingLookupUrl = undefined
+    meetingLookupUrl = undefined,
+    sessionCorrelationId: string = undefined
   ) {
     // Validate meeting information based on the provided destination and
     // type. This must be performed prior to determining if the meeting is
@@ -1105,6 +1192,10 @@ export default class Meetings extends WebexPlugin {
       callStateForMetrics = {...(callStateForMetrics || {}), correlationId};
     }
 
+    if (sessionCorrelationId) {
+      callStateForMetrics = {...(callStateForMetrics || {}), sessionCorrelationId};
+    }
+
     return (
       this.meetingInfo
         .fetchInfoOptions(destination, type)
@@ -1176,10 +1267,9 @@ export default class Meetings extends WebexPlugin {
                       locusId: createdMeeting.locusId,
                       meetingId: createdMeeting.locusInfo?.info?.webExMeetingId,
                       autoupload: true,
-                    }).then(() => this.destroy(createdMeeting, payload.reason));
-                  } else {
-                    this.destroy(createdMeeting, payload.reason);
+                    });
                   }
+                  this.destroy(createdMeeting, payload.reason);
                 });
 
                 createdMeeting.on(EVENTS.REQUEST_UPLOAD_LOGS, (meetingInstance) => {
@@ -1206,7 +1296,7 @@ export default class Meetings extends WebexPlugin {
               return Promise.resolve(createdMeeting);
             });
           }
-          meeting.setCallStateForMetrics(callStateForMetrics);
+          meeting.updateCallStateForMetrics(callStateForMetrics);
 
           // Return the existing meeting.
           return Promise.resolve(meeting);
@@ -1308,7 +1398,8 @@ export default class Meetings extends WebexPlugin {
       if (
         !(err instanceof CaptchaError) &&
         !(err instanceof PasswordError) &&
-        !(err instanceof PermissionError)
+        !(err instanceof PermissionError) &&
+        !(err instanceof WebinarRegistrationError)
       ) {
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`

package/src/metrics/constants.ts

@@ -70,6 +70,7 @@ const BEHAVIORAL_METRICS = {
   ROAP_HTTP_RESPONSE_MISSING: 'js_sdk_roap_http_response_missing',
   TURN_DISCOVERY_REQUIRES_OK: 'js_sdk_turn_discovery_requires_ok',
   REACHABILITY_COMPLETED: 'js_sdk_reachability_completed',
+  WEBINAR_REGISTRATION_ERROR: 'js_sdk_webinar_registration_error',
 };
 
 export {BEHAVIORAL_METRICS as default};

package/src/multistream/remoteMedia.ts

@@ -107,11 +107,16 @@ export class RemoteMedia extends EventsScope {
    * to restrict the requested resolution to this size
    * @param width width of the video element
    * @param height height of the video element
+   * @note width/height of 0 will be ignored
    */
   public setSizeHint(width, height) {
     // only base on height for now
     let fs: number;
 
+    if (width === 0 || height === 0) {
+      return;
+    }
+
     if (height < 135) {
       fs = 60;
     } else if (height < 270) {

package/src/roap/request.ts

@@ -79,7 +79,9 @@ export default class RoapRequest extends StatelessWebexPlugin {
     });
 
     LoggerProxy.logger.info(
-      `Roap:request#sendRoap --> ${locusSelfUrl} \n ${roapMessage.messageType} \n seq:${roapMessage.seq}`
+      `Roap:request#sendRoap --> ${roapMessage.messageType} seq:${roapMessage.seq} ${
+        ipVersion ? `ipver=${ipVersion} ` : ''
+      } ${locusSelfUrl}`
     );
 
     return locusMediaRequest

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

@@ -1807,6 +1807,35 @@ describe('plugin-meetings', () => {
         assert.calledWith(locusInfo.applyLocusDeltaData, action, parsedLoci, fakeMeeting);
       });
 
+      it('catches errors thrown by onDeltaAction and is able to process next Locus delta', () => {
+        const fakeLocusDelta = {
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+          },
+        };
+        locusInfo.locusParser.workingCopy = {
+          sequence: {
+            rangeStart: 0,
+            rangeEnd: 0,
+          },
+        };
+        const testMeeting = {locusInfo: {onDeltaLocus: sinon.stub()}};
+
+        locusParser.onDeltaAction = sandbox
+          .stub()
+          .onCall(0)
+          .callsFake(() => {
+            throw new Error('fake error');
+          });
+
+        // simulate first locus delta coming - it will trigger an error thrown by onDeltaAction
+        locusInfo.handleLocusDelta(fakeLocusDelta, testMeeting);
+
+        // simulate a second locus delta coming - it should be processed without errors
+        locusInfo.handleLocusDelta(fakeLocusDelta, testMeeting);
+      });
+
       it('applyLocusDeltaData handles USE_INCOMING action correctly', () => {
         const {USE_INCOMING} = LocusDeltaParser.loci;
         const meeting = {

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

@@ -83,6 +83,7 @@ describe('createMediaConnection', () => {
         username: 'turn username',
         password: 'turn password',
       },
+      iceCandidatesTimeout: undefined,
     });
     assert.calledOnce(roapMediaConnectionConstructorStub);
     assert.calledWith(
@@ -100,6 +101,7 @@ describe('createMediaConnection', () => {
             credential: 'turn password',
           },
         ],
+        iceCandidatesTimeout: undefined,
         skipInactiveTransceivers: false,
         requireH264: true,
         sdpMunging: {
@@ -306,12 +308,14 @@ describe('createMediaConnection', () => {
         enableRtx: ENABLE_RTX,
         enableExtmap: ENABLE_EXTMAP,
         turnServerInfo,
+        iceCandidatesTimeout: undefined,
       });
       assert.calledOnce(roapMediaConnectionConstructorStub);
       assert.calledWith(
         roapMediaConnectionConstructorStub,
         {
           iceServers: [],
+          iceCandidatesTimeout: undefined,
           skipInactiveTransceivers: false,
           requireH264: true,
           sdpMunging: {

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

@@ -78,6 +78,7 @@ describe('plugin-meetings', () => {
         supportHDV: null,
         canShareWhiteBoard: null,
         enforceVirtualBackground: null,
+        canPollingAndQA: null,
         ...expected,
       };
 
@@ -161,6 +162,7 @@ describe('plugin-meetings', () => {
       'supportHDV',
       'canShareWhiteBoard',
       'enforceVirtualBackground',
+      'canPollingAndQA',
     ].forEach((key) => {
       it(`get and set for ${key} work as expected`, () => {
         const inMeetingActions = new InMeetingActions();