@webex/plugin-meetings 3.0.0-beta.198 → 3.0.0-beta.199

package/src/meeting/index.ts

@@ -204,7 +204,6 @@ export enum ScreenShareFloorStatus {
  * @property {String} [meetingQuality.remote]
  * @property {Boolean} [rejoin]
  * @property {Boolean} [enableMultistream]
- * @property {String} [correlationId]
  */
 
 /**
@@ -593,7 +592,14 @@ export default class Meeting extends StatelessWebexPlugin {
      * @public
      * @memberof Meeting
      */
-    this.correlationId = this.id;
+    if (attrs.correlationId) {
+      LoggerProxy.logger.log(
+        `Meetings:index#constructor --> Initializing the meeting object with correlation id from app ${this.correlationId}`
+      );
+      this.correlationId = attrs.correlationId;
+    } else {
+      this.correlationId = this.id;
+    }
     /**
      * @instance
      * @type {String}
@@ -4255,16 +4261,9 @@ export default class Meeting extends StatelessWebexPlugin {
       joinSuccess = resolve;
     });
 
-    if (options.correlationId) {
-      this.setCorrelationId(options.correlationId);
-      LoggerProxy.logger.log(
-        `Meeting:index#join --> Using a new correlation id from app ${this.correlationId}`
-      );
-    }
-
     if (!this.hasJoinedOnce) {
       this.hasJoinedOnce = true;
-    } else if (!options.correlationId) {
+    } else {
       LoggerProxy.logger.log(
         `Meeting:index#join --> Generating a new correlation id for meeting ${this.id}`
       );
@@ -4772,7 +4771,7 @@ export default class Meeting extends StatelessWebexPlugin {
     };
 
     if (error instanceof Errors.SdpOfferCreationError) {
-      sendBehavioralMetric(BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE, error, this.id);
+      sendBehavioralMetric(BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE, error, this.correlationId);
 
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
@@ -4786,7 +4785,7 @@ export default class Meeting extends StatelessWebexPlugin {
       error instanceof Errors.SdpOfferHandlingError ||
       error instanceof Errors.SdpAnswerHandlingError
     ) {
-      sendBehavioralMetric(BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE, error, this.id);
+      sendBehavioralMetric(BEHAVIORAL_METRICS.PEERCONNECTION_FAILURE, error, this.correlationId);
 
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({
@@ -4798,7 +4797,7 @@ export default class Meeting extends StatelessWebexPlugin {
       });
     } else if (error instanceof Errors.SdpError) {
       // this covers also the case of Errors.IceGatheringError which extends Errors.SdpError
-      sendBehavioralMetric(BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE, error, this.id);
+      sendBehavioralMetric(BEHAVIORAL_METRICS.INVALID_ICE_CANDIDATE, error, this.correlationId);
 
       // @ts-ignore
       this.webex.internal.newMetrics.submitClientEvent({

package/src/meetings/index.ts

@@ -1054,6 +1054,7 @@ export default class Meetings extends WebexPlugin {
    * @param {string} [type] - the optional specified type, such as locusId
    * @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
    * @returns {Promise<Meeting>} A new Meeting.
    * @public
    * @memberof Meetings
@@ -1062,7 +1063,8 @@ export default class Meetings extends WebexPlugin {
     destination: string,
     type: string = null,
     useRandomDelayForInfo = false,
-    infoExtraParams = {}
+    infoExtraParams = {},
+    correlationId: string = undefined
   ) {
     // TODO: type should be from a dictionary
 
@@ -1112,7 +1114,8 @@ export default class Meetings extends WebexPlugin {
               targetDest,
               type,
               useRandomDelayForInfo,
-              infoExtraParams
+              infoExtraParams,
+              correlationId
             ).then((createdMeeting: any) => {
               // If the meeting was successfully created.
               if (createdMeeting && createdMeeting.on) {
@@ -1166,6 +1169,7 @@ export default class Meetings extends WebexPlugin {
    * @param {String} type see create()
    * @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
    * @returns {Promise} a new meeting instance complete with meeting info and destination
    * @private
    * @memberof Meetings
@@ -1174,7 +1178,8 @@ export default class Meetings extends WebexPlugin {
     destination: any,
     type: string = null,
     useRandomDelayForInfo = false,
-    infoExtraParams = {}
+    infoExtraParams = {},
+    correlationId: string = undefined
   ) {
     const meeting = new Meeting(
       {
@@ -1188,6 +1193,7 @@ export default class Meetings extends WebexPlugin {
         meetingInfoProvider: this.meetingInfo,
         destination,
         destinationType: type,
+        correlationId,
       },
       {
         // @ts-ignore

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

@@ -185,6 +185,7 @@ describe('plugin-meetings', () => {
   let testDestination;
   let membersSpy;
   let meetingRequestSpy;
+  let correlationId;
 
   beforeEach(() => {
     webex = new MockWebex({
@@ -243,6 +244,7 @@ describe('plugin-meetings', () => {
     test3 = `test3-${uuid.v4()}`;
     test4 = `test4-${uuid.v4()}`;
     testDestination = `testDestination-${uuid.v4()}`;
+    correlationId = uuid.v4();
 
     meeting = new Meeting(
       {
@@ -252,6 +254,7 @@ describe('plugin-meetings', () => {
         locus: {url: url1},
         destination: testDestination,
         destinationType: _MEETING_ID_,
+        correlationId,
       },
       {
         parent: webex,
@@ -270,9 +273,11 @@ describe('plugin-meetings', () => {
           assert.exists(meeting.options);
           assert.exists(meeting.attrs);
           assert.exists(meeting.id);
+          assert.exists(meeting.correlationId);
           assert.equal(meeting.userId, uuid1);
           assert.equal(meeting.resource, uuid2);
           assert.equal(meeting.deviceUrl, uuid3);
+          assert.equal(meeting.correlationId, correlationId);
           assert.deepEqual(meeting.meetingInfo, {});
           assert.instanceOf(meeting.members, Members);
           assert.calledOnceWithExactly(
@@ -324,6 +329,21 @@ describe('plugin-meetings', () => {
           assert.instanceOf(meeting.mediaRequestManagers.screenShareVideo, MediaRequestManager);
         });
 
+        it('uses meeting id as correlation id if not provided in constructor', () => {
+          const newMeeting = new Meeting({
+            userId: uuid1,
+            resource: uuid2,
+            deviceUrl: uuid3,
+            locus: {url: url1},
+            destination: testDestination,
+            destinationType: _MEETING_ID_,
+          },
+          {
+            parent: webex,
+          });
+          assert.equal(newMeeting.correlationId, newMeeting.id);
+        })
+
         describe('creates ReceiveSlot manager instance', () => {
           let mockReceiveSlotManagerCtor;
           let providedCreateSlotCallback;

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

@@ -679,23 +679,26 @@ describe('plugin-meetings', () => {
 
         it('calls createMeeting and returns its promise', async () => {
           const FAKE_USE_RANDOM_DELAY = true;
-          const create = webex.meetings.create(test1, test2, FAKE_USE_RANDOM_DELAY);
+          const correlationId = 'my-correlationId';
+          const create = webex.meetings.create(test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId);
 
           assert.exists(create.then);
           await create;
           assert.calledOnce(webex.meetings.createMeeting);
-          assert.calledWith(webex.meetings.createMeeting, test1, test2, FAKE_USE_RANDOM_DELAY, {});
+          assert.calledWith(webex.meetings.createMeeting, test1, test2, FAKE_USE_RANDOM_DELAY, {}, correlationId);
         });
 
         it('calls createMeeting with extra info params and returns its promise', async () => {
           const FAKE_USE_RANDOM_DELAY = false;
+          const correlationId = 'my-correlationId';
+
           const FAKE_INFO_EXTRA_PARAMS = {mtid: 'm9fe0afd8c435e892afcce9ea25b97046', joinTXId: 'TSmrX61wNF'};
-          const create = webex.meetings.create(test1, test2, FAKE_USE_RANDOM_DELAY, FAKE_INFO_EXTRA_PARAMS);
+          const create = webex.meetings.create(test1, test2, FAKE_USE_RANDOM_DELAY, FAKE_INFO_EXTRA_PARAMS, correlationId);
 
           assert.exists(create.then);
           await create;
           assert.calledOnce(webex.meetings.createMeeting);
-          assert.calledWith(webex.meetings.createMeeting, test1, test2, FAKE_USE_RANDOM_DELAY, FAKE_INFO_EXTRA_PARAMS);
+          assert.calledWith(webex.meetings.createMeeting, test1, test2, FAKE_USE_RANDOM_DELAY, FAKE_INFO_EXTRA_PARAMS, correlationId);
         });
 
         it('creates a new meeting when a scheduled meeting exists in the conversation', async () => {
@@ -1095,6 +1098,9 @@ describe('plugin-meetings', () => {
             if (expectedMeetingData.meetingJoinUrl) {
               assert.equal(meeting.meetingJoinUrl, expectedMeetingData.meetingJoinUrl);
             }
+            if(expectedMeetingData.correlationId) {
+              assert.equal(meeting.correlationId, expectedMeetingData.correlationId);
+            }
             assert.equal(meeting.destination, destination);
             assert.equal(meeting.destinationType, type);
             assert.calledWith(
@@ -1124,6 +1130,7 @@ describe('plugin-meetings', () => {
             const expectedMeetingData = {
               permissionToken: 'PT',
               meetingJoinUrl: 'meetingJoinUrl',
+              correlationId: meeting.id,
             };
 
             checkCreateWithoutDelay(meeting, 'test destination', 'test type', {}, expectedMeetingData);
@@ -1334,6 +1341,16 @@ describe('plugin-meetings', () => {
             );
             checkCreateWithoutDelay(meeting, FAKE_LOCUS_MEETING, 'test type');
           });
+
+          it('creates meeting with the correlationId provided', async () => {
+            const meeting = await webex.meetings.createMeeting('test destination', 'test type', false, {}, 'my-correlationId');
+
+            const expectedMeetingData = {
+              correlationId: 'my-correlationId',
+            };
+
+            checkCreateWithoutDelay(meeting, 'test destination', 'test type', {}, expectedMeetingData);
+          })
         });
 
         describe('rejected MeetingInfo.#fetchMeetingInfo', () => {