@webex/plugin-meetings 3.0.0-beta.261 → 3.0.0-beta.262

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.261",
+  "version": "3.0.0-beta.262",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.261",
-    "@webex/test-helper-chai": "3.0.0-beta.261",
-    "@webex/test-helper-mocha": "3.0.0-beta.261",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.261",
-    "@webex/test-helper-retry": "3.0.0-beta.261",
-    "@webex/test-helper-test-users": "3.0.0-beta.261",
+    "@webex/plugin-meetings": "3.0.0-beta.262",
+    "@webex/test-helper-chai": "3.0.0-beta.262",
+    "@webex/test-helper-mocha": "3.0.0-beta.262",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.262",
+    "@webex/test-helper-retry": "3.0.0-beta.262",
+    "@webex/test-helper-test-users": "3.0.0-beta.262",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,19 +46,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.261",
+    "@webex/common": "3.0.0-beta.262",
     "@webex/internal-media-core": "2.0.4",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.261",
-    "@webex/internal-plugin-device": "3.0.0-beta.261",
-    "@webex/internal-plugin-llm": "3.0.0-beta.261",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.261",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.261",
-    "@webex/internal-plugin-support": "3.0.0-beta.261",
-    "@webex/internal-plugin-user": "3.0.0-beta.261",
-    "@webex/media-helpers": "3.0.0-beta.261",
-    "@webex/plugin-people": "3.0.0-beta.261",
-    "@webex/plugin-rooms": "3.0.0-beta.261",
-    "@webex/webex-core": "3.0.0-beta.261",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.262",
+    "@webex/internal-plugin-device": "3.0.0-beta.262",
+    "@webex/internal-plugin-llm": "3.0.0-beta.262",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.262",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.262",
+    "@webex/internal-plugin-support": "3.0.0-beta.262",
+    "@webex/internal-plugin-user": "3.0.0-beta.262",
+    "@webex/media-helpers": "3.0.0-beta.262",
+    "@webex/plugin-people": "3.0.0-beta.262",
+    "@webex/plugin-rooms": "3.0.0-beta.262",
+    "@webex/webex-core": "3.0.0-beta.262",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/common/errors/no-meeting-info.ts

@@ -0,0 +1,24 @@
+import {ERROR_DICTIONARY} from '../../constants';
+
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class NoMeetingInfoError extends Error {
+  code: any;
+  error: any;
+  sdkMessage: any;
+
+  /**
+   * @constructor
+   * @param {String} [message]
+   * @param {Object} [error]
+   */
+  constructor(message: string = ERROR_DICTIONARY.NO_MEETING_INFO.MESSAGE, error: any = null) {
+    super(message);
+    this.name = ERROR_DICTIONARY.NO_MEETING_INFO.NAME;
+    this.sdkMessage = ERROR_DICTIONARY.NO_MEETING_INFO.MESSAGE;
+    this.error = error;
+    this.stack = error ? error.stack : new Error().stack;
+    this.code = ERROR_DICTIONARY.NO_MEETING_INFO.CODE;
+  }
+}

package/src/constants.ts

@@ -389,6 +389,7 @@ export const MEETING_REMOVED_REASON = {
   NO_MEETINGS_TO_SYNC: 'NO_MEETINGS_TO_SYNC', // After the syncMeeting no meeting exists
   MEETING_CONNECTION_FAILED: 'MEETING_CONNECTION_FAILED', // meeting failed to connect due to ice failures or firewall issue
   LOCUS_DTO_SYNC_FAILED: 'LOCUS_DTO_SYNC_FAILED', // failed to get any Locus DTO for that meeting
+  MISSING_MEETING_INFO: 'MISSING_MEETING_INFO', // meeting info failed to be fetched
 };
 
 // One one one calls ends for the following reasons
@@ -485,6 +486,11 @@ export const ERROR_DICTIONARY = {
     MESSAGE: 'Edit lock token mismatch',
     CODE: 9,
   },
+  NO_MEETING_INFO: {
+    NAME: 'NoMeetingInfo',
+    MESSAGE: 'No meeting info found for the meeting',
+    CODE: 10,
+  },
 };
 
 export const FLOOR_ACTION = {

package/src/meetings/index.ts

@@ -61,6 +61,7 @@ import MeetingsUtil from './util';
 import PermissionError from '../common/errors/permission';
 import {INoiseReductionEffect, IVirtualBackgroundEffect} from './meetings.types';
 import {SpaceIDDeprecatedError} from '../common/errors/webex-errors';
+import NoMeetingInfoError from '../common/errors/no-meeting-info';
 
 let mediaLogger;
 
@@ -1043,6 +1044,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Boolean} useRandomDelayForInfo - whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
    * @param {string} correlationId - the optional specified correlationId
+   * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1052,7 +1054,8 @@ export default class Meetings extends WebexPlugin {
     type: string = null,
     useRandomDelayForInfo = false,
     infoExtraParams = {},
-    correlationId: string = undefined
+    correlationId: string = undefined,
+    failOnMissingMeetingInfo = false
   ) {
     // TODO: type should be from a dictionary
 
@@ -1106,7 +1109,8 @@ export default class Meetings extends WebexPlugin {
               type,
               useRandomDelayForInfo,
               infoExtraParams,
-              correlationId
+              correlationId,
+              failOnMissingMeetingInfo
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
               if (createdMeeting && createdMeeting.on) {
@@ -1161,6 +1165,7 @@ export default class Meetings extends WebexPlugin {
    * @param {Boolean} useRandomDelayForInfo whether a random delay should be added to fetching meeting info
    * @param {Object} infoExtraParams extra parameters to be provided when fetching meeting info
    * @param {String} correlationId the optional specified correlationId
+   * @param {Boolean} failOnMissingMeetingInfo - whether to throw an error if meeting info fails to fetch (for calls that are not 1:1 or content share)
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
    * @memberof Meetings
@@ -1170,7 +1175,8 @@ export default class Meetings extends WebexPlugin {
     type: string = null,
     useRandomDelayForInfo = false,
     infoExtraParams = {},
-    correlationId: string = undefined
+    correlationId: string = undefined,
+    failOnMissingMeetingInfo = false
   ) {
     const meeting = new Meeting(
       {
@@ -1239,10 +1245,18 @@ export default class Meetings extends WebexPlugin {
         !(err instanceof PasswordError) &&
         !(err instanceof PermissionError)
       ) {
-        // if there is no meeting info we assume its a 1:1 call or wireless share
         LoggerProxy.logger.info(
           `Meetings:index#createMeeting --> Info Unable to fetch meeting info for ${destination}.`
         );
+        if (failOnMissingMeetingInfo) {
+          LoggerProxy.logger.info(
+            `Meetings:index#createMeeting --> Destroying meeting due to missing meeting info.`
+          );
+          // @ts-ignore
+          this.destroy(meeting, MEETING_REMOVED_REASON.MISSING_MEETING_INFO);
+          throw new NoMeetingInfoError();
+        }
+        // if there is no meeting info and no error should be thrown then we assume its a 1:1 call or wireless share
         LoggerProxy.logger.info(
           'Meetings:index#createMeeting --> Info assuming this destination is a 1:1 or wireless share'
         );

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

@@ -36,6 +36,7 @@ import { forEach } from 'lodash';
 import PasswordError from '@webex/plugin-meetings/src/common/errors/password-error';
 import PermissionError from '@webex/plugin-meetings/src/common/errors/permission';
 import {NoiseReductionEffect,VirtualBackgroundEffect} from '@webex/media-helpers';
+import NoMeetingInfoError from '../../../../src/common/errors/no-meeting-info';
 
 describe('plugin-meetings', () => {
   const logger = {
@@ -662,15 +663,28 @@ describe('plugin-meetings', () => {
           });
         });
 
-        it('calls createMeeting and returns its promise', async () => {
-          const FAKE_USE_RANDOM_DELAY = true;
-          const correlationId = 'my-correlationId';
-          const create = webex.meetings.create(test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId);
+        const FAKE_USE_RANDOM_DELAY = true;
+        const correlationId = 'my-correlationId';
+
+        const checkCallCreateMeeting = async (createParameters, createMeetingParameters) => {
+          const create = webex.meetings.create(...createParameters);
 
           assert.exists(create.then);
           await create;
           assert.calledOnce(webex.meetings.createMeeting);
-          assert.calledWith(webex.meetings.createMeeting, test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId);
+          assert.calledWith(webex.meetings.createMeeting, ...createMeetingParameters);
+        } 
+
+        it('calls createMeeting and returns its promise', async () => {
+          checkCallCreateMeeting([test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, true], [test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, true]);
+        });
+
+        it('calls createMeeting when failOnMissingMeetinginfo is undefined and returns its promise', async () => {
+          checkCallCreateMeeting([test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, undefined], [test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, false]);
+        });
+
+        it('calls createMeeting when failOnMissingMeetinginfo is false and returns its promise', async () => {
+          checkCallCreateMeeting([test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, false], [test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId, false]);
         });
 
         it('calls createMeeting with extra info params and returns its promise', async () => {
@@ -1346,37 +1360,63 @@ describe('plugin-meetings', () => {
             webex.meetings.meetingInfo.fetchMeetingInfo = sinon
               .stub()
               .returns(Promise.reject(new Error('test')));
+            webex.meetings.destroy = sinon
+              .stub()
+              .returns(Promise.resolve());
+            webex.meetings.createMeeting = sinon.spy(webex.meetings.createMeeting);
           });
-          it('creates the meeting from a rejected meeting info fetch', async () => {
-            const meeting = await webex.meetings.createMeeting('test destination', 'test type');
 
-            assert.instanceOf(
-              meeting,
-              Meeting,
-              'createMeeting should eventually resolve to a Meeting Object'
-            );
-            assert.calledOnce(webex.meetings.meetingInfo.fetchMeetingInfo);
-            assert.calledOnce(MeetingsUtil.getMeetingAddedType);
-            assert.calledThrice(TriggerProxy.trigger);
-            assert.calledWith(
-              webex.meetings.meetingInfo.fetchMeetingInfo,
-              'test destination',
-              'test type'
-            );
-            assert.calledWith(MeetingsUtil.getMeetingAddedType, 'test type');
-            assert.calledWith(
-              TriggerProxy.trigger,
-              sinon.match.instanceOf(Meetings),
-              {
-                file: 'meetings',
-                function: 'createMeeting',
-              },
-              'meeting:added',
-              {
-                meeting: sinon.match.instanceOf(Meeting),
-                type: 'test meeting added type',
+          const checkCreateMeetingWithNoMeetingInfo = async (failOnMissingMeetingInfo, destroy) => {
+            try {
+              const meeting = await webex.meetings.createMeeting('test destination', 'test type', undefined, undefined, undefined, failOnMissingMeetingInfo);
+              
+              assert.instanceOf(
+                meeting,
+                Meeting,
+                'createMeeting should eventually resolve to a Meeting Object'
+              );
+              assert.calledOnce(webex.meetings.meetingInfo.fetchMeetingInfo);
+              assert.calledOnce(MeetingsUtil.getMeetingAddedType);
+              assert.calledThrice(TriggerProxy.trigger);
+              assert.calledWith(
+                webex.meetings.meetingInfo.fetchMeetingInfo,
+                'test destination',
+                'test type'
+              );
+  
+              if (destroy) {
+                assert.calledWith(webex.meetings.destroy, sinon.match.instanceOf(Meeting), 'MISSING_MEETING_INFO')
+                assert.notCalled(MeetingsUtil.getMeetingAddedType);
+                assert.notCalled(TriggerProxy.trigger);
+                assert.throw(webex.meetings.createMeeting, 'meeting information not found');
+              } else {
+                assert.notCalled(webex.meetings.destroy);
+                assert.calledWith(MeetingsUtil.getMeetingAddedType, 'test type');
+                assert.calledWith(
+                  TriggerProxy.trigger,
+                  sinon.match.instanceOf(Meetings),
+                  {
+                    file: 'meetings',
+                    function: 'createMeeting',
+                  },
+                  'meeting:added',
+                  {
+                    meeting: sinon.match.instanceOf(Meeting),
+                    type: 'test meeting added type',
+                  }
+                );
               }
-            );
+            } catch (err) { 
+              assert.instanceOf(err, NoMeetingInfoError);
+            }
+          }
+
+          it('creates the meeting from a rejected meeting info fetch', async () => {
+            checkCreateMeetingWithNoMeetingInfo(false, false);
+          });
+
+          it('creates the meeting from a rejected meeting info fetch and destroys it if failOnMissingMeetingInfo', async () => {
+            checkCreateMeetingWithNoMeetingInfo(true, true);
           });
         });