@webex/plugin-meetings 3.0.0-beta.169 → 3.0.0-beta.170

package/src/meeting/index.ts

@@ -1,5 +1,6 @@
 import uuid from 'uuid';
 import {cloneDeep, isEqual, defer, isEmpty} from 'lodash';
+import jwt from 'jsonwebtoken';
 // @ts-ignore - Fix this
 import {StatelessWebexPlugin} from '@webex/webex-core';
 import {ClientEvent, CALL_DIAGNOSTIC_CONFIG} from '@webex/internal-plugin-metrics';
@@ -508,6 +509,7 @@ export default class Meeting extends StatelessWebexPlugin {
   controlsOptionsManager: ControlsOptionsManager;
   requiredCaptcha: any;
   receiveSlotManager: ReceiveSlotManager;
+  selfUserPolicies: any;
   shareStatus: string;
   statsAnalyzer: StatsAnalyzer;
   transcription: Transcription;
@@ -2426,10 +2428,22 @@ export default class Meeting extends StatelessWebexPlugin {
           ),
           canSetMuted: ControlsOptionsUtil.canSetMuted(payload.info.userDisplayHints),
           canUnsetMuted: ControlsOptionsUtil.canUnsetMuted(payload.info.userDisplayHints),
-          canStartRecording: RecordingUtil.canUserStart(payload.info.userDisplayHints),
-          canStopRecording: RecordingUtil.canUserStop(payload.info.userDisplayHints),
-          canPauseRecording: RecordingUtil.canUserPause(payload.info.userDisplayHints),
-          canResumeRecording: RecordingUtil.canUserResume(payload.info.userDisplayHints),
+          canStartRecording: RecordingUtil.canUserStart(
+            payload.info.userDisplayHints,
+            this.selfUserPolicies
+          ),
+          canStopRecording: RecordingUtil.canUserStop(
+            payload.info.userDisplayHints,
+            this.selfUserPolicies
+          ),
+          canPauseRecording: RecordingUtil.canUserPause(
+            payload.info.userDisplayHints,
+            this.selfUserPolicies
+          ),
+          canResumeRecording: RecordingUtil.canUserResume(
+            payload.info.userDisplayHints,
+            this.selfUserPolicies
+          ),
           canRaiseHand: MeetingUtil.canUserRaiseHand(payload.info.userDisplayHints),
           canLowerAllHands: MeetingUtil.canUserLowerAllHands(payload.info.userDisplayHints),
           canLowerSomeoneElsesHand: MeetingUtil.canUserLowerSomeoneElsesHand(
@@ -2564,6 +2578,7 @@ export default class Meeting extends StatelessWebexPlugin {
         });
 
         this.recordingController.setDisplayHints(payload.info.userDisplayHints);
+        this.recordingController.setUserPolicy(this.selfUserPolicies);
         this.controlsOptionsManager.setDisplayHints(payload.info.userDisplayHints);
 
         if (changed) {
@@ -3128,11 +3143,21 @@ export default class Meeting extends StatelessWebexPlugin {
         webexMeetingInfo?.hostId ||
         this.owner;
       this.permissionToken = webexMeetingInfo?.permissionToken;
+      this.setSelfUserPolicies(this.permissionToken);
       // Need to populate environment when sending CA event
       this.environment = locusMeetingObject?.info.channel || webexMeetingInfo?.channel;
     }
   }
 
+  /**
+   * Sets the self user policies based on the contents of the permission token
+   * @param {String} permissionToken
+   * @returns {void}
+   */
+  setSelfUserPolicies(permissionToken: string) {
+    this.selfUserPolicies = jwt.decode(permissionToken)?.permission?.userPolicies;
+  }
+
   /**
    * Sets the sip uri on the class instance
    * uses meeting info as precedence

package/src/meeting/util.ts

@@ -10,6 +10,7 @@ import {
   PASSWORD_STATUS,
   DISPLAY_HINTS,
   FULL_STATE,
+  SELF_POLICY,
 } from '../constants';
 import IntentToJoinError from '../common/errors/intent-to-join';
 import JoinMeetingError from '../common/errors/join-meeting';
@@ -557,6 +558,14 @@ const MeetingUtil = {
 
     return locusDeltaRequest;
   },
+
+  selfSupportsFeature: (feature: SELF_POLICY, userPolicies: Record<SELF_POLICY, boolean>) => {
+    if (!userPolicies) {
+      return true;
+    }
+
+    return userPolicies[feature];
+  },
 };
 
 export default MeetingUtil;

package/src/recording-controller/index.ts

@@ -1,5 +1,5 @@
 import PermissionError from '../common/errors/permission';
-import {CONTROLS, HTTP_VERBS} from '../constants';
+import {CONTROLS, HTTP_VERBS, SELF_POLICY} from '../constants';
 import MeetingRequest from '../meeting/request';
 import RecordingAction from './enums';
 import Util from './util';
@@ -28,6 +28,14 @@ export default class RecordingController {
    */
   private displayHints: Array<string> = [];
 
+  /**
+   * @instance
+   * @type {Object}
+   * @private
+   * @memberof RecordingInfo
+   */
+  private selfUserPolicies: Record<SELF_POLICY, boolean>;
+
   /**
    * @instance
    * @type {string}
@@ -126,6 +134,16 @@ export default class RecordingController {
     this.displayHints = hints;
   }
 
+  /**
+   * @param {Object} selfUserPolicies
+   * @returns {void}
+   * @public
+   * @memberof RecordingController
+   */
+  public setUserPolicy(selfUserPolicies: Record<SELF_POLICY, boolean>) {
+    this.selfUserPolicies = selfUserPolicies;
+  }
+
   /**
    * @param {string} id
    * @returns {void}
@@ -264,7 +282,7 @@ export default class RecordingController {
     );
 
     // assumes action is proper cased (i.e., Example)
-    if (Util?.[`canUser${action}`](this.displayHints)) {
+    if (Util?.[`canUser${action}`](this.displayHints, this.selfUserPolicies)) {
       if (this.serviceUrl) {
         return this.recordingService(action);
       }

package/src/recording-controller/util.ts

@@ -1,17 +1,34 @@
-import {DISPLAY_HINTS} from '../constants';
+import {DISPLAY_HINTS, SELF_POLICY} from '../constants';
 import RecordingAction from './enums';
+import MeetingUtil from '../meeting/util';
 
-const canUserStart = (displayHints: Array<string>): boolean =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_START);
+const canUserStart = (
+  displayHints: Array<string>,
+  userPolicies: Record<SELF_POLICY, boolean>
+): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_START) &&
+  MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_NETWORK_BASED_RECORD, userPolicies);
 
-const canUserPause = (displayHints: Array<string>): boolean =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_PAUSE);
+const canUserPause = (
+  displayHints: Array<string>,
+  userPolicies: Record<SELF_POLICY, boolean>
+): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_PAUSE) &&
+  MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_NETWORK_BASED_RECORD, userPolicies);
 
-const canUserResume = (displayHints: Array<string>): boolean =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_RESUME);
+const canUserResume = (
+  displayHints: Array<string>,
+  userPolicies: Record<SELF_POLICY, boolean>
+): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_RESUME) &&
+  MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_NETWORK_BASED_RECORD, userPolicies);
 
-const canUserStop = (displayHints: Array<string>): boolean =>
-  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_STOP);
+const canUserStop = (
+  displayHints: Array<string>,
+  userPolicies: Record<SELF_POLICY, boolean>
+): boolean =>
+  displayHints.includes(DISPLAY_HINTS.RECORDING_CONTROL_STOP) &&
+  MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_NETWORK_BASED_RECORD, userPolicies);
 
 const extractLocusId = (url: string) => {
   return url?.split('/').pop();

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

@@ -2,6 +2,7 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 import 'jsdom-global/register';
+import jwt from 'jsonwebtoken';
 import {cloneDeep, forEach, isEqual} from 'lodash';
 import sinon from 'sinon';
 import * as internalMediaModule from '@webex/internal-media-core';
@@ -5107,6 +5108,56 @@ describe('plugin-meetings', () => {
           assert.equal(meeting.sipUri, test1);
         });
       });
+
+      describe('#setSelfUserPolicies', () => {
+        it('sets correctly when policy data is present in token', () => {
+          assert.notOk(meeting.selfUserPolicies);
+
+          const dummyToken = 'some data';
+          const policyData = {permission: {userPolicies: {a: true}}};
+
+          sinon.stub(jwt, 'decode').returns(policyData);
+
+          meeting.setSelfUserPolicies(dummyToken);
+
+          assert.deepEqual(meeting.selfUserPolicies, {a: true});
+        });
+
+        it('handles missing permission data', () => {
+          assert.notOk(meeting.selfUserPolicies);
+
+          const dummyToken = 'some data';
+          const policyData = {};
+
+          sinon.stub(jwt, 'decode').returns(policyData);
+
+          meeting.setSelfUserPolicies(dummyToken);
+
+          assert.deepEqual(meeting.selfUserPolicies, undefined);
+        });
+
+        it('handles missing policy data', () => {
+          assert.notOk(meeting.selfUserPolicies);
+
+          const dummyToken = 'some data';
+          const policyData = {permission: {}};
+
+          sinon.stub(jwt, 'decode').returns(policyData);
+
+          meeting.setSelfUserPolicies(dummyToken);
+
+          assert.deepEqual(meeting.selfUserPolicies, undefined);
+        });
+
+        it('handles missing token', () => {
+          assert.notOk(meeting.selfUserPolicies);
+
+          meeting.setSelfUserPolicies();
+
+          assert.deepEqual(meeting.selfUserPolicies, undefined);
+        });
+      });
+
       describe('#unsetRemoteTracks', () => {
         it('should unset the remote tracks and return null', () => {
           meeting.mediaProperties.unsetRemoteTracks = sinon.stub().returns(true);
@@ -5142,6 +5193,7 @@ describe('plugin-meetings', () => {
           assert.calledOnce(meeting.mediaProperties.unsetPeerConnection);
         });
       });
+
       describe('#parseMeetingInfo', () => {
         const checkParseMeetingInfo = (expectedInfoToParse) => {
           assert.equal(meeting.conversationUrl, expectedInfoToParse.conversationUrl);
@@ -5151,6 +5203,7 @@ describe('plugin-meetings', () => {
           assert.equal(meeting.meetingJoinUrl, expectedInfoToParse.meetingJoinUrl);
           assert.equal(meeting.owner, expectedInfoToParse.owner);
           assert.equal(meeting.permissionToken, expectedInfoToParse.permissionToken);
+          assert.deepEqual(meeting.selfUserPolicies, expectedInfoToParse.selfUserPolicies);
         };
 
         it('should parse meeting info from api return when locus meeting object is not available, set values, and return null', () => {
@@ -5162,7 +5215,8 @@ describe('plugin-meetings', () => {
               locusUrl: url1,
               meetingJoinUrl: url2,
               meetingNumber: '12345',
-              permissionToken: 'abc',
+              permissionToken:
+                'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwZXJtaXNzaW9uIjp7InVzZXJQb2xpY2llcyI6eyJhIjp0cnVlfX0sImlhdCI6MTY4OTE2NDEwMn0.9uL_U7QUdYyMerrgHC_gCKOax2j_bz04u8Ikbv9KiXU',
               sipMeetingUri: test1,
               sipUrl: test1,
               owner: test2,
@@ -5177,7 +5231,9 @@ describe('plugin-meetings', () => {
             meetingNumber: '12345',
             meetingJoinUrl: url2,
             owner: test2,
-            permissionToken: 'abc',
+            selfUserPolicies: {a: true},
+            permissionToken:
+              'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwZXJtaXNzaW9uIjp7InVzZXJQb2xpY2llcyI6eyJhIjp0cnVlfX0sImlhdCI6MTY4OTE2NDEwMn0.9uL_U7QUdYyMerrgHC_gCKOax2j_bz04u8Ikbv9KiXU',
           };
 
           checkParseMeetingInfo(expectedInfoToParse);
@@ -5398,6 +5454,9 @@ describe('plugin-meetings', () => {
           const restorableHasHints = ControlsOptionsUtil.hasHints;
           ControlsOptionsUtil.hasHints = sinon.stub().returns(true);
 
+          const setUserPolicySpy = sinon.spy(meeting.recordingController, 'setUserPolicy');
+          meeting.selfUserPolicies = {a: true};
+
           meeting.setUpLocusInfoMeetingInfoListener();
 
           assert.calledThrice(locusInfoOnSpy);
@@ -5509,6 +5568,8 @@ describe('plugin-meetings', () => {
             displayHints: payload.info.userDisplayHints,
           });
 
+          assert.calledWith(setUserPolicySpy, {a: true});
+
           assert.calledWith(
             TriggerProxy.trigger,
             meeting,

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

@@ -3,6 +3,8 @@ import {assert} from '@webex/test-helper-chai';
 import MeetingUtil from '@webex/plugin-meetings/src/meeting/util';
 import LoggerProxy from '@webex/plugin-meetings/src/common/logs/logger-proxy';
 import LoggerConfig from '@webex/plugin-meetings/src/common/logs/logger-config';
+import Metrics from '@webex/plugin-meetings/src/metrics/index';
+import {SELF_POLICY} from '@webex/plugin-meetings/src/constants';
 import {DISPLAY_HINTS} from '@webex/plugin-meetings/src/constants';
 import MockWebex from '@webex/test-helper-mock-webex';
 
@@ -269,6 +271,33 @@ describe('plugin-meetings', () => {
 
     });
 
+    describe('selfSupportsFeature', () => {
+      it('returns true if there are no user policies', () => {
+        assert.equal(
+          MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_ANNOTATION, undefined),
+          true
+        );
+      });
+
+      it('returns true if policy is true', () => {
+        assert.equal(
+          MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_ANNOTATION, {
+            [SELF_POLICY.SUPPORT_ANNOTATION]: true
+          }),
+          true
+        );
+      });
+
+      it('returns false if policy is false', () => {
+        assert.equal(
+          MeetingUtil.selfSupportsFeature(SELF_POLICY.SUPPORT_ANNOTATION, {
+            [SELF_POLICY.SUPPORT_ANNOTATION]: false,
+          }),
+          false
+        );
+      });
+    });
+
     describe('remoteUpdateAudioVideo', () => {
       it('#Should call meetingRequest.locusMediaRequest with correct parameters', async () => {
         const meeting = {