@webex/webex-core 2.59.8-next.1 → 2.60.0-next.1

package/dist/webex-internal-core.js.map

@@ -1 +1 @@
-{"version":3,"names":["_util","_interopRequireDefault","require","_ampersandState","WebexInternalCore","AmpState","extend","derived","ready","deps","fn","_this","_keys","default","_children","reduce","name","inspect","depth","util","serialize","props","session","_default","exports"],"sources":["webex-internal-core.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport util from 'util';\n\nimport AmpState from 'ampersand-state';\n\n/**\n * WebexInternalCore is an extra layer of nesting to make it blatantly clear that\n * private plugins are, in fact, private.\n * @class\n */\nconst WebexInternalCore = AmpState.extend({\n  derived: {\n    ready: {\n      deps: [],\n      fn() {\n        return Object.keys(this._children).reduce(\n          (ready, name) => ready && this[name] && this[name].ready !== false,\n          true\n        );\n      },\n    },\n  },\n\n  /**\n   * @instance\n   * @memberof WebexPlugin\n   * @param {number} depth\n   * @private\n   * @returns {Object}\n   */\n  inspect(depth) {\n    return util.inspect(\n      this.serialize({\n        props: true,\n        session: true,\n        derived: true,\n      }),\n      {depth}\n    );\n  },\n});\n\nexport default WebexInternalCore;\n"],"mappings":";;;;;;;;;AAIA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,eAAA,GAAAF,sBAAA,CAAAC,OAAA;AANA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA,IAAME,iBAAiB,GAAGC,uBAAQ,CAACC,MAAM,CAAC;EACxCC,OAAO,EAAE;IACPC,KAAK,EAAE;MACLC,IAAI,EAAE,EAAE;MACRC,EAAE,WAAAA,GAAA,EAAG;QAAA,IAAAC,KAAA;QACH,OAAO,IAAAC,KAAA,CAAAC,OAAA,EAAY,IAAI,CAACC,SAAS,CAAC,CAACC,MAAM,CACvC,UAACP,KAAK,EAAEQ,IAAI;UAAA,OAAKR,KAAK,IAAIG,KAAI,CAACK,IAAI,CAAC,IAAIL,KAAI,CAACK,IAAI,CAAC,CAACR,KAAK,KAAK,KAAK;QAAA,GAClE,IAAI,CACL;MACH;IACF;EACF,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACES,OAAO,WAAAA,QAACC,KAAK,EAAE;IACb,OAAOC,aAAI,CAACF,OAAO,CACjB,IAAI,CAACG,SAAS,CAAC;MACbC,KAAK,EAAE,IAAI;MACXC,OAAO,EAAE,IAAI;MACbf,OAAO,EAAE;IACX,CAAC,CAAC,EACF;MAACW,KAAK,EAALA;IAAK,CAAC,CACR;EACH;AACF,CAAC,CAAC;AAAC,IAAAK,QAAA,GAEYnB,iBAAiB;AAAAoB,OAAA,CAAAX,OAAA,GAAAU,QAAA"}
+{"version":3,"names":["_util","_interopRequireDefault","require","_ampersandState","WebexInternalCore","AmpState","extend","derived","ready","deps","fn","_this","_keys","default","_children","reduce","name","inspect","depth","util","serialize","props","session","_default","exports"],"sources":["webex-internal-core.js"],"sourcesContent":["/*!\n * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport util from 'util';\n\nimport AmpState from 'ampersand-state';\n\n/**\n * WebexInternalCore is an extra layer of nesting to make it blatantly clear that\n * private plugins are, in fact, private.\n * @class\n */\nconst WebexInternalCore = AmpState.extend({\n  derived: {\n    ready: {\n      deps: [],\n      fn() {\n        return Object.keys(this._children).reduce(\n          (ready, name) => ready && this[name] && this[name].ready !== false,\n          true\n        );\n      },\n    },\n  },\n\n  /**\n   * @instance\n   * @memberof WebexPlugin\n   * @param {number} depth\n   * @private\n   * @returns {Object}\n   */\n  inspect(depth) {\n    return util.inspect(\n      this.serialize({\n        props: true,\n        session: true,\n        derived: true,\n      }),\n      {depth}\n    );\n  },\n});\n\nexport default WebexInternalCore;\n"],"mappings":";;;;;;;;;AAIA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,eAAA,GAAAF,sBAAA,CAAAC,OAAA;AANA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA,IAAME,iBAAiB,GAAGC,uBAAQ,CAACC,MAAM,CAAC;EACxCC,OAAO,EAAE;IACPC,KAAK,EAAE;MACLC,IAAI,EAAE,EAAE;MACRC,EAAE,WAAAA,GAAA,EAAG;QAAA,IAAAC,KAAA;QACH,OAAO,IAAAC,KAAA,CAAAC,OAAA,EAAY,IAAI,CAACC,SAAS,CAAC,CAACC,MAAM,CACvC,UAACP,KAAK,EAAEQ,IAAI;UAAA,OAAKR,KAAK,IAAIG,KAAI,CAACK,IAAI,CAAC,IAAIL,KAAI,CAACK,IAAI,CAAC,CAACR,KAAK,KAAK,KAAK;QAAA,GAClE,IACF,CAAC;MACH;IACF;EACF,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;EACES,OAAO,WAAAA,QAACC,KAAK,EAAE;IACb,OAAOC,aAAI,CAACF,OAAO,CACjB,IAAI,CAACG,SAAS,CAAC;MACbC,KAAK,EAAE,IAAI;MACXC,OAAO,EAAE,IAAI;MACbf,OAAO,EAAE;IACX,CAAC,CAAC,EACF;MAACW,KAAK,EAALA;IAAK,CACR,CAAC;EACH;AACF,CAAC,CAAC;AAAC,IAAAK,QAAA,GAAAC,OAAA,CAAAX,OAAA,GAEYT,iBAAiB"}

package/package.json

@@ -20,7 +20,7 @@
     "directory": "packages/@webex/webex-core"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16"
   },
   "browserify": {
     "transform": [
@@ -35,12 +35,12 @@
     "@webex/eslint-config-legacy": "^0.0.0",
     "@webex/jest-config-legacy": "^0.0.0",
     "@webex/legacy-tools": "^0.0.0",
-    "@webex/test-helper-chai": "^2.59.8-next.1",
-    "@webex/test-helper-make-local-url": "^2.59.8-next.1",
-    "@webex/test-helper-mocha": "^2.59.8-next.1",
-    "@webex/test-helper-mock-webex": "^2.59.8-next.1",
-    "@webex/test-helper-refresh-callback": "^2.59.8-next.1",
-    "@webex/test-helper-test-users": "^2.59.8-next.1",
+    "@webex/test-helper-chai": "^2.60.0-next.1",
+    "@webex/test-helper-make-local-url": "^2.60.0-next.1",
+    "@webex/test-helper-mocha": "^2.60.0-next.1",
+    "@webex/test-helper-mock-webex": "^2.60.0-next.1",
+    "@webex/test-helper-refresh-callback": "^2.60.0-next.1",
+    "@webex/test-helper-test-users": "^2.60.0-next.1",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -48,12 +48,12 @@
     "sinon": "^9.2.4"
   },
   "dependencies": {
-    "@webex/common": "^2.59.8-next.1",
-    "@webex/common-timers": "^2.59.8-next.1",
-    "@webex/http-core": "^2.59.8-next.1",
-    "@webex/internal-plugin-device": "^2.59.8-next.1",
-    "@webex/plugin-logger": "^2.59.8-next.1",
-    "@webex/storage-adapter-spec": "^2.59.8-next.1",
+    "@webex/common": "^2.60.0-next.1",
+    "@webex/common-timers": "^2.60.0-next.1",
+    "@webex/http-core": "^2.60.0-next.1",
+    "@webex/internal-plugin-device": "^2.60.0-next.1",
+    "@webex/plugin-logger": "^2.60.0-next.1",
+    "@webex/storage-adapter-spec": "^2.60.0-next.1",
     "ampersand-collection": "^2.0.2",
     "ampersand-events": "^2.0.2",
     "ampersand-state": "^5.0.3",
@@ -73,5 +73,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "2.59.8-next.1"
+  "version": "2.60.0-next.1"
 }

package/src/lib/constants.js

@@ -0,0 +1,6 @@
+// Metric to do with WDM registration
+export const METRICS = {
+  JS_SDK_CREDENTIALS_DOWNSCOPE_FAILED: 'JS_SDK_CREDENTIALS_DOWNSCOPE_FAILED',
+  JS_SDK_CREDENTIALS_TOKEN_REFRESH_SCOPE_MISMATCH:
+    'JS_SDK_CREDENTIALS_TOKEN_REFRESH_SCOPE_MISMATCH',
+};

package/src/lib/credentials/credentials.js

@@ -13,10 +13,11 @@ import {clone, cloneDeep, isObject, isEmpty} from 'lodash';
 import WebexPlugin from '../webex-plugin';
 import {persist, waitForValue} from '../storage/decorators';
 
-import grantErrors from './grant-errors';
-import {filterScope, sortScope} from './scope';
+import grantErrors, {OAuthError} from './grant-errors';
+import {filterScope, diffScopes, sortScope} from './scope';
 import Token from './token';
 import TokenCollection from './token-collection';
+import {METRICS} from '../constants';
 
 /**
  * @class
@@ -48,6 +49,25 @@ const Credentials = WebexPlugin.extend({
         return Boolean(this.supertoken && this.supertoken.canRefresh);
       },
     },
+    isUnverifiedGuest: {
+      deps: ['supertoken'],
+      /**
+       * Returns true if the user is an unverified guest
+       * @returns {boolean}
+       */
+      fn() {
+        let isGuest = false;
+        try {
+          isGuest =
+            JSON.parse(base64.decode(this.supertoken.access_token.split('.')[1])).user_type ===
+            'guest';
+        } catch {
+          /* the non-guest token is formatted differently so catch is expected */
+        }
+
+        return isGuest;
+      },
+    },
   },
 
   props: {
@@ -240,8 +260,15 @@ const Credentials = WebexPlugin.extend({
    */
   downscope(scope) {
     return this.supertoken.downscope(scope).catch((reason) => {
-      this.logger.trace(`credentials: failed to downscope supertoken to ${scope}`, reason);
+      const failReason = reason?.body ?? reason;
+      this.logger.warn(`credentials: failed to downscope supertoken to "${scope}"`, failReason);
       this.logger.trace(`credentials: falling back to supertoken for ${scope}`);
+      this.webex.internal.metrics.submitClientMetrics(METRICS.JS_SDK_CREDENTIALS_DOWNSCOPE_FAILED, {
+        fields: {
+          requestedScope: scope,
+          failReason,
+        },
+      });
 
       return Promise.resolve(new Token({scope, ...this.supertoken.serialize()}), {
         parent: this,
@@ -322,12 +349,12 @@ const Credentials = WebexPlugin.extend({
       }
 
       if (!scope) {
-        scope = filterScope('spark:kms', this.config.scope);
+        scope = filterScope('spark:kms', this.supertoken.scope);
       }
 
       scope = sortScope(scope);
 
-      if (scope === sortScope(this.config.scope)) {
+      if (scope === sortScope(this.supertoken.scope)) {
         return Promise.resolve(this.supertoken);
       }
 
@@ -477,42 +504,10 @@ const Credentials = WebexPlugin.extend({
 
     return supertoken
       .refresh()
-      .then((st) => {
-        // clear refresh timer
-        if (this.refreshTimer) {
-          clearTimeout(this.refreshTimer);
-          this.unset('refreshTimer');
-        }
-        this.supertoken = st;
-
-        return Promise.all(
-          tokens.map((token) =>
-            this.downscope(token.scope)
-              // eslint-disable-next-line max-nested-callbacks
-              .then((t) => {
-                this.logger.info(`credentials: revoking token for ${token.scope}`);
-
-                return token
-                  .revoke()
-                  .catch((err) => {
-                    this.logger.warn('credentials: failed to revoke user token', err);
-                  })
-                  .then(() => {
-                    this.userTokens.remove(token.scope);
-                    this.userTokens.add(t);
-                  });
-              })
-          )
-        );
-      })
-      .then(() => {
-        this.scheduleRefresh(this.supertoken.expires);
-      })
       .catch((error) => {
-        const {InvalidRequestError} = grantErrors;
-
-        if (error instanceof InvalidRequestError) {
-          // Error: The refresh token provided is expired, revoked, malformed, or invalid. Hence emit an event to the client, an opportunity to logout.
+        if (error instanceof OAuthError) {
+          // Error: super token refresh failed with 400 status code.
+          // Hence emit an event to the client, an opportunity to logout.
           this.unset('supertoken');
           while (this.userTokens.models.length) {
             try {
@@ -525,6 +520,53 @@ const Credentials = WebexPlugin.extend({
         }
 
         return Promise.reject(error);
+      })
+      .then((st) => {
+        // clear refresh timer
+        if (this.refreshTimer) {
+          clearTimeout(this.refreshTimer);
+          this.unset('refreshTimer');
+        }
+        this.supertoken = st;
+
+        const invalidScopes = diffScopes(this.config.scope, st.scope);
+
+        if (invalidScopes !== '') {
+          this.logger.warn(
+            `credentials: "${invalidScopes}" scope(s) are invalid because not listed in the supertoken, they will be excluded from user token requests.`
+          );
+          this.webex.internal.metrics.submitClientMetrics(
+            METRICS.JS_SDK_CREDENTIALS_TOKEN_REFRESH_SCOPE_MISMATCH,
+            {fields: {invalidScopes}}
+          );
+        }
+
+        return Promise.all(
+          tokens.map((token) => {
+            const tokenScope = filterScope(diffScopes(token.scope, st.scope), token.scope);
+
+            return (
+              this.downscope(tokenScope)
+                // eslint-disable-next-line max-nested-callbacks
+                .then((t) => {
+                  this.logger.info(`credentials: revoking token for ${token.scope}`);
+
+                  return token
+                    .revoke()
+                    .catch((err) => {
+                      this.logger.warn('credentials: failed to revoke user token', err);
+                    })
+                    .then(() => {
+                      this.userTokens.remove(token.scope);
+                      this.userTokens.add(t);
+                    });
+                })
+            );
+          })
+        );
+      })
+      .then(() => {
+        this.scheduleRefresh(this.supertoken.expires);
       });
   },
 

package/src/lib/credentials/scope.js

@@ -2,6 +2,8 @@
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
+import {difference} from 'lodash';
+
 /**
  * sorts a list of scopes
  * @param {string} scope
@@ -17,7 +19,7 @@ export function sortScope(scope) {
 
 /**
  * sorts a list of scopes and filters the specified scope
- * @param {string} toFilter
+ * @param {string|string[]} toFilter
  * @param {string} scope
  * @returns {string}
  */
@@ -25,10 +27,25 @@ export function filterScope(toFilter, scope) {
   if (!scope) {
     return '';
   }
+  const toFilterArr = Array.isArray(toFilter) ? toFilter : [toFilter];
 
   return scope
     .split(' ')
-    .filter((item) => item !== toFilter)
+    .filter((item) => !toFilterArr.includes(item))
     .sort()
     .join(' ');
 }
+
+/**
+ * Returns a string containing all items in scopeA that are not in scopeB, or an empty string if there are none.
+ *
+ * @param {string} scopeA
+ * @param {string} scopeB
+ * @returns {string}
+ */
+export function diffScopes(scopeA, scopeB) {
+  const a = scopeA?.split(' ') ?? [];
+  const b = scopeB?.split(' ') ?? [];
+
+  return difference(a, b).sort().join(' ');
+}

package/src/lib/services/interceptors/service.js

@@ -36,11 +36,11 @@ export default class ServiceInterceptor extends Interceptor {
 
     // Destructure commonly referenced namespaces.
     const {services} = this.webex.internal;
-    const {service, resource} = options;
+    const {service, resource, waitForServiceTimeout} = options;
 
     // Attempt to collect the service url.
     return services
-      .waitForService({name: service})
+      .waitForService({name: service, timeout: waitForServiceTimeout})
       .then((serviceUrl) => {
         // Generate the combined service url and resource.
         options.uri = this.generateUri(serviceUrl, resource);

package/src/lib/services/service-catalog.js

@@ -413,6 +413,8 @@ const ServiceCatalog = AmpState.extend({
         resolve();
       }
 
+      const validatedTimeout = typeof timeout === 'number' && timeout >= 0 ? timeout : 60;
+
       const timeoutTimer = setTimeout(
         () =>
           reject(
@@ -420,7 +422,7 @@ const ServiceCatalog = AmpState.extend({
               `services: timeout occured while waiting for '${serviceGroup}' catalog to populate`
             )
           ),
-        timeout ? timeout * 1000 : 60000
+        validatedTimeout * 1000
       );
 
       this.once(serviceGroup, () => {

package/src/webex-core.js

@@ -6,7 +6,12 @@ import {EventEmitter} from 'events';
 import util from 'util';
 
 import {proxyEvents, retry, transferEvents} from '@webex/common';
-import {HttpStatusInterceptor, defaults as requestDefaults} from '@webex/http-core';
+import {
+  HttpStatusInterceptor,
+  defaults as requestDefaults,
+  protoprepareFetchOptions as prepareFetchOptions,
+  setTimingsAndFetch as _setTimingsAndFetch,
+} from '@webex/http-core';
 import {defaultsDeep, get, isFunction, isString, last, merge, omit, set, unset} from 'lodash';
 import AmpState from 'ampersand-state';
 import uuid from 'uuid';
@@ -402,6 +407,13 @@ const WebexCore = AmpState.extend({
       interceptors: ints,
     });
 
+    this.prepareFetchOptions = prepareFetchOptions({
+      json: true,
+      interceptors: ints,
+    });
+
+    this.setTimingsAndFetch = _setTimingsAndFetch;
+
     let sessionId = `${get(this, 'config.trackingIdPrefix', 'webex-js-sdk')}_${get(
       this,
       'config.trackingIdBase',