@webex/plugin-meetings 3.11.0-next.2 → 3.11.0-next.21

package/dist/locus-info/index.js

@@ -210,7 +210,7 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
           // in some cases Locus might return us full DTO even when we asked for a delta
           _loggerProxy.default.logger.info('Locus-info:index#doLocusSync --> got full DTO when we asked for delta');
         }
-        meeting.locusInfo.onFullLocus(res.body);
+        meeting.locusInfo.onFullLocus('classic Locus sync', res.body);
       }).catch(function (e) {
         _loggerProxy.default.logger.info("Locus-info:index#doLocusSync --> getLocusDTO succeeded but failed to handle result, locus parser will resume but not all data may be synced (".concat(e.toString(), ")"));
         _metrics.default.sendBehavioralMetric(_constants2.default.LOCUS_SYNC_HANDLING_FAILED, {
@@ -339,9 +339,11 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
   }, {
     key: "createHashTreeParser",
     value: function createHashTreeParser(_ref) {
-      var initialLocus = _ref.initialLocus;
+      var initialLocus = _ref.initialLocus,
+        metadata = _ref.metadata;
       return new _hashTreeParser.default({
         initialLocus: initialLocus,
+        metadata: metadata,
         webexRequest: this.webex.request.bind(this.webex),
         locusInfoUpdateCallback: this.updateFromHashTree.bind(this),
         debugId: "HT-".concat(this.meetingId.substring(0, 4))
@@ -358,7 +360,7 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
     value: (function () {
       var _initialSetup = (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee(data) {
         var _data$locus, _data$locus$links, _data$locus$links$res, _data$locus$links$res2;
-        var _data$hashTreeMessage, _selfObject$data, selfObject, _data$locus2, _data$locus2$self, _t;
+        var _data$hashTreeMessage, _metadataObject$data, metadataObject, _t;
         return _regenerator.default.wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -370,29 +372,28 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
                 _context.next = 4;
                 break;
               }
-              // we need the SELF object to be in the received message, because it contains visibleDataSets
+              // we need the Metadata object to be in the received message, because it contains visibleDataSets
               // and these are needed to initialize all the hash trees
-              selfObject = (_data$hashTreeMessage = data.hashTreeMessage.locusStateElements) === null || _data$hashTreeMessage === void 0 ? void 0 : _data$hashTreeMessage.find(function (el) {
-                return (0, _utils.isSelf)(el);
+              metadataObject = (_data$hashTreeMessage = data.hashTreeMessage.locusStateElements) === null || _data$hashTreeMessage === void 0 ? void 0 : _data$hashTreeMessage.find(function (el) {
+                return (0, _utils.isMetadata)(el);
               });
-              if (selfObject !== null && selfObject !== void 0 && (_selfObject$data = selfObject.data) !== null && _selfObject$data !== void 0 && _selfObject$data.visibleDataSets) {
+              if (metadataObject !== null && metadataObject !== void 0 && (_metadataObject$data = metadataObject.data) !== null && _metadataObject$data !== void 0 && _metadataObject$data.visibleDataSets) {
                 _context.next = 2;
                 break;
               }
-              _loggerProxy.default.logger.warn("Locus-info:index#initialSetup --> cannot initialize HashTreeParser, SELF object with visibleDataSets is missing in the message");
-              throw new Error('SELF object with visibleDataSets is missing in the message');
+              _loggerProxy.default.logger.warn("Locus-info:index#initialSetup --> cannot initialize HashTreeParser, Metadata object with visibleDataSets is missing in the message");
+              throw new Error('Metadata object with visibleDataSets is missing in the message');
             case 2:
               _loggerProxy.default.logger.info('Locus-info:index#initialSetup --> creating HashTreeParser from message');
               // first create the HashTreeParser, but don't initialize it with any data yet
-              // pass just a fake locus that contains only the visibleDataSets
               this.hashTreeParser = this.createHashTreeParser({
                 initialLocus: {
-                  locus: {
-                    self: {
-                      visibleDataSets: selfObject.data.visibleDataSets
-                    }
-                  },
+                  locus: null,
                   dataSets: [] // empty, because they will be populated in initializeFromMessage() call  // dataSets: data.hashTreeMessage.dataSets,
+                },
+                metadata: {
+                  htMeta: metadataObject.htMeta,
+                  visibleDataSets: metadataObject.data.visibleDataSets
                 }
               });
 
@@ -405,12 +406,12 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
             case 4:
               // "classic" Locus case, no hash trees involved
               this.updateLocusCache(data.locus);
-              this.onFullLocus(data.locus, undefined);
+              this.onFullLocus('classic locus message', data.locus, undefined);
             case 5:
               return _context.abrupt("continue", 10);
             case 6:
               this.updateLocusCache(data.locus);
-              this.onFullLocus(data.locus, undefined, data.dataSets);
+              this.onFullLocus('join response', data.locus, undefined, data.dataSets, data.metadata);
               return _context.abrupt("continue", 10);
             case 7:
               if (!((_data$locus = data.locus) !== null && _data$locus !== void 0 && (_data$locus$links = _data$locus.links) !== null && _data$locus$links !== void 0 && (_data$locus$links$res = _data$locus$links.resources) !== null && _data$locus$links$res !== void 0 && (_data$locus$links$res2 = _data$locus$links$res.visibleDataSets) !== null && _data$locus$links$res2 !== void 0 && _data$locus$links$res2.url)) {
@@ -419,16 +420,12 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
               }
               _loggerProxy.default.logger.info('Locus-info:index#initialSetup --> creating HashTreeParser from get-loci-response');
               // first create the HashTreeParser, but don't initialize it with any data yet
-              // pass just a fake locus that contains only the visibleDataSets
               this.hashTreeParser = this.createHashTreeParser({
                 initialLocus: {
-                  locus: {
-                    self: {
-                      visibleDataSets: (_data$locus2 = data.locus) === null || _data$locus2 === void 0 ? void 0 : (_data$locus2$self = _data$locus2.self) === null || _data$locus2$self === void 0 ? void 0 : _data$locus2$self.visibleDataSets
-                    }
-                  },
+                  locus: null,
                   dataSets: [] // empty, because we don't have them yet
-                }
+                },
+                metadata: null // get-loci-response doesn't contain Metadata object
               });
 
               // now initialize all the data
@@ -440,7 +437,7 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
             case 9:
               // "classic" Locus case, no hash trees involved
               this.updateLocusCache(data.locus);
-              this.onFullLocus(data.locus, undefined);
+              this.onFullLocus('classic get-loci-response', data.locus, undefined);
             case 10:
               // Change it to true after it receives it first locus object
               this.emitChange = true;
@@ -598,6 +595,10 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
             }
           }
           break;
+        case _types.ObjectType.metadata:
+          _loggerProxy.default.logger.info("Locus-info:index#updateLocusFromHashTreeObject --> metadata object updated to version ".concat(object.htMeta.elementId.version));
+          // we don't use hash tree metadata right now for anything, it's mainly used internally by HashTreeParser
+          break;
         default:
           _loggerProxy.default.logger.warn("Locus-info:index#updateLocusFromHashTreeObject --> received unsupported object type ".concat(type));
           break;
@@ -749,8 +750,13 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
       if (this.hashTreeParser) {
         this.handleHashTreeMessage(meeting, data.eventType, data.stateElementsMessage);
       } else {
-        // eslint-disable-next-line @typescript-eslint/no-shadow
         var eventType = data.eventType;
+        if (eventType === _constants.LOCUSEVENT.HASH_TREE_DATA_UPDATED) {
+          // this can happen when we get an event before join http response
+          // it's OK to just ignore it
+          _loggerProxy.default.logger.info("Locus-info:index#parse --> received locus hash tree event before hashTreeParser is created");
+          return;
+        }
         var locus = this.getTheLocusToUpdate(data.locus);
         _loggerProxy.default.logger.info("Locus-info:index#parse --> received locus data: ".concat(eventType));
         locus.jsSdkMeta = {
@@ -771,14 +777,11 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
           case _constants.LOCUSEVENT.PARTICIPANT_DECLINED:
           case _constants.LOCUSEVENT.FLOOR_GRANTED:
           case _constants.LOCUSEVENT.FLOOR_RELEASED:
-            this.onFullLocus(locus, eventType);
+            this.onFullLocus("classic locus event ".concat(eventType), locus, eventType);
             break;
           case _constants.LOCUSEVENT.DIFFERENCE:
             this.handleLocusDelta(locus, meeting);
             break;
-          case _constants.LOCUSEVENT.HASH_TREE_DATA_UPDATED:
-            this.sendClassicVsHashTreeMismatchMetric(meeting, "got ".concat(eventType, ", expected classic events"));
-            break;
           default:
             // Why will there be a event with no eventType ????
             // we may not need this, we can get full locus
@@ -803,32 +806,36 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
     /**
      * Function for handling full locus when it's using hash trees (so not the "classic" one).
      *
+     * @param {string} debugText string explaining the trigger for this call, added to logs for debugging purposes
      * @param {object} locus locus object
+     * @param {object} metadata locus hash trees metadata
      * @param {string} eventType locus event
      * @param {DataSet[]} dataSets
      * @returns {void}
      */
   }, {
     key: "onFullLocusWithHashTrees",
-    value: function onFullLocusWithHashTrees(locus, eventType, dataSets) {
+    value: function onFullLocusWithHashTrees(debugText, locus, metadata, eventType, dataSets) {
       if (!this.hashTreeParser) {
-        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus --> creating hash tree parser");
-        _loggerProxy.default.logger.info('Locus-info:index#onFullLocus --> dataSets:', dataSets, ' and locus:', locus);
+        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus (".concat(debugText, ") --> creating hash tree parser"));
+        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus (".concat(debugText, ") --> dataSets:"), dataSets, ' and locus:', locus, ' and metadata:', metadata);
         this.hashTreeParser = this.createHashTreeParser({
           initialLocus: {
             locus: locus,
             dataSets: dataSets
-          }
+          },
+          metadata: metadata
         });
         this.onFullLocusCommon(locus, eventType);
       } else {
         // in this case the Locus we're getting is not necessarily the full one
         // so treat it like if we just got it in any api response
 
-        _loggerProxy.default.logger.info('Locus-info:index#onFullLocus --> hash tree parser already exists, handling it like a normal API response');
+        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus (".concat(debugText, ") --> hash tree parser already exists, handling it like a normal API response"));
         this.handleLocusAPIResponse(undefined, {
           dataSets: dataSets,
-          locus: locus
+          locus: locus,
+          metadata: metadata
         });
       }
     }
@@ -836,15 +843,16 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
     /**
      * Function for handling full locus when it's the "classic" one (not hash trees)
      *
+     * @param {string} debugText string explaining the trigger for this call, added to logs for debugging purposes
      * @param {object} locus locus object
      * @param {string} eventType locus event
      * @returns {void}
      */
   }, {
     key: "onFullLocusClassic",
-    value: function onFullLocusClassic(locus, eventType) {
+    value: function onFullLocusClassic(debugText, locus, eventType) {
       if (!this.locusParser.isNewFullLocus(locus)) {
-        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus --> ignoring old full locus DTO, eventType=".concat(eventType));
+        _loggerProxy.default.logger.info("Locus-info:index#onFullLocus (".concat(debugText, ") --> ignoring old full locus DTO, eventType=").concat(eventType));
         return;
       }
       this.onFullLocusCommon(locus, eventType);
@@ -852,23 +860,28 @@ var LocusInfo = exports.default = /*#__PURE__*/function (_EventsScope) {
 
     /**
      * updates the locus with full locus object
+     * @param {string} debugText string explaining the trigger for this call, added to logs for debugging purposes
      * @param {object} locus locus object
      * @param {string} eventType locus event
      * @param {DataSet[]} dataSets
+     * @param {object} metadata locus hash trees metadata
      * @returns {object} null
      * @memberof LocusInfo
      */
   }, {
     key: "onFullLocus",
-    value: function onFullLocus(locus, eventType, dataSets) {
+    value: function onFullLocus(debugText, locus, eventType, dataSets, metadata) {
       if (!locus) {
-        _loggerProxy.default.logger.error('Locus-info:index#onFullLocus --> object passed as argument was invalid, continuing.');
+        _loggerProxy.default.logger.error("Locus-info:index#onFullLocus (".concat(debugText, ") --> object passed as argument was invalid, continuing."));
       }
       if (dataSets) {
+        if (!metadata) {
+          throw new Error("Locus-info:index#onFullLocus (".concat(debugText, ") --> hash tree metadata is missing with full Locus"));
+        }
         // this is the new hashmap Locus DTO format (only applicable to webinars for now)
-        this.onFullLocusWithHashTrees(locus, eventType, dataSets);
+        this.onFullLocusWithHashTrees(debugText, locus, metadata, eventType, dataSets);
       } else {
-        this.onFullLocusClassic(locus, eventType);
+        this.onFullLocusClassic(debugText, locus, eventType);
       }
     }