@webex/webex-core 3.12.0-webex-services-ready.1 → 3.12.0-webex-services-ready.2

package/dist/lib/batcher.js

@@ -302,7 +302,7 @@ var Batcher = _webexPlugin.default.extend({
   fingerprintResponse: function fingerprintResponse(item) {
     throw new Error('fingerprintResponse() must be implemented');
   },
-  version: "3.12.0-webex-services-ready.1"
+  version: "3.12.0-webex-services-ready.2"
 });
 var _default2 = exports.default = Batcher;
 //# sourceMappingURL=batcher.js.map

package/dist/lib/credentials/credentials.js

@@ -600,7 +600,7 @@ var Credentials = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       this.refresh();
     }
   },
-  version: "3.12.0-webex-services-ready.1"
+  version: "3.12.0-webex-services-ready.2"
 }, (0, _applyDecoratedDescriptor2.default)(_obj, "getUserToken", [_dec, _dec2], (0, _getOwnPropertyDescriptor.default)(_obj, "getUserToken"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "initialize", [_dec3], (0, _getOwnPropertyDescriptor.default)(_obj, "initialize"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "invalidate", [_common.oneFlight, _dec4], (0, _getOwnPropertyDescriptor.default)(_obj, "invalidate"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight, _dec5, _dec6], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj), _obj));
 var _default = exports.default = Credentials;
 //# sourceMappingURL=credentials.js.map

package/dist/lib/credentials/token.js

@@ -532,7 +532,7 @@ var Token = _webexPlugin.default.extend((_dec = (0, _common.oneFlight)({
       return res.body;
     });
   },
-  version: "3.12.0-webex-services-ready.1"
+  version: "3.12.0-webex-services-ready.2"
 }, (0, _applyDecoratedDescriptor2.default)(_obj, "downscope", [_dec], (0, _getOwnPropertyDescriptor.default)(_obj, "downscope"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "refresh", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "refresh"), _obj), (0, _applyDecoratedDescriptor2.default)(_obj, "revoke", [_common.oneFlight], (0, _getOwnPropertyDescriptor.default)(_obj, "revoke"), _obj), _obj));
 var _default = exports.default = Token;
 //# sourceMappingURL=token.js.map

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; } /* eslint-disable no-console */
+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; }
 var trailingSlashes = /(?:^\/)|(?:\/$)/;
 
 // The default cluster when one is not provided (usually as 'US' from hydra)
@@ -81,8 +81,10 @@ var Services = _webexPlugin.default.extend({
   },
   session: {
     /**
-     * Becomes `true` once service catalog initialization has completed.
-     * Blocks `webex.ready` until services are initialized.
+     * 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}
@@ -1426,7 +1428,6 @@ var Services = _webexPlugin.default.extend({
             });
           case 1:
             _this1.ready = true;
-            _this1.trigger('services:initialized');
           case 2:
           case "end":
             return _context4.stop();
@@ -1450,34 +1451,118 @@ var Services = _webexPlugin.default.extend({
     this.registries.set(this.webex, registry);
     this.states.set(this.webex, state);
 
-    // 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 () {
+      var _this10$webex$config, _this10$webex$config$;
       _this10.initConfig();
-    });
 
-    // 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;
+      // 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 = ((_this10$webex$config = _this10.webex.config) === null || _this10$webex$config === void 0 ? void 0 : (_this10$webex$config$ = _this10$webex$config.services) === null || _this10$webex$config$ === void 0 ? void 0 : _this10$webex$config$.waitForCatalogInit) === true;
+      if (waitForCatalogInit) {
+        _this10._initializeCatalogsGated(catalog);
+      } else {
+        // Not gating - immediately mark ready so we do not block webex.ready.
+        _this10.ready = true;
+        _this10._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 _this11 = this;
+    // 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 _callee5() {
+      var cachedCatalog, supertoken, email;
       return _regenerator.default.wrap(function (_context5) {
         while (1) switch (_context5.prev = _context5.next) {
           case 0:
             _context5.next = 1;
-            return _this10._loadCatalogFromCache();
+            return _this11._loadCatalogFromCache();
           case 1:
             cachedCatalog = _context5.sent;
             if (!cachedCatalog) {
-              _context5.next = 3;
+              _context5.next = 2;
               break;
             }
             catalog.isReady = true;
-            _context5.next = 2;
-            return _this10._finalizeReady();
-          case 2:
             return _context5.abrupt("return");
+          case 2:
+            supertoken = _this11.webex.credentials.supertoken; // Validate if the supertoken exists.
+            if (supertoken && supertoken.access_token) {
+              _this11.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));
+              });
+            } else {
+              email = _this11.webex.config.email;
+              _this11.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));
+              });
+            }
           case 3:
-            supertoken = _this10.webex.credentials.supertoken; // Race init against a hard timeout so a hung request never leaves
+          case "end":
+            return _context5.stop();
+        }
+      }, _callee5);
+    })));
+  },
+  /**
+   * 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 _this12 = 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 _callee6() {
+      var cachedCatalog, supertoken, timeout, email;
+      return _regenerator.default.wrap(function (_context6) {
+        while (1) switch (_context6.prev = _context6.next) {
+          case 0:
+            _context6.next = 1;
+            return _this12._loadCatalogFromCache();
+          case 1:
+            cachedCatalog = _context6.sent;
+            if (!cachedCatalog) {
+              _context6.next = 3;
+              break;
+            }
+            catalog.isReady = true;
+            _context6.next = 2;
+            return _this12._finalizeReady();
+          case 2:
+            return _context6.abrupt("return");
+          case 3:
+            supertoken = _this12.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) {
@@ -1486,44 +1571,43 @@ var Services = _webexPlugin.default.extend({
               }, SERVICES_INIT_TIMEOUT_MS);
             }); // Validate if the supertoken exists.
             if (supertoken && supertoken.access_token) {
-              _promise.default.race([_this10.initServiceCatalogs(), timeout]).then(function () {
+              _promise.default.race([_this12.initServiceCatalogs(), timeout]).then(function () {
                 catalog.isReady = true;
               }).catch(function (error) {
-                _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));
+                _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));
               }).finally(function () {
-                return _this10._finalizeReady();
+                return _this12._finalizeReady();
               });
             } else {
-              email = _this10.webex.config.email;
-              _promise.default.race([_this10.collectPreauthCatalog(email ? {
+              email = _this12.webex.config.email;
+              _promise.default.race([_this12.collectPreauthCatalog(email ? {
                 email: email
               } : 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));
+                _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));
               }).finally(function () {
-                return _this10._finalizeReady();
+                return _this12._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));
+
+              // Handle fresh login: 'loaded' fires before OAuth completes, so listen
+              // for `canAuthorize` flipping true and then collect the postauth catalog.
+              _this12.listenToOnce(_this12.webex, 'change:canAuthorize', function () {
+                if (_this12.webex.canAuthorize && !catalog.status.postauth.ready) {
+                  _this12.initServiceCatalogs().catch(function (error) {
+                    _this12.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();
+            return _context6.stop();
         }
-      }, _callee5);
+      }, _callee6);
     })));
   },
-  version: "3.12.0-webex-services-ready.1"
+  version: "3.12.0-webex-services-ready.2"
 });
 /* eslint-enable no-underscore-dangle */
 var _default = exports.default = Services;