@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

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

@@ -8,6 +8,7 @@ import Meetings from '@webex/plugin-meetings';
 import MembersRequest from '@webex/plugin-meetings/src/members/request';
 import membersUtil from '@webex/plugin-meetings/src/members/util';
 import ParameterError from '@webex/plugin-meetings/src/common/errors/parameter';
+import { merge } from 'lodash';
 
 const {assert} = chai;
 
@@ -18,28 +19,56 @@ describe('plugin-meetings', () => {
   let membersRequest;
   let url1;
   let sandbox;
+  const sequence = {some: 'sequenceData'};
+  const requestResponse = {some: 'data'};
+  let locusDeltaRequestSpy;
+  const correlationId = '12345';
 
   beforeEach(() => {
     const webex = new MockWebex({
       children: {
-        meetings: Meetings
-      }
+        meetings: Meetings,
+      },
     });
 
     sandbox = sinon.createSandbox();
 
+    sinon.stub(uuid, 'v4').returns(correlationId);
+
     url1 = `https://example.com/${uuid.v4()}`;
 
-    membersRequest = new MembersRequest({}, {
-      parent: webex
-    });
-    membersRequest.request = sinon.mock().returns(Promise.resolve({}));
+    const request = sinon.mock().returns(Promise.resolve(requestResponse));
+
+    membersRequest = new MembersRequest(
+      {
+        meeting: {
+          request,
+          locusInfo: {
+            sequence,
+          },
+        },
+      },
+      {
+        parent: webex,
+      }
+    );
+    locusDeltaRequestSpy = sinon.spy(membersRequest, 'locusDeltaRequest');
+
+    membersRequest.request = request;
   });
 
   afterEach(() => {
     sandbox.restore();
+    uuid.v4.restore();
   });
 
+  const checkRequest = (expectedParams) => {
+    assert.calledOnceWithExactly(locusDeltaRequestSpy, expectedParams);
+    assert.calledOnceWithExactly(
+      membersRequest.request,
+      merge(expectedParams, {body: {sequence}})
+    );
+  };
 
   describe('members request library', () => {
     describe('#sendDialPadKey', () => {
@@ -53,14 +82,24 @@ describe('plugin-meetings', () => {
           url,
           tones,
           memberId,
-          locusUrl
+          locusUrl,
         });
-        const requestParams = membersRequest.request.getCall(0).args[0];
 
-        assert.equal(requestParams.method, 'POST');
-        assert.equal(requestParams.uri, `${locusUrl}/participant/${memberId}/sendDtmf`);
-        assert.equal(requestParams.body.dtmf.tones, tones);
-        assert.equal(requestParams.body.device.url, url);
+        checkRequest({
+          method: 'POST',
+          uri: `${locusUrl}/participant/${memberId}/sendDtmf`,
+          body: {
+            memberId,
+            dtmf: {
+              direction: 'transmit',
+              correlationId,
+              tones,
+            },
+            device: {
+              url,
+            }
+          }
+        });
       });
     });
 
@@ -68,17 +107,97 @@ describe('plugin-meetings', () => {
       it('sends a PUT to the locus endpoint', async () => {
         const options = {
           invitee: {
-            phoneNumber: '+18578675309'
+            phoneNumber: '+18578675309',
           },
-          locusUrl: url1
+          locusUrl: url1,
         };
 
         await membersRequest.addMembers(options);
-        const requestParams = membersRequest.request.getCall(0).args[0];
 
-        assert.equal(requestParams.method, 'PUT');
-        assert.equal(requestParams.uri, url1);
-        assert.equal(requestParams.body.invitees[0].address, '+18578675309');
+        checkRequest({
+          method: 'PUT',
+          uri: url1,
+          body: {
+            alertIfActive: undefined,
+            invitees: [{address: '+18578675309'}]
+          }
+        })
+      });
+    });
+
+    describe('#admitMember', () => {
+      it('sends a request to admit members', async () => {
+        const options = {
+          locusUrl: url1,
+          memberIds: ['1', '2'],
+        };
+  
+        await membersRequest.admitMember(options)
+
+        checkRequest({
+          method: 'PUT',
+          uri: 'https://example.com/12345/controls',
+          body: {
+            admit: {
+              participantIds: options.memberIds
+            }
+          }
+        });
+      });
+    });
+
+    describe('#removeMember', () => {
+      it('sends a request to remove a member', async () => {
+        const options = {
+          locusUrl: url1,
+          memberId: 'member1',
+        };
+
+        await membersRequest.removeMember(options);
+
+        checkRequest({
+          method: 'PUT',
+          uri: 'https://example.com/12345/participant/member1/leave',
+          body: {
+            reason: undefined
+          },
+        });
+      });
+    });
+
+    describe('#muteMember', () => {
+      it('sends a request to mute a member', async () => {
+        const options = {
+          locusUrl: url1,
+          memberId: 'member1',
+          muted: true,
+        };
+
+        await membersRequest.muteMember(options);
+
+        checkRequest({
+          method: 'PATCH',
+          uri: 'https://example.com/12345/participant/member1/controls',
+          body: {audio: {muted: true}},
+        });
+      });
+    });
+
+    describe('#transferHostToMember', () => {
+      it('sends a request to transfer host to a member', async () => {
+        const options = {
+          locusUrl: url1,
+          memberId: 'member1',
+          moderator: true,
+        };
+
+        await membersRequest.transferHostToMember(options);
+
+        checkRequest({
+          method: 'PATCH',
+          uri: 'https://example.com/12345/participant/member1/controls',
+          body: {role: {moderator: true}},
+        });
       });
     });
 
@@ -86,18 +205,51 @@ describe('plugin-meetings', () => {
       it('sends a PUT to the locus endpoint', async () => {
         const options = {
           invitee: {
-            phoneNumber: '+18578675309'
+            phoneNumber: '+18578675309',
           },
-          locusUrl: url1
+          locusUrl: url1,
         };
 
         await membersRequest.cancelPhoneInvite(options);
-        const requestParams = membersRequest.request.getCall(0).args[0];
 
-        assert.equal(requestParams.method, 'PUT');
-        assert.equal(requestParams.uri, url1);
-        assert.equal(requestParams.body.invitees[0].address, '+18578675309');
-        assert.equal(requestParams.body.actionType, 'REMOVE');
+        checkRequest({
+          method: 'PUT',
+          uri: url1,
+          body: {
+            invitees: [{address: '+18578675309'}],
+            actionType: 'REMOVE',
+          },
+        });
+      });
+    });
+
+    describe('#assignRolesMember', () => {
+      it('sends a PATCH to the locus endpoint', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const roles = [
+          {type: 'PRESENTER', hasRole: true},
+          {type: 'MODERATOR', hasRole: false},
+          {type: 'COHOST', hasRole: true},
+        ];
+
+        const options = {
+          memberId,
+          locusUrl,
+          roles,
+        };
+
+        await membersRequest.assignRolesMember(options);
+
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/participant/${memberId}/controls`,
+          body: {
+            role: {
+              roles
+            }
+          }
+        });
       });
     });
 
@@ -109,23 +261,33 @@ describe('plugin-meetings', () => {
         const options = {
           memberId,
           locusUrl,
-          raised: true
+          raised: true,
         };
 
         await membersRequest.raiseOrLowerHandMember(options);
-        const requestParams = membersRequest.request.getCall(0).args[0];
 
-        assert.equal(requestParams.method, 'PATCH');
-        assert.equal(requestParams.uri, `${locusUrl}/participant/${memberId}/controls`);
-        assert.equal(requestParams.body.hand.raised, true);
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/participant/${memberId}/controls`,
+          body: {
+            hand: {
+              raised: true
+            }
+          }
+        });
       });
     });
 
     describe('#lowerAllHands', () => {
-      const parameterErrorMessage = 'requestingParticipantId must be defined, and the associated locus url for this meeting object must be defined.';
+      const parameterErrorMessage =
+        'requestingParticipantId must be defined, and the associated locus url for this meeting object must be defined.';
 
       const checkInvalid = async (functionParams) => {
-        assert.throws(() => membersRequest.lowerAllHandsMember(functionParams), ParameterError, parameterErrorMessage);
+        assert.throws(
+          () => membersRequest.lowerAllHandsMember(functionParams),
+          ParameterError,
+          parameterErrorMessage
+        );
         assert(membersRequest.request.notCalled);
         assert(membersUtil.getLowerAllHandsMemberRequestParams.notCalled);
       };
@@ -151,7 +313,9 @@ describe('plugin-meetings', () => {
           locusUrl,
         };
 
-        assert.strictEqual(membersRequest.lowerAllHandsMember(options), membersRequest.request.getCall(0).returnValue);
+        const result = await membersRequest.lowerAllHandsMember(options);
+
+        assert.strictEqual(result, requestResponse);
       });
 
       it('sends a PATCH to the locus endpoint', async () => {
@@ -163,26 +327,50 @@ describe('plugin-meetings', () => {
           locusUrl,
         };
 
-
         const getRequestParamsSpy = sandbox.spy(membersUtil, 'getLowerAllHandsMemberRequestParams');
 
         await membersRequest.lowerAllHandsMember(options);
 
         assert.calledOnceWithExactly(getRequestParamsSpy, {
           requestingParticipantId: memberId,
-          locusUrl: url1
+          locusUrl: url1,
         });
 
-        const requestParams = membersRequest.request.getCall(0).args[0];
-
-        assert.deepEqual(requestParams, {
+        checkRequest({
           method: 'PATCH',
           uri: `${locusUrl}/controls`,
           body: {
             hand: {
-              raised: false
+              raised: false,
             },
-            requestingParticipantId: memberId
+            requestingParticipantId: memberId,
+          },
+        });
+      });
+    });
+
+    describe('#editDisplayName', () => {
+      it('sends a POST request to the locus endpoint', async () => {
+        const locusUrl = url1;
+        const memberId = 'test1';
+        const requestingParticipantId = 'test2';
+        const aliasValue = 'alias';
+
+        const options = {
+          memberId,
+          requestingParticipantId,
+          alias: aliasValue,
+          locusUrl,
+        };
+
+        await membersRequest.editDisplayNameMember(options);
+
+        checkRequest({
+          method: 'POST',
+          uri: `${locusUrl}/participant/${memberId}/alias`,
+          body: {
+            aliasValue,
+            requestingParticipantId,
           }
         });
       });

package/test/unit/spec/members/utils.js

@@ -3,6 +3,7 @@ import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 
 import MembersUtil from '@webex/plugin-meetings/src/members/util';
+import {HTTP_VERBS, CONTROLS, PARTICIPANT} from '@webex/plugin-meetings/src/constants';
 
 const {assert} = chai;
 
@@ -11,6 +12,55 @@ sinon.assert.expose(chai.assert, {prefix: ''});
 
 describe('plugin-meetings', () => {
   describe('members utils library', () => {
+    describe('#generateRoleAssignmentMemberOptions', () => {
+      it('returns the correct options', () => {
+        const memberId = 'test';
+        const roles = [
+          {type: 'PRESENTER', hasRole: true},
+          {type: 'MODERATOR', hasRole: true},
+          {type: 'COHOST', hasRole: true},
+        ];
+        const locusUrl = 'urlTest1';
+
+        assert.deepEqual(
+          MembersUtil.generateRoleAssignmentMemberOptions(memberId, roles, locusUrl),
+          {
+            memberId,
+            roles,
+            locusUrl,
+          }
+        );
+      });
+    });
+
+    describe('#getRoleAssignmentMemberRequestParams', () => {
+      it('returns the correct request params', () => {
+        const format = {
+          locusUrl: 'locusUrl',
+          memberId: 'test',
+          roles: [
+            {type: 'PRESENTER', hasRole: true},
+            {type: 'MODERATOR', hasRole: false},
+            {type: 'COHOST', hasRole: true},
+          ],
+        };
+
+        assert.deepEqual(MembersUtil.getRoleAssignmentMemberRequestParams(format), {
+          method: 'PATCH',
+          uri: `locusUrl/${PARTICIPANT}/test/${CONTROLS}`,
+          body: {
+            role: {
+              roles: [
+                {type: 'PRESENTER', hasRole: true},
+                {type: 'MODERATOR', hasRole: false},
+                {type: 'COHOST', hasRole: true},
+              ],
+            },
+          },
+        });
+      });
+    });
+
     describe('#generateRaiseHandMemberOptions', () => {
       it('returns the correct options', () => {
         const memberId = 'test';
@@ -20,7 +70,7 @@ describe('plugin-meetings', () => {
         assert.deepEqual(MembersUtil.generateRaiseHandMemberOptions(memberId, status, locusUrl), {
           memberId,
           raised: status,
-          locusUrl
+          locusUrl,
         });
       });
     });
@@ -29,10 +79,147 @@ describe('plugin-meetings', () => {
         const requestingParticipantId = 'test';
         const locusUrl = 'urlTest1';
 
-        assert.deepEqual(MembersUtil.generateLowerAllHandsMemberOptions(requestingParticipantId, locusUrl), {
-          requestingParticipantId,
-          locusUrl
+        assert.deepEqual(
+          MembersUtil.generateLowerAllHandsMemberOptions(requestingParticipantId, locusUrl),
+          {
+            requestingParticipantId,
+            locusUrl,
+          }
+        );
+      });
+    });
+    describe('#generateEditDisplayNameMemberOptions', () => {
+      it('returns the correct options', () => {
+        const locusUrl = 'urlTest1';
+        const memberId = 'test1';
+        const requestingParticipantId = 'test2';
+        const alias = 'alias';
+
+        assert.deepEqual(
+          MembersUtil.generateEditDisplayNameMemberOptions(
+            memberId,
+            requestingParticipantId,
+            alias,
+            locusUrl
+          ),
+          {
+            memberId,
+            requestingParticipantId,
+            alias,
+            locusUrl,
+          }
+        );
+      });
+    });
+    describe('#getAdmitMemberRequestBody', () => {
+      it('returns the correct request body', () => {
+        const option1 = {memberIds: ['uuid']};
+
+        assert.deepEqual(MembersUtil.getAdmitMemberRequestBody(option1), {
+          admit: {participantIds: ['uuid']},
+        });
+
+        const option2 = {
+          memberIds: ['uuid'],
+          sessionLocusUrls: {authorizingLocusUrl: 'authorizingLocusUrl'},
+        };
+
+        assert.deepEqual(MembersUtil.getAdmitMemberRequestBody(option2), {
+          admit: {participantIds: ['uuid']},
+          authorizingLocusUrl: 'authorizingLocusUrl',
+        });
+      });
+    });
+    describe('#getAdmitMemberRequestParams', () => {
+      it('returns the correct request params', () => {
+        const format1 = {memberIds: ['uuid'], locusUrl: 'locusUrl'};
+
+        assert.deepEqual(MembersUtil.getAdmitMemberRequestParams(format1), {
+          method: 'PUT',
+          uri: 'locusUrl/controls',
+          body: {admit: {participantIds: ['uuid']}},
+        });
+
+        const format2 = {
+          memberIds: ['uuid'],
+          sessionLocusUrls: {
+            authorizingLocusUrl: 'authorizingLocusUrl',
+            mainLocusUrl: 'mainLocusUrl',
+          },
+          locusUrl: 'locusUrl',
+        };
+
+        assert.deepEqual(MembersUtil.getAdmitMemberRequestParams(format2), {
+          method: 'PUT',
+          uri: 'mainLocusUrl/controls',
+          body: {
+            admit: {participantIds: ['uuid']},
+            authorizingLocusUrl: 'authorizingLocusUrl',
+          },
+        });
+      });
+    });
+
+    describe('#generateMuteMemberOptions', () => {
+      const testOptions = (isAudio) => {
+        const memberId = 'bob';
+        const muteStatus = true;
+        const locusUrl = 'urlTest1';
+
+        assert.deepEqual(
+          MembersUtil.generateMuteMemberOptions(memberId, muteStatus, locusUrl, isAudio),
+          {
+            memberId,
+            muted: muteStatus,
+            locusUrl,
+            isAudio,
+          }
+        );
+      };
+
+      it('returns the correct options for audio', () => {
+        testOptions(true);
+      });
+
+      it('returns the correct options for video', () => {
+        testOptions(false);
+      });
+    });
+
+    describe('#getMuteMemberRequestParams', () => {
+      const testParams = (isAudio) => {
+        const memberId = 'bob';
+        const muteStatus = true;
+        const locusUrl = 'urlTest1';
+
+        const options = {
+          memberId,
+          muted: muteStatus,
+          locusUrl,
+          isAudio,
+        };
+
+        const uri = `${options.locusUrl}/${PARTICIPANT}/${options.memberId}/${CONTROLS}`;
+        const property = isAudio ? 'audio' : 'video';
+        const body = {
+          [property]: {
+            muted: options.muted,
+          },
+        };
+
+        assert.deepEqual(MembersUtil.getMuteMemberRequestParams(options), {
+          method: HTTP_VERBS.PATCH,
+          uri,
+          body,
         });
+      };
+
+      it('returns the correct params for audio', () => {
+        testParams(true);
+      });
+
+      it('returns the correct params for video', () => {
+        testParams(false);
       });
     });
   });

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

@@ -10,7 +10,6 @@ import {assert} from '@webex/test-helper-chai';
 
 import metrics from '@webex/plugin-meetings/src/metrics';
 
-
 /**
  * Meeting can only run in a browser, so we can only send metrics for
  * browser usage.
@@ -18,73 +17,24 @@ import metrics from '@webex/plugin-meetings/src/metrics';
 browserOnly(describe)('Meeting metrics', () => {
   let webex, mockSubmitMetric, sandbox;
 
-  const geoHintInfo = {
-    clientAddress: '2001:0db8:0000:08d3:0000:0000:0070:0000',
-    clientRegion: 'US-WEST',
-    countryCode: 'US',
-    regionCode: 'US-WEST',
-    timezone: 'America/Los_Angeles'
-  };
-
   beforeEach(() => {
     sandbox = sinon.createSandbox();
     mockSubmitMetric = sandbox.stub();
     webex = new MockWebex({
       children: {
-        metrics: Metrics
-      }
+        metrics: Metrics,
+      },
     });
 
-    webex.version = '1.2.3';
-    webex.credentials.getOrgId = sinon.fake.returns('7890');
-    webex.credentials.config = {
-      _values: {
-        clientId: 'mock-client-id'
-      }
-    };
     webex.config.metrics.type = ['behavioral'];
     webex.internal.metrics.submitClientMetrics = mockSubmitMetric;
-    metrics.initialSetup({}, webex);
+    metrics.initialSetup(webex);
   });
 
   afterEach(() => {
     sandbox.restore();
   });
 
-  describe('initPayload / initMediaPayload', () => {
-    it('should create payload with masked IPv4', () => {
-      geoHintInfo.clientAddress = '128.0.0.1';
-      webex.meetings = {
-        geoHintInfo
-      };
-      metrics.initialSetup({}, webex);
-      const payload = metrics.initPayload('myMetric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload.origin.clientInfo.localNetworkPrefix === '128.0.0.0');
-      assert(payload.event.name === 'myMetric');
-
-      const payload2 = metrics.initMediaPayload('myMetric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload2.origin.clientInfo.localNetworkPrefix === '128.0.0.0');
-    });
-
-    it('should create payload with masked IPv6', () => {
-      geoHintInfo.clientAddress = '2001:0db8:0000:08d3:0000:0000:0070:0000';
-      webex.meetings = {
-        geoHintInfo
-      };
-      metrics.initialSetup({}, webex);
-      const payload = metrics.initPayload('myIPv6Metric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload.origin.clientInfo.localNetworkPrefix === '2001:db8:0:8d3::');
-      assert(payload.event.name === 'myIPv6Metric');
-
-      const payload2 = metrics.initMediaPayload('myIPv6Metric', {}, {clientType: 'TEAMS_CLIENT'});
-
-      assert(payload2.origin.clientInfo.localNetworkPrefix === '2001:db8:0:8d3::');
-    });
-  });
-
   describe('#sendBehavioralMetric', () => {
     it('sends client metric via Metrics plugin', () => {
       metrics.sendBehavioralMetric('myMetric');
@@ -98,19 +48,15 @@ browserOnly(describe)('Meeting metrics', () => {
 
       metrics.sendBehavioralMetric('myMetric', fields, metricTags);
 
-      assert.calledWithMatch(
-        mockSubmitMetric,
-        'myMetric',
-        {
-          type: ['behavioral'],
-          fields: {
-            value: 567
-          },
-          tags: {
-            test: true
-          }
-        }
-      );
+      assert.calledWithMatch(mockSubmitMetric, 'myMetric', {
+        type: ['behavioral'],
+        fields: {
+          value: 567,
+        },
+        tags: {
+          test: true,
+        },
+      });
     });
   });
 });