@webex/internal-plugin-lyra 3.0.0-beta.2 → 3.0.0-beta.21

package/test/integration/spec/device.js

@@ -24,20 +24,22 @@ describe('plugin-lyra', () => {
     before('create lyra machine', function () {
       this.timeout(retry.timeout(20000));
 
-      return retry(() => testUsers.create({
-        count: 1,
-        config: {
-          machineType: 'LYRA_SPACE',
-          type: 'MACHINE',
-          password: `${generateRandomString(32)}d_wA*`
-        }
-      }))
+      return retry(() =>
+        testUsers.create({
+          count: 1,
+          config: {
+            machineType: 'LYRA_SPACE',
+            type: 'MACHINE',
+            password: `${generateRandomString(32)}d_wA*`,
+          },
+        })
+      )
         .then((machines) => {
           lyraMachine = machines[0];
           lyraMachine.webex = new WebexCore({
             credentials: {
-              authorization: lyraMachine.token
-            }
+              authorization: lyraMachine.token,
+            },
           });
 
           // binding to conversation only works with webex board device
@@ -56,31 +58,37 @@ describe('plugin-lyra', () => {
         });
     });
 
-    before('create users', () => testUsers.create({count: 2})
-      .then((users) => {
+    before('create users', () =>
+      testUsers.create({count: 2}).then((users) => {
         participants = users;
         spock = participants[0];
 
-        return Promise.all(Array.map(participants, (participant) => {
-          participant.webex = new WebexCore({
-            credentials: {
-              authorization: participant.token
-            }
-          });
-
-          return participant.webex.internal.mercury.connect();
-        }));
-      }));
-
-    before('create conversation', () => retry(() => participants[0].webex.internal.conversation.create({
-      displayName: 'Test Lyra Conversation',
-      participants
-    }))
-      .then((c) => {
+        return Promise.all(
+          Array.map(participants, (participant) => {
+            participant.webex = new WebexCore({
+              credentials: {
+                authorization: participant.token,
+              },
+            });
+
+            return participant.webex.internal.mercury.connect();
+          })
+        );
+      })
+    );
+
+    before('create conversation', () =>
+      retry(() =>
+        participants[0].webex.internal.conversation.create({
+          displayName: 'Test Lyra Conversation',
+          participants,
+        })
+      ).then((c) => {
         conversation = c;
 
         return conversation;
-      }));
+      })
+    );
 
     describe('#getAudioState', () => {
       let audioState;
@@ -88,19 +96,19 @@ describe('plugin-lyra', () => {
       before('put audio state', () => {
         audioState = {
           volume: {
-            level: 2
+            level: 2,
           },
           microphones: {
-            muted: false
+            muted: false,
           },
-          deviceUrl: lyraMachine.webex.internal.device.url
+          deviceUrl: lyraMachine.webex.internal.device.url,
         };
 
         return lyraMachine.webex.internal.lyra.device.putAudioState(lyraMachine.space, audioState);
       });
 
-      it('returns audio state', () => lyraMachine.webex.internal.lyra.device.getAudioState(lyraMachine.space)
-        .then((res) => {
+      it('returns audio state', () =>
+        lyraMachine.webex.internal.lyra.device.getAudioState(lyraMachine.space).then((res) => {
           assert.equal(res.microphones.muted, audioState.microphones.muted);
           assert.equal(res.volume.level, audioState.volume.level);
         }));
@@ -108,14 +116,19 @@ describe('plugin-lyra', () => {
 
     // Skip until we can bind a conversation to lyra space by posting capabilities to Lyra.
     describe.skip('when a call is in progress', () => {
-      before('ensure participant joined space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id))
-        .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation)));
+      before('ensure participant joined space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() =>
+            lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id)
+          )
+          .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
+      );
 
       before('make a call', () => {
         const locus = {
           url: conversation.locusUrl,
-          correlationId: uuid.v4()
+          correlationId: uuid.v4(),
         };
 
         return spock.webex.request({
@@ -124,19 +137,23 @@ describe('plugin-lyra', () => {
           body: {
             correlationId: locus.correlationId,
             deviceUrl: spock.webex.internal.device.url,
-            localMedias: []
-          }
+            localMedias: [],
+          },
         });
       });
 
-      after('remove binding', () => spock.webex.internal.lyra.space.unbindConversation(lyraMachine.space, conversation)
-        // After hooks shouldn't be able to break tests
-        .catch((err) => console.error(err)));
+      after('remove binding', () =>
+        spock.webex.internal.lyra.space
+          .unbindConversation(lyraMachine.space, conversation)
+          // After hooks shouldn't be able to break tests
+          .catch((err) => console.error(err))
+      );
 
       it('mutes', () => {
         spock.webex.internal.lyra.device.mute(lyraMachine.space);
 
-        return lyraMachine.webex.internal.mercury.when('event:lyra.space_audio_microphones_mute_action')
+        return lyraMachine.webex.internal.mercury
+          .when('event:lyra.space_audio_microphones_mute_action')
           .then(([event]) => {
             assert.equal(event.data.action, 'mute');
           });
@@ -145,7 +162,8 @@ describe('plugin-lyra', () => {
       it('unmutes', () => {
         spock.webex.internal.lyra.device.unmute(lyraMachine.space);
 
-        return lyraMachine.webex.internal.mercury.when('event:lyra.space_audio_microphones_mute_action')
+        return lyraMachine.webex.internal.mercury
+          .when('event:lyra.space_audio_microphones_mute_action')
           .then(([event]) => {
             assert.equal(event.data.action, 'unMute');
           });
@@ -154,7 +172,8 @@ describe('plugin-lyra', () => {
       it('increases volume', () => {
         spock.webex.internal.lyra.device.increaseVolume(lyraMachine.space);
 
-        return lyraMachine.webex.internal.mercury.when('event:lyra.space_audio_volume_change_action')
+        return lyraMachine.webex.internal.mercury
+          .when('event:lyra.space_audio_volume_change_action')
           .then(([event]) => {
             assert.equal(event.data.action, 'increase');
           });
@@ -163,7 +182,8 @@ describe('plugin-lyra', () => {
       it('decreases volume', () => {
         spock.webex.internal.lyra.device.decreaseVolume(lyraMachine.space);
 
-        return lyraMachine.webex.internal.mercury.when('event:lyra.space_audio_volume_change_action')
+        return lyraMachine.webex.internal.mercury
+          .when('event:lyra.space_audio_volume_change_action')
           .then(([event]) => {
             assert.equal(event.data.action, 'decrease');
           });
@@ -172,7 +192,8 @@ describe('plugin-lyra', () => {
       it('sets volume', () => {
         spock.webex.internal.lyra.device.setVolume(lyraMachine.space, 2);
 
-        return lyraMachine.webex.internal.mercury.when('event:lyra.space_audio_volume_set_action')
+        return lyraMachine.webex.internal.mercury
+          .when('event:lyra.space_audio_volume_set_action')
           .then(([event]) => {
             assert.equal(event.data.level, 2);
           });

package/test/integration/spec/space.js

@@ -25,20 +25,22 @@ describe('plugin-lyra', function () {
     before('create lyra machine', function () {
       this.timeout(retry.timeout(20000));
 
-      return retry(() => testUsers.create({
-        count: 1,
-        config: {
-          machineType: 'LYRA_SPACE',
-          type: 'MACHINE',
-          password: `${generateRandomString(32)}d_wA*`
-        }
-      }))
+      return retry(() =>
+        testUsers.create({
+          count: 1,
+          config: {
+            machineType: 'LYRA_SPACE',
+            type: 'MACHINE',
+            password: `${generateRandomString(32)}d_wA*`,
+          },
+        })
+      )
         .then((machines) => {
           lyraMachine = machines[0];
           lyraMachine.webex = new WebexCore({
             credentials: {
-              authorization: lyraMachine.token
-            }
+              authorization: lyraMachine.token,
+            },
           });
 
           // binding to conversation only works with webex board device
@@ -57,131 +59,174 @@ describe('plugin-lyra', function () {
         });
     });
 
-    before('create users', () => testUsers.create({count: 2})
-      .then((users) => {
+    before('create users', () =>
+      testUsers.create({count: 2}).then((users) => {
         participants = users;
         spock = participants[0];
 
-        return Promise.all(Array.map(participants, (participant) => {
-          participant.webex = new WebexCore({
-            credentials: {
-              authorization: participant.token
-            }
-          });
-
-          return participant.webex.internal.mercury.connect();
-        }));
-      }));
-
-    before('create conversation', () => retry(() => participants[0].webex.internal.conversation.create({
-      displayName: 'Test Lyra Conversation',
-      participants
-    }))
-      .then((c) => {
+        return Promise.all(
+          Array.map(participants, (participant) => {
+            participant.webex = new WebexCore({
+              credentials: {
+                authorization: participant.token,
+              },
+            });
+
+            return participant.webex.internal.mercury.connect();
+          })
+        );
+      })
+    );
+
+    before('create conversation', () =>
+      retry(() =>
+        participants[0].webex.internal.conversation.create({
+          displayName: 'Test Lyra Conversation',
+          participants,
+        })
+      ).then((c) => {
         conversation = c;
 
         return conversation;
-      }));
+      })
+    );
 
     describe('#list()', () => {
-      before('ensure participant joined space', () => spock.webex.internal.lyra.space.join(lyraSpace));
+      before('ensure participant joined space', () =>
+        spock.webex.internal.lyra.space.join(lyraSpace)
+      );
 
-      it('returns spaces', () => spock.webex.internal.lyra.space.list()
-        .then((spaces) => {
+      it('returns spaces', () =>
+        spock.webex.internal.lyra.space.list().then((spaces) => {
           assert.lengthOf(spaces, 1);
           assert.deepEqual(spaces[0].identity, lyraMachine.space.identity);
         }));
     });
 
     describe('#get()', () => {
-      it('returns space info', () => spock.webex.internal.lyra.space.get(lyraMachine.space)
-        .then((lyraSpace) => assert.deepEqual(lyraMachine.space.identity, lyraSpace.identity)));
+      it('returns space info', () =>
+        spock.webex.internal.lyra.space
+          .get(lyraMachine.space)
+          .then((lyraSpace) => assert.deepEqual(lyraMachine.space.identity, lyraSpace.identity)));
     });
 
     describe('#join()', () => {
-      it('adds the current user to lyra space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
-        .then((lyraSpace) => {
-          assert.lengthOf(lyraSpace.occupants.items, 1);
-          assert.equal(lyraSpace.occupants.items[0].identity.id, spock.id);
-        }));
+      it('adds the current user to lyra space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
+          .then((lyraSpace) => {
+            assert.lengthOf(lyraSpace.occupants.items, 1);
+            assert.equal(lyraSpace.occupants.items[0].identity.id, spock.id);
+          }));
     });
 
     describe('#leave()', () => {
-      it('removes the current user from lyra space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => spock.webex.internal.lyra.space.leave(lyraSpace))
-        .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
-        .then((lyraSpace) => assert.lengthOf(lyraSpace.occupants.items, 0)));
+      it('removes the current user from lyra space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() => spock.webex.internal.lyra.space.leave(lyraSpace))
+          .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
+          .then((lyraSpace) => assert.lengthOf(lyraSpace.occupants.items, 0)));
 
       describe('when a user has multiple devices in the space', () => {
         before('add another device', () => {
           spock.webex2 = new WebexCore({
             credentials: {
-              authorization: spock.token
-            }
+              authorization: spock.token,
+            },
           });
 
-          return spock.webex2.internal.device.register()
+          return spock.webex2.internal.device
+            .register()
             .then(() => spock.webex.internal.lyra.space.join(lyraSpace))
             .then(() => spock.webex2.internal.lyra.space.join(lyraSpace));
         });
 
-        it('removes all devices from lyra space', () => spock.webex.internal.lyra.space.leave(lyraSpace, {
-          removeAllDevices: true
-        })
-          .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
-          .then((lyraSpace) => assert.lengthOf(lyraSpace.occupants.items, 0)));
+        it('removes all devices from lyra space', () =>
+          spock.webex.internal.lyra.space
+            .leave(lyraSpace, {
+              removeAllDevices: true,
+            })
+            .then(() => lyraMachine.webex.internal.lyra.space.get(lyraMachine.space))
+            .then((lyraSpace) => assert.lengthOf(lyraSpace.occupants.items, 0)));
       });
     });
 
-
     // Skip until we can bind a conversation to lyra space by posting capabilities to Lyra.
 
     describe.skip('#bindConversation()', () => {
-      before('ensure participant joined space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id))
-        .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation)));
-
-      after('remove binding', () => spock.webex.internal.lyra.space.unbindConversation(lyraSpace, conversation)
-        // After hooks shouldn't be able to break tests
-        .catch((err) => console.error(err)));
-
-      it('binds conversation and lyra space', () => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space)
-        .then(({bindings}) => {
+      before('ensure participant joined space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() =>
+            lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id)
+          )
+          .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
+      );
+
+      after('remove binding', () =>
+        spock.webex.internal.lyra.space
+          .unbindConversation(lyraSpace, conversation)
+          // After hooks shouldn't be able to break tests
+          .catch((err) => console.error(err))
+      );
+
+      it('binds conversation and lyra space', () =>
+        spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space).then(({bindings}) => {
           assert.lengthOf(bindings, 1);
           assert.equal(bindings[0].conversationUrl, conversation.url);
         }));
     });
 
     describe.skip('#unbindConversation()', () => {
-      before('ensure participant joined space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id))
-        .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
-        .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
-        .then(({bindings}) => assert.lengthOf(bindings, 1)));
+      before('ensure participant joined space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() =>
+            lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id)
+          )
+          .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
+          .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
+          .then(({bindings}) => assert.lengthOf(bindings, 1))
+      );
 
       // Skip this feature in IE. We do not support it at this time.
-      (bowser.msie ? it.skip : it)('removes the binding between conversation and lyra space', () => spock.webex.internal.lyra.space.unbindConversation(lyraSpace, conversation)
-        .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
-        .then(({bindings}) => assert.lengthOf(bindings, 0)));
+      (bowser.msie ? it.skip : it)('removes the binding between conversation and lyra space', () =>
+        spock.webex.internal.lyra.space
+          .unbindConversation(lyraSpace, conversation)
+          .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
+          .then(({bindings}) => assert.lengthOf(bindings, 0))
+      );
     });
 
     describe.skip('#deleteBinding()', () => {
       let bindingId;
 
-      before('ensure participant joined space', () => spock.webex.internal.lyra.space.join(lyraSpace)
-        .then(() => lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id))
-        .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
-        .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
-        .then(({bindings}) => {
-          assert.lengthOf(bindings, 1);
-          bindingId = bindings[0].bindingUrl.split('/').pop();
-        }));
+      before('ensure participant joined space', () =>
+        spock.webex.internal.lyra.space
+          .join(lyraSpace)
+          .then(() =>
+            lyraMachine.webex.internal.lyra.space.verifyOccupant(lyraMachine.space, spock.id)
+          )
+          .then(() => spock.webex.internal.lyra.space.bindConversation(lyraSpace, conversation))
+          .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
+          .then(({bindings}) => {
+            assert.lengthOf(bindings, 1);
+            bindingId = bindings[0].bindingUrl.split('/').pop();
+          })
+      );
 
       // Skip this feature in IE. We do not support it at this time.
-      (bowser.msie ? it.skip : it)('removes the binding between conversation and lyra space', () => spock.webex.internal.lyra.space.deleteBinding(lyraMachine.space, {kmsResourceObjectUrl: conversation.kmsResourceObjectUrl, bindingId})
-        .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
-        .then(({bindings}) => assert.lengthOf(bindings, 0)));
+      (bowser.msie ? it.skip : it)('removes the binding between conversation and lyra space', () =>
+        spock.webex.internal.lyra.space
+          .deleteBinding(lyraMachine.space, {
+            kmsResourceObjectUrl: conversation.kmsResourceObjectUrl,
+            bindingId,
+          })
+          .then(() => spock.webex.internal.lyra.space.getCurrentBindings(lyraMachine.space))
+          .then(({bindings}) => assert.lengthOf(bindings, 0))
+      );
     });
   });
 });

package/test/unit/spec/device.js

@@ -12,9 +12,9 @@ describe('plugin-lyra', () => {
   const lyraSpaceUrl = `https://lyra/api/v1/${lyraSpaceId}`;
   const lyraSpace = {
     identity: {
-      id: lyraSpaceId
+      id: lyraSpaceId,
     },
-    url: lyraSpaceUrl
+    url: lyraSpaceUrl,
   };
 
   let webex;
@@ -22,12 +22,12 @@ describe('plugin-lyra', () => {
   before(() => {
     webex = new MockWebex({
       children: {
-        lyra: Lyra
+        lyra: Lyra,
       },
       device: {
         url: 'deviceUrl',
-        userId: '1234'
-      }
+        userId: '1234',
+      },
     });
 
     webex.config.lyra = lyraConfig.lyra;
@@ -39,19 +39,26 @@ describe('plugin-lyra', () => {
 
   describe('device', () => {
     describe('#putAudioState', () => {
-      it('requires audioState.deviceUrl', () => assert.isRejected(webex.internal.lyra.device.putAudioState(lyraSpace), /audioState.deviceUrl is required/));
+      it('requires audioState.deviceUrl', () =>
+        assert.isRejected(
+          webex.internal.lyra.device.putAudioState(lyraSpace),
+          /audioState.deviceUrl is required/
+        ));
     });
 
     describe('#setVolume', () => {
-      it('defaults to level 0', () => webex.internal.lyra.device.setVolume(lyraSpace)
-        .then(() => {
-          assert.calledWith(webex.request, sinon.match({
-            method: 'POST',
-            uri: `${lyraSpace.url}/audio/volume/actions/set/invoke`,
-            body: {
-              level: 0
-            }
-          }));
+      it('defaults to level 0', () =>
+        webex.internal.lyra.device.setVolume(lyraSpace).then(() => {
+          assert.calledWith(
+            webex.request,
+            sinon.match({
+              method: 'POST',
+              uri: `${lyraSpace.url}/audio/volume/actions/set/invoke`,
+              body: {
+                level: 0,
+              },
+            })
+          );
         }));
     });
   });

package/test/unit/spec/lyra.js

@@ -13,8 +13,8 @@ describe('plugin-lyra', () => {
   before(() => {
     webex = new MockWebex({
       children: {
-        lyra: Lyra
-      }
+        lyra: Lyra,
+      },
     });
 
     webex.config.lyra = lyraConfig.lyra;
@@ -26,15 +26,20 @@ describe('plugin-lyra', () => {
 
   describe('lyra', () => {
     describe('#getAdvertisedEndpoint()', () => {
-      it('sends GET request to proximity', () => webex.internal.lyra.getAdvertisedEndpoint('token')
-        .then(() => assert.calledWith(webex.request, sinon.match({
-          method: 'GET',
-          api: 'proximity',
-          resource: '/ultrasound/advertisements',
-          qs: {
-            token: 'token'
-          }
-        }))));
+      it('sends GET request to proximity', () =>
+        webex.internal.lyra.getAdvertisedEndpoint('token').then(() =>
+          assert.calledWith(
+            webex.request,
+            sinon.match({
+              method: 'GET',
+              api: 'proximity',
+              resource: '/ultrasound/advertisements',
+              qs: {
+                token: 'token',
+              },
+            })
+          )
+        ));
     });
   });
 });