Skip to content

Fix BLE disconnect crash and event listener leaks #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
makermelissa-piclaw wants to merge 1 commit into
base: beta
Choose a base branch
from
Open

Fix BLE disconnect crash and event listener leaks #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions js/workflows/ble.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ class BLEWorkflow extends Workflow {
{reconnect: false, request: true},
{reconnect: true, request: true},
];

// Store bound event handlers so they can be properly removed
this._boundOnDisconnected = this.onDisconnected.bind(this);
this._boundOnSerialReceive = this.onSerialReceive.bind(this);
}

// This is called when a user clicks the main disconnect button
Expand Down Expand Up @@ -102,8 +106,8 @@ class BLEWorkflow extends Workflow {
this.rxCharacteristic = await this.serialService.getCharacteristic(bleNusCharRXUUID);

// Remove any existing event listeners to prevent multiple reads
this.txCharacteristic.removeEventListener('characteristicvaluechanged', this.onSerialReceive.bind(this));
this.txCharacteristic.addEventListener('characteristicvaluechanged', this.onSerialReceive.bind(this));
this.txCharacteristic.removeEventListener('characteristicvaluechanged', this._boundOnSerialReceive);
this.txCharacteristic.addEventListener('characteristicvaluechanged', this._boundOnSerialReceive);
await this.txCharacteristic.startNotifications();
return true;
} catch (e) {
Expand Down Expand Up @@ -144,7 +148,12 @@ class BLEWorkflow extends Workflow {
async connectToBluetoothDevice(device) {
const abortController = new AbortController();

async function onAdvertisementReceived(event) {
// Remove previous advertisement listener if one was stored
if (this._boundOnAdvertisementReceived) {
device.removeEventListener('advertisementreceived', this._boundOnAdvertisementReceived);
}

this._boundOnAdvertisementReceived = (async function onAdvertisementReceived(event) {
console.log('> Received advertisement from "' + device.name + '"...');
// Stop watching advertisements to conserve battery life.
abortController.abort();
Expand All @@ -164,10 +173,9 @@ class BLEWorkflow extends Workflow {
} else {
console.log('Unable to connect to bluetooth device "' + device.name + '.');
}
}
}).bind(this);

device.removeEventListener('advertisementreceived', onAdvertisementReceived.bind(this));
device.addEventListener('advertisementreceived', onAdvertisementReceived.bind(this));
device.addEventListener('advertisementreceived', this._boundOnAdvertisementReceived);

this.debugLog("Attempting to connect to " + device.name + "...");
try {
Expand Down Expand Up @@ -199,8 +207,8 @@ class BLEWorkflow extends Workflow {

async switchToDevice(device) {
this.bleDevice = device;
this.bleDevice.removeEventListener("gattserverdisconnected", this.onDisconnected.bind(this));
this.bleDevice.addEventListener("gattserverdisconnected", this.onDisconnected.bind(this));
this.bleDevice.removeEventListener("gattserverdisconnected", this._boundOnDisconnected);
this.bleDevice.addEventListener("gattserverdisconnected", this._boundOnDisconnected);
console.log("connected", this.bleServer);

try {
Expand Down Expand Up @@ -267,7 +275,9 @@ class BLEWorkflow extends Workflow {

updateConnected(connectionState) {
super.updateConnected(connectionState);
this.connectionStep(2);
if (this.connectDialog && this.connectDialog.isOpen()) {
this.connectionStep(2);
}
}

async available() {
Expand Down