@webex/plugin-meetings 3.0.0-beta.213 → 3.0.0-beta.215

package/src/meeting/util.ts

@@ -188,6 +188,24 @@ const MeetingUtil = {
     });
   },
 
+  /**
+   * Returns options for leaving a meeting.
+   * @param {any} meeting
+   * @param {any} options
+   * @returns {any} leave options
+   */
+  prepareLeaveMeetingOptions: (meeting, options: any = {}) => {
+    const defaultOptions = {
+      locusUrl: meeting.locusUrl,
+      selfId: meeting.selfId,
+      correlationId: meeting.correlationId,
+      resourceId: meeting.resourceId,
+      deviceUrl: meeting.deviceUrl,
+    };
+
+    return {...defaultOptions, ...options};
+  },
+
   // by default will leave on meeting's resourceId
   // if you explicity want it not to leave on resource id, pass
   // {resourceId: null}
@@ -202,15 +220,7 @@ const MeetingUtil = {
       return Promise.reject(new UserNotJoinedError());
     }
 
-    const defaultOptions = {
-      locusUrl: meeting.locusUrl,
-      selfId: meeting.selfId,
-      correlationId: meeting.correlationId,
-      resourceId: meeting.resourceId,
-      deviceUrl: meeting.deviceUrl,
-    };
-
-    const leaveOptions = {...defaultOptions, ...options};
+    const leaveOptions = MeetingUtil.prepareLeaveMeetingOptions(meeting, options);
 
     return meeting.meetingRequest
       .leaveMeeting(leaveOptions)
@@ -302,6 +312,18 @@ const MeetingUtil = {
       });
   },
 
+  /**
+   * Returns request options for leaving a meeting.
+   * @param {any} meeting
+   * @param {any} options
+   * @returns {any} request options
+   */
+  buildLeaveFetchRequestOptions: (meeting, options: any = {}) => {
+    const leaveOptions = MeetingUtil.prepareLeaveMeetingOptions(meeting, options);
+
+    return meeting.meetingRequest.buildLeaveMeetingRequestOptions(leaveOptions);
+  },
+
   getTrack: (stream) => {
     let audioTrack = null;
     let videoTrack = null;
@@ -538,14 +560,14 @@ const MeetingUtil = {
     return response;
   },
 
-  generateLocusDeltaRequest: (originalMeeting) => {
+  generateBuildLocusDeltaRequestOptions: (originalMeeting) => {
     const meetingRef = new WeakRef(originalMeeting);
 
-    const locusDeltaRequest = (originalOptions) => {
+    const buildLocusDeltaRequestOptions = (originalOptions) => {
       const meeting = meetingRef.deref();
 
       if (!meeting) {
-        return Promise.resolve();
+        return originalOptions;
       }
 
       const options = cloneDeep(originalOptions);
@@ -556,6 +578,27 @@ const MeetingUtil = {
 
       MeetingUtil.addSequence(meeting, options.body);
 
+      return options;
+    };
+
+    return buildLocusDeltaRequestOptions;
+  },
+
+  generateLocusDeltaRequest: (originalMeeting) => {
+    const meetingRef = new WeakRef(originalMeeting);
+
+    const buildLocusDeltaRequestOptions =
+      MeetingUtil.generateBuildLocusDeltaRequestOptions(originalMeeting);
+
+    const locusDeltaRequest = (originalOptions) => {
+      const meeting = meetingRef.deref();
+
+      if (!meeting) {
+        return Promise.resolve();
+      }
+
+      const options = buildLocusDeltaRequestOptions(originalOptions);
+
       return meeting
         .request(options)
         .then((response) => MeetingUtil.updateLocusWithDelta(meeting, response));

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

@@ -255,6 +255,7 @@ describe('plugin-meetings', () => {
         destination: testDestination,
         destinationType: _MEETING_ID_,
         correlationId,
+        selfId: uuid1,
       },
       {
         parent: webex,
@@ -262,6 +263,7 @@ describe('plugin-meetings', () => {
     );
 
     meeting.members.selfId = uuid1;
+    meeting.selfId = uuid1;
   });
 
   describe('meeting index', () => {
@@ -2487,7 +2489,7 @@ describe('plugin-meetings', () => {
         });
 
         it('should send client.call.leave after meetingRequest.leaveMeeting', async () => {
-          const leave = meeting.leave();
+          const leave = meeting.leave({clientEventLeaveReason: 'ended-by-locus'});
 
           await leave;
 
@@ -2496,7 +2498,7 @@ describe('plugin-meetings', () => {
             payload: {
               trigger: 'user-interaction',
               canProceed: false,
-              leaveReason: 'CLIENT_LEAVE_REQUEST',
+              leaveReason: 'ended-by-locus',
             },
             options: {meetingId: meeting.id},
           });
@@ -2520,7 +2522,7 @@ describe('plugin-meetings', () => {
             payload: {
               trigger: 'user-interaction',
               canProceed: false,
-              leaveReason: 'CLIENT_LEAVE_REQUEST',
+              leaveReason: undefined,
               errors: [
                 {
                   fatal: false,
@@ -7961,4 +7963,39 @@ describe('plugin-meetings', () => {
       });
     });
   });
+
+  describe('#buildLeaveFetchRequestOptions', () => {
+    it('should have #buildLeaveFetchRequestOptions', () => {
+      assert.exists(meeting.buildLeaveFetchRequestOptions);
+    });
+
+    it('calls expected functions', () => {
+      const buildLeaveFetchRequestOptionsSpy = sinon.spy(
+        MeetingUtil,
+        'buildLeaveFetchRequestOptions'
+      );
+      const prepareFetchOptionsSpy = sinon.stub();
+      webex.prepareFetchOptions = prepareFetchOptionsSpy;
+
+      meeting.buildLeaveFetchRequestOptions({resourceId: 'foo'});
+
+      assert.calledOnce(buildLeaveFetchRequestOptionsSpy);
+      assert.instanceOf(buildLeaveFetchRequestOptionsSpy.getCall(0).args[0], Meeting);
+      assert.deepEqual(buildLeaveFetchRequestOptionsSpy.getCall(0).args[1], {resourceId: 'foo'});
+
+      assert.calledOnce(prepareFetchOptionsSpy);
+      assert.deepEqual(prepareFetchOptionsSpy.getCall(0).args[0], {
+        body: {
+          correlationId: meeting.correlationId,
+          device: {
+            deviceType: undefined,
+            url: uuid3,
+          },
+          usingResource: 'foo',
+        },
+        method: 'PUT',
+        uri: `${url1}/participant/${uuid1}/leave`,
+      });
+    });
+  });
 });

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

@@ -4,8 +4,7 @@ import MockWebex from '@webex/test-helper-mock-webex';
 import Meetings from '@webex/plugin-meetings';
 import MeetingRequest from '@webex/plugin-meetings/src/meeting/request';
 import uuid from 'uuid';
-import { merge } from 'lodash';
-
+import {merge} from 'lodash';
 
 describe('plugin-meetings', () => {
   let meetingsRequest;
@@ -30,7 +29,9 @@ describe('plugin-meetings', () => {
       },
     };
 
-    webex.boundedStorage.get = sinon.mock().returns(Promise.resolve(JSON.stringify({anycastEntryPoint: "aws-eu-west-1"})))
+    webex.boundedStorage.get = sinon
+      .mock()
+      .returns(Promise.resolve(JSON.stringify({anycastEntryPoint: 'aws-eu-west-1'})));
 
     const request = sinon.mock().returns(Promise.resolve({}));
 
@@ -39,9 +40,9 @@ describe('plugin-meetings', () => {
         meeting: {
           request,
           locusInfo: {
-            sequence: {}
-          }
-        }
+            sequence: {},
+          },
+        },
       },
       {
         parent: webex,
@@ -54,11 +55,13 @@ describe('plugin-meetings', () => {
 
   const checkRequest = (expectedParams) => {
     assert.calledOnceWithExactly(locusDeltaRequestSpy, expectedParams);
-    assert.calledOnceWithExactly(meetingsRequest.request, merge(expectedParams, {body: {sequence: {}}}));
-  }
+    assert.calledOnceWithExactly(
+      meetingsRequest.request,
+      merge(expectedParams, {body: {sequence: {}}})
+    );
+  };
 
   describe('meeting request library', () => {
-
     beforeEach(() => {
       sinon.stub(uuid, 'v4').returns('12345');
     });
@@ -73,8 +76,6 @@ describe('plugin-meetings', () => {
         const deviceUrl = 'deviceUrl';
         const tones = '1234';
 
-
-
         await meetingsRequest.sendDTMF({
           locusUrl,
           deviceUrl,
@@ -236,7 +237,7 @@ describe('plugin-meetings', () => {
 
       it('adds deviceCapabilities to request when breakouts are supported', async () => {
         await meetingsRequest.joinMeeting({
-          breakoutsSupported: true
+          breakoutsSupported: true,
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
@@ -245,7 +246,7 @@ describe('plugin-meetings', () => {
 
       it('adds deviceCapabilities to request when live annotation are supported', async () => {
         await meetingsRequest.joinMeeting({
-          liveAnnotationSupported: true
+          liveAnnotationSupported: true,
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
         assert.deepEqual(requestParams.body.deviceCapabilities, ['ANNOTATION_ON_SHARE_SUPPORTED']);
@@ -256,7 +257,10 @@ describe('plugin-meetings', () => {
           breakoutsSupported: true,
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
-        assert.deepEqual(requestParams.body.deviceCapabilities, ['BREAKOUTS_SUPPORTED','ANNOTATION_ON_SHARE_SUPPORTED']);
+        assert.deepEqual(requestParams.body.deviceCapabilities, [
+          'BREAKOUTS_SUPPORTED',
+          'ANNOTATION_ON_SHARE_SUPPORTED',
+        ]);
       });
       it('does not add deviceCapabilities to request when breakouts and live annotation are not supported', async () => {
         await meetingsRequest.joinMeeting({});
@@ -264,17 +268,18 @@ describe('plugin-meetings', () => {
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
         assert.deepEqual(requestParams.body.deviceCapabilities, undefined);
-
       });
 
       it('adds deviceCapabilities and locale to request when they are provided', async () => {
         await meetingsRequest.joinMeeting({
           locale: 'en_UK',
-          deviceCapabilities: ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED']
+          deviceCapabilities: ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED'],
         });
         const requestParams = meetingsRequest.request.getCall(0).args[0];
 
-        assert.deepEqual(requestParams.body.deviceCapabilities, ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED']);
+        assert.deepEqual(requestParams.body.deviceCapabilities, [
+          'SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED',
+        ]);
         assert.deepEqual(requestParams.body.locale, 'en_UK');
       });
 
@@ -305,8 +310,8 @@ describe('plugin-meetings', () => {
         assert.equal(requestParams.method, 'POST');
         assert.equal(requestParams.uri, `${locusUrl}/participant?alternateRedirect=true`);
         assert.deepEqual(requestParams.body.clientMediaPreferences, {
-          "joinCookie": {anycastEntryPoint: "aws-eu-west-1"},
-          "preferTranscoding": true
+          joinCookie: {anycastEntryPoint: 'aws-eu-west-1'},
+          preferTranscoding: true,
         });
       });
     });
@@ -335,8 +340,8 @@ describe('plugin-meetings', () => {
               provisionalType: 'DIAL_IN',
               clientUrl,
             },
-            correlationId
-          }
+            correlationId,
+          },
         });
       });
 
@@ -369,7 +374,6 @@ describe('plugin-meetings', () => {
             correlationId,
           },
         });
-
       });
 
       it('sends disconnect phone audio request', async () => {
@@ -391,10 +395,10 @@ describe('plugin-meetings', () => {
           body: {
             device: {
               url: phoneUrl,
-              deviceType: 'PROVISIONAL'
+              deviceType: 'PROVISIONAL',
             },
-            correlationId
-          }
+            correlationId,
+          },
         });
       });
     });
@@ -467,13 +471,12 @@ describe('plugin-meetings', () => {
           method: 'PATCH',
           uri: `${locusUrl}/controls`,
           body: {
-            lock: {locked: true}
-          }
+            lock: {locked: true},
+          },
         });
       });
     });
 
-
     describe('#endMeetingForAll', () => {
       it('sends request to endMeetingForAll', async () => {
         const locusUrl = 'locusURL';
@@ -551,10 +554,83 @@ describe('plugin-meetings', () => {
         });
       });
     });
+
+    describe('#prepareLeaveMeetingRequestOptions', () => {
+      it('returns expected result', async () => {
+        const result = meetingsRequest.prepareLeaveMeetingRequestOptions({
+          locusUrl: 'locusUrl',
+          selfId: 'selfId',
+          correlationId: 'correlationId',
+          resourceId: 'resourceId',
+          deviceUrl: 'deviceUrl',
+        });
+
+        assert.deepEqual(result, {
+          body: {
+            correlationId: 'correlationId',
+            device: {
+              deviceType: undefined,
+              url: 'deviceUrl',
+            },
+            usingResource: 'resourceId',
+          },
+          method: 'PUT',
+          uri: 'locusUrl/participant/selfId/leave',
+        });
+      });
+    });
+
+    describe('#buildLeaveMeetingRequestOptions', () => {
+      it('calls expected functions and returns expected result', async () => {
+        // return this.buildLocusDeltaRequestOptions(this.prepareLeaveMeetingRequestOptions(options));
+        const prepareLeaveMeetingRequestOptionsSpy = sinon.spy(
+          meetingsRequest,
+          'prepareLeaveMeetingRequestOptions'
+        );
+        const buildLocusDeltaRequestOptionsSpy = sinon.spy(
+          meetingsRequest,
+          'buildLocusDeltaRequestOptions'
+        );
+
+        const inputOpts = {
+          locusUrl: 'locusUrl',
+          selfId: 'selfId',
+          correlationId: 'correlationId',
+          resourceId: 'resourceId',
+          deviceUrl: 'deviceUrl',
+        };
+
+        const result = meetingsRequest.buildLeaveMeetingRequestOptions(inputOpts);
+
+        assert.calledOnceWithExactly(prepareLeaveMeetingRequestOptionsSpy, inputOpts);
+        assert.calledOnceWithExactly(buildLocusDeltaRequestOptionsSpy, {
+          method: 'PUT',
+          uri: 'locusUrl/participant/selfId/leave',
+          body: {
+            device: {deviceType: undefined, url: 'deviceUrl'},
+            usingResource: 'resourceId',
+            correlationId: 'correlationId',
+          },
+        });
+
+        assert.deepEqual(result, {
+          body: {
+            correlationId: 'correlationId',
+            device: {
+              deviceType: undefined,
+              url: 'deviceUrl',
+            },
+            sequence: {},
+            usingResource: 'resourceId',
+          },
+          method: 'PUT',
+          uri: 'locusUrl/participant/selfId/leave',
+        });
+      });
+    });
   });
 
   describe('#declineMeeting', () => {
-
     it('sends a request to decline the meeting', async () => {
       const reason = 'reason';
       const deviceUrl = 'deviceUrl';
@@ -564,7 +640,7 @@ describe('plugin-meetings', () => {
       await meetingsRequest.declineMeeting({
         locusUrl,
         deviceUrl,
-        reason
+        reason,
       });
 
       const expectedBody = {
@@ -581,7 +657,6 @@ describe('plugin-meetings', () => {
         body: expectedBody,
       });
     });
-
   });
 
   describe('#getLocusStatusByUrl', () => {
@@ -592,12 +667,11 @@ describe('plugin-meetings', () => {
       assert.deepEqual(meetingsRequest.request.getCall(0).args[0], {
         method: 'GET',
         uri: locusUrl,
-      })
+      });
     });
   });
 
   describe('#changeMeetingFloor', () => {
-
     it('change meeting floor', async () => {
       const options = {
         disposition: 'GRANTED',
@@ -606,11 +680,11 @@ describe('plugin-meetings', () => {
         resourceId: 'resourceId',
         resourceUrl: 'resourceUrl',
         uri: 'optionsUrl',
-        annotationInfo:{
+        annotationInfo: {
           version: '1',
           policy: 'Approval',
         },
-      }
+      };
 
       const expectBody = {
         annotation: {
@@ -622,27 +696,26 @@ describe('plugin-meetings', () => {
             devices: [
               {
                 deviceType: undefined,
-                url: "deviceUrl"
-              }
+                url: 'deviceUrl',
+              },
             ],
             url: 'personUrl',
           },
           disposition: 'GRANTED',
           requester: {
-            "url": "personUrl"
-          }
+            url: 'personUrl',
+          },
         },
         resourceUrl: 'resourceUrl',
       };
 
-
       await meetingsRequest.changeMeetingFloor(options);
 
       assert.deepEqual(meetingsRequest.request.getCall(0).args[0], {
         method: 'PUT',
         uri: 'optionsUrl',
         body: expectBody,
-      })
+      });
     });
   });
 });