@webex/internal-plugin-device 3.0.0-beta.4 → 3.0.0-beta.400

package/src/config.js

@@ -2,7 +2,6 @@ import {inBrowser, deviceType} from '@webex/common';
 
 export default {
   device: {
-
     /**
      * The duration to wait for the catalog to populate in seconds.
      *
@@ -16,22 +15,22 @@ export default {
      * @type {Object}
      */
     defaults: {
-
       /**
        * The default body configuration of registration requests.
        *
        * @type {Object}
        */
       body: {
-        name: (typeof process.title === 'string' ?
-          process.title.trim() : undefined) ||
-          inBrowser && 'browser' || 'javascript',
+        name:
+          (typeof process.title === 'string' ? process.title.trim() : undefined) ||
+          (inBrowser && 'browser') ||
+          'javascript',
         deviceType: deviceType.WEB,
         model: 'web-js-sdk',
         localizedModel: 'webex-js-sdk',
         systemName: 'WEBEX_JS_SDK',
-        systemVersion: '1.0.0'
-      }
+        systemVersion: '1.0.0',
+      },
     },
 
     /**
@@ -56,6 +55,15 @@ export default {
      *
      * @type {boolean}
      */
-    ephemeralDeviceTTL: 30 * 60
-  }
+    ephemeralDeviceTTL: 30 * 60,
+  },
+
+  /**
+   * installationId is used exclusively as web client for fraud prevention,
+   * and is aliased to as machineId by CA.
+   *
+   * @alias device.machineId
+   * @type {string}
+   */
+  installationId: undefined,
 };

package/src/constants.js

@@ -8,18 +8,16 @@ export const CISCO_DEVICE_URL = 'cisco-device-url';
 export const FEATURE_COLLECTION_NAMES = [
   FEATURE_COLLECTION_DEVELOPER,
   FEATURE_COLLECTION_ENTITLEMENT,
-  FEATURE_COLLECTION_USER
+  FEATURE_COLLECTION_USER,
 ];
 
 export const FEATURE_TYPES = {
   BOOLEAN: 'boolean',
   NUMBER: 'number',
-  STRING: 'string'
+  STRING: 'string',
 };
 
 // Device constants.
 export const DEVICE_EVENT_REGISTRATION_SUCCESS = 'registration:success';
 
-export const DEVICE_EVENTS = [
-  DEVICE_EVENT_REGISTRATION_SUCCESS
-];
+export const DEVICE_EVENTS = [DEVICE_EVENT_REGISTRATION_SUCCESS];

package/src/device.js

@@ -4,11 +4,9 @@ import {persist, waitForValue, WebexPlugin} from '@webex/webex-core';
 import {safeSetTimeout} from '@webex/common-timers';
 
 import METRICS from './metrics';
-import {
-  FEATURE_COLLECTION_NAMES,
-  DEVICE_EVENT_REGISTRATION_SUCCESS
-} from './constants';
+import {FEATURE_COLLECTION_NAMES, DEVICE_EVENT_REGISTRATION_SUCCESS} from './constants';
 import FeaturesModel from './features/features-model';
+import IpNetworkDetector from './ipNetworkDetector';
 
 /**
  * Determine if the plugin should be initialized based on cached storage.
@@ -20,7 +18,6 @@ function decider() {
 }
 
 const Device = WebexPlugin.extend({
-
   // Ampersand property members.
 
   namespace: 'Device',
@@ -37,7 +34,13 @@ const Device = WebexPlugin.extend({
      *
      * @type {FeaturesModel}
      */
-    features: FeaturesModel
+    features: FeaturesModel,
+    /**
+     * Helper class for detecting what IP network version (ipv4, ipv6) we're on.
+     *
+     * @type {IpNetworkDetector}
+     */
+    ipNetworkDetector: IpNetworkDetector,
   },
 
   /**
@@ -121,7 +124,7 @@ const Device = WebexPlugin.extend({
      *
      * @returns {Array<string>}
      */
-    ecmSupportedStorageProviders: ['array', false, (() => [])],
+    ecmSupportedStorageProviders: ['array', false, () => []],
 
     /**
      * This property stores the modification time value retrieved from the
@@ -242,7 +245,7 @@ const Device = WebexPlugin.extend({
      *
      * @type {'ALLOW' | 'BLOCK'}
      */
-    whiteboardFileShareControl: 'string'
+    whiteboardFileShareControl: 'string',
   },
 
   /**
@@ -268,9 +271,9 @@ const Device = WebexPlugin.extend({
        * @returns {boolean}
        */
       fn() {
-        return !!(this.url);
-      }
-    }
+        return !!this.url;
+      },
+    },
   },
 
   /**
@@ -318,7 +321,7 @@ const Device = WebexPlugin.extend({
      *
      * @type {boolean}
      */
-    isInNetwork: 'boolean'
+    isInNetwork: 'boolean',
   },
 
   // Event method members.
@@ -355,61 +358,60 @@ const Device = WebexPlugin.extend({
     this.logger.info('device: refreshing');
 
     // Validate that the device can be registered.
-    return this.canRegister()
-      .then(() => {
-        // Validate if the device is not registered and register instead.
-        if (!this.registered) {
-          this.logger.info('device: device not registered, registering');
-
-          return this.register();
-        }
-
-        // Merge body configurations, overriding defaults.
-        const body = {
-          ...(this.serialize()),
-          ...(this.config.body ? this.config.body : {})
-        };
-
-        // Remove unneeded properties from the body object.
-        delete body.features;
-        delete body.mediaCluster;
-        delete body.etag;
-
-        // Append a ttl value if the device is marked as ephemeral.
-        if (this.config.ephemeral) {
-          body.ttl = this.config.ephemeralDeviceTTL;
-        }
-
-        // Merge header configurations, overriding defaults.
-        const headers = {
-          ...(this.config.defaults.headers ? this.config.defaults.headers : {}),
-          ...(this.config.headers ? this.config.headers : {}),
-          // If etag is sent, WDM will not send developer feature toggles unless they have changed
-          ...(this.etag ? {'If-None-Match': this.etag} : {})
-        };
-
-        return this.request({
-          method: 'PUT',
-          uri: this.url,
-          body,
-          headers
-        })
-          .then((response) => this.processRegistrationSuccess(response))
-          .catch((reason) => {
-            // Handle a 404 error, which indicates that the device is no longer
-            // valid and needs to be registered as a new device.
-            if (reason.statusCode === 404) {
-              this.logger.info('device: refresh failed, device is not valid');
-              this.logger.info('device: attempting to register a new device');
+    return this.canRegister().then(() => {
+      // Validate if the device is not registered and register instead.
+      if (!this.registered) {
+        this.logger.info('device: device not registered, registering');
 
-              this.clear();
+        return this.register();
+      }
 
-              return this.register();
-            }
+      // Merge body configurations, overriding defaults.
+      const body = {
+        ...this.serialize(),
+        ...(this.config.body ? this.config.body : {}),
+      };
 
-            return Promise.reject(reason);
-          });
-      });
+      // Remove unneeded properties from the body object.
+      delete body.features;
+      delete body.mediaCluster;
+      delete body.etag;
+
+      // Append a ttl value if the device is marked as ephemeral.
+      if (this.config.ephemeral) {
+        body.ttl = this.config.ephemeralDeviceTTL;
+      }
+
+      // Merge header configurations, overriding defaults.
+      const headers = {
+        ...(this.config.defaults.headers ? this.config.defaults.headers : {}),
+        ...(this.config.headers ? this.config.headers : {}),
+        // If etag is sent, WDM will not send developer feature toggles unless they have changed
+        ...(this.etag ? {'If-None-Match': this.etag} : {}),
+      };
+
+      return this.request({
+        method: 'PUT',
+        uri: this.url,
+        body,
+        headers,
+      })
+        .then((response) => this.processRegistrationSuccess(response))
+        .catch((reason) => {
+          // Handle a 404 error, which indicates that the device is no longer
+          // valid and needs to be registered as a new device.
+          if (reason.statusCode === 404) {
+            this.logger.info('device: refresh failed, device is not valid');
+            this.logger.info('device: attempting to register a new device');
+
+            this.clear();
+
+            return this.register();
+          }
+
+          return Promise.reject(reason);
+        });
+    });
   },
 
   /**
@@ -425,52 +427,68 @@ const Device = WebexPlugin.extend({
     this.logger.info('device: registering');
 
     // Validate that the device can be registered.
-    return this.canRegister()
-      .then(() => {
-        // Validate if the device is already registered and refresh instead.
-        if (this.registered) {
-          this.logger.info('device: device already registered, refreshing');
-
-          return this.refresh();
-        }
-
-        // Merge body configurations, overriding defaults.
-        const body = {
-          ...(this.config.defaults.body ? this.config.defaults.body : {}),
-          ...(this.config.body ? this.config.body : {})
-        };
-
-        // Merge header configurations, overriding defaults.
-        const headers = {
-          ...(this.config.defaults.headers ? this.config.defaults.headers : {}),
-          ...(this.config.headers ? this.config.headers : {})
-        };
-
-        // Append a ttl value if the device is marked as ephemeral
-        if (this.config.ephemeral) {
-          body.ttl = this.config.ephemeralDeviceTTL;
-        }
-
-        // This will be replaced by a `create()` method.
-        return this.request({
-          method: 'POST',
-          service: 'wdm',
-          resource: 'devices',
-          body,
-          headers
+    return this.canRegister().then(() => {
+      // Validate if the device is already registered and refresh instead.
+      if (this.registered) {
+        this.logger.info('device: device already registered, refreshing');
+
+        return this.refresh();
+      }
+
+      // Merge body configurations, overriding defaults.
+      const body = {
+        ...(this.config.defaults.body ? this.config.defaults.body : {}),
+        ...(this.config.body ? this.config.body : {}),
+      };
+
+      // Merge header configurations, overriding defaults.
+      const headers = {
+        ...(this.config.defaults.headers ? this.config.defaults.headers : {}),
+        ...(this.config.headers ? this.config.headers : {}),
+      };
+
+      // Append a ttl value if the device is marked as ephemeral
+      if (this.config.ephemeral) {
+        body.ttl = this.config.ephemeralDeviceTTL;
+      }
+      this.webex.internal.newMetrics.submitInternalEvent({
+        name: 'internal.register.device.request',
+      });
+
+      // This will be replaced by a `create()` method.
+      return this.request({
+        method: 'POST',
+        service: 'wdm',
+        resource: 'devices',
+        body,
+        headers,
+      })
+        .catch((error) => {
+          this.webex.internal.newMetrics.submitInternalEvent({
+            name: 'internal.register.device.response',
+          });
+
+          throw error;
         })
-          .then((response) => {
-            this.webex.internal.metrics.submitClientMetrics(METRICS.JS_SDK_WDM_REGISTRATION_SUCCESSFUL);
-
-            return this.processRegistrationSuccess(response);
-          })
-          .catch((error) => {
-            this.webex.internal.metrics.submitClientMetrics(METRICS.JS_SDK_WDM_REGISTRATION_FAILED, {
-              fields: {error}
-            });
-            throw error;
+        .then((response) => {
+          // Do not add any processing of response above this as that will affect timestamp
+          this.webex.internal.newMetrics.submitInternalEvent({
+            name: 'internal.register.device.response',
           });
-      });
+
+          this.webex.internal.metrics.submitClientMetrics(
+            METRICS.JS_SDK_WDM_REGISTRATION_SUCCESSFUL
+          );
+
+          return this.processRegistrationSuccess(response);
+        })
+        .catch((error) => {
+          this.webex.internal.metrics.submitClientMetrics(METRICS.JS_SDK_WDM_REGISTRATION_FAILED, {
+            fields: {error},
+          });
+          throw error;
+        });
+    });
   },
 
   /**
@@ -493,9 +511,8 @@ const Device = WebexPlugin.extend({
 
     return this.request({
       uri: this.url,
-      method: 'DELETE'
-    })
-      .then(() => this.clear());
+      method: 'DELETE',
+    }).then(() => this.clear());
   },
   /* eslint-enable require-jsdoc */
 
@@ -515,19 +532,19 @@ const Device = WebexPlugin.extend({
     const {services} = this.webex.internal;
 
     // Wait for the postauth catalog to populate.
-    return services.waitForCatalog(
-      'postauth',
-      this.config.canRegisterWaitDuration
-    )
-      .then(() => (
-        // Validate that the service exists after waiting for the catalog.
-        services.get('wdm') ?
-          Promise.resolve() :
-          Promise.reject(new Error([
-            'device: cannot register,',
-            '\'wdm\' service is not available from the postauth catalog'
-          ].join(' ')))
-      ));
+    return services.waitForCatalog('postauth', this.config.canRegisterWaitDuration).then(() =>
+      // Validate that the service exists after waiting for the catalog.
+      services.get('wdm')
+        ? Promise.resolve()
+        : Promise.reject(
+            new Error(
+              [
+                'device: cannot register,',
+                "'wdm' service is not available from the postauth catalog",
+              ].join(' ')
+            )
+          )
+    );
   },
 
   /**
@@ -556,14 +573,14 @@ const Device = WebexPlugin.extend({
     const headers = {
       'cisco-no-http-redirect': null,
       'spark-user-agent': null,
-      trackingid: null
+      trackingid: null,
     };
 
     // Send the network reachability request.
     return this.request({
       headers,
       method: 'GET',
-      uri: this.intranetInactivityCheckUrl
+      uri: this.intranetInactivityCheckUrl,
     })
       .then(() => {
         this.isInNetwork = true;
@@ -612,17 +629,15 @@ const Device = WebexPlugin.extend({
         .catch((error) => {
           this.logger.warn(error.message);
 
-          return Promise.reject(new Error(
-            'device: failed to get the current websocket url'
-          ));
+          return Promise.reject(new Error('device: failed to get the current websocket url'));
         });
     }
 
     // Validate if the device is registered.
     if (!this.registered) {
-      return Promise.reject(new Error(
-        'device: cannot get websocket url, device is not registered'
-      ));
+      return Promise.reject(
+        new Error('device: cannot get websocket url, device is not registered')
+      );
     }
 
     // Attempt to collect the priority-host-mapped web socket URL.
@@ -633,9 +648,7 @@ const Device = WebexPlugin.extend({
       return Promise.resolve(wsUrl);
     }
 
-    return Promise.reject(new Error(
-      'device: failed to get the current websocket url'
-    ));
+    return Promise.reject(new Error('device: failed to get the current websocket url'));
   },
 
   /**
@@ -654,9 +667,9 @@ const Device = WebexPlugin.extend({
     delete body.services;
     delete body.serviceHostMap;
 
-    const {etag} = response.headers;
+    const {etag} = response.headers || {};
 
-    if (this.etag && this.etag === etag) {
+    if (this.etag && etag && this.etag === etag) {
       // If current etag matches the previous one and we have sent
       // If-None-Match header the developer and entitlement feature
       // toggles will not be returned
@@ -707,12 +720,14 @@ const Device = WebexPlugin.extend({
 
     // Validate if the device is currently in a meeting and is configured to
     // required inactivity enforcement.
-    if (!this.isInMeeting && this.config.enableInactivityEnforcement &&
-      this.isReachabilityChecked) {
+    if (
+      !this.isInMeeting &&
+      this.config.enableInactivityEnforcement &&
+      this.isReachabilityChecked
+    ) {
       if (this.isInNetwork) {
         this.setLogoutTimer(this.inNetworkInactivityDuration);
-      }
-      else {
+      } else {
         this.setLogoutTimer(this.intranetInactivityDuration);
       }
     }
@@ -732,7 +747,9 @@ const Device = WebexPlugin.extend({
     }
 
     // Setup user activity date event listener.
-    this.on('change:lastUserActivityDate', () => { this.resetLogoutTimer(); });
+    this.on('change:lastUserActivityDate', () => {
+      this.resetLogoutTimer();
+    });
 
     // Initialize a new timer.
     this.logoutTimer = safeSetTimeout(() => {
@@ -754,9 +771,10 @@ const Device = WebexPlugin.extend({
         resolve();
       }
 
-      const timeoutTimer = safeSetTimeout(() => reject(
-        new Error('device: timeout occured while waiting for registration')
-      ), timeout * 1000);
+      const timeoutTimer = safeSetTimeout(
+        () => reject(new Error('device: timeout occured while waiting for registration')),
+        timeout * 1000
+      );
 
       this.once(DEVICE_EVENT_REGISTRATION_SUCCESS, () => {
         clearTimeout(timeoutTimer);
@@ -832,7 +850,7 @@ const Device = WebexPlugin.extend({
       this.isInMeeting = false;
       this.resetLogoutTimer();
     });
-  }
+  },
   /* eslint-enable require-jsdoc */
 });
 

package/src/features/feature-collection.js

@@ -24,7 +24,7 @@ const FeatureCollection = AmpCollection.extend({
    *
    * @type {Class}
    */
-  model: FeatureModel
+  model: FeatureModel,
 });
 
 export default FeatureCollection;

package/src/features/feature-model.js

@@ -20,7 +20,6 @@ import {FEATURE_TYPES} from '../constants';
  * **WDM** service upon registration.
  */
 const FeatureModel = AmpState.extend({
-
   idAttribute: 'key', // needed by Ampersand to determine unique item
 
   // Ampersand property members.
@@ -67,7 +66,7 @@ const FeatureModel = AmpState.extend({
      *
      * @type {any}
      */
-    value: 'any'
+    value: 'any',
   },
 
   /**
@@ -82,11 +81,7 @@ const FeatureModel = AmpState.extend({
   constructor(attrs, options = {}) {
     defaults(options, {parse: true});
 
-    return Reflect.apply(
-      AmpState.prototype.constructor,
-      this,
-      [attrs, options]
-    );
+    return Reflect.apply(AmpState.prototype.constructor, this, [attrs, options]);
   },
 
   // Ampsersand method members.
@@ -150,7 +145,7 @@ const FeatureModel = AmpState.extend({
     // Validate that the overloaded class member returned an object with the
     // `lastModified` key-value pair and instance it as an ISO string.
     if (attrs.lastModified) {
-      attrs.lastModified = (new Date(attrs.lastModified).toISOString());
+      attrs.lastModified = new Date(attrs.lastModified).toISOString();
     }
 
     return attrs;
@@ -179,8 +174,7 @@ const FeatureModel = AmpState.extend({
     if (isObject(key) || key === null) {
       attrs = key;
       optns = value;
-    }
-    else {
+    } else {
       attrs = {};
       attrs[key] = value;
       optns = options;
@@ -189,7 +183,7 @@ const FeatureModel = AmpState.extend({
     attrs = this.parse(attrs, optns);
 
     return Reflect.apply(AmpState.prototype.set, this, [attrs, optns]);
-  }
+  },
 });
 
 export default FeatureModel;

package/src/features/features-model.js

@@ -14,7 +14,6 @@ import FeatureCollection from './feature-collection';
  * organize the data retrieved from the **wdm** service on device registration.
  */
 const FeaturesModel = AmpState.extend({
-
   // Ampersand property members.
 
   collections: {
@@ -37,7 +36,7 @@ const FeaturesModel = AmpState.extend({
      *
      * @type {FeatureCollection}
      */
-    user: FeatureCollection
+    user: FeatureCollection,
   },
 
   // Helper method members.
@@ -87,16 +86,11 @@ const FeaturesModel = AmpState.extend({
     eventNames.forEach((eventName) => {
       FEATURE_COLLECTION_NAMES.forEach((collectionName) => {
         this[collectionName].on(eventName, (model, options) => {
-          this.trigger(
-            `change:${collectionName}`,
-            this,
-            this[collectionName],
-            options
-          );
+          this.trigger(`change:${collectionName}`, this, this[collectionName], options);
         });
       });
     });
-  }
+  },
 });
 
 export default FeaturesModel;

package/src/features/index.js

@@ -2,8 +2,4 @@ import FeatureCollection from './feature-collection';
 import FeatureModel from './feature-model';
 import FeaturesModel from './features-model';
 
-export {
-  FeatureCollection,
-  FeatureModel,
-  FeaturesModel
-};
+export {FeatureCollection, FeatureModel, FeaturesModel};

package/src/index.js

@@ -13,7 +13,7 @@ import config from './config';
 registerInternalPlugin('device', Device, {
   config,
   interceptors: {
-    DeviceUrlInterceptor: DeviceUrlInterceptor.create
+    DeviceUrlInterceptor: DeviceUrlInterceptor.create,
   },
   /**
    * Unregister the device in the case that the webex instance has logged out.
@@ -22,16 +22,8 @@ registerInternalPlugin('device', Device, {
    */
   onBeforeLogout() {
     return this.unregister();
-  }
+  },
 });
 
 export {default} from './device';
-export {
-  config,
-  constants,
-  DeviceUrlInterceptor,
-  FeatureCollection,
-  FeatureModel,
-  FeaturesModel
-};
-
+export {config, constants, DeviceUrlInterceptor, FeatureCollection, FeatureModel, FeaturesModel};