@webex/webex-core 3.12.0-next.32 → 3.12.0-next.34

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

@@ -52,6 +52,21 @@ var Services = _webexPlugin.default.extend({
     validateDomains: ['boolean', false, true],
     initFailed: ['boolean', false, false]
   },
+  session: {
+    /**
+     * Becomes `true` once the initial catalog collection has completed
+     * (successfully or otherwise) and any in-flight credentials refresh has
+     * settled. Blocks `webex.ready` so consumers can rely on `webex.ready`
+     * implying "catalogs populated AND credential state stable".
+     * @instance
+     * @memberof Services
+     * @type {boolean}
+     */
+    ready: {
+      default: false,
+      type: 'boolean'
+    }
+  },
   _catalogs: new _weakMap.default(),
   _activeServices: {},
   _services: [],
@@ -1285,6 +1300,7 @@ var Services = _webexPlugin.default.extend({
 
     // Destructure the credentials plugin.
     var credentials = this.webex.credentials;
+    var catalog = this._getCatalog();
 
     // Init a promise chain. Must be done as a Promise.resolve() to allow
     // credentials#getOrgId() to properly throw.
@@ -1301,9 +1317,14 @@ var Services = _webexPlugin.default.extend({
     }).then(function () {
       // Validate if the token is authorized.
       if (credentials.canAuthorize) {
-        // Attempt to collect the postauth catalog.
+        // Attempt to collect the postauth catalog, then mark the catalog
+        // ready. Setting `isReady` here - rather than only in the init
+        // callers - means a slow postauth fetch that loses the gated-init
+        // timeout race still marks the catalog ready once it completes.
         return _this11.updateServices({
           forceRefresh: refresh
+        }).then(function () {
+          catalog.isReady = true;
         }).catch(function () {
           _this11.initFailed = true;
           _this11.logger.warn('services: cannot retrieve postauth catalog');
@@ -1314,6 +1335,42 @@ 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;
+          case 2:
+          case "end":
+            return _context3.stop();
+        }
+      }, _callee3);
+    }))();
+  },
   /**
    * Initializer
    *
@@ -1322,58 +1379,170 @@ 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.
+    // Listen for configuration changes once. The config is not populated on the
+    // webex instance until the `change:config` event fires, so any decision that
+    // depends on config values (such as the gated-vs-ungated init below) must be
+    // made from within this handler rather than synchronously in `initialize()`.
     this.listenToOnce(this.webex, 'change:config', function () {
-      _this12.initConfig();
-    });
+      var _this13$webex$config, _this13$webex$config$;
+      _this13.initConfig();
 
+      // Feature flag: when enabled, `webex.ready` is blocked until the initial
+      // catalog collection has settled AND any in-flight credentials refresh has
+      // completed. When disabled (the default), preserves the pre-existing
+      // behavior where `webex.ready` fires as soon as `webex.loaded` does and
+      // the catalog is collected out-of-band.
+      var waitForCatalogInit = ((_this13$webex$config = _this13.webex.config) === null || _this13$webex$config === void 0 ? void 0 : (_this13$webex$config$ = _this13$webex$config.services) === null || _this13$webex$config$ === void 0 ? void 0 : _this13$webex$config$.waitForCatalogInit) === true;
+      if (waitForCatalogInit) {
+        _this13._initializeCatalogsGated(catalog);
+      } else {
+        // Not gating - immediately mark ready so we do not block webex.ready.
+        _this13.ready = true;
+        _this13._initializeCatalogsUngated(catalog);
+      }
+    });
+  },
+  /**
+   * Original (pre-verified-ready) initialization path. Runs on `webex.ready`
+   * and collects catalogs opportunistically without blocking anything.
+   *
+   * @private
+   * @param {ServiceCatalog} catalog
+   * @returns {void}
+   */
+  _initializeCatalogsUngated: function _initializeCatalogsUngated(catalog) {
+    var _this14 = this;
     // 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() {
+    this.listenToOnce(this.webex, 'ready', /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee4() {
       var warmed, supertoken, email;
-      return _regenerator.default.wrap(function (_context3) {
-        while (1) switch (_context3.prev = _context3.next) {
+      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 _this14._loadCatalogFromCache();
           case 1:
-            warmed = _context3.sent;
+            warmed = _context4.sent;
             if (!warmed) {
-              _context3.next = 2;
+              _context4.next = 2;
               break;
             }
             catalog.isReady = true;
-            return _context3.abrupt("return");
+            return _context4.abrupt("return");
           case 2:
-            supertoken = _this12.webex.credentials.supertoken; // Validate if the supertoken exists.
+            supertoken = _this14.webex.credentials.supertoken; // Validate if the supertoken exists.
             if (supertoken && supertoken.access_token) {
-              _this12.initServiceCatalogs().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));
+              // `initServiceCatalogs` marks the catalog ready internally once the
+              // postauth catalog is collected.
+              _this14.initServiceCatalogs().catch(function (error) {
+                _this14.initFailed = true;
+                _this14.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
               });
             } else {
-              email = _this12.webex.config.email;
-              _this12.collectPreauthCatalog(email ? {
+              email = _this14.webex.config.email;
+              _this14.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));
+                _this14.initFailed = true;
+                _this14.logger.error("services: failed to init initial services when no credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
               });
             }
           case 3:
           case "end":
-            return _context3.stop();
+            return _context4.stop();
         }
-      }, _callee3);
+      }, _callee4);
+    })));
+  },
+  /**
+   * Verified-ready initialization path. Blocks `webex.ready` until the initial
+   * catalog fetch has settled (or timed out) AND any in-flight credentials
+   * refresh has completed. Also handles the fresh-login case where OAuth
+   * completes after `loaded` fires.
+   *
+   * @private
+   * @param {ServiceCatalog} catalog
+   * @returns {void}
+   */
+  _initializeCatalogsGated: function _initializeCatalogsGated(catalog) {
+    var _this15 = this;
+    // Wait for storage to be loaded before attempting to update the service
+    // catalogs. We listen for 'loaded' instead of 'ready' because `services.ready`
+    // now blocks `webex.ready` - listening to 'ready' would deadlock.
+    this.listenToOnce(this.webex, 'loaded', /*#__PURE__*/(0, _asyncToGenerator2.default)(/*#__PURE__*/_regenerator.default.mark(function _callee5() {
+      var _this15$webex$config, _this15$webex$config$;
+      var warmed, supertoken, initTimeoutMs, initServiceCatalogsTimeout, email;
+      return _regenerator.default.wrap(function (_context5) {
+        while (1) switch (_context5.prev = _context5.next) {
+          case 0:
+            _context5.next = 1;
+            return _this15._loadCatalogFromCache();
+          case 1:
+            warmed = _context5.sent;
+            if (!warmed) {
+              _context5.next = 3;
+              break;
+            }
+            catalog.isReady = true;
+            _context5.next = 2;
+            return _this15._finalizeReady();
+          case 2:
+            return _context5.abrupt("return");
+          case 3:
+            supertoken = _this15.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 consumers waiting on it indefinitely. Timeout is configurable via
+            // `config.services.catalogInitTimeout` (defaults to 15s in config).
+            initTimeoutMs = (_this15$webex$config = _this15.webex.config) === null || _this15$webex$config === void 0 ? void 0 : (_this15$webex$config$ = _this15$webex$config.services) === null || _this15$webex$config$ === void 0 ? void 0 : _this15$webex$config$.catalogInitTimeout;
+            initServiceCatalogsTimeout = new _promise.default(function (_, reject) {
+              setTimeout(function () {
+                return reject(new Error("services: init timed out after ".concat(initTimeoutMs, "ms")));
+              }, initTimeoutMs);
+            }); // Validate if the supertoken exists.
+            if (supertoken && supertoken.access_token) {
+              // `initServiceCatalogs` marks the catalog ready internally once the
+              // postauth catalog is collected - even if it loses the timeout race
+              // above, so a slow fetch still eventually flips `catalog.isReady`.
+              _promise.default.race([_this15.initServiceCatalogs(), initServiceCatalogsTimeout]).catch(function (error) {
+                _this15.initFailed = true;
+                _this15.logger.error("services: failed to init initial services when credentials available, ".concat(error === null || error === void 0 ? void 0 : error.message));
+              }).finally(function () {
+                return _this15._finalizeReady();
+              });
+            } else {
+              email = _this15.webex.config.email;
+              _promise.default.race([_this15.collectPreauthCatalog(email ? {
+                email: email
+              } : undefined), initServiceCatalogsTimeout]).catch(function (error) {
+                _this15.initFailed = true;
+                _this15.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 _this15._finalizeReady();
+              });
+
+              // Handle fresh login: 'loaded' fires before OAuth completes, so listen
+              // for `canAuthorize` flipping true and then collect the postauth catalog.
+              _this15.listenToOnce(_this15.webex, 'change:canAuthorize', function () {
+                if (_this15.webex.canAuthorize && !catalog.status.postauth.ready) {
+                  // `initServiceCatalogs` marks the catalog ready internally.
+                  _this15.initServiceCatalogs().catch(function (error) {
+                    _this15.logger.error("services: failed to init service catalogs after auth, ".concat(error === null || error === void 0 ? void 0 : error.message));
+                  });
+                }
+              });
+            }
+          case 4:
+          case "end":
+            return _context5.stop();
+        }
+      }, _callee5);
     })));
   },
-  version: "3.12.0-next.32"
+  version: "3.12.0-next.34"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;