Release v2.5.1 (#109)

* Prep v2.4.5 and merging master back into develop

* no-jira nullify active conversationId upon disconnect (#100)

* no-jira nullify active conversationId upon disconnect

* no-jira added in unit test coverage for new line

* CyberAcoustics first pull request (#94)

* CyberAcoustics first pull request

* Fixed various codacy warnings

* fixed more codacy warnings

* Fixed even more codacy warnings

* More codacy warnings fixed.  There are some bogus
warnings which will not be addressed.

* fixed bug: double notifications from device
sometimes, added Timeout when requesting WebHIDPermissions

* Added logging message to detect multiple
EventListeners on device input reports.

* added code to deal with occasional unstable button
presses on the device.

* no-jira tweaking gitignores and dependencies

* no-jira code cleanup and removal of trailing spaces; updated unit tests

---------

Co-authored-by: Steve V <sverity77@gmail.com>
Co-authored-by: maxwellmooney13 <83785824+maxwellmooney13@users.noreply.github.com>

* Updating to standard MIT license

* Updating to standard MIT license

* Updating to standard MIT license

* Updating to standard MIT license

* Updating to standard MIT license

* Updating to standard MIT license

* Updating to standard MIT license

* [STREAM-4] Update team name and mailing list (#105)

* HID - Filter with specific vendor and product id (#104)

* HID - Request specific devices per vendor id

* HID - Filter with selected productId if possible

* Fixed string to hex issue

* Fix when label does not contain the productId

* [STREAM-44] Add `jiraProjectKey` (#107)

* [STREAM-73] [STREAM-74] fixes for Jabra (constant webhid modal) and Sennheiser/EPOS (new call starts muted) (#108)

* [STREAM-73] [STREAM-74] - added in fixes for Jabra and Sennheiser/EPOS issues that have come up recently; testing still required

* [STREAM-73] [STREAM-74] - unit tests

* [STREAM-73] [STREAM-74] - attempting dep fix

* [STREAM-73] [STREAM-74] - adjust files for linting purposes

* [STREAM-73] [STREAM-74] - addressing PR comments

* 2.5.0

* 2.5.1

* [STREAM-73] [STREAM-74] - update changelog

* no-jira release prep

---------

Co-authored-by: PureCloud Jenkins <jenkins@genesys.com>
Co-authored-by: sverity77 <fxworks@fxworks.com>
Co-authored-by: Steve V <sverity77@gmail.com>
Co-authored-by: Genesys Developer Evangelists <developerevangelists@genesys.com>
Co-authored-by: Jon Hjelle <hjon@users.noreply.github.com>
Co-authored-by: Angelos Fasoulis <22166661+Draginfable@users.noreply.github.com>

Author: 7 people

.gitignore

@@ -6,3 +6,4 @@ dist
 coverage/
 tmp/
 softphone-vendor-headsets*.tgz
+.history/

Jenkinsfile

@@ -25,8 +25,9 @@ def getBuildType = {
 
 webappPipeline {
     projectName = 'vendor-headsets'
-    team = 'Genesys Client Media (WebRTC)'
-    mailer = 'genesyscloud-client-media@genesys.com'
+    team = 'Client Streaming and Signaling'
+    jiraProjectKey = 'STREAM'
+    mailer = 'GcMediaStreamSignal@genesys.com'
     chatGroupId = '763fcc91-e530-4ed7-b318-03f525a077f6'
 
     nodeVersion = '14.x'

changelog.md

@@ -3,7 +3,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keepa Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# [Unreleased](https://github.com/purecloudlabs/softphone-vendor-headsets/compare/v2.5.0...HEAD)
+# [Unreleased](https://github.com/purecloudlabs/softphone-vendor-headsets/compare/v2.5.1...HEAD)
+
+# [v2.5.1](https://github.com/purecloudlabs/softphone-vendor-headsets/compare/v2.5.0...v2.5.1)
+## Fixed
+* [STREAM-73](https://inindca.atlassian.net/browse/STREAM-73) - fix for issue where Sennheiser/EPOS devices maintained a mute state when starting a new call
+* [STREAM-74](https://inindca.atlassian.net/browse/STREAM-73) - fix for issue where the WebHID permission modal popped up constantly for Jabra
 
 # [v2.5.0](https://github.com/purecloudlabs/softphone-vendor-headsets/compare/v2.4.5...v2.5.0)
 ## Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "softphone-vendor-headsets",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "author": "Genesys",
   "license": "MIT",
   "cjs": "dist/cjs/src/library/index.js",

package.json

@@ -30,7 +30,7 @@ export default class HeadsetService {
   cyberAcoustics: VendorImplementation;
   selectedImplementation: VendorImplementation;
   headsetEvents$: Observable<ConsumedHeadsetEvents>;
-  
+
   private headsetConversationStates: { [conversationId: string]: HeadsetStateRecord } = {};
   private _headsetEvents$: Subject<ConsumedHeadsetEvents>;
   private logger: any;

react-app/package-lock.json

@@ -163,11 +163,14 @@ export default class CyberAcousticsService extends VendorImplementation {
           const HIDPermissionTimeout = setTimeout(reject, 30000);
           this.requestWebHidPermissions(async () => {
             this.logger.debug("Requesting web HID permissions");
+            const productId = this.deductProductId(originalDeviceLabel);
+
             const devList = await (window.navigator as any).hid.requestDevice({
               filters: [
                 {
                   vendorId: 0x3391,
                   //vendorId: 0x046D,
+                  productId: productId || undefined
                 },
               ],
             });

react-app/src/library/services/headset.ts

@@ -63,13 +63,9 @@ const initializeSdk = async (subject?: Subject<IDevice[]>) => {
 
 describe('JabraService', () => {
   let jabraService: JabraService;
-  Object.defineProperty(window.navigator, 'hid', {
-    get: () => ({
-      getDevices: () => {
-        return [];
-      },
-    }),
-  });
+  (window.navigator as any) = { ...(window.navigator as any), hid: {
+    getDevices: jest.fn().mockResolvedValue([])
+  } };
   Object.defineProperty(window.navigator, 'locks', { get: () => ({}) });
   (window as any).BroadcastChannel = BroadcastChannel;
 
@@ -163,6 +159,7 @@ describe('JabraService', () => {
     it('should connect with previouslyConnectedDevice', async () => {
       const statusChangeSpy = jest.spyOn(jabraService, 'changeConnectionStatus');
       jest.spyOn(jabraService, 'getPreviouslyConnectedDevice').mockResolvedValue(mockDevice2 as any);
+      jest.spyOn(jabraService, 'deviceHasPermissions').mockResolvedValue(true);
 
       const callControl = createMockCallControl(new Subject<ICallControlSignal>().asObservable());
       jest
@@ -173,10 +170,36 @@ describe('JabraService', () => {
           },
         } as any);
 
+
       await jabraService.connect(mockDevice2.name);
       expect(statusChangeSpy).toHaveBeenCalledWith({ isConnected: true, isConnecting: false });
     });
 
+    it('should attempt to connect with previouslyConnectedDevice but timeout', async () => {
+      const statusChangeSpy = jest.spyOn(jabraService, 'changeConnectionStatus');
+      const resetHeadsetSpy = jest.spyOn(jabraService, 'resetHeadsetState');
+      const processEventsSpy = jest.spyOn(jabraService, '_processEvents');
+      const callControl = createMockCallControl(new Subject<ICallControlSignal>().asObservable());
+      jest
+        .spyOn(jabraService, 'createCallControlFactory')
+        .mockReturnValue({
+          createCallControl: async () => {
+            return callControl;
+          },
+        } as any);
+      jest.useFakeTimers();
+      jest.spyOn(jabraService,'deviceHasPermissions').mockResolvedValue(true);
+      await jabraService.connect(mockDevice2.name);
+
+      await flushPromises();
+
+      jest.advanceTimersByTime(15005);
+
+      expect(statusChangeSpy).toHaveBeenCalledWith({ isConnected: false, isConnecting: false });
+      expect(resetHeadsetSpy).not.toHaveBeenCalled();
+      expect(processEventsSpy).not.toHaveBeenCalled();
+    });
+
     it('should connect with webhidRequest', async () => {
       const statusChangeSpy = jest.spyOn(jabraService, 'changeConnectionStatus');
       jest.spyOn(jabraService, 'getPreviouslyConnectedDevice').mockResolvedValue(null);
@@ -1379,7 +1402,21 @@ describe('JabraService', () => {
       await expect(devicePromise).rejects.toThrow('random error');
     });
   });
-  
+
+  describe('deviceHasPermissions', () => {
+    Object.defineProperty(window.navigator, 'hid', {
+      get: () => ({
+        getDevices: () => { return [{ productName: 'test-device' } as any]; }
+      })
+    });
+    it('should return true if passed in label exists in getDevices', async () => {
+      const deviceHasPermissions = await jabraService.deviceHasPermissions('test-device');
+      await flushPromises();
+
+      expect(deviceHasPermissions).toBe(true);
+    });
+  });
+
   describe('getPreviouslyConnectedDevice', () => {
     afterEach(() => {
       jest.useRealTimers();
@@ -1425,22 +1462,6 @@ describe('JabraService', () => {
       expect(device).toBeNull();
     });
 
-    it('should timeout after 3 seconds', async () => {
-      jest.useFakeTimers();
-
-      const sub = new BehaviorSubject([]);
-      jabraService.jabraSdk = await initializeSdk(sub as any) as any;
-
-      const devicePromise = jabraService.getPreviouslyConnectedDevice(mockDevice2.name);
-
-      await flushPromises();
-
-      jest.advanceTimersByTime(3100);
-
-      const device = await devicePromise;
-      expect(device).toBeFalsy();
-    });
-
     it('should log random error', async () => {
       const sub = new BehaviorSubject([]);
       jabraService.jabraSdk = await initializeSdk(sub as any) as any;

react-app/src/library/services/vendor-implementations/CyberAcoustics/CyberAcoustics.ts

@@ -347,8 +347,16 @@ export default class JabraService extends VendorImplementation {
 
     this._deviceInfo = null;
 
-    let selectedDevice = await this.getPreviouslyConnectedDevice(deviceLabel);
-    if (!selectedDevice) {
+    let selectedDevice;
+    if (await this.deviceHasPermissions(deviceLabel)) {
+      selectedDevice = await this.getPreviouslyConnectedDevice(deviceLabel);
+
+      if (!selectedDevice) {
+        console.warn('Unable to find appropriate device. Setting state to "Not Running" to allow a retry"', deviceLabel);
+        this.changeConnectionStatus({ isConnected: false, isConnecting: false });
+        return;
+      }
+    } else {
       try {
         selectedDevice = await this.getDeviceFromWebhid(deviceLabel);
       } catch (e) {
@@ -370,16 +378,26 @@ export default class JabraService extends VendorImplementation {
     this.changeConnectionStatus({ isConnected: true, isConnecting: false });
   }
 
+  async deviceHasPermissions (deviceLabel: string): Promise<boolean> {
+    const allowedHIDDevices = await (window.navigator as any).hid.getDevices();
+    let deviceFound = false;
+    allowedHIDDevices.forEach(device => {
+      if (deviceLabel.includes(device?.productName?.toLowerCase())) {
+        deviceFound = true;
+      }
+    });
+    return deviceFound;
+  }
+
   async getPreviouslyConnectedDevice (deviceLabel: string): Promise<IDevice> {
-    // we want to wait for up to 2 events or timeout after 2 seconds
     const waitForDevice: Observable<IDevice> = this.jabraSdk.deviceList.pipe(
       defaultIfEmpty(null),
       first((devices: IDevice[]) => !!devices.length),
       map((devices: IDevice[]) =>
         devices.find((device) => this.isDeviceInList(device, deviceLabel))
       ),
       filter((device) => !!device),
-      timeout(3000)
+      timeout(15000)
     );
 
     return firstValueFrom(waitForDevice).catch((err) => {
@@ -445,7 +463,7 @@ export default class JabraService extends VendorImplementation {
       this.callControl.releaseCallLock();
     } catch (e) {
       this.logger.warn('Failed to takeCallLock in order to resetHeadsetState. Ignoring reset.');
-    } 
+    }
   }
 
   async disconnect (): Promise<void> {

react-app/src/library/services/vendor-implementations/jabra/jabra.test.ts

@@ -383,11 +383,45 @@ describe('SennheiserService', () => {
         EventType: SennheiserEventTypes.Request,
         CallID: conversationId
       };
+      const expectedHoldPayload: SennheiserPayload = {
+        Event: SennheiserEvents.Resume,
+        EventType: SennheiserEventTypes.Request
+      };
+      const expectedMutePayload: SennheiserPayload = {
+        Event: SennheiserEvents.UnmuteFromApp,
+        EventType: SennheiserEventTypes.Request
+      };
 
-      await sennheiserService.endCall(conversationId);
+      await sennheiserService.endCall(conversationId, true);
 
       expect(sennheiserService._sendMessage).toHaveBeenCalledWith(expectedPayload);
+      expect(sennheiserService._sendMessage).not.toHaveBeenCalledWith(expectedHoldPayload);
+      expect(sennheiserService._sendMessage).not.toHaveBeenCalledWith(expectedMutePayload);
     });
+
+    it('should reset state for mute and hold when there are no other active calls', async () => {
+      jest.spyOn(sennheiserService, '_sendMessage');
+      const conversationId = '23f897b';
+      const expectedHoldPayload: SennheiserPayload = {
+        Event: SennheiserEvents.Resume,
+        EventType: SennheiserEventTypes.Request
+      };
+      const expectedMutePayload: SennheiserPayload = {
+        Event: SennheiserEvents.UnmuteFromApp,
+        EventType: SennheiserEventTypes.Request
+      };
+      const expectedEndPayload: SennheiserPayload = {
+        Event: SennheiserEvents.CallEnded,
+        EventType: SennheiserEventTypes.Request,
+        CallID: conversationId
+      };
+
+      await sennheiserService.endCall(conversationId, false);
+
+      expect(sennheiserService._sendMessage).toHaveBeenCalledWith(expectedHoldPayload);
+      expect(sennheiserService._sendMessage).toHaveBeenCalledWith(expectedMutePayload);
+      expect(sennheiserService._sendMessage).toHaveBeenCalledWith(expectedEndPayload);
+    })
   });
 
   describe('_handleMessage', () => {

react-app/src/library/services/vendor-implementations/jabra/jabra.ts

@@ -189,13 +189,22 @@ export default class SennheiserService extends VendorImplementation {
     return Promise.resolve();
   }
 
-  endCall (conversationId: string): Promise<void> {
+  endCall (conversationId: string, hasOtherActiveCalls?: boolean): Promise<void> {
+    if (!hasOtherActiveCalls) {
+      this._sendMessage({
+        Event: SennheiserEvents.Resume,
+        EventType: SennheiserEventTypes.Request
+      });
+      this._sendMessage({
+        Event: SennheiserEvents.UnmuteFromApp,
+        EventType: SennheiserEventTypes.Request,
+      });
+    }
     this._sendMessage({
       Event: SennheiserEvents.CallEnded,
       EventType: SennheiserEventTypes.Request,
       CallID: conversationId,
     });
-
     return Promise.resolve();
   }
 
@@ -237,7 +246,7 @@ export default class SennheiserService extends VendorImplementation {
         if (!this.isConnected || this.isConnecting) {
           this.changeConnectionStatus({ isConnected: true, isConnecting: false });
         }
-          
+
         this._sendMessage({
           Event: SennheiserEvents.SystemInformation,
           EventType: SennheiserEventTypes.Request,
@@ -285,6 +294,10 @@ export default class SennheiserService extends VendorImplementation {
         break;
       case SennheiserEvents.CallEnded:
         if (payload.EventType === SennheiserEventTypes.Notification) {
+          this._sendMessage({
+            Event: SennheiserEvents.UnmuteFromApp,
+            EventType: SennheiserEventTypes.Request,
+          });
           this.deviceEndedCall({ name: payload.Event, conversationId });
         }
         break;

react-app/src/library/services/vendor-implementations/sennheiser/sennheiser.test.ts

@@ -6,6 +6,7 @@ import { isCefHosted } from '../../../utils';
 
 const HEADSET_USAGE = 0x0005;
 const HEADSET_USAGE_PAGE = 0x000b;
+const VENDOR_ID = 0x340b;
 const BT100USeries = [0x0001];
 const CMEDIASeries = [0x0020, 0x0022];
 const DECTSeries = [0x0014];
@@ -110,7 +111,8 @@ export default class VBetService extends VendorImplementation {
         this.activeDevice = await new Promise((resolve, reject) => {
           const waiter = setTimeout(reject, 30000);
           this.requestWebHidPermissions(async () => {
-            const filters = [{ usage: HEADSET_USAGE, usagePage: HEADSET_USAGE_PAGE }];
+            const productId = this.deductProductId(originalDeviceLabel);
+            const filters = [{ usage: HEADSET_USAGE, usagePage: HEADSET_USAGE_PAGE, vendorId: VENDOR_ID, productId: productId || undefined }];
             await (window.navigator as any).hid.requestDevice({ filters });
             clearTimeout(waiter);
             const deviceList = await (window.navigator as any).hid.getDevices();
@@ -143,9 +145,9 @@ export default class VBetService extends VendorImplementation {
       }
     }
 
-   
+
     !this.activeDevice.opened && await this.activeDevice.open();
-    
+
 
     this.logger.debug(`device input reportId ${this.inputReportReportId}`);
     this.activeDevice.addEventListener('inputreport', (event: PartialInputReportEvent) => {
@@ -214,7 +216,7 @@ export default class VBetService extends VendorImplementation {
         await this.setMuteFromDevice(!this.isMuted);
         break;
       }
-    } 
+    }
     if (this.activeDevice.productId >= 0x0040 && this.activeDevice.productId <= 0x0083) {
       switch (value) {
       case 0x20:
@@ -323,7 +325,7 @@ export default class VBetService extends VendorImplementation {
         await this.sendOpToDevice('onHook');
       } else {
         this.logger.error('no call to be ended');
-      } 
+      }
     }
   }
 

react-app/src/library/services/vendor-implementations/sennheiser/sennheiser.ts

@@ -138,4 +138,16 @@ export abstract class VendorImplementation extends (EventEmitter as { new(): Str
     this.isConnecting = headsetState.isConnecting;
     this.emitEvent('deviceConnectionStatusChanged', { currentVendor: this, ...headsetState });
   }
+
+  /**
+   * Try to deduct the product id based on the label.
+   * Making the assumption that the label will end with (vendorid:productid).
+   *
+   * @param selectedMicLabel
+   * @returns The product id if matched or null.
+   */
+  deductProductId (selectedMicLabel: string) : number {
+    const match = selectedMicLabel?.match(/\((\w+):(\w+)\)$/);
+    return match ? parseInt(match[2], 16) : null;
+  }
 }