@webex/plugin-meetings 3.10.0-webex-services-ready.2 → 3.10.0-webex-services-ready.3

package/dist/types/locus-info/index.d.ts

@@ -29,10 +29,7 @@ export default class LocusInfo extends EventsScope {
     aclUrl: any;
     baseSequence: any;
     created: any;
-    identities: any;
-    membership: any;
     participants: any;
-    participantsUrl: any;
     replaces: any;
     scheduledMeeting: any;
     sequence: any;
@@ -44,7 +41,6 @@ export default class LocusInfo extends EventsScope {
     info: any;
     roles: any;
     mediaShares: any;
-    replace: any;
     url: any;
     links?: Links;
     mainSessionLocusCache: any;
@@ -320,17 +316,11 @@ export default class LocusInfo extends EventsScope {
      */
     updateMediaShares(mediaShares: object, forceUpdate?: boolean): void;
     /**
-     * @param {String} participantsUrl
+     * @param {Object} replaces
      * @returns {undefined}
      * @memberof LocusInfo
      */
-    updateParticipantsUrl(participantsUrl: string): void;
-    /**
-     * @param {Object} replace
-     * @returns {undefined}
-     * @memberof LocusInfo
-     */
-    updateReplace(replace: object): void;
+    updateReplaces(replaces: object): void;
     /**
      * handles when the locus.self is updated
      * @param {Object} self the new locus.self
@@ -365,18 +355,6 @@ export default class LocusInfo extends EventsScope {
      * @memberof LocusInfo
      */
     updateSequence(sequence: number): void;
-    /**
-     * @param {Object} membership
-     * @returns {undefined}
-     * @memberof LocusInfo
-     */
-    updateMemberShip(membership: object): void;
-    /**
-     * @param {Array} identities
-     * @returns {undefined}
-     * @memberof LocusInfo
-     */
-    updateIdentifiers(identities: Array<any>): void;
     /**
      * check the locus is main session's one or not, if is main session's, update main session cache
      * @param {Object} locus

package/dist/webinar/index.js

@@ -448,7 +448,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.10.0-webex-services-ready.2"
+  version: "3.10.0-webex-services-ready.3"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,12 +43,12 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-rooms": "3.10.0-webex-services-ready.2",
-    "@webex/test-helper-chai": "3.10.0-webex-services-ready.1",
-    "@webex/test-helper-mocha": "3.10.0-webex-services-ready.1",
-    "@webex/test-helper-mock-webex": "3.10.0-webex-services-ready.1",
-    "@webex/test-helper-retry": "3.10.0-webex-services-ready.1",
-    "@webex/test-helper-test-users": "3.10.0-webex-services-ready.1",
+    "@webex/plugin-rooms": "3.10.0-webex-services-ready.3",
+    "@webex/test-helper-chai": "3.10.0-webex-services-ready.2",
+    "@webex/test-helper-mocha": "3.10.0-webex-services-ready.2",
+    "@webex/test-helper-mock-webex": "3.10.0-webex-services-ready.2",
+    "@webex/test-helper-retry": "3.10.0-webex-services-ready.2",
+    "@webex/test-helper-test-users": "3.10.0-webex-services-ready.2",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -60,23 +60,23 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.10.0-webex-services-ready.1",
+    "@webex/common": "3.10.0-webex-services-ready.2",
     "@webex/event-dictionary-ts": "^1.0.1930",
     "@webex/internal-media-core": "2.20.3",
-    "@webex/internal-plugin-conversation": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-device": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-llm": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-mercury": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-metrics": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-support": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-user": "3.10.0-webex-services-ready.2",
-    "@webex/internal-plugin-voicea": "3.10.0-webex-services-ready.2",
-    "@webex/media-helpers": "3.10.0-webex-services-ready.1",
-    "@webex/plugin-people": "3.10.0-webex-services-ready.2",
-    "@webex/plugin-rooms": "3.10.0-webex-services-ready.2",
+    "@webex/internal-plugin-conversation": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-device": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-llm": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-mercury": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-metrics": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-support": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-user": "3.10.0-webex-services-ready.3",
+    "@webex/internal-plugin-voicea": "3.10.0-webex-services-ready.3",
+    "@webex/media-helpers": "3.10.0-webex-services-ready.2",
+    "@webex/plugin-people": "3.10.0-webex-services-ready.3",
+    "@webex/plugin-rooms": "3.10.0-webex-services-ready.3",
     "@webex/ts-sdp": "^1.8.1",
     "@webex/web-capabilities": "^1.7.1",
-    "@webex/webex-core": "3.10.0-webex-services-ready.2",
+    "@webex/webex-core": "3.10.0-webex-services-ready.3",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.10.0-webex-services-ready.2"
+  "version": "3.10.0-webex-services-ready.3"
 }

package/src/hashTree/hashTree.ts

@@ -1,4 +1,4 @@
-import {XXH3_128} from 'xxh3-ts';
+import {XXH3_128} from 'xxh3-ts/xxh3';
 import {EMPTY_HASH} from './constants';
 import {ObjectType} from './types';
 

package/src/locus-info/index.ts

@@ -18,6 +18,7 @@ import {
   CALL_REMOVED_REASON,
   RECORDING_STATE,
   Enum,
+  SELF_ROLES,
 } from '../constants';
 
 import InfoUtils from './infoUtils';
@@ -96,10 +97,7 @@ export default class LocusInfo extends EventsScope {
   aclUrl: any;
   baseSequence: any;
   created: any;
-  identities: any;
-  membership: any;
   participants: any;
-  participantsUrl: any;
   replaces: any;
   scheduledMeeting: any;
   sequence: any;
@@ -111,7 +109,6 @@ export default class LocusInfo extends EventsScope {
   info: any;
   roles: any;
   mediaShares: any;
-  replace: any;
   url: any;
   links?: Links;
   mainSessionLocusCache: any;
@@ -327,13 +324,10 @@ export default class LocusInfo extends EventsScope {
   init(locus: any = {}) {
     this.created = locus.created || null;
     this.scheduledMeeting = locus.meeting || null;
-    this.participantsUrl = locus.participantsUrl || null;
     this.replaces = locus.replaces || null;
     this.aclUrl = locus.aclUrl || null;
     this.baseSequence = locus.baseSequence || null;
     this.sequence = locus.sequence || null;
-    this.membership = locus.membership || null;
-    this.identities = locus.identities || null;
     this.participants = locus.participants || null;
 
     /**
@@ -512,6 +506,14 @@ export default class LocusInfo extends EventsScope {
   updateLocusFromHashTreeObject(object: HashTreeObject, locus: LocusDTO): LocusDTO {
     const type = object.htMeta.elementId.type.toLowerCase();
 
+    const addParticipantObject = (obj: HashTreeObject) => {
+      if (!locus.participants) {
+        locus.participants = [];
+      }
+      locus.participants.push(obj.data);
+      this.hashTreeObjectId2ParticipantId.set(obj.htMeta.elementId.id, obj.data.id);
+    };
+
     switch (type) {
       case ObjectType.locus: {
         if (!object.data) {
@@ -577,13 +579,7 @@ export default class LocusInfo extends EventsScope {
           } ${object.data ? 'updated' : 'removed'} version=${object.htMeta.elementId.version}`
         );
         if (object.data) {
-          if (!locus.participants) {
-            locus.participants = [];
-          }
-          const participantObject = object.data;
-          participantObject.htMeta = object.htMeta;
-          locus.participants.push(participantObject);
-          this.hashTreeObjectId2ParticipantId.set(object.htMeta.elementId.id, participantObject.id);
+          addParticipantObject(object);
         } else {
           const participantId = this.hashTreeObjectId2ParticipantId.get(object.htMeta.elementId.id);
 
@@ -610,6 +606,24 @@ export default class LocusInfo extends EventsScope {
           );
           const locusDtoKey = ObjectTypeToLocusKeyMap[type];
           locus[locusDtoKey] = object.data;
+
+          /* Hash tree based webinar attendees don't receive a Participant object for themselves from Locus,
+             but a lot of existing code in SDK and web app expects a member object for self to exist,
+             so whenever SELF changes for a webinar attendee, we copy it into a participant object.
+             We can do it, because SELF has always all the same properties as a participant object.
+          */
+          if (
+            type === ObjectType.self &&
+            locus.info?.isWebinar &&
+            object.data.controls?.role?.roles?.find(
+              (r) => r.type === SELF_ROLES.ATTENDEE && r.hasRole
+            )
+          ) {
+            LoggerProxy.logger.info(
+              `Locus-info:index#updateLocusFromHashTreeObject --> webinar attendee: creating participant object from self`
+            );
+            addParticipantObject(object);
+          }
         }
         break;
       default:
@@ -1022,14 +1036,11 @@ export default class LocusInfo extends EventsScope {
     this.updateLocusUrl(locus.url, ControlsUtils.isMainSessionDTO(locus));
     this.updateMeetingInfo(locus.info, locus.self);
     this.updateMediaShares(locus.mediaShares);
-    this.updateParticipantsUrl(locus.participantsUrl);
-    this.updateReplace(locus.replace);
+    this.updateReplaces(locus.replaces);
     this.updateSelf(locus.self);
     this.updateAclUrl(locus.aclUrl);
     this.updateBasequence(locus.baseSequence);
     this.updateSequence(locus.sequence);
-    this.updateMemberShip(locus.membership);
-    this.updateIdentifiers(locus.identities);
     this.updateEmbeddedApps(locus.embeddedApps);
     this.updateLinks(locus.links);
     this.compareAndUpdate();
@@ -1904,24 +1915,13 @@ export default class LocusInfo extends EventsScope {
   }
 
   /**
-   * @param {String} participantsUrl
-   * @returns {undefined}
-   * @memberof LocusInfo
-   */
-  updateParticipantsUrl(participantsUrl: string) {
-    if (participantsUrl && !isEqual(this.participantsUrl, participantsUrl)) {
-      this.participantsUrl = participantsUrl;
-    }
-  }
-
-  /**
-   * @param {Object} replace
+   * @param {Object} replaces
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateReplace(replace: object) {
-    if (replace && !isEqual(this.replace, replace)) {
-      this.replace = replace;
+  updateReplaces(replaces: object) {
+    if (replaces && !isEqual(this.replaces, replaces)) {
+      this.replaces = replaces;
     }
   }
 
@@ -2258,28 +2258,6 @@ export default class LocusInfo extends EventsScope {
     }
   }
 
-  /**
-   * @param {Object} membership
-   * @returns {undefined}
-   * @memberof LocusInfo
-   */
-  updateMemberShip(membership: object) {
-    if (membership && !isEqual(this.membership, membership)) {
-      this.membership = membership;
-    }
-  }
-
-  /**
-   * @param {Array} identities
-   * @returns {undefined}
-   * @memberof LocusInfo
-   */
-  updateIdentifiers(identities: Array<any>) {
-    if (identities && !isEqual(this.identities, identities)) {
-      this.identities = identities;
-    }
-  }
-
   /**
    * check the locus is main session's one or not, if is main session's, update main session cache
    * @param {Object} locus

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

@@ -358,6 +358,76 @@ describe('plugin-meetings', () => {
           });
         });
 
+        it('should process locus update correctly when called with updated SELF (webinar non-attendee)', () => {
+          const newSelf = {
+            id: 'new-self',
+            visibleDataSets: ['dataset1', 'dataset2'],
+            controls: {
+              role: {
+                roles: [
+                  {type: 'PANELIST', hasRole: true},
+                  {type: 'ATTENDEE', hasRole: false},
+                ],
+              },
+            },
+          };
+          locusInfo.info.isWebinar = true;
+
+          // simulate an update from the HashTreeParser (normally this would be triggered by incoming locus messages)
+          locusInfoUpdateCallback(OBJECTS_UPDATED, {
+            updatedObjects: [{htMeta: {elementId: {type: 'self'}}, data: newSelf}],
+          });
+
+          // check onDeltaLocus() was called with correctly updated locus info
+          // without any participant generated
+          assert.calledOnceWithExactly(onDeltaLocusStub, {
+            ...expectedLocusInfo,
+            info: {
+              ...expectedLocusInfo.info,
+              isWebinar: true,
+            },
+            self: newSelf,
+          });
+        });
+
+        it('should generate a participant when called with updated SELF for webinar attendee', () => {
+          const newSelf = {
+            id: 'new-self',
+            visibleDataSets: ['dataset1', 'dataset2'],
+            controls: {
+              role: {
+                roles: [
+                  {type: 'something else - should be ignored', hasRole: true},
+                  {type: 'ATTENDEE', hasRole: true},
+                ],
+              },
+            },
+          };
+
+          locusInfo.info.isWebinar = true;
+
+          // simulate an update from the HashTreeParser (normally this would be triggered by incoming locus messages)
+          locusInfoUpdateCallback(OBJECTS_UPDATED, {
+            updatedObjects: [{htMeta: {elementId: {type: 'self'}}, data: newSelf}],
+          });
+
+          // check onDeltaLocus() was called with correctly updated locus info
+          // that contains a participant created from self
+          assert.calledOnceWithExactly(onDeltaLocusStub, {
+            ...expectedLocusInfo,
+            info: {
+              ...expectedLocusInfo.info,
+              isWebinar: true,
+            },
+            self: newSelf,
+            participants: [
+              {
+                ...newSelf,
+              },
+            ],
+          });
+        });
+
         it('should process locus update correctly when called with updated fullState', () => {
           const newFullState = {
             id: 'new-fullState',
@@ -2780,8 +2850,7 @@ describe('plugin-meetings', () => {
           callOrder.push("updateMeetingInfo");
         });
         sinon.stub(locusInfo, "updateMediaShares");
-        sinon.stub(locusInfo, "updateParticipantsUrl");
-        sinon.stub(locusInfo, "updateReplace");
+        sinon.stub(locusInfo, "updateReplaces");
         sinon.stub(locusInfo, "updateSelf");
         sinon.stub(locusInfo, "updateLocusUrl").callsFake(() => {
           callOrder.push("updateLocusUrl");
@@ -2789,8 +2858,6 @@ describe('plugin-meetings', () => {
         sinon.stub(locusInfo, "updateAclUrl");
         sinon.stub(locusInfo, "updateBasequence");
         sinon.stub(locusInfo, "updateSequence");
-        sinon.stub(locusInfo, "updateMemberShip");
-        sinon.stub(locusInfo, "updateIdentifiers");
         sinon.stub(locusInfo, "updateEmbeddedApps");
         sinon.stub(locusInfo, "updateLinks");
         sinon.stub(locusInfo, "compareAndUpdate");
@@ -2816,15 +2883,12 @@ describe('plugin-meetings', () => {
         locusInfo.updateHostInfo = sinon.stub();
         locusInfo.updateMeetingInfo = sinon.stub();
         locusInfo.updateMediaShares = sinon.stub();
-        locusInfo.updateParticipantsUrl = sinon.stub();
-        locusInfo.updateReplace = sinon.stub();
+        locusInfo.updateReplaces = sinon.stub();
         locusInfo.updateSelf = sinon.stub();
         locusInfo.updateLocusUrl = sinon.stub();
         locusInfo.updateAclUrl = sinon.stub();
         locusInfo.updateBasequence = sinon.stub();
         locusInfo.updateSequence = sinon.stub();
-        locusInfo.updateMemberShip = sinon.stub();
-        locusInfo.updateIdentifiers = sinon.stub();
         locusInfo.updateEmbeddedApps = sinon.stub();
         locusInfo.updateLinks = sinon.stub();
         locusInfo.compareAndUpdate = sinon.stub();
@@ -2838,15 +2902,12 @@ describe('plugin-meetings', () => {
         assert.notCalled(locusInfo.updateHostInfo);
         assert.notCalled(locusInfo.updateMeetingInfo);
         assert.notCalled(locusInfo.updateMediaShares);
-        assert.notCalled(locusInfo.updateParticipantsUrl);
-        assert.notCalled(locusInfo.updateReplace);
+        assert.notCalled(locusInfo.updateReplaces);
         assert.notCalled(locusInfo.updateSelf);
         assert.notCalled(locusInfo.updateLocusUrl);
         assert.notCalled(locusInfo.updateAclUrl);
         assert.notCalled(locusInfo.updateBasequence);
         assert.notCalled(locusInfo.updateSequence);
-        assert.notCalled(locusInfo.updateMemberShip);
-        assert.notCalled(locusInfo.updateIdentifiers);
         assert.notCalled(locusInfo.updateEmbeddedApps);
         assert.notCalled(locusInfo.updateLinks);
         assert.notCalled(locusInfo.compareAndUpdate);