@webex/plugin-meetings 3.11.0-next.32 → 3.11.0-next.34

package/dist/types/constants.d.ts

@@ -310,7 +310,6 @@ export declare const HEADERS: {
 };
 export declare const MEETING_REMOVED_REASON: {
     SELF_REMOVED: string;
-    FULLSTATE_REMOVED: string;
     MEETING_INACTIVE_TERMINATING: string;
     CLIENT_LEAVE_REQUEST: string;
     CLIENT_LEAVE_REQUEST_TAB_CLOSED: string;

package/dist/types/hashTree/constants.d.ts

@@ -5,4 +5,5 @@ export declare const DataSetNames: {
     ATD_ACTIVE: string;
     ATD_UNMUTED: string;
     SELF: string;
+    UNJOINED: string;
 };

package/dist/types/hashTree/hashTreeParser.d.ts

@@ -48,6 +48,12 @@ export type LocusInfoUpdateType = Enum<typeof LocusInfoUpdateType>;
 export type LocusInfoUpdateCallback = (updateType: LocusInfoUpdateType, data?: {
     updatedObjects: HashTreeObject[];
 }) => void;
+/**
+ * This error is thrown if we receive information that the meeting has ended while we're processing some hash messages.
+ * It's handled internally by HashTreeParser and results in MEETING_ENDED being sent up.
+ */
+export declare class MeetingEndedError extends Error {
+}
 /**
  * Parses hash tree eventing locus data
  */
@@ -177,6 +183,13 @@ declare class HashTreeParser {
      * @returns {void}
      */
     private handleRootHashHeartBeatMessage;
+    /**
+     * Asynchronously initializes new visible data sets
+     *
+     * @param {VisibleDataSetInfo[]} dataSetsRequiringInitialization list of datasets to initialize
+     * @returns {void}
+     */
+    private queueInitForNewVisibleDataSets;
     /**
      * Handles updates to Metadata object that we receive from Locus via other means than messages. Right now
      * that means only in the API response alongside locus object.
@@ -302,6 +315,7 @@ declare class HashTreeParser {
      * @returns {void}
      */
     private stopAllTimers;
+    private checkForSentinelHttpResponse;
     /**
      * Gets the current hashes from the locus for a specific data set.
      * @param {string} dataSetName

package/dist/webinar/index.js

@@ -506,7 +506,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee8);
     }))();
   },
-  version: "3.11.0-next.32"
+  version: "3.11.0-next.34"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.11.0-next.32"
+  "version": "3.11.0-next.34"
 }

package/src/aiEnableRequest/index.ts

@@ -51,7 +51,13 @@ const AIEnableRequest = WebexPlugin.extend({
         const isApprover = !!approverId && approverId === this.selfParticipantId;
         const initiatorId = initiator?.participantId;
         const isInitiator = !!initiatorId && initiatorId === this.selfParticipantId;
-        if (!isApprover && !isInitiator) {
+        if (
+          !isApprover &&
+          !isInitiator &&
+          // Not just the initiator needs to know about declined all because
+          // all future requests will be rejected if the meeting is in the declined all state
+          actionType !== AI_ENABLE_REQUEST.ACTION_TYPE.DECLINED_ALL
+        ) {
           return;
         }
         this.trigger(AI_ENABLE_REQUEST.EVENTS.APPROVAL_REQUEST_ARRIVED, {

package/src/constants.ts

@@ -414,7 +414,6 @@ export const HEADERS = {
 // Meeting actually ended
 export const MEETING_REMOVED_REASON = {
   SELF_REMOVED: 'SELF_REMOVED', // server or host removed you from the meeting
-  FULLSTATE_REMOVED: 'FULLSTATE_REMOVED', // meeting got dropped ? not sure
   MEETING_INACTIVE_TERMINATING: 'MEETING_INACTIVE_TERMINATING', // Meeting got ended or everyone left the meeting
   CLIENT_LEAVE_REQUEST: 'CLIENT_LEAVE_REQUEST', // You triggered leave meeting
   CLIENT_LEAVE_REQUEST_TAB_CLOSED: 'CLIENT_LEAVE_REQUEST_TAB_CLOSED', // You triggered leave meeting, such as closing the browser tab directly

package/src/hashTree/constants.ts

@@ -6,4 +6,5 @@ export const DataSetNames = {
   ATD_ACTIVE: 'atd-active', // only sent to panelists, over LLM; the attendees that have their hands raised or are allowed to unmute themselves
   ATD_UNMUTED: 'atd-unmuted', // sent to web client, over LLM, not sent to panelists; the attendees that are unmuted
   SELF: 'self', // sent to web client, over Mercury
+  UNJOINED: 'unjoined', // sent when you are not joined, but can still see some stuff from the meeting (mutually exclusive with "main")
 };

package/src/hashTree/hashTreeParser.ts

@@ -73,13 +73,19 @@ interface LeafInfo {
  * This error is thrown if we receive information that the meeting has ended while we're processing some hash messages.
  * It's handled internally by HashTreeParser and results in MEETING_ENDED being sent up.
  */
-class MeetingEndedError extends Error {}
+export class MeetingEndedError extends Error {}
 
 /* Currently Locus always sends Metadata objects only in the "self" dataset.
  * If this ever changes, update all the code that relies on this constant.
  */
 const MetadataDataSetName = DataSetNames.SELF;
 
+const PossibleSentinelMessageDataSetNames = [
+  DataSetNames.MAIN,
+  DataSetNames.SELF,
+  DataSetNames.UNJOINED,
+];
+
 /**
  * Parses hash tree eventing locus data
  */
@@ -285,9 +291,15 @@ class HashTreeParser {
     return this.webexRequest({
       method: HTTP_VERBS.GET,
       uri: this.visibleDataSetsUrl,
-    }).then((response) => {
-      return response.body.dataSets as Array<DataSet>;
-    });
+    })
+      .then((response) => {
+        return response.body.dataSets as Array<DataSet>;
+      })
+      .catch((error) => {
+        this.checkForSentinelHttpResponse(error);
+
+        throw error;
+      });
   }
 
   /**
@@ -511,21 +523,19 @@ class HashTreeParser {
    * @returns {boolean} - Returns true if the message indicates the end of the meeting, false otherwise
    */
   private isEndMessage(message: HashTreeMessage) {
-    const mainDataSet = message.dataSets.find(
-      (dataSet) => dataSet.name.toLowerCase() === DataSetNames.MAIN
-    );
-
-    if (
-      mainDataSet &&
-      mainDataSet.leafCount === 1 &&
-      mainDataSet.root === EMPTY_HASH &&
-      this.dataSets[DataSetNames.MAIN].version < mainDataSet.version
-    ) {
-      // this is a special way for Locus to indicate that this meeting has ended
-      return true;
-    }
+    return message.dataSets.some((dataSet) => {
+      if (
+        dataSet.leafCount === 1 &&
+        dataSet.root === EMPTY_HASH &&
+        (!this.dataSets[dataSet.name] || this.dataSets[dataSet.name].version < dataSet.version) &&
+        PossibleSentinelMessageDataSetNames.includes(dataSet.name.toLowerCase())
+      ) {
+        // this is a special way for Locus to indicate that this meeting has ended
+        return true;
+      }
 
-    return false;
+      return false;
+    });
   }
 
   /**
@@ -556,6 +566,33 @@ class HashTreeParser {
     });
   }
 
+  /**
+   * Asynchronously initializes new visible data sets
+   *
+   * @param {VisibleDataSetInfo[]} dataSetsRequiringInitialization list of datasets to initialize
+   * @returns {void}
+   */
+  private queueInitForNewVisibleDataSets(dataSetsRequiringInitialization: VisibleDataSetInfo[]) {
+    queueMicrotask(() => {
+      this.initializeNewVisibleDataSets(dataSetsRequiringInitialization).catch((error) => {
+        if (error instanceof MeetingEndedError) {
+          this.callLocusInfoUpdateCallback({
+            updateType: LocusInfoUpdateType.MEETING_ENDED,
+          });
+        } else {
+          LoggerProxy.logger.warn(
+            `HashTreeParser#queueInitForNewVisibleDataSets --> ${
+              this.debugId
+            } error while initializing new visible datasets: ${dataSetsRequiringInitialization
+              .map((ds) => ds.name)
+              .join(', ')}: `,
+            error
+          );
+        }
+      });
+    });
+  }
+
   /**
    * Handles updates to Metadata object that we receive from Locus via other means than messages. Right now
    * that means only in the API response alongside locus object.
@@ -600,9 +637,7 @@ class HashTreeParser {
 
         if (dataSetsRequiringInitialization.length > 0) {
           // there are some data sets that we need to initialize asynchronously
-          queueMicrotask(() => {
-            this.initializeNewVisibleDataSets(dataSetsRequiringInitialization);
-          });
+          this.queueInitForNewVisibleDataSets(dataSetsRequiringInitialization);
         }
       }
     }
@@ -931,15 +966,6 @@ class HashTreeParser {
     this.visibleDataSetsUrl = visibleDataSetsUrl;
     dataSets.forEach((dataSet) => this.updateDataSetInfo(dataSet));
 
-    if (this.isEndMessage(message)) {
-      LoggerProxy.logger.info(
-        `HashTreeParser#parseMessage --> ${this.debugId} received END message`
-      );
-      this.stopAllTimers();
-
-      return {updateType: LocusInfoUpdateType.MEETING_ENDED};
-    }
-
     let isRosterDropped = false;
     const updatedObjects: HashTreeObject[] = [];
 
@@ -1039,9 +1065,7 @@ class HashTreeParser {
 
     if (dataSetsRequiringInitialization.length > 0) {
       // there are some data sets that we need to initialize asynchronously
-      queueMicrotask(() => {
-        this.initializeNewVisibleDataSets(dataSetsRequiringInitialization);
-      });
+      this.queueInitForNewVisibleDataSets(dataSetsRequiringInitialization);
     }
 
     if (updatedObjects.length === 0) {
@@ -1064,7 +1088,14 @@ class HashTreeParser {
     if (message.heartbeatIntervalMs) {
       this.heartbeatIntervalMs = message.heartbeatIntervalMs;
     }
-    if (message.locusStateElements === undefined) {
+    if (this.isEndMessage(message)) {
+      LoggerProxy.logger.info(
+        `HashTreeParser#parseMessage --> ${this.debugId} received sentinel END MEETING message`
+      );
+      this.stopAllTimers();
+
+      this.callLocusInfoUpdateCallback({updateType: LocusInfoUpdateType.MEETING_ENDED});
+    } else if (message.locusStateElements === undefined) {
       this.handleRootHashHeartBeatMessage(message);
       this.resetHeartbeatWatchdogs(message.dataSets);
     } else {
@@ -1169,54 +1200,67 @@ class HashTreeParser {
       return;
     }
 
-    LoggerProxy.logger.info(
-      `HashTreeParser#performSync --> ${this.debugId} ${reason}, syncing data set "${dataSet.name}"`
-    );
+    try {
+      LoggerProxy.logger.info(
+        `HashTreeParser#performSync --> ${this.debugId} ${reason}, syncing data set "${dataSet.name}"`
+      );
 
-    const mismatchedLeavesData: Record<number, LeafDataItem[]> = {};
+      const mismatchedLeavesData: Record<number, LeafDataItem[]> = {};
 
-    if (dataSet.leafCount !== 1) {
-      let receivedHashes;
+      if (dataSet.leafCount !== 1) {
+        let receivedHashes;
 
-      try {
-        // request hashes from sender
-        const {hashes, dataSet: latestDataSetInfo} = await this.getHashesFromLocus(
-          dataSet.name,
-          rootHash
-        );
+        try {
+          // request hashes from sender
+          const {hashes, dataSet: latestDataSetInfo} = await this.getHashesFromLocus(
+            dataSet.name,
+            rootHash
+          );
 
-        receivedHashes = hashes;
+          receivedHashes = hashes;
 
-        dataSet.hashTree.resize(latestDataSetInfo.leafCount);
-      } catch (error) {
-        if (error.statusCode === 409) {
-          // this is a leaf count mismatch, we should do nothing, just wait for another heartbeat message from Locus
-          LoggerProxy.logger.info(
-            `HashTreeParser#getHashesFromLocus --> ${this.debugId} Got 409 when fetching hashes for data set "${dataSet.name}": ${error.message}`
-          );
+          dataSet.hashTree.resize(latestDataSetInfo.leafCount);
+        } catch (error) {
+          if (error.statusCode === 409) {
+            // this is a leaf count mismatch, we should do nothing, just wait for another heartbeat message from Locus
+            LoggerProxy.logger.info(
+              `HashTreeParser#getHashesFromLocus --> ${this.debugId} Got 409 when fetching hashes for data set "${dataSet.name}": ${error.message}`
+            );
 
-          return;
+            return;
+          }
+          throw error;
         }
-        throw error;
-      }
 
-      // identify mismatched leaves
-      const mismatchedLeaveIndexes = dataSet.hashTree.diffHashes(receivedHashes);
+        // identify mismatched leaves
+        const mismatchedLeaveIndexes = dataSet.hashTree.diffHashes(receivedHashes);
 
-      mismatchedLeaveIndexes.forEach((index) => {
-        mismatchedLeavesData[index] = dataSet.hashTree.getLeafData(index);
-      });
-    } else {
-      mismatchedLeavesData[0] = dataSet.hashTree.getLeafData(0);
-    }
-    // request sync for mismatched leaves
-    if (Object.keys(mismatchedLeavesData).length > 0) {
-      const syncResponse = await this.sendSyncRequestToLocus(dataSet, mismatchedLeavesData);
-
-      // sync API may return nothing (in that case data will arrive via messages)
-      // or it may return a response in the same format as messages
-      if (syncResponse) {
-        this.handleMessage(syncResponse, 'via sync API');
+        mismatchedLeaveIndexes.forEach((index) => {
+          mismatchedLeavesData[index] = dataSet.hashTree.getLeafData(index);
+        });
+      } else {
+        mismatchedLeavesData[0] = dataSet.hashTree.getLeafData(0);
+      }
+      // request sync for mismatched leaves
+      if (Object.keys(mismatchedLeavesData).length > 0) {
+        const syncResponse = await this.sendSyncRequestToLocus(dataSet, mismatchedLeavesData);
+
+        // sync API may return nothing (in that case data will arrive via messages)
+        // or it may return a response in the same format as messages
+        if (syncResponse) {
+          this.handleMessage(syncResponse, 'via sync API');
+        }
+      }
+    } catch (error) {
+      if (error instanceof MeetingEndedError) {
+        this.callLocusInfoUpdateCallback({
+          updateType: LocusInfoUpdateType.MEETING_ENDED,
+        });
+      } else {
+        LoggerProxy.logger.warn(
+          `HashTreeParser#performSync --> ${this.debugId} error during sync for data set "${dataSet.name}":`,
+          error
+        );
       }
     }
   }
@@ -1360,6 +1404,25 @@ class HashTreeParser {
     });
   }
 
+  private checkForSentinelHttpResponse(error: any, dataSetName?: string) {
+    const isValidDataSetForSentinel =
+      dataSetName === undefined ||
+      PossibleSentinelMessageDataSetNames.includes(dataSetName.toLowerCase());
+
+    if (
+      ((error.statusCode === 409 && error.body?.errorCode === 2403004) ||
+        error.statusCode === 404) &&
+      isValidDataSetForSentinel
+    ) {
+      LoggerProxy.logger.info(
+        `HashTreeParser#checkForSentinelHttpResponse --> ${this.debugId} Received ${error.statusCode} for data set "${dataSetName}", indicating that the meeting has ended`
+      );
+      this.stopAllTimers();
+
+      throw new MeetingEndedError();
+    }
+  }
+
   /**
    * Gets the current hashes from the locus for a specific data set.
    * @param {string} dataSetName
@@ -1410,6 +1473,8 @@ class HashTreeParser {
           `HashTreeParser#getHashesFromLocus --> ${this.debugId} Error ${error.statusCode} fetching hashes for data set "${dataSetName}":`,
           error
         );
+        this.checkForSentinelHttpResponse(error, dataSet.name);
+
         throw error;
       });
   }
@@ -1472,6 +1537,8 @@ class HashTreeParser {
           `HashTreeParser#sendSyncRequestToLocus --> ${this.debugId} Error ${error.statusCode} sending sync request for data set "${dataSet.name}":`,
           error
         );
+        this.checkForSentinelHttpResponse(error, dataSet.name);
+
         throw error;
       });
   }

package/src/locus-info/index.ts

@@ -35,6 +35,7 @@ import HashTreeParser, {
   DataSet,
   HashTreeMessage,
   LocusInfoUpdateType,
+  MeetingEndedError,
   Metadata,
 } from '../hashTree/hashTreeParser';
 import {HashTreeObject, ObjectType, ObjectTypeToLocusKeyMap} from '../hashTree/types';
@@ -416,10 +417,13 @@ export default class LocusInfo extends EventsScope {
           );
 
           if (!metadataObject?.data?.visibleDataSets) {
-            LoggerProxy.logger.warn(
+            // this is a common case (not an error)
+            // it happens for example after we leave the meeting and still get some heartbeats or delayed messages
+            LoggerProxy.logger.info(
               `Locus-info:index#initialSetup --> cannot initialize HashTreeParser, Metadata object with visibleDataSets is missing in the message`
             );
 
+            // throw so that handleLocusEvent() catches it and destroys the partially created meeting object
             throw new Error('Metadata object with visibleDataSets is missing in the message');
           }
 
@@ -727,7 +731,11 @@ export default class LocusInfo extends EventsScope {
    * @param {HashTreeMessage} message incoming hash tree message
    * @returns {void}
    */
-  private handleHashTreeMessage(meeting: any, eventType: LOCUSEVENT, message: HashTreeMessage) {
+  private async handleHashTreeMessage(
+    meeting: any,
+    eventType: LOCUSEVENT,
+    message: HashTreeMessage
+  ) {
     if (eventType !== LOCUSEVENT.HASH_TREE_DATA_UPDATED) {
       this.sendClassicVsHashTreeMismatchMetric(
         meeting,
@@ -736,8 +744,15 @@ export default class LocusInfo extends EventsScope {
 
       return;
     }
-
-    this.hashTreeParser.handleMessage(message);
+    try {
+      await this.hashTreeParser.handleMessage(message);
+    } catch (error) {
+      if (error instanceof MeetingEndedError) {
+        this.webex.meetings.destroy(meeting, MEETING_REMOVED_REASON.SELF_REMOVED);
+      } else {
+        throw error;
+      }
+    }
   }
 
   /**
@@ -1292,27 +1307,6 @@ export default class LocusInfo extends EventsScope {
             shouldLeave: false,
           }
         );
-      } else if (this.fullState && this.fullState.removed) {
-        // user has been dropped from a meeting
-
-        // @ts-ignore
-        this.webex.internal.newMetrics.submitClientEvent({
-          name: 'client.call.remote-ended',
-          options: {
-            meetingId: this.meetingId,
-          },
-        });
-        this.emitScoped(
-          {
-            file: 'locus-info',
-            function: 'isMeetingActive',
-          },
-          EVENTS.DESTROY_MEETING,
-          {
-            reason: MEETING_REMOVED_REASON.FULLSTATE_REMOVED,
-            shouldLeave: false,
-          }
-        );
       }
       // If you are  guest and you are removed from the meeting
       // You wont get any further events

package/test/unit/spec/aiEnableRequest/index.ts

@@ -206,6 +206,34 @@ describe('plugin-meetings', () => {
         sinon.assert.notCalled(triggerSpy);
       });
 
+      it('should trigger DECLINED_ALL event even when user is neither approver nor initiator', () => {
+        aiEnableRequest.listenToApprovalRequests();
+
+        const event = {
+          data: {
+            approval: {
+              resourceType: AI_ENABLE_REQUEST.RESOURCE_TYPE,
+              receivers: [{participantId: testApproverId}],
+              initiator: {participantId: testInitiatorId},
+              actionType: AI_ENABLE_REQUEST.ACTION_TYPE.DECLINED_ALL,
+              url: testUrl,
+            },
+          },
+        };
+
+        webex.internal.mercury.emit(`event:${LOCUSEVENT.APPROVAL_REQUEST}`, event);
+
+        sinon.assert.calledOnce(triggerSpy);
+        sinon.assert.calledWith(triggerSpy, AI_ENABLE_REQUEST.EVENTS.APPROVAL_REQUEST_ARRIVED, {
+          actionType: AI_ENABLE_REQUEST.ACTION_TYPE.DECLINED_ALL,
+          isApprover: false,
+          isInitiator: false,
+          initiatorId: testInitiatorId,
+          approverId: testApproverId,
+          url: testUrl,
+        });
+      });
+
       it('should not trigger event when resourceType does not match', () => {
         aiEnableRequest.listenToApprovalRequests();