Skip to content

Commit

Permalink
fix(bluetooth): improve adapter state handling
Browse files Browse the repository at this point in the history 
The async code is waited for where needed and the locks prevent an
adapter from being re-locked.

Closes #316, closes #302
  • Loading branch information
@mKeRix
mKeRix committed Oct 26, 2020
1 parent e2fac58 commit 7a8fa44
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 43 deletions.
9 changes: 0 additions & 9 deletions package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion package.json
View file
Expand Up @@ -83,7 +83,6 @@
"@types/lodash": "^4.14.162",
"@types/mathjs": "^6.0.5",
"@types/mdns": "0.0.33",
"@types/noble": "0.0.40",
"@types/node": "^12.12.68",
"@types/supertest": "^2.0.10",
"@typescript-eslint/eslint-plugin": "^4.4.1",
Expand Down
52 changes: 30 additions & 22 deletions src/integrations/bluetooth/bluetooth.service.spec.ts
View file
Expand Up @@ -2,7 +2,7 @@ const mockExec = jest.fn();
const mockNoble = {
state: 'poweredOn',
on: jest.fn(),
startScanning: jest.fn(),
startScanningAsync: jest.fn(),
stopScanning: jest.fn(),
};
jest.mock(
Expand Down Expand Up @@ -46,35 +46,43 @@ describe('BluetoothService', () => {
});

describe('Bluetooth Classic', () => {
it('should return measured RSSI value from command output', () => {
it('should return measured RSSI value from command output', async () => {
mockExec.mockResolvedValue({ stdout: 'RSSI return value: -4' });

const address = '77:50:fb:4d:ab:70';

expect(service.inquireClassicRssi(1, address)).resolves.toBe(-4);
expect(await service.inquireClassicRssi(1, address)).toBe(-4);
expect(mockExec).toHaveBeenCalledWith(
`hcitool -i hci1 cc \"${address}\" && hcitool -i hci1 rssi \"${address}\"`,
expect.anything()
);
});

it('should return undefined if no RSSI could be determined', () => {
it('should return undefined if no RSSI could be determined', async () => {
mockExec.mockResolvedValue({
stdout: "Can't create connection: Input/output error",
stderr: 'Not connected.',
});

expect(
service.inquireClassicRssi(0, '08:05:90:ed:3b:60')
).resolves.toBeUndefined();
await service.inquireClassicRssi(0, '08:05:90:ed:3b:60')
).toBeUndefined();
});

it('should return undefined if the command failed', () => {
it('should return undefined if the command failed', async () => {
mockExec.mockRejectedValue({ message: 'Command failed' });

expect(
service.inquireClassicRssi(0, '08:05:90:ed:3b:60')
).resolves.toBeUndefined();
await service.inquireClassicRssi(0, '08:05:90:ed:3b:60')
).toBeUndefined();
});

it('should throw an exception if an inquiry is requested for a locked adapter', async () => {
await service.lockAdapter(1);

await expect(
service.inquireClassicRssi(1, '77:50:fb:4d:ab:71')
).rejects.toThrow();
});

it('should reset the HCI device if the query took too long', async () => {
Expand All @@ -85,18 +93,18 @@ describe('BluetoothService', () => {
expect(mockExec).toHaveBeenCalledWith('hciconfig hci1 reset');
});

it('should stop scanning on an adapter while performing an inquiry', () => {
it('should stop scanning on an adapter while performing an inquiry', async () => {
service.onLowEnergyDiscovery(() => undefined);
const stateChangeHandler = mockNoble.on.mock.calls[0][1];
stateChangeHandler('poweredOn');
await stateChangeHandler('poweredOn');

expect(mockNoble.startScanning).toHaveBeenCalledTimes(1);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(1);

let execResolve;
const execPromise = new Promise((r) => (execResolve = r));
mockExec.mockReturnValue(execPromise);
const inquirePromise = service.inquireClassicRssi(0, 'x').then(() => {
expect(mockNoble.startScanning).toHaveBeenCalledTimes(2);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(2);
});

expect(mockNoble.stopScanning).toHaveBeenCalledTimes(1);
Expand All @@ -114,23 +122,23 @@ describe('BluetoothService', () => {
mockExec.mockRejectedValue({ stderr: 'error' });
await service.inquireClassicRssi(0, 'x');

expect(mockNoble.startScanning).toHaveBeenCalledTimes(2);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(2);
});

it('should stop scanning on an adapter while getting Classic device info', () => {
it('should stop scanning on an adapter while getting Classic device info', async () => {
service.onLowEnergyDiscovery(() => undefined);
const stateChangeHandler = mockNoble.on.mock.calls[0][1];
stateChangeHandler('poweredOn');
await stateChangeHandler('poweredOn');

expect(mockNoble.startScanning).toHaveBeenCalledTimes(1);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(1);

let execResolve;
const execPromise = new Promise((r) => (execResolve = r));
mockExec.mockReturnValue(execPromise);
const inquirePromise = service
.inquireClassicDeviceInfo(0, 'x')
.then(() => {
expect(mockNoble.startScanning).toHaveBeenCalledTimes(2);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(2);
});

expect(mockNoble.stopScanning).toHaveBeenCalledTimes(1);
Expand Down Expand Up @@ -247,7 +255,7 @@ Requesting information ...

stateChangeHandler('poweredOn');

expect(mockNoble.startScanning).toHaveBeenCalledTimes(1);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(1);
});

it('should not enable scanning when the adapter is performing a Classic inquiry', () => {
Expand All @@ -258,12 +266,12 @@ Requesting information ...
const execPromise = new Promise((r) => (execResolve = r));
mockExec.mockReturnValue(execPromise);
const inquirePromise = service.inquireClassicRssi(0, 'x').then(() => {
expect(mockNoble.startScanning).toHaveBeenCalledTimes(1);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(1);
});

stateChangeHandler('poweredOn');

expect(mockNoble.startScanning).not.toHaveBeenCalled();
expect(mockNoble.startScanningAsync).not.toHaveBeenCalled();

execResolve({ stdout: '-1' });

Expand All @@ -279,7 +287,7 @@ Requesting information ...
mockExec.mockReturnValue(execPromise);
await service.inquireClassicRssi(1, 'x');

expect(mockNoble.startScanning).toHaveBeenCalledTimes(1);
expect(mockNoble.startScanningAsync).toHaveBeenCalledTimes(1);
expect(mockNoble.stopScanning).not.toHaveBeenCalled();
});
});
Expand Down
25 changes: 15 additions & 10 deletions src/integrations/bluetooth/bluetooth.service.ts
View file
Expand Up @@ -51,7 +51,7 @@ export class BluetoothService {
adapterId: number,
address: string
): Promise<number> {
this.lockAdapter(adapterId);
await this.lockAdapter(adapterId);

this.logger.debug(`Querying for RSSI of ${address} using hcitool`);
try {
Expand Down Expand Up @@ -105,7 +105,7 @@ export class BluetoothService {
adapterId: number,
address: string
): Promise<Device> {
this.lockAdapter(adapterId);
await this.lockAdapter(adapterId);

try {
const output = await execPromise(
Expand Down Expand Up @@ -149,9 +149,14 @@ export class BluetoothService {
*
* @param adapterId - HCI Device ID of the adapter to lock
*/
protected lockAdapter(adapterId: number): void {
if (this.adapterStates.get(adapterId) == 'scan') {
noble.stopScanning();
async lockAdapter(adapterId: number): Promise<void> {
switch (this.adapterStates.get(adapterId)) {
case 'inquiry':
throw new Error(
`Trying to lock adapter ${adapterId} even though it is already locked`
);
case 'scan':
noble.stopScanning();
}

this.adapterStates.set(adapterId, 'inquiry');
Expand All @@ -162,11 +167,11 @@ export class BluetoothService {
*
* @param adapterId - HCI Device ID of the adapter to unlock
*/
protected unlockAdapter(adapterId: number): void {
async unlockAdapter(adapterId: number): Promise<void> {
this.adapterStates.set(adapterId, 'inactive');

if (adapterId == this.lowEnergyAdapterId) {
this.handleAdapterStateChange(noble.state);
await this.handleAdapterStateChange(noble.state);
}
}

Expand All @@ -191,13 +196,13 @@ export class BluetoothService {
*
* @param state - State of the HCI adapter
*/
private handleAdapterStateChange(state: string): void {
private async handleAdapterStateChange(state: string): Promise<void> {
if (this.adapterStates.get(this.lowEnergyAdapterId) != 'inquiry') {
if (state === 'poweredOn') {
noble.startScanning([], true);
await noble.startScanningAsync([], true);
this.adapterStates.set(this.lowEnergyAdapterId, 'scan');
} else {
noble.stopScanning();
await noble.stopScanning();
this.adapterStates.set(this.lowEnergyAdapterId, 'inactive');
}
}
Expand Down
1 change: 0 additions & 1 deletion tsconfig.json
View file
Expand Up @@ -12,7 +12,6 @@
"outDir": "./dist",
"baseUrl": "./",
"paths": {
"@abandonware/noble": ["node_modules/@types/noble"],
"democracy": ["typings/democracy"]
},
"incremental": true
Expand Down

0 comments on commit 7a8fa44

Please sign in to comment.