@webex/internal-plugin-mercury 3.0.0-beta.9 → 3.0.0-bnr.0

package/src/mercury.js

@@ -15,16 +15,11 @@ import {
   Forbidden,
   NotAuthorized,
   UnknownResponse,
-  ConnectionError
+  ConnectionError,
   // NotFound
 } from './errors';
 
-const normalReconnectReasons = [
-  'idle',
-  'done (forced)',
-  'pong not received',
-  'pong mismatch'
-];
+const normalReconnectReasons = ['idle', 'done (forced)', 'pong not received', 'pong mismatch'];
 
 const Mercury = WebexPlugin.extend({
   namespace: 'Mercury',
@@ -32,14 +27,14 @@ const Mercury = WebexPlugin.extend({
   session: {
     connected: {
       default: false,
-      type: 'boolean'
+      type: 'boolean',
     },
     connecting: {
       default: false,
-      type: 'boolean'
+      type: 'boolean',
     },
     socket: 'object',
-    localClusterServiceUrls: 'object'
+    localClusterServiceUrls: 'object',
   },
 
   derived: {
@@ -47,8 +42,8 @@ const Mercury = WebexPlugin.extend({
       deps: ['connected'],
       fn() {
         return this.connected;
-      }
-    }
+      },
+    },
   },
 
   @oneFlight
@@ -61,12 +56,13 @@ const Mercury = WebexPlugin.extend({
 
     this.connecting = true;
 
-    return Promise.resolve(this.webex.internal.device.registered || this.webex.internal.device.register())
-      .then(() => {
-        this.logger.info('mercury: connecting');
+    return Promise.resolve(
+      this.webex.internal.device.registered || this.webex.internal.device.register()
+    ).then(() => {
+      this.logger.info('mercury: connecting');
 
-        return this._connectWithBackoff(webSocketUrl);
-      });
+      return this._connectWithBackoff(webSocketUrl);
+    });
   },
 
   @oneFlight
@@ -121,7 +117,8 @@ const Mercury = WebexPlugin.extend({
       webSocketUrl = this.webex.internal.device.webSocketUrl;
     }
 
-    return this.webex.internal.feature.getFeature('developer', 'web-high-availability')
+    return this.webex.internal.feature
+      .getFeature('developer', 'web-high-availability')
       .then((haMessagingEnabled) => {
         if (haMessagingEnabled) {
           return this.webex.internal.services.convertUrlToPriorityHostUrl(webSocketUrl);
@@ -138,13 +135,13 @@ const Mercury = WebexPlugin.extend({
         Object.assign(webSocketUrl.query, {
           outboundWireFormat: 'text',
           bufferStates: true,
-          aliasHttpStatus: true
+          aliasHttpStatus: true,
         });
 
         if (webSharedMercury) {
           Object.assign(webSocketUrl.query, {
             mercuryRegistrationStatus: true,
-            isRegistrationRefreshEnabled: true
+            isRegistrationRefreshEnabled: true,
           });
           Reflect.deleteProperty(webSocketUrl.query, 'bufferStates');
         }
@@ -183,7 +180,7 @@ const Mercury = WebexPlugin.extend({
           pongTimeout: this.config.pongTimeout,
           token: token.toString(),
           trackingId: `${this.webex.sessionId}_${Date.now()}`,
-          logger: this.logger
+          logger: this.logger,
         };
 
         // if the consumer has supplied request options use them
@@ -201,16 +198,17 @@ const Mercury = WebexPlugin.extend({
       .then(() => {
         this.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
           fields: {
-            success: true
+            success: true,
           },
           tags: {
             action: 'connected',
-            url: attemptWSUrl
-          }
+            url: attemptWSUrl,
+          },
         });
         callback();
 
-        return this.webex.internal.feature.getFeature('developer', 'web-high-availability')
+        return this.webex.internal.feature
+          .getFeature('developer', 'web-high-availability')
           .then((haMessagingEnabled) => {
             if (haMessagingEnabled) {
               return this.webex.internal.device.refresh();
@@ -231,17 +229,17 @@ const Mercury = WebexPlugin.extend({
         // UnknownResponse is produced by IE for any 4XXX; treated it like a bad
         // web socket url and let WDM handle the token checking
         if (reason instanceof UnknownResponse) {
-          this.logger.info('mercury: received unknown response code, refreshing device registration');
+          this.logger.info(
+            'mercury: received unknown response code, refreshing device registration'
+          );
 
-          return this.webex.internal.device.refresh()
-            .then(() => callback(reason));
+          return this.webex.internal.device.refresh().then(() => callback(reason));
         }
         // NotAuthorized implies expired token
         if (reason instanceof NotAuthorized) {
           this.logger.info('mercury: received authorization error, reauthorizing');
 
-          return this.webex.credentials.refresh({force: true})
-            .then(() => callback(reason));
+          return this.webex.credentials.refresh({force: true}).then(() => callback(reason));
         }
         // // NotFound implies expired web socket url
         // else if (reason instanceof NotFound) {
@@ -258,19 +256,22 @@ const Mercury = WebexPlugin.extend({
           return callback(reason);
         }
         if (reason instanceof ConnectionError) {
-          return this.webex.internal.feature.getFeature('developer', 'web-high-availability')
+          return this.webex.internal.feature
+            .getFeature('developer', 'web-high-availability')
             .then((haMessagingEnabled) => {
               if (haMessagingEnabled) {
-                this.logger.info('mercury: received a generic connection error, will try to connect to another datacenter');
+                this.logger.info(
+                  'mercury: received a generic connection error, will try to connect to another datacenter'
+                );
                 this.webex.internal.metrics.submitClientMetrics('web-ha-mercury', {
                   fields: {
-                    success: false
+                    success: false,
                   },
                   tags: {
                     action: 'failed',
                     error: reason.message,
-                    url: attemptWSUrl
-                  }
+                    url: attemptWSUrl,
+                  },
                 });
 
                 return this.webex.internal.services.markFailedUrl(attemptWSUrl);
@@ -299,7 +300,9 @@ const Mercury = WebexPlugin.extend({
 
         this.backoffCall = undefined;
         if (err) {
-          this.logger.info(`mercury: failed to connect after ${call.getNumRetries()} retries; log statement about next retry was inaccurate; ${err}`);
+          this.logger.info(
+            `mercury: failed to connect after ${call.getNumRetries()} retries; log statement about next retry was inaccurate; ${err}`
+          );
 
           return reject(err);
         }
@@ -315,10 +318,12 @@ const Mercury = WebexPlugin.extend({
         this._attemptConnection(webSocketUrl, callback);
       }, onComplete);
 
-      call.setStrategy(new backoff.ExponentialStrategy({
-        initialDelay: this.config.backoffTimeReset,
-        maxDelay: this.config.backoffTimeMax
-      }));
+      call.setStrategy(
+        new backoff.ExponentialStrategy({
+          initialDelay: this.config.backoffTimeReset,
+          maxDelay: this.config.backoffTimeMax,
+        })
+      );
 
       if (this.config.maxRetries) {
         call.failAfter(this.config.maxRetries);
@@ -334,7 +339,9 @@ const Mercury = WebexPlugin.extend({
           const number = call.getNumRetries();
           const delay = Math.min(call.strategy_.nextBackoffDelay_, this.config.backoffTimeMax);
 
-          this.logger.info(`mercury: failed to connect; attempting retry ${number + 1} in ${delay} ms`);
+          this.logger.info(
+            `mercury: failed to connect; attempting retry ${number + 1} in ${delay} ms`
+          );
           /* istanbul ignore if */
           if (process.env.NODE_ENV === 'development') {
             this.logger.debug('mercury: ', err, err.stack);
@@ -354,8 +361,7 @@ const Mercury = WebexPlugin.extend({
   _emit(...args) {
     try {
       this.trigger(...args);
-    }
-    catch (error) {
+    } catch (error) {
       this.logger.error('mercury: error occurred in event handler', error);
     }
   },
@@ -373,7 +379,7 @@ const Mercury = WebexPlugin.extend({
     if ((this.webex[namespace] || this.webex.internal[namespace])[handlerName]) {
       handlers.push({
         name: handlerName,
-        namespace
+        namespace,
       });
     }
 
@@ -395,8 +401,10 @@ const Mercury = WebexPlugin.extend({
 
       switch (event.code) {
         case 1003:
-        // metric: disconnect
-          this.logger.info(`mercury: Mercury service rejected last message; will not reconnect: ${event.reason}`);
+          // metric: disconnect
+          this.logger.info(
+            `mercury: Mercury service rejected last message; will not reconnect: ${event.reason}`
+          );
           this._emit('offline.permanent', event);
           break;
         case 4000:
@@ -421,8 +429,7 @@ const Mercury = WebexPlugin.extend({
             this._reconnect(socketUrl);
             // metric: disconnect
             // if (reason === done forced) metric: force closure
-          }
-          else {
+          } else {
             this.logger.info('mercury: socket disconnected; will not reconnect');
             this._emit('offline.permanent', event);
           }
@@ -432,8 +439,7 @@ const Mercury = WebexPlugin.extend({
           // unexpected disconnect
           this._emit('offline.permanent', event);
       }
-    }
-    catch (error) {
+    } catch (error) {
       this.logger.error('mercury: error occurred in close handler', error);
     }
   },
@@ -450,20 +456,29 @@ const Mercury = WebexPlugin.extend({
     this._applyOverrides(data);
 
     return this._getEventHandlers(data.eventType)
-      .reduce((promise, handler) => promise.then(() => {
-        const {namespace, name} = handler;
-
-        return new Promise((resolve) => resolve((this.webex[namespace] || this.webex.internal[namespace])[name](data)))
-          .catch((reason) => this.logger.error(`mercury: error occurred in autowired event handler for ${data.eventType}`, reason));
-      }), Promise.resolve())
+      .reduce(
+        (promise, handler) =>
+          promise.then(() => {
+            const {namespace, name} = handler;
+
+            return new Promise((resolve) =>
+              resolve((this.webex[namespace] || this.webex.internal[namespace])[name](data))
+            ).catch((reason) =>
+              this.logger.error(
+                `mercury: error occurred in autowired event handler for ${data.eventType}`,
+                reason
+              )
+            );
+          }),
+        Promise.resolve()
+      )
       .then(() => {
         this._emit('event', event.data);
         const [namespace] = data.eventType.split('.');
 
         if (namespace === data.eventType) {
           this._emit(`event:${namespace}`, envelope);
-        }
-        else {
+        } else {
           this._emit(`event:${namespace}`, envelope);
           this._emit(`event:${data.eventType}`, envelope);
         }
@@ -477,7 +492,7 @@ const Mercury = WebexPlugin.extend({
     this.logger.info('mercury: reconnecting');
 
     return this.connect(webSocketUrl);
-  }
+  },
 });
 
 export default Mercury;

package/src/socket/socket-base.js

@@ -14,7 +14,7 @@ import {
   ConnectionError,
   Forbidden,
   NotAuthorized,
-  UnknownResponse
+  UnknownResponse,
   // NotFound
 } from '../errors';
 
@@ -88,7 +88,9 @@ export default class Socket extends EventEmitter {
    * @returns {WebSocket}
    */
   static getWebSocketConstructor() {
-    throw new Error('Socket.getWebSocketConstructor() must be implemented in an environmentally appropriate way');
+    throw new Error(
+      'Socket.getWebSocketConstructor() must be implemented in an environmentally appropriate way'
+    );
   }
 
   /**
@@ -127,18 +129,19 @@ export default class Socket extends EventEmitter {
 
       options = defaults(options, {
         code: 1000,
-        reason: 'Done'
+        reason: 'Done',
       });
 
       const closeTimer = safeSetTimeout(() => {
         try {
           this.logger.info('socket: no close event received, forcing closure');
-          resolve(this.onclose({
-            code: 1000,
-            reason: 'Done (forced)'
-          }));
-        }
-        catch (error) {
+          resolve(
+            this.onclose({
+              code: 1000,
+              reason: 'Done (forced)',
+            })
+          );
+        } catch (error) {
           this.logger.warn('socket: force-close failed', error);
         }
       }, this.forceCloseDelay);
@@ -184,19 +187,15 @@ export default class Socket extends EventEmitter {
 
       options = options || {};
 
-      checkRequired([
-        'forceCloseDelay',
-        'pingInterval',
-        'pongTimeout',
-        'token',
-        'trackingId',
-        'logger'
-      ], options);
+      checkRequired(
+        ['forceCloseDelay', 'pingInterval', 'pongTimeout', 'token', 'trackingId', 'logger'],
+        options
+      );
 
       Object.keys(options).forEach((key) => {
         Reflect.defineProperty(this, key, {
           enumerable: false,
-          value: options[key]
+          value: options[key],
         });
       });
 
@@ -213,10 +212,10 @@ export default class Socket extends EventEmitter {
         this.logger.info('socket: closed before open', event.code, event.reason);
         switch (event.code) {
           case 1005:
-          // IE 11 doesn't seem to allow 4XXX codes, so if we get a 1005, assume
-          // it's a bad websocket url. That'll trigger a device refresh; if it
-          // turns out we had a bad token, the device refresh should 401 and
-          // trigger a token refresh.
+            // IE 11 doesn't seem to allow 4XXX codes, so if we get a 1005, assume
+            // it's a bad websocket url. That'll trigger a device refresh; if it
+            // turns out we had a bad token, the device refresh should 401 and
+            // trigger a token refresh.
             return reject(new UnknownResponse(event));
           case 4400:
             return reject(new BadRequest(event));
@@ -224,8 +223,8 @@ export default class Socket extends EventEmitter {
             return reject(new NotAuthorized(event));
           case 4403:
             return reject(new Forbidden(event));
-            // case 4404:
-            //   return reject(new NotFound(event));
+          // case 4404:
+          //   return reject(new NotFound(event));
           default:
             return reject(new ConnectionError(event));
         }
@@ -281,7 +280,9 @@ export default class Socket extends EventEmitter {
 
       this.logger.debug('socket: sequence number: ', sequenceNumber);
       if (this.expectedSequenceNumber && sequenceNumber !== this.expectedSequenceNumber) {
-        this.logger.debug(`socket: sequence number mismatch indicates lost mercury message. expected: ${this.expectedSequenceNumber}, actual: ${sequenceNumber}`);
+        this.logger.debug(
+          `socket: sequence number mismatch indicates lost mercury message. expected: ${this.expectedSequenceNumber}, actual: ${sequenceNumber}`
+        );
         this.emit('sequence-mismatch', sequenceNumber, this.expectedSequenceNumber);
       }
       this.expectedSequenceNumber = sequenceNumber + 1;
@@ -294,12 +295,10 @@ export default class Socket extends EventEmitter {
       this._acknowledge(processedEvent);
       if (data.type === 'pong') {
         this.emit('pong', processedEvent);
-      }
-      else {
+      } else {
         this.emit('message', processedEvent);
       }
-    }
-    catch (error) {
+    } catch (error) {
       // The above code should only be able to throw if we receive an unparsable
       // message from Mercury. At this time, the only action we have is to
       // ignore it and move on.
@@ -347,7 +346,7 @@ export default class Socket extends EventEmitter {
 
     return this.send({
       messageId: event.data.id,
-      type: 'ack'
+      type: 'ack',
     });
   }
 
@@ -363,14 +362,18 @@ export default class Socket extends EventEmitter {
         id: uuid.v4(),
         type: 'authorization',
         data: {
-          token: this.token
+          token: this.token,
         },
         trackingId: this.trackingId,
-        logLevelToken: this.logLevelToken
+        logLevelToken: this.logLevelToken,
       });
 
       const waitForBufferState = (event) => {
-        if (!event.data.type && (event.data.data.eventType === 'mercury.buffer_state' || event.data.data.eventType === 'mercury.registration_status')) {
+        if (
+          !event.data.type &&
+          (event.data.data.eventType === 'mercury.buffer_state' ||
+            event.data.data.eventType === 'mercury.registration_status')
+        ) {
           this.removeListener('message', waitForBufferState);
           this._ping();
           resolve();
@@ -423,11 +426,10 @@ export default class Socket extends EventEmitter {
           this.logger.debug('socket: expected', id, 'received', event.data.id);
           this.close({
             code: 1000,
-            reason: 'Pong mismatch'
+            reason: 'Pong mismatch',
           });
         }
-      }
-      catch (error) {
+      } catch (error) {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
@@ -440,13 +442,11 @@ export default class Socket extends EventEmitter {
         this.logger.info('socket: pong not receive in expected period, closing socket');
         this.close({
           code: 1000,
-          reason: 'Pong not received'
-        })
-          .catch((reason) => {
-            this.logger.warn('socket: failed to close socket after missed pong', reason);
-          });
-      }
-      catch (error) {
+          reason: 'Pong not received',
+        }).catch((reason) => {
+          this.logger.warn('socket: failed to close socket after missed pong', reason);
+        });
+      } catch (error) {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
@@ -458,8 +458,7 @@ export default class Socket extends EventEmitter {
       try {
         clearTimeout(this.pongTimer);
         this.pingTimer = safeSetTimeout(() => this._ping(), this.pingInterval);
-      }
-      catch (error) {
+      } catch (error) {
         // This try/catch block was added as a debugging step; to the best of my
         // knowledge, the above can never throw.
         /* istanbul ignore next */
@@ -476,7 +475,7 @@ export default class Socket extends EventEmitter {
 
     return this.send({
       id,
-      type: 'ping'
+      type: 'ping',
     });
   }
 }

package/src/socket/socket.shim.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-restricted-globals */
+
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
@@ -12,18 +14,14 @@ Socket.getWebSocketConstructor = function getWebSocketConstructor() {
 
   if (typeof WebSocket !== 'undefined') {
     ws = WebSocket;
-  }
-  else if (typeof MozWebSocket !== 'undefined') {
+  } else if (typeof MozWebSocket !== 'undefined') {
     // eslint-disable-next-line no-undef
     ws = MozWebSocket;
-  }
-  else if (typeof global !== 'undefined') {
+  } else if (typeof global !== 'undefined') {
     ws = global.WebSocket || global.MozWebSocket;
-  }
-  else if (typeof window !== 'undefined') {
+  } else if (typeof window !== 'undefined') {
     ws = window.WebSocket || window.MozWebSocket;
-  }
-  else if (typeof self !== 'undefined') {
+  } else if (typeof self !== 'undefined') {
     ws = self.WebSocket || self.MozWebSocket;
   }
 

package/test/integration/spec/mercury.js

@@ -16,34 +16,37 @@ describe('plugin-mercury', function () {
   describe('Mercury', () => {
     let webex;
 
-    beforeEach(() => testUsers.create({count: 1})
-      .then((users) => {
+    beforeEach(() =>
+      testUsers.create({count: 1}).then((users) => {
         webex = new WebexCore({
           credentials: {
-            supertoken: users[0].token
+            supertoken: users[0].token,
           },
           config: {
             credentials: {
-              refreshCallback
-            }
-          }
+              refreshCallback,
+            },
+          },
         });
-      }));
+      })
+    );
 
     afterEach(() => webex && webex.internal.mercury.disconnect());
 
     describe('#connect()', () => {
       it('connects to mercury', () => webex.internal.mercury.connect());
 
-      it('refreshes the access token when a 4401 is received', () => webex.internal.device.register()
-        .then(() => {
-          // eslint-disable-next-line camelcase
-          webex.credentials.supertoken.access_token = 'fake token';
+      it('refreshes the access token when a 4401 is received', () =>
+        webex.internal.device
+          .register()
+          .then(() => {
+            // eslint-disable-next-line camelcase
+            webex.credentials.supertoken.access_token = 'fake token';
 
-          return webex.internal.mercury.connect();
-        })
-        // eslint-disable-next-line camelcase
-        .then(() => assert.notEqual(webex.credentials.supertoken.access_token, 'fake token')));
+            return webex.internal.mercury.connect();
+          })
+          // eslint-disable-next-line camelcase
+          .then(() => assert.notEqual(webex.credentials.supertoken.access_token, 'fake token')));
 
       // This doesn't work as designed yet. The only way to get a 4404 is to try
       // to connect to someone else's valid registration; the intent was to get
@@ -70,26 +73,34 @@ describe('plugin-mercury', function () {
       });
 
       describe('when web-high-availability is enabled', () => {
-        flaky(it, process.env.SKIP_FLAKY_TESTS)('connects to mercury using service catalog url', () => {
-          let defaultWebSocketUrl;
-
-          // we need to ensure the feature is set for user before "registering"
-          // the device
-          return webex.internal.device.register()
-            .then(() => webex.internal.feature.setFeature('developer', 'web-high-availability', true))
-            .then(() => webex.internal.device.unregister())
-            // start the test flow the device list
-            .then(() => webex.internal.device.register())
-            .then(() => {
-              defaultWebSocketUrl = webex.internal.device.webSocketUrl;
-            })
-            .then(() => webex.internal.mercury.connect())
-            .then(() => webex.internal.device.getWebSocketUrl())
-            .then((wsUrl) => {
-              assert.notEqual(defaultWebSocketUrl, webex.internal.mercury.socket.url);
-              assert.include(webex.internal.mercury.socket.url, wsUrl);
-            });
-        });
+        flaky(it, process.env.SKIP_FLAKY_TESTS)(
+          'connects to mercury using service catalog url',
+          () => {
+            let defaultWebSocketUrl;
+
+            // we need to ensure the feature is set for user before "registering"
+            // the device
+            return (
+              webex.internal.device
+                .register()
+                .then(() =>
+                  webex.internal.feature.setFeature('developer', 'web-high-availability', true)
+                )
+                .then(() => webex.internal.device.unregister())
+                // start the test flow the device list
+                .then(() => webex.internal.device.register())
+                .then(() => {
+                  defaultWebSocketUrl = webex.internal.device.webSocketUrl;
+                })
+                .then(() => webex.internal.mercury.connect())
+                .then(() => webex.internal.device.getWebSocketUrl())
+                .then((wsUrl) => {
+                  assert.notEqual(defaultWebSocketUrl, webex.internal.mercury.socket.url);
+                  assert.include(webex.internal.mercury.socket.url, wsUrl);
+                })
+            );
+          }
+        );
       });
     });
 
@@ -98,10 +109,9 @@ describe('plugin-mercury', function () {
 
       webex.internal.mercury.on('event:mercury.buffer_state', spy);
 
-      return webex.internal.mercury.connect()
-        .then(() => {
-          assert.calledOnce(spy);
-        });
+      return webex.internal.mercury.connect().then(() => {
+        assert.calledOnce(spy);
+      });
     });
   });
 });