@webex/webex-core 3.12.0-next.9 → 3.12.0-webex-services-ready.1

package/dist/lib/services/services.js

@@ -31,7 +31,7 @@ var _serviceState = _interopRequireDefault(require("./service-state"));
 var _serviceFedRamp = _interopRequireDefault(require("./service-fed-ramp"));
 var _constants = require("../constants");
 function ownKeys(e, r) { var t = _Object$keys2(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return _Object$getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; } /* eslint-disable no-console */
 var trailingSlashes = /(?:^\/)|(?:\/$)/;
 
 // The default cluster when one is not provided (usually as 'US' from hydra)
@@ -43,6 +43,12 @@ var DEFAULT_CLUSTER_IDENTIFIER = process.env.WEBEX_CONVERSATION_DEFAULT_CLUSTER
 var CATALOG_CACHE_KEY_V1 = 'services.v1.u2cHostMap';
 var CATALOG_TTL_MS = 24 * 60 * 60 * 1000; // 24 hours
 
+// Maximum time we will wait for the initial catalog collection before letting
+// `services.ready` (and therefore `webex.ready`) fire anyway. A hung request
+// must never leave the app on a permanent spinner - past this point downstream
+// consumers must fall through to their normal error/login paths.
+var SERVICES_INIT_TIMEOUT_MS = 15000;
+
 /* eslint-disable no-underscore-dangle */
 /**
  * @class
@@ -73,6 +79,19 @@ var Services = _webexPlugin.default.extend({
     validateDomains: ['boolean', false, true],
     initFailed: ['boolean', false, false]
   },
+  session: {
+    /**
+     * Becomes `true` once service catalog initialization has completed.
+     * Blocks `webex.ready` until services are initialized.
+     * @instance
+     * @memberof Services
+     * @type {boolean}
+     */
+    ready: {
+      default: false,
+      type: 'boolean'
+    }
+  },
   _catalogs: new _weakMap.default(),
   _serviceUrls: null,
   _hostCatalog: null,
@@ -1378,6 +1397,43 @@ var Services = _webexPlugin.default.extend({
       return _promise.default.resolve();
     });
   },
+  /**
+   * Await any in-flight credentials refresh, then flip `services.ready` so
+   * `webex.ready` can fire. Closes the parallel-refresh window: if a credential
+   * refresh is in flight when initial catalog collection settles, we must not
+   * signal ready until the refresh has resolved - otherwise downstream
+   * consumers may observe `canAuthorize`/token state that is about to change
+   * under them.
+   *
+   * @private
+   * @returns {Promise<void>}
+   */
+  _finalizeReady: function _finalizeReady() {
+    var _this1 = this;
+    return (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
+      var credentials;
+      return _regenerator.default.wrap(function (_context4) {
+        while (1) switch (_context4.prev = _context4.next) {
+          case 0:
+            credentials = _this1.webex.credentials;
+            if (!(credentials && credentials.isRefreshing)) {
+              _context4.next = 1;
+              break;
+            }
+            _context4.next = 1;
+            return new _promise.default(function (resolve) {
+              credentials.once('change:isRefreshing', resolve);
+            });
+          case 1:
+            _this1.ready = true;
+            _this1.trigger('services:initialized');
+          case 2:
+          case "end":
+            return _context4.stop();
+        }
+      }, _callee4);
+    }))();
+  },
   /**
    * Initializer
    *
@@ -1386,7 +1442,7 @@ var Services = _webexPlugin.default.extend({
    * @returns {Services}
    */
   initialize: function initialize() {
-    var _this1 = this;
+    var _this10 = this;
     var catalog = new _serviceCatalog.default();
     var registry = new _serviceRegistry.default();
     var state = new _serviceState.default();
@@ -1396,54 +1452,78 @@ var Services = _webexPlugin.default.extend({
 
     // Listen for configuration changes once.
     this.listenToOnce(this.webex, 'change:config', function () {
-      _this1.initConfig();
+      _this10.initConfig();
     });
 
-    // wait for webex instance to be ready before attempting
-    // to update the service catalogs
-    // this can cause a race condition because credentials may
-    // not be valid when services is initialized
-    this.listenToOnce(this.webex, 'ready', /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
-      var cachedCatalog, supertoken, email;
-      return _regenerator.default.wrap(function (_context4) {
-        while (1) switch (_context4.prev = _context4.next) {
+    // Wait for storage to be loaded before attempting to update the service catalogs.
+    // We listen for 'loaded' instead of 'ready' because services.ready is a dependency
+    // of webex.ready - listening to 'ready' would cause a deadlock.
+    this.listenToOnce(this.webex, 'loaded', /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5() {
+      var cachedCatalog, supertoken, timeout, email;
+      return _regenerator.default.wrap(function (_context5) {
+        while (1) switch (_context5.prev = _context5.next) {
           case 0:
-            _context4.next = 1;
-            return _this1._loadCatalogFromCache();
+            _context5.next = 1;
+            return _this10._loadCatalogFromCache();
           case 1:
-            cachedCatalog = _context4.sent;
+            cachedCatalog = _context5.sent;
             if (!cachedCatalog) {
-              _context4.next = 2;
+              _context5.next = 3;
               break;
             }
             catalog.isReady = true;
-            return _context4.abrupt("return");
+            _context5.next = 2;
+            return _this10._finalizeReady();
           case 2:
-            supertoken = _this1.webex.credentials.supertoken; // Validate if the supertoken exists.
+            return _context5.abrupt("return");
+          case 3:
+            supertoken = _this10.webex.credentials.supertoken; // Race init against a hard timeout so a hung request never leaves
+            // `services.ready` false forever - that would stall `webex.ready` and
+            // leave the app on a permanent spinner.
+            timeout = new _promise.default(function (_, reject) {
+              setTimeout(function () {
+                return reject(new Error("services: init timed out after ".concat(SERVICES_INIT_TIMEOUT_MS, "ms")));
+              }, SERVICES_INIT_TIMEOUT_MS);
+            }); // Validate if the supertoken exists.
             if (supertoken && supertoken.access_token) {
-              _this1.initServiceCatalogs().then(function () {
+              _promise.default.race([_this10.initServiceCatalogs(), timeout]).then(function () {
                 catalog.isReady = true;
               }).catch(function (error) {
-                _this1.initFailed = true;
-                _this1.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+                _this10.initFailed = true;
+                _this10.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+              }).finally(function () {
+                return _this10._finalizeReady();
               });
             } else {
-              email = _this1.webex.config.email;
-              _this1.collectPreauthCatalog(email ? {
+              email = _this10.webex.config.email;
+              _promise.default.race([_this10.collectPreauthCatalog(email ? {
                 email: email
-              } : undefined).catch(function (error) {
-                _this1.initFailed = true;
-                _this1.logger.error("services: failed to init initial services when no credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+              } : undefined), timeout]).catch(function (error) {
+                _this10.initFailed = true;
+                _this10.logger.error("services: failed to init initial services when no credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+              }).finally(function () {
+                return _this10._finalizeReady();
+              });
+              // Listen for when credentials become available to fetch the full catalog.
+              // This handles fresh login where 'loaded' fires before OAuth completes.
+              _this10.listenToOnce(_this10.webex, 'change:canAuthorize', function () {
+                if (_this10.webex.canAuthorize && !catalog.status.postauth.ready) {
+                  _this10.initServiceCatalogs().then(function () {
+                    catalog.isReady = true;
+                  }).catch(function (error) {
+                    _this10.logger.error("services: failed to init service catalogs after auth, ".concat(error === null || error === void 0 ? void 0 : error.message));
+                  });
+                }
               });
             }
-          case 3:
+          case 4:
           case "end":
-            return _context4.stop();
+            return _context5.stop();
         }
-      }, _callee4);
+      }, _callee5);
     })));
   },
-  version: "3.12.0-next.9"
+  version: "3.12.0-webex-services-ready.1"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;