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

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

@@ -42,6 +42,12 @@ var DEFAULT_CLUSTER_IDENTIFIER = process.env.WEBEX_CONVERSATION_DEFAULT_CLUSTER
 var CATALOG_CACHE_KEY_V2 = 'services.v2.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
@@ -52,6 +58,19 @@ var Services = _webexPlugin.default.extend({
     validateDomains: ['boolean', false, true],
     initFailed: ['boolean', false, false]
   },
+  session: {
+    /**
+     * Becomes `true` once services initialization has completed.
+     * This blocks `webex.ready` until services are initialized.
+     * @instance
+     * @memberof Services
+     * @type {boolean}
+     */
+    ready: {
+      default: false,
+      type: 'boolean'
+    }
+  },
   _catalogs: new _weakMap.default(),
   _activeServices: {},
   _services: [],
@@ -1314,6 +1333,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 _this12 = this;
+    return (0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
+      var credentials;
+      return _regenerator.default.wrap(function (_context3) {
+        while (1) switch (_context3.prev = _context3.next) {
+          case 0:
+            credentials = _this12.webex.credentials;
+            if (!(credentials && credentials.isRefreshing)) {
+              _context3.next = 1;
+              break;
+            }
+            _context3.next = 1;
+            return new _promise.default(function (resolve) {
+              credentials.once('change:isRefreshing', resolve);
+            });
+          case 1:
+            _this12.ready = true;
+            _this12.trigger('services:initialized');
+          case 2:
+          case "end":
+            return _context3.stop();
+        }
+      }, _callee3);
+    }))();
+  },
   /**
    * Initializer
    *
@@ -1322,58 +1378,84 @@ var Services = _webexPlugin.default.extend({
    * @returns {Services}
    */
   initialize: function initialize() {
-    var _this12 = this;
+    var _this13 = this;
     var catalog = new _serviceCatalog.default();
     this._catalogs.set(this.webex, catalog);
 
     // Listen for configuration changes once.
     this.listenToOnce(this.webex, 'change:config', function () {
-      _this12.initConfig();
+      _this13.initConfig();
     });
 
-    // wait for webex instance to be ready before attempting
-    // to update the service catalogs
-    this.listenToOnce(this.webex, 'ready', /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee3() {
-      var warmed, supertoken, email;
-      return _regenerator.default.wrap(function (_context3) {
-        while (1) switch (_context3.prev = _context3.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 _callee4() {
+      var warmed, supertoken, timeout, email;
+      return _regenerator.default.wrap(function (_context4) {
+        while (1) switch (_context4.prev = _context4.next) {
           case 0:
-            _context3.next = 1;
-            return _this12._loadCatalogFromCache();
+            _context4.next = 1;
+            return _this13._loadCatalogFromCache();
           case 1:
-            warmed = _context3.sent;
+            warmed = _context4.sent;
             if (!warmed) {
-              _context3.next = 2;
+              _context4.next = 3;
               break;
             }
             catalog.isReady = true;
-            return _context3.abrupt("return");
+            _context4.next = 2;
+            return _this13._finalizeReady();
           case 2:
-            supertoken = _this12.webex.credentials.supertoken; // Validate if the supertoken exists.
+            return _context4.abrupt("return");
+          case 3:
+            supertoken = _this13.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) {
-              _this12.initServiceCatalogs().then(function () {
+              _promise.default.race([_this13.initServiceCatalogs(), timeout]).then(function () {
                 catalog.isReady = true;
               }).catch(function (error) {
-                _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));
+                _this13.initFailed = true;
+                _this13.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+              }).finally(function () {
+                return _this13._finalizeReady();
               });
             } else {
-              email = _this12.webex.config.email;
-              _this12.collectPreauthCatalog(email ? {
+              email = _this13.webex.config.email;
+              _promise.default.race([_this13.collectPreauthCatalog(email ? {
                 email: email
-              } : undefined).catch(function (error) {
-                _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));
+              } : undefined), timeout]).catch(function (error) {
+                _this13.initFailed = true;
+                _this13.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 _this13._finalizeReady();
+              });
+              // Listen for when credentials become available to fetch the full catalog.
+              // This handles fresh login where 'loaded' fires before OAuth completes.
+              _this13.listenToOnce(_this13.webex, 'change:canAuthorize', function () {
+                if (_this13.webex.canAuthorize && !catalog.status.postauth.ready) {
+                  _this13.initServiceCatalogs().then(function () {
+                    catalog.isReady = true;
+                  }).catch(function (error) {
+                    _this13.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 _context3.stop();
+            return _context4.stop();
         }
-      }, _callee3);
+      }, _callee4);
     })));
   },
-  version: "3.12.0-next.9"
+  version: "3.12.0-webex-services-ready.1"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;