@webex/plugin-meetings 2.27.0 → 2.28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "2.27.0",
+  "version": "2.28.0",
   "description": "",
   "license": "MIT",
   "contributors": [
@@ -24,15 +24,15 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.14.8",
-    "@webex/webex-core": "2.27.0",
-    "@webex/internal-plugin-mercury": "2.27.0",
-    "@webex/internal-plugin-conversation": "2.27.0",
+    "@webex/webex-core": "2.28.0",
+    "@webex/internal-plugin-mercury": "2.28.0",
+    "@webex/internal-plugin-conversation": "2.28.0",
     "webrtc-adapter": "^7.7.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2",
     "global": "^4.4.0",
     "ip-anonymize": "^0.1.0",
-    "@webex/common": "2.27.0",
+    "@webex/common": "2.28.0",
     "bowser": "^2.11.0",
     "sdp-transform": "^2.12.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -302,6 +302,7 @@ export const EVENT_TRIGGERS = {
   MEETING_ACTIONS_UPDATE: 'meeting:actionsUpdate',
   MEETING_STATE_CHANGE: 'meeting:stateChange',
   MEETING_MEETING_CONTAINER_UPDATE: 'meeting:meetingContainer:update',
+  MEETING_EMBEDDED_APPS_UPDATE: 'meeting:embeddedApps:update',
   MEDIA_QUALITY: 'media:quality',
   MEETINGS_NETWORK_DISCONNECTED: 'network:disconnected',
   MEETINGS_NETWORK_CONNECTED: 'network:connected',
@@ -508,7 +509,8 @@ export const LOCUSINFO = {
     MEETING_LOCKED: 'MEETING_LOCKED',
     MEETING_UNLOCKED: 'MEETING_UNLOCKED',
     SELF_OBSERVING: 'SELF_OBSERVING',
-    DISCONNECT_DUE_TO_INACTIVITY: 'DISCONNECT_DUE_TO_INACTIVITY'
+    DISCONNECT_DUE_TO_INACTIVITY: 'DISCONNECT_DUE_TO_INACTIVITY',
+    EMBEDDED_APPS_UPDATED: 'EMBEDDED_APPS_UPDATED'
   }
 };
 
@@ -1053,3 +1055,8 @@ export const BNR_STATUS = {
   SHOULD_DISABLE: 'SHOULD_DISABLE',
   NOT_ENABLED: 'NOT_ENABLED'
 };
+
+export const EMBEDDED_APP_TYPES = {
+  SLIDO: 'SLIDO',
+  OTHER: 'OTHER'
+};

package/src/locus-info/embeddedAppsUtils.js

@@ -0,0 +1,51 @@
+import {EMBEDDED_APP_TYPES} from '../constants';
+
+const EmbeddedAppsUtils = {};
+
+const SLIDO_REGEX = /.sli.do\//;
+
+/**
+ * Parse the relevant values that we care about
+ * @param {Object} embeddedApp - raw embedded app object
+ * @returns {Object} parsedObject - parsed embedded app object
+ */
+EmbeddedAppsUtils.parseApp = (embeddedApp) => {
+  const parsedApp = {...embeddedApp};
+
+  parsedApp.type = EMBEDDED_APP_TYPES.OTHER;
+  const url = parsedApp.instanceInfo?.appInstanceUrl;
+
+  if (url && url.match(SLIDO_REGEX)) {
+    parsedApp.type = EMBEDDED_APP_TYPES.SLIDO;
+  }
+
+  return parsedApp;
+};
+
+/**
+ * Determines if two embedded apps arrays are similar.
+ * NOTE: This is a simple test for performance reasons.
+ * @param {any[]} apps1 - an array of apps
+ * @param {any[]} apps2 - an array of apps
+ * @returns {boolean} true if the arrays are different
+ */
+EmbeddedAppsUtils.areSimilar = (apps1, apps2) => {
+  if (apps1?.length !== apps2?.length) {
+    return false;
+  }
+  if (apps1?.[0]?.state !== apps2?.[0]?.state) {
+    return false;
+  }
+
+  return true;
+};
+
+/**
+ * Parse the array of embedded apps
+ * @param {array} embeddedApps
+ * @returns {array} result - new array of parsed embedded app objects
+ */
+EmbeddedAppsUtils.parse = (embeddedApps) => embeddedApps && embeddedApps.map(EmbeddedAppsUtils.parseApp);
+
+
+export default EmbeddedAppsUtils;

package/src/locus-info/index.js

@@ -24,6 +24,7 @@ import FullState from '../locus-info/fullState';
 import SelfUtils from '../locus-info/selfUtils';
 import HostUtils from '../locus-info/hostUtils';
 import ControlsUtils from '../locus-info/controlsUtils';
+import EmbeddedAppsUtils from '../locus-info/embeddedAppsUtils';
 import MediaSharesUtils from '../locus-info/mediaSharesUtils';
 import LocusDeltaParser from '../locus-info/parser';
 
@@ -151,6 +152,7 @@ export default class LocusInfo extends EventsScope {
     this.updateLocusUrl(locus.url);
     this.updateFullState(locus.fullState);
     this.updateMeetingInfo(locus.info);
+    this.updateEmbeddedApps(locus.embeddedApps);
     // self and participants generate sipUrl for 1:1 meeting
     this.updateSelf(locus.self, locus.participants);
     this.updateHostInfo(locus.host);
@@ -315,6 +317,7 @@ export default class LocusInfo extends EventsScope {
     this.updateSequence(locus.sequence);
     this.updateMemberShip(locus.membership);
     this.updateIdentifiers(locus.identities);
+    this.updateEmbeddedApps(locus.embeddedApps);
     this.compareAndUpdate();
     // update which required to compare different objects from locus
   }
@@ -841,6 +844,30 @@ export default class LocusInfo extends EventsScope {
     }
   }
 
+  /**
+   * @param {Object} embeddedApps
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  updateEmbeddedApps(embeddedApps) {
+    // don't do anything if the arrays of apps haven't changed significantly
+    if (EmbeddedAppsUtils.areSimilar(this.embeddedApps, embeddedApps)) {
+      return;
+    }
+
+    this.parsedLocus.embeddedApps = EmbeddedAppsUtils.parse(embeddedApps);
+
+    this.emitScoped(
+      {
+        file: 'locus-info',
+        function: 'updateEmbeddedApps'
+      },
+      LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
+      embeddedApps
+    );
+    this.embeddedApps = embeddedApps;
+  }
+
   /**
    * handles when the locus.mediaShares is updated
    * @param {Object} mediaShares the locus.mediaShares property

package/src/meeting/index.js

@@ -1065,6 +1065,7 @@ export default class Meeting extends StatelessWebexPlugin {
     this.setUpLocusParticipantsListener();
     this.setupLocusControlsListener();
     this.setUpLocusMediaSharesListener();
+    this.setUpLocusEmbeddedAppsListener();
     this.setUpLocusInfoMeetingInfoListener();
     this.setUpLocusInfoAssignHostListener();
     this.setUpLocusInfoMediaInactiveListener();
@@ -1905,6 +1906,28 @@ export default class Meeting extends StatelessWebexPlugin {
     });
   }
 
+  /**
+   * Set up the locus info embedded apps listener
+   * @returns {undefined}
+   * @private
+   * @memberof meeting
+   */
+  setUpLocusEmbeddedAppsListener() {
+    this.locusInfo.on(LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED, (embeddedApps) => {
+      if (embeddedApps) {
+        Trigger.trigger(
+          this,
+          {
+            file: 'meeting/index',
+            function: 'setUpLocusEmbeddedAppsListener'
+          },
+          EVENT_TRIGGERS.MEETING_EMBEDDED_APPS_UPDATE,
+          embeddedApps
+        );
+      }
+    });
+  }
+
   /**
    * Internal function to listen to the self object changes
    * @returns {undefined}

package/test/unit/spec/locus-info/embeddedAppsUtils.js

@@ -0,0 +1,102 @@
+import {assert} from '@webex/test-helper-chai';
+import {cloneDeep} from 'lodash';
+
+import EmbeddedAppUtils from '@webex/plugin-meetings/src/locus-info/embeddedAppsUtils';
+
+describe('plugin-meetings', () => {
+  describe('embeddedAppsUtils', () => {
+    const slidoApp = {
+      url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
+      sequence: 138849877016800000,
+      appId: 'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
+      instanceInfo: {
+        appInstanceUrl: 'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
+        externalAppInstanceUrl: '',
+        title: 'Active session'
+      },
+      state: 'STARTED',
+      lastModified: '2022-10-13T21:01:41.680Z'
+    };
+    const otherApp = {
+      url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
+      sequence: 138849877016800000,
+      appId: 'some-other-app-id',
+      instanceInfo: {
+        appInstanceUrl: 'https://webex.someotherapp.com/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
+        externalAppInstanceUrl: '',
+        title: 'Active session'
+      },
+      state: 'STARTED',
+      lastModified: '2022-10-13T21:01:31.680Z'
+    };
+
+    describe('parseApp', () => {
+      it('returns a parsed embedded app with type of SLIDO', () => {
+        const parsedApp = EmbeddedAppUtils.parseApp(slidoApp);
+        const expectedApp = {...slidoApp, ...{type: 'SLIDO'}};
+
+        assert.deepEqual(parsedApp, expectedApp);
+      });
+
+      it('returns a parsed embedded app with type of OTHER', () => {
+        const parsedApp = EmbeddedAppUtils.parseApp(otherApp);
+        const expectedApp = {...otherApp, ...{type: 'OTHER'}};
+
+        assert.deepEqual(parsedApp, expectedApp);
+      });
+    });
+
+    describe('parse', () => {
+      it('returns a copy of embeddedApps', () => {
+        const embeddedApps = [slidoApp];
+        const parsedApps = EmbeddedAppUtils.parse(embeddedApps);
+
+        assert.notStrictEqual(parsedApps, embeddedApps);
+        assert.equal(parsedApps.length, embeddedApps.length);
+      });
+    });
+
+    describe('areSimilar', () => {
+      it('returns true if the apps are the same', () => {
+        const apps1 = [slidoApp];
+        const apps2 = [cloneDeep(slidoApp)];
+
+        const different = EmbeddedAppUtils.areSimilar(apps1, apps2);
+
+        assert.equal(different, true);
+      });
+
+      it('returns false if the number of apps is different', () => {
+        const apps1 = [slidoApp];
+        const apps2 = [cloneDeep(slidoApp), cloneDeep(slidoApp)];
+
+        const different = EmbeddedAppUtils.areSimilar(apps1, apps2);
+
+        assert.equal(different, false);
+      });
+
+      it('returns false if the state of the first apps is different', () => {
+        const apps1 = [slidoApp];
+        const apps2 = [cloneDeep(slidoApp)];
+
+        apps2[0].state = 'STOPPED';
+
+        const different = EmbeddedAppUtils.areSimilar(apps1, apps2);
+
+        assert.equal(different, false);
+      });
+
+      it('handles null apps', () => {
+        assert.equal(EmbeddedAppUtils.areSimilar(null, null), true);
+        assert.equal(EmbeddedAppUtils.areSimilar(null, [slidoApp]), false);
+        assert.equal(EmbeddedAppUtils.areSimilar([slidoApp], null), false);
+      });
+
+      it('handles empty apps', () => {
+        assert.equal(EmbeddedAppUtils.areSimilar([], []), true);
+        assert.equal(EmbeddedAppUtils.areSimilar([], [slidoApp]), false);
+        assert.equal(EmbeddedAppUtils.areSimilar([slidoApp], []), false);
+      });
+    });
+  });
+});

package/test/unit/spec/locus-info/index.js

@@ -828,6 +828,60 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('#updateEmbeddedApps()', () => {
+      const newEmbeddedApps = [{
+        url: 'https://hecate-b.wbx2.com/apps/api/v1/locus/7a4994a7',
+        sequence: 138849877016800000,
+        appId: 'Y2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzQxODc1MGQ0LTM3ZDctNGY2MC1hOWE3LWEwZTE1NDFhNjRkNg',
+        instanceInfo: {
+          appInstanceUrl: 'https://webex.sli.do/participant/event/mFKKjcYxzx9h31eyWgngFS?clusterId=eu1',
+          externalAppInstanceUrl: '',
+          title: 'Active session'
+        },
+        state: 'STARTED',
+        lastModified: '2022-10-13T21:01:41.680Z'
+      }];
+
+      it('updates the embeddedApps object', () => {
+        const prev = locusInfo.embeddedApps;
+
+        locusInfo.updateEmbeddedApps(newEmbeddedApps);
+
+        assert.notEqual(locusInfo.embeddedApps, prev);
+      });
+
+      it('does not emit EMBEDDED_APPS_UPDATED when apps didn\'t change', () => {
+        locusInfo.updateEmbeddedApps(newEmbeddedApps);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        const clonedApps = cloneDeep(newEmbeddedApps);
+
+        locusInfo.updateEmbeddedApps(clonedApps);
+
+        assert.notCalled(locusInfo.emitScoped);
+      });
+
+      it('emits EMBEDDED_APPS_UPDATED when apps changed', () => {
+        locusInfo.updateEmbeddedApps(newEmbeddedApps);
+
+        locusInfo.emitScoped = sinon.stub();
+
+        const clonedApps = cloneDeep(newEmbeddedApps);
+
+        clonedApps[0].state = 'STOPPED';
+
+        locusInfo.updateEmbeddedApps(clonedApps);
+
+        assert.calledWith(locusInfo.emitScoped, {
+          file: 'locus-info',
+          function: 'updateEmbeddedApps'
+        },
+        LOCUSINFO.EVENTS.EMBEDDED_APPS_UPDATED,
+        clonedApps);
+      });
+    });
+
     describe('#LocusDeltaEvents', () => {
       const fakeMeeting = 'fakeMeeting';
       let sandbox = null;