@webex/webex-core 3.0.0-beta.13 → 3.0.0-beta.15

package/src/interceptors/webex-user-agent.js

@@ -40,11 +40,7 @@ export default class WebexUserAgentInterceptor extends Interceptor {
    */
   onRequest(options) {
     options.headers = options.headers || {};
-    const {
-      appName,
-      appVersion,
-      appPlatform
-    } = this.webex?.config ?? {};
+    const {appName, appVersion, appPlatform} = this.webex?.config ?? {};
     let sparkUserAgent = `${strings.get(this)}`;
 
     if (appName) {
@@ -61,11 +57,9 @@ export default class WebexUserAgentInterceptor extends Interceptor {
 
     if (
       options.uri &&
-      (
-        options.uri.includes(this.webex.config.credentials.samlUrl) ||
+      (options.uri.includes(this.webex.config.credentials.samlUrl) ||
         options.uri.includes(this.webex.config.credentials.tokenUrl) ||
-        options.uri.includes(this.webex.config.credentials.authorizeUrl)
-      )
+        options.uri.includes(this.webex.config.credentials.authorizeUrl))
     ) {
       return options;
     }

package/src/lib/batcher.js

@@ -3,11 +3,7 @@
  */
 
 import {has} from 'lodash';
-import {
-  cappedDebounce,
-  Defer,
-  tap
-} from '@webex/common';
+import {cappedDebounce, Defer, tap} from '@webex/common';
 
 import WebexPlugin from './webex-plugin';
 import WebexHttpError from './webex-http-error';
@@ -22,14 +18,14 @@ const Batcher = WebexPlugin.extend({
       type: 'object',
       default() {
         return new Map();
-      }
+      },
     },
     queue: {
       type: 'array',
       default() {
         return [];
-      }
-    }
+      },
+    },
   },
 
   derived: {
@@ -37,10 +33,10 @@ const Batcher = WebexPlugin.extend({
       fn() {
         return cappedDebounce((...args) => this.executeQueue(...args), this.config.batcherWait, {
           maxCalls: this.config.batcherMaxCalls,
-          maxWait: this.config.batcherMaxWait
+          maxWait: this.config.batcherMaxWait,
         });
-      }
-    }
+      },
+    },
   },
 
   /**
@@ -113,25 +109,30 @@ const Batcher = WebexPlugin.extend({
     const queue = this.queue.splice(0, this.config.batcherMaxCalls);
 
     return new Promise((resolve) => {
-      resolve(this.prepareRequest(queue)
-        .then((payload) => this.submitHttpRequest(payload)
-          .then((res) => this.handleHttpSuccess(res)))
-        .catch((reason) => {
-          if (reason instanceof WebexHttpError) {
-            return this.handleHttpError(reason);
-          }
-
-          return Promise.all(queue.map((item) => this.getDeferredForRequest(item)
-            .then((defer) => {
-              defer.reject(reason);
-            })));
-        }));
-    })
-      .catch((reason) => {
-        this.logger.error(process.env.NODE_ENV === 'production' ? reason : reason.stack);
-
-        return Promise.reject(reason);
-      });
+      resolve(
+        this.prepareRequest(queue)
+          .then((payload) =>
+            this.submitHttpRequest(payload).then((res) => this.handleHttpSuccess(res))
+          )
+          .catch((reason) => {
+            if (reason instanceof WebexHttpError) {
+              return this.handleHttpError(reason);
+            }
+
+            return Promise.all(
+              queue.map((item) =>
+                this.getDeferredForRequest(item).then((defer) => {
+                  defer.reject(reason);
+                })
+              )
+            );
+          })
+      );
+    }).catch((reason) => {
+      this.logger.error(process.env.NODE_ENV === 'production' ? reason : reason.stack);
+
+      return Promise.reject(reason);
+    });
   },
 
   /**
@@ -162,7 +163,9 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<undefined>}
    */
   handleHttpSuccess(res) {
-    return Promise.all((res.body && res.body.items || res.body).map((item) => this.acceptItem(item)));
+    return Promise.all(
+      ((res.body && res.body.items) || res.body).map((item) => this.acceptItem(item))
+    );
   },
 
   /**
@@ -176,10 +179,13 @@ const Batcher = WebexPlugin.extend({
   handleHttpError(reason) {
     if (reason instanceof WebexHttpError) {
       if (has(reason, 'options.body.map')) {
-        return Promise.all(reason.options.body.map((item) => this.getDeferredForRequest(item)
-          .then((defer) => {
-            defer.reject(reason);
-          })));
+        return Promise.all(
+          reason.options.body.map((item) =>
+            this.getDeferredForRequest(item).then((defer) => {
+              defer.reject(reason);
+            })
+          )
+        );
       }
     }
     this.logger.error('http error handler called without a WebexHttpError object', reason);
@@ -193,14 +199,13 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<undefined>}
    */
   acceptItem(item) {
-    return this.didItemFail(item)
-      .then((didFail) => {
-        if (didFail) {
-          return this.handleItemFailure(item);
-        }
+    return this.didItemFail(item).then((didFail) => {
+      if (didFail) {
+        return this.handleItemFailure(item);
+      }
 
-        return this.handleItemSuccess(item);
-      });
+      return this.handleItemSuccess(item);
+    });
   },
 
   /**
@@ -221,10 +226,9 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<undefined>}
    */
   handleItemFailure(item) {
-    return this.getDeferredForResponse(item)
-      .then((defer) => {
-        defer.reject(item);
-      });
+    return this.getDeferredForResponse(item).then((defer) => {
+      defer.reject(item);
+    });
   },
 
   /**
@@ -234,10 +238,9 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<undefined>}
    */
   handleItemSuccess(item) {
-    return this.getDeferredForResponse(item)
-      .then((defer) => {
-        defer.resolve(item);
-      });
+    return this.getDeferredForResponse(item).then((defer) => {
+      defer.resolve(item);
+    });
   },
 
   /**
@@ -246,17 +249,16 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<Defer>}
    */
   getDeferredForRequest(item) {
-    return this.fingerprintRequest(item)
-      .then((idx) => {
-        const defer = this.deferreds.get(idx);
+    return this.fingerprintRequest(item).then((idx) => {
+      const defer = this.deferreds.get(idx);
 
-        /* istanbul ignore if */
-        if (!defer) {
-          throw new Error('Could not find pending request for received response');
-        }
+      /* istanbul ignore if */
+      if (!defer) {
+        throw new Error('Could not find pending request for received response');
+      }
 
-        return defer;
-      });
+      return defer;
+    });
   },
 
   /**
@@ -265,17 +267,16 @@ const Batcher = WebexPlugin.extend({
    * @returns {Promise<Defer>}
    */
   getDeferredForResponse(item) {
-    return this.fingerprintResponse(item)
-      .then((idx) => {
-        const defer = this.deferreds.get(idx);
+    return this.fingerprintResponse(item).then((idx) => {
+      const defer = this.deferreds.get(idx);
 
-        /* istanbul ignore if */
-        if (!defer) {
-          throw new Error('Could not find pending request for received response');
-        }
+      /* istanbul ignore if */
+      if (!defer) {
+        throw new Error('Could not find pending request for received response');
+      }
 
-        return defer;
-      });
+      return defer;
+    });
   },
 
   /**
@@ -300,7 +301,7 @@ const Batcher = WebexPlugin.extend({
   // eslint-disable-next-line no-unused-vars
   fingerprintResponse(item) {
     throw new Error('fingerprintResponse() must be implemented');
-  }
+  },
 });
 
 export default Batcher;

package/src/lib/credentials/credentials.js

@@ -6,13 +6,7 @@ import querystring from 'querystring';
 import url from 'url';
 
 import jwt from 'jsonwebtoken';
-import {
-  base64,
-  makeStateDataType,
-  oneFlight,
-  tap,
-  whileInFlight
-} from '@webex/common';
+import {base64, makeStateDataType, oneFlight, tap, whileInFlight} from '@webex/common';
 import {safeSetTimeout} from '@webex/common-timers';
 import {clone, cloneDeep, isObject, isEmpty} from 'lodash';
 
@@ -29,29 +23,22 @@ import TokenCollection from './token-collection';
  */
 const Credentials = WebexPlugin.extend({
   collections: {
-    userTokens: TokenCollection
+    userTokens: TokenCollection,
   },
 
   dataTypes: {
-    token: makeStateDataType(Token, 'token').dataType
+    token: makeStateDataType(Token, 'token').dataType,
   },
 
   derived: {
     canAuthorize: {
-      deps: [
-        'supertoken',
-        'supertoken.canAuthorize',
-        'canRefresh'
-      ],
+      deps: ['supertoken', 'supertoken.canAuthorize', 'canRefresh'],
       fn() {
-        return Boolean(this.supertoken && this.supertoken.canAuthorize || this.canRefresh);
-      }
+        return Boolean((this.supertoken && this.supertoken.canAuthorize) || this.canRefresh);
+      },
     },
     canRefresh: {
-      deps: [
-        'supertoken',
-        'supertoken.canRefresh'
-      ],
+      deps: ['supertoken', 'supertoken.canRefresh'],
       fn() {
         // If we're operating in JWT mode, we have to delegate to the consumer
         if (this.config.jwtRefreshCallback) {
@@ -59,12 +46,12 @@ const Credentials = WebexPlugin.extend({
         }
 
         return Boolean(this.supertoken && this.supertoken.canRefresh);
-      }
-    }
+      },
+    },
   },
 
   props: {
-    supertoken: makeStateDataType(Token, 'token').prop
+    supertoken: makeStateDataType(Token, 'token').prop,
   },
 
   namespace: 'Credentials',
@@ -72,7 +59,7 @@ const Credentials = WebexPlugin.extend({
   session: {
     isRefreshing: {
       default: false,
-      type: 'boolean'
+      type: 'boolean',
     },
     /**
      * Becomes `true` once the {@link loaded} event fires.
@@ -83,12 +70,12 @@ const Credentials = WebexPlugin.extend({
      */
     ready: {
       default: false,
-      type: 'boolean'
+      type: 'boolean',
     },
     refreshTimer: {
       default: undefined,
-      type: 'any'
-    }
+      type: 'any',
+    },
   },
 
   /**
@@ -120,8 +107,7 @@ const Credentials = WebexPlugin.extend({
     if (options.state) {
       if (!isEmpty(options.state)) {
         options.state = base64.toBase64Url(JSON.stringify(options.state));
-      }
-      else {
+      } else {
         delete options.state;
       }
     }
@@ -137,27 +123,21 @@ const Credentials = WebexPlugin.extend({
    * @returns {string} - The OrgId.
    */
   getOrgId() {
-    this.logger.info(
-      'credentials: attempting to retrieve the OrgId from token'
-    );
+    this.logger.info('credentials: attempting to retrieve the OrgId from token');
 
     try {
       // Attempt to extract a client-authenticated token's OrgId.
       this.logger.info('credentials: trying to extract OrgId from JWT');
 
       return this.extractOrgIdFromJWT(this.supertoken.access_token);
-    }
-    catch (e) {
+    } catch (e) {
       // Attempt to extract a user token's OrgId.
       this.logger.info('credentials: could not extract OrgId from JWT');
-      this.logger.info(
-        'credentials: attempting to extract OrgId from user token'
-      );
+      this.logger.info('credentials: attempting to extract OrgId from user token');
 
       try {
         return this.extractOrgIdFromUserToken(this.supertoken?.access_token);
-      }
-      catch (f) {
+      } catch (f) {
         this.logger.info('credentials: could not extract OrgId from user token');
         throw f;
       }
@@ -218,10 +198,11 @@ const Credentials = WebexPlugin.extend({
    * @returns {[type]}
    */
   buildLogoutUrl(options = {}) {
-    return `${this.config.logoutUrl}?${querystring.stringify(Object.assign({
+    return `${this.config.logoutUrl}?${querystring.stringify({
       cisService: this.config.service,
-      goto: this.config.redirect_uri
-    }, options))}`;
+      goto: this.config.redirect_uri,
+      ...options,
+    })}`;
   },
 
   /**
@@ -233,7 +214,7 @@ const Credentials = WebexPlugin.extend({
    * @returns {number}
    */
   calcRefreshTimeout(expiration) {
-    return Math.floor((Math.floor(Math.random() * 4) + 6) / 10 * expiration);
+    return Math.floor(((Math.floor(Math.random() * 4) + 6) / 10) * expiration);
   },
 
   constructor(...args) {
@@ -258,13 +239,14 @@ const Credentials = WebexPlugin.extend({
    * @returns {Promise<Token>}
    */
   downscope(scope) {
-    return this.supertoken.downscope(scope)
-      .catch((reason) => {
-        this.logger.trace(`credentials: failed to downscope supertoken to ${scope}`, reason);
-        this.logger.trace(`credentials: falling back to supertoken for ${scope}`);
+    return this.supertoken.downscope(scope).catch((reason) => {
+      this.logger.trace(`credentials: failed to downscope supertoken to ${scope}`, reason);
+      this.logger.trace(`credentials: falling back to supertoken for ${scope}`);
 
-        return Promise.resolve(new Token(Object.assign({scope}, this.supertoken.serialize())), {parent: this});
+      return Promise.resolve(new Token({scope, ...this.supertoken.serialize()}), {
+        parent: this,
       });
+    });
   },
 
   /**
@@ -279,23 +261,24 @@ const Credentials = WebexPlugin.extend({
   getClientToken(options = {}) {
     this.logger.info('credentials: requesting client credentials grant');
 
-    return this.webex.request({
-      /* eslint-disable camelcase */
-      method: 'POST',
-      uri: options.uri || this.config.tokenUrl,
-      form: {
-        grant_type: 'client_credentials',
-        scope: options.scope || 'webexsquare:admin',
-        self_contained_token: true
-      },
-      auth: {
-        user: this.config.client_id,
-        pass: this.config.client_secret,
-        sendImmediately: true
-      },
-      shouldRefreshAccessToken: false
-      /* eslint-enable camelcase */
-    })
+    return this.webex
+      .request({
+        /* eslint-disable camelcase */
+        method: 'POST',
+        uri: options.uri || this.config.tokenUrl,
+        form: {
+          grant_type: 'client_credentials',
+          scope: options.scope || 'webexsquare:admin',
+          self_contained_token: true,
+        },
+        auth: {
+          user: this.config.client_id,
+          pass: this.config.client_secret,
+          sendImmediately: true,
+        },
+        shouldRefreshAccessToken: false,
+        /* eslint-enable camelcase */
+      })
       .then((res) => new Token(res.body, {parent: this}))
       .catch((res) => {
         if (res.statusCode !== 400) {
@@ -320,41 +303,44 @@ const Credentials = WebexPlugin.extend({
    * @returns {Promise<Token>}
    */
   getUserToken(scope) {
-    return Promise.resolve(!this.isRefreshing || new Promise((resolve) => {
-      this.logger.info('credentials: token refresh inflight; delaying getUserToken until refresh completes');
-      this.once('change:isRefreshing', () => {
-        this.logger.info('credentials: token refresh complete; reinvoking getUserToken');
-        resolve();
-      });
-    }))
-      .then(() => {
-        if (!this.canAuthorize) {
-          this.logger.info('credentials: cannot produce an access token from current state');
-
-          return Promise.reject(new Error('Current state cannot produce an access token'));
-        }
+    return Promise.resolve(
+      !this.isRefreshing ||
+        new Promise((resolve) => {
+          this.logger.info(
+            'credentials: token refresh inflight; delaying getUserToken until refresh completes'
+          );
+          this.once('change:isRefreshing', () => {
+            this.logger.info('credentials: token refresh complete; reinvoking getUserToken');
+            resolve();
+          });
+        })
+    ).then(() => {
+      if (!this.canAuthorize) {
+        this.logger.info('credentials: cannot produce an access token from current state');
+
+        return Promise.reject(new Error('Current state cannot produce an access token'));
+      }
 
-        if (!scope) {
-          scope = filterScope('spark:kms', this.config.scope);
-        }
+      if (!scope) {
+        scope = filterScope('spark:kms', this.config.scope);
+      }
 
-        scope = sortScope(scope);
+      scope = sortScope(scope);
 
-        if (scope === sortScope(this.config.scope)) {
-          return Promise.resolve(this.supertoken);
-        }
+      if (scope === sortScope(this.config.scope)) {
+        return Promise.resolve(this.supertoken);
+      }
 
-        const token = this.userTokens.get(scope);
+      const token = this.userTokens.get(scope);
 
-        // we should also check for the token.access_token since token object does
-        // not get cleared on unsetting while logging out.
-        if (!token || !token.access_token) {
-          return this.downscope(scope)
-            .then(tap((t) => this.userTokens.add(t)));
-        }
+      // we should also check for the token.access_token since token object does
+      // not get cleared on unsetting while logging out.
+      if (!token || !token.access_token) {
+        return this.downscope(scope).then(tap((t) => this.userTokens.add(t)));
+      }
 
-        return Promise.resolve(token);
-      });
+      return Promise.resolve(token);
+    });
   },
 
   @persist('@')
@@ -380,8 +366,7 @@ const Credentials = WebexPlugin.extend({
       if (attrs.authorization) {
         if (attrs.authorization.supertoken) {
           this.supertoken = attrs.authorization.supertoken;
-        }
-        else {
+        } else {
           this.supertoken = attrs.authorization;
         }
       }
@@ -434,16 +419,14 @@ const Credentials = WebexPlugin.extend({
 
     try {
       this.unset('supertoken');
-    }
-    catch (err) {
+    } catch (err) {
       this.logger.warn('credentials: failed to clear supertoken', err);
     }
 
     while (this.userTokens.models.length) {
       try {
         this.userTokens.remove(this.userTokens.models[0]);
-      }
-      catch (err) {
+      } catch (err) {
         this.logger.warn('credentials: failed to remove user token', err);
       }
     }
@@ -480,15 +463,20 @@ const Credentials = WebexPlugin.extend({
     // while I like #2 from a code simplicity standpoint, the third-party DX
     // isn't great
     if (this.config.jwtRefreshCallback) {
-      return this.config.jwtRefreshCallback(this.webex)
-        .then((jwt) => this.webex.authorization.requestAccessTokenFromJwt({jwt}));
+      return (
+        this.config
+          .jwtRefreshCallback(this.webex)
+          // eslint-disable-next-line no-shadow
+          .then((jwt) => this.webex.authorization.requestAccessTokenFromJwt({jwt}))
+      );
     }
 
     if (this.webex.internal.services) {
       this.webex.internal.services.updateCredentialsConfig();
     }
 
-    return supertoken.refresh()
+    return supertoken
+      .refresh()
       .then((st) => {
         // clear refresh timer
         if (this.refreshTimer) {
@@ -497,20 +485,25 @@ const Credentials = WebexPlugin.extend({
         }
         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);
+        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.userTokens.remove(token.scope);
-                this.userTokens.add(t);
-              });
-          })));
+          )
+        );
       })
       .then(() => {
         this.scheduleRefresh(this.supertoken.expires);
@@ -524,8 +517,7 @@ const Credentials = WebexPlugin.extend({
           while (this.userTokens.models.length) {
             try {
               this.userTokens.remove(this.userTokens.models[0]);
-            }
-            catch (err) {
+            } catch (err) {
               this.logger.warn('credentials: failed to remove user token', err);
             }
           }
@@ -551,12 +543,10 @@ const Credentials = WebexPlugin.extend({
       const timeoutLength = this.calcRefreshTimeout(expiresIn);
 
       this.refreshTimer = safeSetTimeout(() => this.refresh(), timeoutLength);
-    }
-    else {
+    } else {
       this.refresh();
     }
-  }
-
+  },
 });
 
 export default Credentials;