@webex/webex-core 3.9.0 → 3.10.0

package/dist/lib/services-v2/services-v2.js

@@ -16,6 +16,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/he
 var _weakMap = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/weak-map"));
 var _keys = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/keys"));
 var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _values = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/object/values"));
 var _sha = _interopRequireDefault(require("crypto-js/sha256"));
 var _lodash = require("lodash");
 var _webexPlugin = _interopRequireDefault(require("../webex-plugin"));
@@ -127,7 +128,9 @@ var Services = _webexPlugin.default.extend({
    * @returns {Promise<object>}
    */
   updateServices: function updateServices() {
-    var _this = this;
+    var _catalog$status,
+      _catalog$status$servi,
+      _this = this;
     var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
       from = _ref.from,
       query = _ref.query,
@@ -149,9 +152,8 @@ var Services = _webexPlugin.default.extend({
         serviceGroup = 'postauth';
         break;
     }
-
     // confirm catalog update for group is not in progress.
-    if (catalog.status[serviceGroup].collecting) {
+    if ((_catalog$status = catalog.status) !== null && _catalog$status !== void 0 && (_catalog$status$servi = _catalog$status[serviceGroup]) !== null && _catalog$status$servi !== void 0 && _catalog$status$servi.collecting) {
       return this.waitForCatalog(serviceGroup);
     }
     catalog.status[serviceGroup].collecting = true;
@@ -177,7 +179,7 @@ var Services = _webexPlugin.default.extend({
       query: formattedQuery,
       forceRefresh: forceRefresh
     }).then(function (serviceHostMap) {
-      catalog.updateServiceGroups(serviceGroup, serviceHostMap);
+      catalog.updateServiceGroups(serviceGroup, serviceHostMap === null || serviceHostMap === void 0 ? void 0 : serviceHostMap.services, serviceHostMap === null || serviceHostMap === void 0 ? void 0 : serviceHostMap.timestamp);
       _this.updateCredentialsConfig();
       catalog.status[serviceGroup].collecting = false;
     }).catch(function (error) {
@@ -331,22 +333,68 @@ var Services = _webexPlugin.default.extend({
       return _promise.default.reject(response);
     });
   },
+  /**
+   * Update cluster id via mercury service update. If the cluster id does not exist,
+   * fetch new catalog.
+   *
+   * @param {ActiveServices} newActiveClusters - The new active clusters to switch to.
+   * @returns {Promsie<void>}
+   * */
+  switchActiveClusterIds: function switchActiveClusterIds(newActiveClusters) {
+    var _this3 = this;
+    this.logger.info('services: switching active cluster ids');
+    var newActiveClusterIds = (0, _values.default)(newActiveClusters);
+    var missingClusterIds = newActiveClusterIds.some(function (clusterId) {
+      // if the clusterId does not exist in the catalog, fetch the catalog
+      return !_this3._services.find(function (service) {
+        return service.id === clusterId;
+      });
+    });
+    if (missingClusterIds) {
+      this.logger.warn('services: some cluster ids do not exist in the catalog, fetching the catalog');
+
+      // fetch the catalog
+      return this.initServiceCatalogs(true);
+    }
+    // update the active services
+    this._updateActiveServices(newActiveClusters);
+    this.logger.info('services: active cluster ids updated successfully');
+    return _promise.default.resolve();
+  },
+  /**
+   * Invalidate cache via mercury notification. If the timestamp is newer than current,
+   * refetch catalog services.
+   *
+   * @param {string} timestamp - The timestamp of invalidation notification.
+   * @returns {Promsie<void>}
+   * */
+  invalidateCache: function invalidateCache(timestamp) {
+    var _this$_getCatalog;
+    this.logger.info('services: invalidate cache, timestamp:', timestamp);
+    var lastTime = (0, _lodash.toNumber)((_this$_getCatalog = this._getCatalog()) === null || _this$_getCatalog === void 0 ? void 0 : _this$_getCatalog.timestamp) || 0;
+    var invalidateTime = (0, _lodash.toNumber)(timestamp) || 0;
+    if (invalidateTime > lastTime) {
+      this.logger.info('services: invalidateCache, refresh services');
+      this.initServiceCatalogs(true);
+    }
+    return _promise.default.resolve();
+  },
   /**
    * Get user meeting preferences (preferred webex site).
    *
    * @returns {object} - User Information including user preferrences .
    */
   getMeetingPreferences: function getMeetingPreferences() {
-    var _this3 = this;
+    var _this4 = this;
     return this.request({
       method: 'GET',
       service: 'hydra',
       resource: 'meetingPreferences'
     }).then(function (res) {
-      _this3.logger.info('services: received user region info');
+      _this4.logger.info('services: received user region info');
       return res.body;
     }).catch(function (err) {
-      _this3.logger.info('services: was not able to fetch user login information', err);
+      _this4.logger.info('services: was not able to fetch user login information', err);
       // resolve successfully even if request failed
     });
   },
@@ -356,7 +404,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {object} - The region info object.
    */
   fetchClientRegionInfo: function fetchClientRegionInfo() {
-    var _this4 = this;
+    var _this5 = this;
     var services = this.webex.config.services;
     return this.request({
       uri: services.discovery.sqdiscovery,
@@ -366,10 +414,10 @@ var Services = _webexPlugin.default.extend({
       },
       timeout: 5000
     }).then(function (res) {
-      _this4.logger.info('services: received user region info');
+      _this5.logger.info('services: received user region info');
       return res.body;
     }).catch(function (err) {
-      _this4.logger.info('services: was not able to get user region info', err);
+      _this5.logger.info('services: was not able to get user region info', err);
       // resolve successfully even if request failed
     });
   },
@@ -389,7 +437,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {LicenseDTO} - The DTO returned from the **License** service.
    */
   sendUserActivation: function sendUserActivation(_ref5) {
-    var _this5 = this;
+    var _this6 = this;
     var email = _ref5.email,
       reqId = _ref5.reqId,
       token = _ref5.token,
@@ -407,7 +455,7 @@ var Services = _webexPlugin.default.extend({
       }
 
       // Send the user activation request to the **License** service.
-      return _this5.request({
+      return _this6.request({
         service: 'license',
         resource: 'users/activations',
         method: 'POST',
@@ -444,7 +492,7 @@ var Services = _webexPlugin.default.extend({
   updateCatalog: function updateCatalog(serviceGroup, hostMap) {
     var catalog = this._getCatalog();
     var serviceHostMap = this._formatReceivedHostmap(hostMap);
-    return catalog.updateServiceGroups(serviceGroup, serviceHostMap);
+    return catalog.updateServiceGroups(serviceGroup, serviceHostMap === null || serviceHostMap === void 0 ? void 0 : serviceHostMap.services, serviceHostMap === null || serviceHostMap === void 0 ? void 0 : serviceHostMap.timestamp);
   },
   /**
    * simplified method to update the preauth catalog via email
@@ -562,7 +610,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {Promise<string>} - Resolves to the priority host of a service.
    */
   waitForService: function waitForService(_ref8) {
-    var _this6 = this;
+    var _this7 = this;
     var name = _ref8.name,
       _ref8$timeout = _ref8.timeout,
       timeout = _ref8$timeout === void 0 ? 5 : _ref8$timeout,
@@ -598,8 +646,8 @@ var Services = _webexPlugin.default.extend({
       var groupsToCheck = ['preauth', 'signin', 'postauth'];
       var checkCatalog = function checkCatalog(catalogGroup) {
         return catalog.waitForCatalog(catalogGroup, timeout).then(function () {
-          var scopedPriorityUrl = _this6.get(name);
-          var scopedPrioriryUrlObj = _this6.getServiceFromUrl(url);
+          var scopedPriorityUrl = _this7.get(name);
+          var scopedPrioriryUrlObj = _this7.getServiceFromUrl(url);
           if (scopedPriorityUrl || scopedPrioriryUrlObj) {
             resolve(scopedPriorityUrl || scopedPrioriryUrlObj.priorityUrl);
           }
@@ -610,7 +658,7 @@ var Services = _webexPlugin.default.extend({
       _promise.default.all(groupsToCheck.map(function (group) {
         return checkCatalog(group);
       })).then(function () {
-        _this6.webex.internal.metrics.submitClientMetrics(_metrics.default.JS_SDK_SERVICE_NOT_FOUND, {
+        _this7.webex.internal.metrics.submitClientMetrics(_metrics.default.JS_SDK_SERVICE_NOT_FOUND, {
           fields: {
             service_name: name
           }
@@ -664,12 +712,21 @@ var Services = _webexPlugin.default.extend({
    * @returns {Array<Service>}
    */
   _formatReceivedHostmap: function _formatReceivedHostmap(_ref10) {
-    var _this7 = this;
+    var _this8 = this;
     var services = _ref10.services,
-      activeServices = _ref10.activeServices;
-    var formattedHostmap = services.map(function (service) {
-      return _this7._formatHostMapEntry(service);
-    });
+      activeServices = _ref10.activeServices,
+      timestamp = _ref10.timestamp,
+      orgId = _ref10.orgId,
+      format = _ref10.format;
+    var formattedHostmap = {
+      activeServices: activeServices,
+      services: services.map(function (service) {
+        return _this8._formatHostMapEntry(service);
+      }),
+      timestamp: timestamp,
+      orgId: orgId,
+      format: format
+    };
     this._updateActiveServices(activeServices);
     this._updateServices(services);
     return formattedHostmap;
@@ -789,7 +846,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {Promise<object>}
    */
   _fetchNewServiceHostmap: function _fetchNewServiceHostmap() {
-    var _this8 = this;
+    var _this9 = this;
     var _ref13 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
       from = _ref13.from,
       query = _ref13.query,
@@ -816,10 +873,10 @@ var Services = _webexPlugin.default.extend({
       };
     }
     return this.webex.internal.newMetrics.callDiagnosticLatencies.measureLatency(function () {
-      return _this8.request(requestObject);
+      return _this9.request(requestObject);
     }, 'internal.get.u2c.time').then(function (_ref14) {
       var body = _ref14.body;
-      return _this8._formatReceivedHostmap(body);
+      return _this9._formatReceivedHostmap(body);
     });
   },
   /**
@@ -828,7 +885,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {void}
    */
   initConfig: function initConfig() {
-    var _this9 = this;
+    var _this10 = this;
     // Get the catalog and destructure the services config.
     var catalog = this._getCatalog();
     var _this$webex$config = this.webex.config,
@@ -844,7 +901,7 @@ var Services = _webexPlugin.default.extend({
       if (services.discovery) {
         // Format the discovery configuration into an injectable array.
         var formattedDiscoveryServices = (0, _keys.default)(services.discovery).map(function (key) {
-          return _this9._formatHostMapEntry({
+          return _this10._formatHostMapEntry({
             id: key,
             serviceName: key,
             serviceUrls: [{
@@ -860,7 +917,7 @@ var Services = _webexPlugin.default.extend({
       if (services.override) {
         // Format the override configuration into an injectable array.
         var formattedOverrideServices = (0, _keys.default)(services.override).map(function (key) {
-          return _this9._formatHostMapEntry({
+          return _this10._formatHostMapEntry({
             id: key,
             serviceName: key,
             serviceUrls: [{
@@ -891,11 +948,12 @@ var Services = _webexPlugin.default.extend({
   },
   /**
    * Make the initial requests to collect the root catalogs.
-   *
+   * @param {boolean} refresh - Is need force update
    * @returns {Promise<void, Error>} - Errors if the token is unavailable.
    */
   initServiceCatalogs: function initServiceCatalogs() {
-    var _this10 = this;
+    var _this11 = this;
+    var refresh = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     this.logger.info('services: initializing initial service catalogs');
 
     // Destructure the credentials plugin.
@@ -910,16 +968,18 @@ var Services = _webexPlugin.default.extend({
     })
     // Begin collecting the preauth/limited catalog.
     .then(function (orgId) {
-      return _this10.collectPreauthCatalog({
+      return _this11.collectPreauthCatalog({
         orgId: orgId
-      });
+      }, refresh);
     }).then(function () {
       // Validate if the token is authorized.
       if (credentials.canAuthorize) {
         // Attempt to collect the postauth catalog.
-        return _this10.updateServices().catch(function () {
-          _this10.initFailed = true;
-          _this10.logger.warn('services: cannot retrieve postauth catalog');
+        return _this11.updateServices({
+          forceRefresh: refresh
+        }).catch(function () {
+          _this11.initFailed = true;
+          _this11.logger.warn('services: cannot retrieve postauth catalog');
         });
       }
 
@@ -935,39 +995,39 @@ var Services = _webexPlugin.default.extend({
    * @returns {Services}
    */
   initialize: function initialize() {
-    var _this11 = this;
+    var _this12 = this;
     var catalog = new _serviceCatalog.default();
     this._catalogs.set(this.webex, catalog);
 
     // Listen for configuration changes once.
     this.listenToOnce(this.webex, 'change:config', function () {
-      _this11.initConfig();
+      _this12.initConfig();
     });
 
     // wait for webex instance to be ready before attempting
     // to update the service catalogs
     this.listenToOnce(this.webex, 'ready', function () {
-      var supertoken = _this11.webex.credentials.supertoken;
+      var supertoken = _this12.webex.credentials.supertoken;
       // Validate if the supertoken exists.
       if (supertoken && supertoken.access_token) {
-        _this11.initServiceCatalogs().then(function () {
+        _this12.initServiceCatalogs().then(function () {
           catalog.isReady = true;
         }).catch(function (error) {
-          _this11.initFailed = true;
-          _this11.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+          _this12.initFailed = true;
+          _this12.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
         });
       } else {
-        var email = _this11.webex.config.email;
-        _this11.collectPreauthCatalog(email ? {
+        var email = _this12.webex.config.email;
+        _this12.collectPreauthCatalog(email ? {
           email: email
         } : undefined).catch(function (error) {
-          _this11.initFailed = true;
-          _this11.logger.error("services: failed to init initial services when no credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+          _this12.initFailed = true;
+          _this12.logger.error("services: failed to init initial services when no credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
         });
       }
     });
   },
-  version: "3.9.0"
+  version: "3.10.0"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;