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

package/test/integration/spec/webex.js

@@ -11,14 +11,15 @@ describe('plugin-device', () => {
     let user;
     let webex;
 
-    before('create users', () => testUsers.create({count: 1})
-      .then(([createdUser]) => {
+    before('create users', () =>
+      testUsers.create({count: 1}).then(([createdUser]) => {
         user = createdUser;
-      }));
+      })
+    );
 
     beforeEach('create webex instance', () => {
       webex = new WebexCore({
-        credentials: user.token
+        credentials: user.token,
       });
 
       device = webex.internal.device;
@@ -32,11 +33,10 @@ describe('plugin-device', () => {
       });
 
       it('unregisters the device', () =>
-        webex.logout({noRedirect: true})
-          .then(() => {
-            assert.called(device.unregister);
-            assert.isFalse(device.registered);
-          }));
+        webex.logout({noRedirect: true}).then(() => {
+          assert.called(device.unregister);
+          assert.isFalse(device.registered);
+        }));
     });
   });
 });

package/test/unit/spec/device.js

@@ -15,8 +15,8 @@ describe('plugin-device', () => {
     beforeEach('initialize webex with the device plugin', () => {
       webex = new MockWebex({
         children: {
-          device: Device
-        }
+          device: Device,
+        },
       });
 
       const clonedDTO = cloneDeep(dto);
@@ -35,20 +35,17 @@ describe('plugin-device', () => {
           spy = sinon.spy();
           modifiedDTOFeatures = {
             ...dto.features,
-            user: [
-              ...dto.features.user,
-              ...dto.features.developer
-            ]
+            user: [...dto.features.user, ...dto.features.developer],
           };
         });
 
-        it('should trigger a \'change\' event', () => {
+        it("should trigger a 'change' event", () => {
           device.on('change', spy);
           device.features.set(modifiedDTOFeatures);
           assert.called(spy);
         });
 
-        it('should trigger a \'change:features\' event', () => {
+        it("should trigger a 'change:features' event", () => {
           device.on('change:features', spy);
           device.features.set(modifiedDTOFeatures);
           assert.called(spy);
@@ -60,12 +57,12 @@ describe('plugin-device', () => {
           device.checkNetworkReachability = sinon.spy();
         });
 
-        describe('when the \'intranetInactivityCheckUrl\' changes', () => {
-          beforeEach('change \'intranetInactivityCheckUrl\'', () => {
+        describe("when the 'intranetInactivityCheckUrl' changes", () => {
+          beforeEach("change 'intranetInactivityCheckUrl'", () => {
             device.intranetInactivityCheckUrl = 'https://not-a-url.com';
           });
 
-          it('should call \'checkNetworkReachability()\'', () => {
+          it("should call 'checkNetworkReachability()'", () => {
             assert.called(device.checkNetworkReachability);
           });
 
@@ -74,12 +71,12 @@ describe('plugin-device', () => {
           });
         });
 
-        describe('when the \'intranetInactivityDuration\' changes', () => {
-          beforeEach('change \'intranetInactivityDuration\'', () => {
+        describe("when the 'intranetInactivityDuration' changes", () => {
+          beforeEach("change 'intranetInactivityDuration'", () => {
             device.intranetInactivityDuration = 1234;
           });
 
-          it('should call \'checkNetworkReachability()\'', () => {
+          it("should call 'checkNetworkReachability()'", () => {
             assert.called(device.checkNetworkReachability);
           });
 
@@ -88,12 +85,12 @@ describe('plugin-device', () => {
           });
         });
 
-        describe('when the \'inNetworkInactivityDuration\' changes', () => {
-          beforeEach('change \'inNetworkInactivityDuration\'', () => {
+        describe("when the 'inNetworkInactivityDuration' changes", () => {
+          beforeEach("change 'inNetworkInactivityDuration'", () => {
             device.inNetworkInactivityDuration = 1234;
           });
 
-          it('should call \'checkNetworkReachability()\'', () => {
+          it("should call 'checkNetworkReachability()'", () => {
             assert.called(device.checkNetworkReachability);
             assert.isTrue(device.isReachabilityChecked);
           });
@@ -104,7 +101,7 @@ describe('plugin-device', () => {
     describe('derived properties', () => {
       describe('#registered', () => {
         describe('when the device does not have a url', () => {
-          beforeEach('remove the device\'s url', () => {
+          beforeEach("remove the device's url", () => {
             device.url = undefined;
           });
 
@@ -114,7 +111,7 @@ describe('plugin-device', () => {
         });
 
         describe('when the device does have a url', () => {
-          beforeEach('set the device\'s url', () => {
+          beforeEach("set the device's url", () => {
             device.url = dto.url;
           });
 
@@ -149,7 +146,7 @@ describe('plugin-device', () => {
           device.resetLogoutTimer = sinon.spy();
         });
 
-        it('should create a \'change:lastUserActivityDate\' listener', () => {
+        it("should create a 'change:lastUserActivityDate' listener", () => {
           device.setLogoutTimer(60000);
           device.trigger('change:lastUserActivityDate');
           assert.called(device.resetLogoutTimer);
@@ -173,10 +170,7 @@ describe('plugin-device', () => {
       });
 
       it('should serialize user feature keys', () => {
-        assert.hasAllKeys(
-          device.serialize().features.user,
-          Object.keys(dto.features.user)
-        );
+        assert.hasAllKeys(device.serialize().features.user, Object.keys(dto.features.user));
       });
     });
 
@@ -201,7 +195,7 @@ describe('plugin-device', () => {
         await result;
 
         assert.deepEqual(requestSpy.args[0][0].headers, {
-          'If-None-Match': 'etag-value'
+          'If-None-Match': 'etag-value',
         });
       });
 
@@ -216,6 +210,72 @@ describe('plugin-device', () => {
       });
     });
 
+    describe('#register()', () => {
+      const setup = () => {
+        webex.internal.metrics.submitClientMetrics = sinon.stub();
+        
+        sinon.stub(device, 'processRegistrationSuccess').callsFake(() => {});
+
+        device.config.defaults = {};
+        device.set('registered', false);
+      };
+
+      it('checks that submitInternalEvent gets called with internal.register.device.request', async () => {
+        setup();
+        sinon.stub(device, 'canRegister').callsFake(() => Promise.resolve());
+        sinon.spy(device, 'request');
+
+        await device.register();
+
+        assert.calledWith(webex.internal.newMetrics.submitInternalEvent, {
+          name: 'internal.register.device.request',
+        });
+
+      });
+
+      it('checks that submitInternalEvent gets called with internal.register.device.response on error', async () => {
+        setup();
+        sinon.stub(device, 'canRegister').callsFake(() => Promise.resolve());
+        sinon.stub(device, 'request').rejects(new Error('some error'));
+
+        const result = device.register();
+
+        await assert.isRejected(result);
+
+        assert.calledWith(webex.internal.newMetrics.submitInternalEvent, {
+          name: 'internal.register.device.response',
+        });
+
+      });
+
+      it('checks that submitInternalEvent gets called with internal.register.device.response on success', async () => {
+        setup();
+        sinon.stub(device, 'canRegister').callsFake(() => Promise.resolve());
+
+        sinon.stub(device, 'request').callsFake(() => Promise.resolve({
+          exampleKey: 'example response value',
+        }));
+
+        await device.register();
+
+        assert.calledWith(webex.internal.newMetrics.submitInternalEvent, {
+          name: 'internal.register.device.response',
+        });
+      });
+
+      it('checks that submitInternalEvent not called when canRegister fails', async () => {
+        setup();
+        sinon.stub(device, 'canRegister').rejects(new Error('some error'));
+
+        const result =  device.register();
+
+        await assert.isRejected(result);
+
+        assert.notCalled(webex.internal.newMetrics.submitInternalEvent);
+      });
+
+    });
+
     describe('#processRegistrationSuccess()', () => {
       const getClonedDTO = (overrides) => {
         const clonedDTO = cloneDeep(dto);
@@ -228,7 +288,7 @@ describe('plugin-device', () => {
               val: 'true',
               value: true,
               mutable: true,
-              lastModified: '2015-06-29T20:02:48.033Z'
+              lastModified: '2015-06-29T20:02:48.033Z',
             },
           ],
           entitlement: [
@@ -236,18 +296,18 @@ describe('plugin-device', () => {
               key: '2',
               val: 'true',
               value: true,
-              mutable: false
-            }
+              mutable: false,
+            },
           ],
           user: [
             {
               key: '3',
               val: 'true',
               value: true,
-              mutable: true
-            }
+              mutable: true,
+            },
           ],
-          ...overrides
+          ...overrides,
         };
 
         return clonedDTO;
@@ -267,11 +327,9 @@ describe('plugin-device', () => {
 
         const response = {
           body: {
-            ...clonedDTO
+            ...clonedDTO,
           },
-          headers: {
-
-          }
+          headers: {},
         };
 
         checkFeatureNotPresent('developer', '1');
@@ -292,11 +350,11 @@ describe('plugin-device', () => {
 
         const response = {
           body: {
-            ...clonedDTO
+            ...clonedDTO,
           },
           headers: {
-            etag: 'etag-value'
-          }
+            etag: 'etag-value',
+          },
         };
 
         checkFeatureNotPresent('developer', '1');
@@ -320,11 +378,11 @@ describe('plugin-device', () => {
 
         const response = {
           body: {
-            ...clonedDTO
+            ...clonedDTO,
           },
           headers: {
-            etag: 'etag-value'
-          }
+            etag: 'etag-value',
+          },
         };
 
         checkFeatureNotPresent('developer', '1');
@@ -348,11 +406,11 @@ describe('plugin-device', () => {
 
         const response = {
           body: {
-            ...clonedDTO
+            ...clonedDTO,
           },
           headers: {
-            etag: 'different-etag-value'
-          }
+            etag: 'different-etag-value',
+          },
         };
 
         checkFeatureNotPresent('developer', '1');
@@ -376,7 +434,7 @@ describe('plugin-device', () => {
               val: 'false',
               value: false,
               mutable: true,
-              lastModified: '2015-06-29T20:02:48.033Z'
+              lastModified: '2015-06-29T20:02:48.033Z',
             },
           ],
           entitlement: [
@@ -384,27 +442,26 @@ describe('plugin-device', () => {
               key: '2',
               val: 'false',
               value: false,
-              mutable: false
-            }
+              mutable: false,
+            },
           ],
           user: [
             {
               key: '3',
               val: 'false',
               value: false,
-              mutable: true
-            }
+              mutable: true,
+            },
           ],
         });
 
-
         const newResponse = {
           body: {
-            ...newClonedDTO
+            ...newClonedDTO,
           },
           headers: {
-            etag: 'different-etag-value'
-          }
+            etag: 'different-etag-value',
+          },
         };
 
         device.processRegistrationSuccess(newResponse);

package/test/unit/spec/features/feature-collection.js

@@ -10,13 +10,13 @@ describe('plugin-device', () => {
     });
 
     describe('#mainIndex', () => {
-      it('should have its index set to \'key\'', () => {
+      it("should have its index set to 'key'", () => {
         assert.equal(featureCollection.mainIndex, 'key');
       });
     });
 
     describe('#model', () => {
-      it('should have its model set to the \'FeatureModel\' class', () => {
+      it("should have its model set to the 'FeatureModel' class", () => {
         assert.equal(featureCollection.model, FeatureModel);
       });
     });

package/test/unit/spec/features/feature-model.js

@@ -14,7 +14,7 @@ describe('plugin-device', () => {
     });
 
     describe('#constructor()', () => {
-      describe('when the feature includes a \'lastModified\' property', () => {
+      describe("when the feature includes a 'lastModified' property", () => {
         beforeEach('generate the feature model', () => {
           featureModel = new FeatureModel(featureLM);
         });
@@ -27,17 +27,14 @@ describe('plugin-device', () => {
           assert.equal(featureLM.value, featureModel.value);
         });
 
-        it('should assign the \'lastModified\' value as a \'Date\'', () => {
+        it("should assign the 'lastModified' value as a 'Date'", () => {
           assert.instanceOf(featureModel.lastModified, Date);
 
-          assert.equal(
-            featureModel.lastModified.toISOString(),
-            featureLM.lastModified
-          );
+          assert.equal(featureModel.lastModified.toISOString(), featureLM.lastModified);
         });
       });
 
-      describe('when the feature excludes a \'lastModified\' property', () => {
+      describe("when the feature excludes a 'lastModified' property", () => {
         beforeEach('generate the feature model', () => {
           featureModel = new FeatureModel(featureNLM);
         });
@@ -50,7 +47,7 @@ describe('plugin-device', () => {
           assert.equal(featureNLM.value, featureModel.value);
         });
 
-        it('should not assign the \'lastModified\' value', () => {
+        it("should not assign the 'lastModified' value", () => {
           assert.isUndefined(featureModel.lastModified);
         });
       });
@@ -83,8 +80,7 @@ describe('plugin-device', () => {
           it('should set the value to a instance of number', () =>
             assert.typeOf(model.value, 'number'));
 
-          it('should set the type to \'number\'', () =>
-            assert.equal(model.type, 'number'));
+          it("should set the type to 'number'", () => assert.equal(model.type, 'number'));
 
           it('should set the model value to the equivalent Number value', () =>
             assert.equal(model.value, Number(fixture.val)));
@@ -96,11 +92,9 @@ describe('plugin-device', () => {
             model = featureModel.parse(fixture);
           });
 
-          it('should set the value to a boolean true', () =>
-            assert.equal(model.value, true));
+          it('should set the value to a boolean true', () => assert.equal(model.value, true));
 
-          it('should set the type to \'boolean\'', () =>
-            assert.equal(model.type, 'boolean'));
+          it("should set the type to 'boolean'", () => assert.equal(model.type, 'boolean'));
         });
 
         describe('when the value is a True boolean', () => {
@@ -109,11 +103,9 @@ describe('plugin-device', () => {
             model = featureModel.parse(fixture);
           });
 
-          it('should set the value to a boolean true', () =>
-            assert.equal(model.value, true));
+          it('should set the value to a boolean true', () => assert.equal(model.value, true));
 
-          it('should set the type to \'boolean\'', () =>
-            assert.equal(model.type, 'boolean'));
+          it("should set the type to 'boolean'", () => assert.equal(model.type, 'boolean'));
         });
 
         describe('when the value is a false string', () => {
@@ -122,11 +114,9 @@ describe('plugin-device', () => {
             model = featureModel.parse(fixture);
           });
 
-          it('should set the value to a boolean false', () =>
-            assert.equal(model.value, false));
+          it('should set the value to a boolean false', () => assert.equal(model.value, false));
 
-          it('should set the type to \'boolean\'', () =>
-            assert.equal(model.type, 'boolean'));
+          it("should set the type to 'boolean'", () => assert.equal(model.type, 'boolean'));
         });
 
         describe('when the value is a False string', () => {
@@ -135,11 +125,9 @@ describe('plugin-device', () => {
             model = featureModel.parse(fixture);
           });
 
-          it('should set the value to a boolean false', () =>
-            assert.equal(model.value, false));
+          it('should set the value to a boolean false', () => assert.equal(model.value, false));
 
-          it('should set the type to \'boolean\'', () =>
-            assert.equal(model.type, 'boolean'));
+          it("should set the type to 'boolean'", () => assert.equal(model.type, 'boolean'));
         });
 
         describe('when the value is a string', () => {
@@ -151,8 +139,7 @@ describe('plugin-device', () => {
           it('should set the value to a instance of string', () =>
             assert.typeOf(model.value, 'string'));
 
-          it('should set the type to \'string\'', () =>
-            assert.equal(model.type, 'string'));
+          it("should set the type to 'string'", () => assert.equal(model.type, 'string'));
 
           it('should set the model value to the equivalent string value', () =>
             assert.equal(model.value, fixture.val));
@@ -167,8 +154,7 @@ describe('plugin-device', () => {
           it('should set the value to the provided val property', () =>
             assert.equal(model.value, fixture.val));
 
-          it('should set the type to \'string\'', () =>
-            assert.equal(model.type, 'string'));
+          it("should set the type to 'string'", () => assert.equal(model.type, 'string'));
         });
 
         describe('when there is no value', () => {
@@ -177,11 +163,9 @@ describe('plugin-device', () => {
             model = featureModel.parse(fixture);
           });
 
-          it('should set the value to undefined', () =>
-            assert.isUndefined(model.value));
+          it('should set the value to undefined', () => assert.isUndefined(model.value));
 
-          it('should set the type to \'string\'', () =>
-            assert.equal(model.type, 'string'));
+          it("should set the type to 'string'", () => assert.equal(model.type, 'string'));
         });
       });
     });
@@ -189,7 +173,7 @@ describe('plugin-device', () => {
     describe('#serialize()', () => {
       let serialized;
 
-      describe('when the feature includes a \'lastModified\' property', () => {
+      describe("when the feature includes a 'lastModified' property", () => {
         beforeEach('generate the feature model', () => {
           featureModel = new FeatureModel(featureLM);
           serialized = featureModel.serialize();
@@ -203,13 +187,13 @@ describe('plugin-device', () => {
           assert.equal(featureLM.value, serialized.value);
         });
 
-        it('should assign the \'lastModified\' value as a \'string\'', () => {
+        it("should assign the 'lastModified' value as a 'string'", () => {
           assert.typeOf(serialized.lastModified, 'string');
           assert.equal(serialized.lastModified, featureLM.lastModified);
         });
       });
 
-      describe('when the feature excludes a \'lastModified\' property', () => {
+      describe("when the feature excludes a 'lastModified' property", () => {
         beforeEach('generate the feature model', () => {
           featureModel = new FeatureModel(featureNLM);
           serialized = featureModel.serialize();
@@ -223,7 +207,7 @@ describe('plugin-device', () => {
           assert.equal(featureNLM.value, serialized.value);
         });
 
-        it('should not assign the \'lastModified\' value', () => {
+        it("should not assign the 'lastModified' value", () => {
           assert.isUndefined(serialized.lastModified);
         });
       });
@@ -234,7 +218,7 @@ describe('plugin-device', () => {
         let key;
         let value;
 
-        beforeEach('configure feature and set \'key\' and \'value\'', () => {
+        beforeEach("configure feature and set 'key' and 'value'", () => {
           key = 'val';
           value = 'false';
           featureModel = new FeatureModel(featureLM);

package/test/unit/spec/features/features-model.js

@@ -1,9 +1,5 @@
 import {assert} from '@webex/test-helper-chai';
-import {
-  constants,
-  FeatureModel,
-  FeaturesModel
-} from '@webex/internal-plugin-device';
+import {constants, FeatureModel, FeaturesModel} from '@webex/internal-plugin-device';
 import sinon from 'sinon';
 
 import dto from '../wdm-dto';
@@ -17,12 +13,8 @@ describe('plugin-device', () => {
     });
 
     describe('collections', () => {
-      it('should have \'developer\', \'entitlement\' and \'user\' keys', () => {
-        assert.containsAllKeys(featuresModel, [
-          'developer',
-          'entitlement',
-          'user'
-        ]);
+      it("should have 'developer', 'entitlement' and 'user' keys", () => {
+        assert.containsAllKeys(featuresModel, ['developer', 'entitlement', 'user']);
       });
     });
 
@@ -58,7 +50,7 @@ describe('plugin-device', () => {
             key = 'testKey';
             model = new FeatureModel({
               ...dto.features[collectionName][0],
-              key
+              key,
             });
             spy = sinon.spy();