@webex/plugin-meetings 3.0.0-beta.247 → 3.0.0-beta.249

package/dist/types/meeting/index.d.ts

@@ -384,7 +384,8 @@ export default class Meeting extends StatelessWebexPlugin {
     meetingJoinUrl: any;
     meetingNumber: any;
     meetingState: any;
-    permissionToken: any;
+    permissionToken: string;
+    permissionTokenPayload: any;
     resourceId: any;
     resourceUrl: string;
     selfId: string;
@@ -757,10 +758,16 @@ export default class Meeting extends StatelessWebexPlugin {
     private updateMeetingActions;
     /**
      * Sets the self user policies based on the contents of the permission token
+     * @returns {void}
+     */
+    setSelfUserPolicies(): void;
+    /**
+     * Sets the permission token payload on the class instance
+     *
      * @param {String} permissionToken
      * @returns {void}
      */
-    setSelfUserPolicies(permissionToken: string): void;
+    setPermissionTokenPayload(permissionToken: string): void;
     /**
      * Sets the sip uri on the class instance
      * uses meeting info as precedence
@@ -1509,4 +1516,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {Promise}
      */
     unpublishTracks(tracks: LocalTrack[]): Promise<void>;
+    /**
+     * Gets the time left in seconds till the permission token expires
+     * (from the time the function has been fired)
+     *
+     * @returns {number} time left in seconds
+     */
+    getPermissionTokenTimeLeftInSec(): number | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.247",
+  "version": "3.0.0-beta.249",
   "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.247",
-    "@webex/test-helper-chai": "3.0.0-beta.247",
-    "@webex/test-helper-mocha": "3.0.0-beta.247",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.247",
-    "@webex/test-helper-retry": "3.0.0-beta.247",
-    "@webex/test-helper-test-users": "3.0.0-beta.247",
+    "@webex/plugin-meetings": "3.0.0-beta.249",
+    "@webex/test-helper-chai": "3.0.0-beta.249",
+    "@webex/test-helper-mocha": "3.0.0-beta.249",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.249",
+    "@webex/test-helper-retry": "3.0.0-beta.249",
+    "@webex/test-helper-test-users": "3.0.0-beta.249",
     "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.247",
+    "@webex/common": "3.0.0-beta.249",
     "@webex/internal-media-core": "1.39.3",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.247",
-    "@webex/internal-plugin-device": "3.0.0-beta.247",
-    "@webex/internal-plugin-llm": "3.0.0-beta.247",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.247",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.247",
-    "@webex/internal-plugin-support": "3.0.0-beta.247",
-    "@webex/internal-plugin-user": "3.0.0-beta.247",
-    "@webex/media-helpers": "3.0.0-beta.247",
-    "@webex/plugin-people": "3.0.0-beta.247",
-    "@webex/plugin-rooms": "3.0.0-beta.247",
-    "@webex/webex-core": "3.0.0-beta.247",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.249",
+    "@webex/internal-plugin-device": "3.0.0-beta.249",
+    "@webex/internal-plugin-llm": "3.0.0-beta.249",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.249",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.249",
+    "@webex/internal-plugin-support": "3.0.0-beta.249",
+    "@webex/internal-plugin-user": "3.0.0-beta.249",
+    "@webex/media-helpers": "3.0.0-beta.249",
+    "@webex/plugin-people": "3.0.0-beta.249",
+    "@webex/plugin-rooms": "3.0.0-beta.249",
+    "@webex/webex-core": "3.0.0-beta.249",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/meeting/index.ts

@@ -542,7 +542,8 @@ export default class Meeting extends StatelessWebexPlugin {
   meetingJoinUrl: any;
   meetingNumber: any;
   meetingState: any;
-  permissionToken: any;
+  permissionToken: string;
+  permissionTokenPayload: any;
   resourceId: any;
   resourceUrl: string;
   selfId: string;
@@ -3021,7 +3022,8 @@ export default class Meeting extends StatelessWebexPlugin {
         webexMeetingInfo?.hostId ||
         this.owner;
       this.permissionToken = webexMeetingInfo?.permissionToken;
-      this.setSelfUserPolicies(this.permissionToken);
+      this.setPermissionTokenPayload(webexMeetingInfo?.permissionToken);
+      this.setSelfUserPolicies();
       // Need to populate environment when sending CA event
       this.environment = locusMeetingObject?.info.channel || webexMeetingInfo?.channel;
     }
@@ -3285,11 +3287,20 @@ export default class Meeting extends StatelessWebexPlugin {
 
   /**
    * Sets the self user policies based on the contents of the permission token
+   * @returns {void}
+   */
+  setSelfUserPolicies() {
+    this.selfUserPolicies = this.permissionTokenPayload?.permission?.userPolicies;
+  }
+
+  /**
+   * Sets the permission token payload on the class instance
+   *
    * @param {String} permissionToken
    * @returns {void}
    */
-  setSelfUserPolicies(permissionToken: string) {
-    this.selfUserPolicies = jwt.decode(permissionToken)?.permission?.userPolicies;
+  public setPermissionTokenPayload(permissionToken: string) {
+    this.permissionTokenPayload = jwt.decode(permissionToken);
   }
 
   /**
@@ -7179,4 +7190,26 @@ export default class Meeting extends StatelessWebexPlugin {
       }
     }
   }
+
+  /**
+   * Gets the time left in seconds till the permission token expires
+   * (from the time the function has been fired)
+   *
+   * @returns {number} time left in seconds
+   */
+  public getPermissionTokenTimeLeftInSec(): number | undefined {
+    if (!this.permissionTokenPayload) {
+      return undefined;
+    }
+
+    const permissionTokenExpValue = Number(this.permissionTokenPayload.exp);
+
+    // using new Date instead of Date.now() to allow for accurate unit testing
+    // https://github.com/sinonjs/fake-timers/issues/321
+    const now = new Date().getTime();
+
+    // substract current time from the permissionTokenExp
+    // (permissionTokenExp is a epoch timestamp, not a time to live duration)
+    return (permissionTokenExpValue - now) / 1000;
+  }
 }

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

@@ -5563,29 +5563,40 @@ describe('plugin-meetings', () => {
         });
       });
 
+      describe('#setPermissionTokenPayload', () => {
+        it('sets correctly', () => {
+          assert.notOk(meeting.permissionTokenPayload);
+
+          const permissionTokenPayloadData = {permission: {userPolicies: {a: true}}, exp: '1234'};
+          
+          const jwtDecodeStub = sinon.stub(jwt, 'decode').returns(permissionTokenPayloadData);
+          
+          meeting.setPermissionTokenPayload();
+
+          assert.calledOnce(jwtDecodeStub);
+          assert.deepEqual(meeting.permissionTokenPayload, permissionTokenPayloadData);
+        });
+      });
+
       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}}};
+          meeting.permissionTokenPayload = policyData;
 
-          sinon.stub(jwt, 'decode').returns(policyData);
-
-          meeting.setSelfUserPolicies(dummyToken);
+          meeting.setSelfUserPolicies();
 
-          assert.deepEqual(meeting.selfUserPolicies, {a: true});
+          assert.deepEqual(meeting.selfUserPolicies, policyData.permission.userPolicies);
         });
 
         it('handles missing permission data', () => {
           assert.notOk(meeting.selfUserPolicies);
 
-          const dummyToken = 'some data';
           const policyData = {};
+          meeting.permissionTokenPayload = policyData;
 
-          sinon.stub(jwt, 'decode').returns(policyData);
-
-          meeting.setSelfUserPolicies(dummyToken);
+          meeting.setSelfUserPolicies();
 
           assert.deepEqual(meeting.selfUserPolicies, undefined);
         });
@@ -5593,12 +5604,10 @@ describe('plugin-meetings', () => {
         it('handles missing policy data', () => {
           assert.notOk(meeting.selfUserPolicies);
 
-          const dummyToken = 'some data';
           const policyData = {permission: {}};
+          meeting.permissionTokenPayload = policyData;
 
-          sinon.stub(jwt, 'decode').returns(policyData);
-
-          meeting.setSelfUserPolicies(dummyToken);
+          meeting.setSelfUserPolicies();
 
           assert.deepEqual(meeting.selfUserPolicies, undefined);
         });
@@ -5658,19 +5667,37 @@ describe('plugin-meetings', () => {
           assert.equal(meeting.owner, expectedInfoToParse.owner);
           assert.equal(meeting.permissionToken, expectedInfoToParse.permissionToken);
           assert.deepEqual(meeting.selfUserPolicies, expectedInfoToParse.selfUserPolicies);
+          
+          if(expectedInfoToParse.permissionTokenPayload) {
+            assert.deepEqual(meeting.permissionTokenPayload, expectedInfoToParse.permissionTokenPayload);
+          }
         };
 
         it('should parse meeting info from api return when locus meeting object is not available, set values, and return null', () => {
           meeting.config.experimental = {enableMediaNegotiatedEvent: true};
           meeting.config.experimental.enableUnifiedMeetings = true;
+
+          const expectedPermissionTokenPayload = {
+            exp: "123456",
+            permission: {
+              userPolicies: {
+                a: true
+              }
+            }
+          };
+
+          // generated permissionToken with secret `secret` and 
+          // value `JSON.stringify(expectedPermissionTokenPayload)`
+          const permissionToken = 
+            'eyJhbGciOiJIUzI1NiJ9.eyJleHAiOiIxMjM0NTYiLCJwZXJtaXNzaW9uIjp7InVzZXJQb2xpY2llcyI6eyJhIjp0cnVlfX19.wkTk0Hp8sUlq2wi2nP4-Ym4Xb7aEUHzyXA1kzk6f0V0';
+
           const FAKE_MEETING_INFO = {
             body: {
               conversationUrl: uuid1,
               locusUrl: url1,
               meetingJoinUrl: url2,
               meetingNumber: '12345',
-              permissionToken:
-                'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwZXJtaXNzaW9uIjp7InVzZXJQb2xpY2llcyI6eyJhIjp0cnVlfX0sImlhdCI6MTY4OTE2NDEwMn0.9uL_U7QUdYyMerrgHC_gCKOax2j_bz04u8Ikbv9KiXU',
+              permissionToken,
               sipMeetingUri: test1,
               sipUrl: test1,
               owner: test2,
@@ -5678,6 +5705,7 @@ describe('plugin-meetings', () => {
           };
 
           meeting.parseMeetingInfo(FAKE_MEETING_INFO);
+
           const expectedInfoToParse = {
             conversationUrl: uuid1,
             locusUrl: url1,
@@ -5686,8 +5714,8 @@ describe('plugin-meetings', () => {
             meetingJoinUrl: url2,
             owner: test2,
             selfUserPolicies: {a: true},
-            permissionToken:
-              'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwZXJtaXNzaW9uIjp7InVzZXJQb2xpY2llcyI6eyJhIjp0cnVlfX0sImlhdCI6MTY4OTE2NDEwMn0.9uL_U7QUdYyMerrgHC_gCKOax2j_bz04u8Ikbv9KiXU',
+            permissionToken,
+            permissionTokenPayload: expectedPermissionTokenPayload
           };
 
           checkParseMeetingInfo(expectedInfoToParse);
@@ -7997,4 +8025,36 @@ describe('plugin-meetings', () => {
       });
     });
   });
+
+  describe('#getPermissionTokenTimeLeftInSec', () => {
+    let now;
+    let clock;
+
+    beforeEach(() => {
+      now = Date.now();
+
+      // mock `new Date()` with constant `now`
+      clock = sinon.useFakeTimers(now);
+    });
+
+    afterEach(() => {
+      clock.restore();  
+    })
+
+    it('should return undefined if exp is undefined', () => { 
+      assert.equal(meeting.getPermissionTokenTimeLeftInSec(), undefined)
+    });
+
+    it('should return the expected positive exp', () => { 
+      // set permission token as now + 1 sec
+      meeting.permissionTokenPayload = {exp: (now + 1000).toString()};
+      assert.equal(meeting.getPermissionTokenTimeLeftInSec(), 1);
+    });
+
+    it('should return the expected negative exp', () => { 
+      // set permission token as now - 1 sec
+      meeting.permissionTokenPayload = {exp: (now - 1000).toString()};
+      assert.equal(meeting.getPermissionTokenTimeLeftInSec(), -1);
+    });
+  });
 });