Merge branch 'device-listener-cleanup-v2' into match-and-event-leak-f…

…ixes-v2

src/Adapter.js

@@ -109,6 +109,8 @@ class Adapter {
 
   /**
    * Init a device instance and returns it.
+   * Caller is responsible of calling cleanup() on the
+   * returned Device before discarding it to free resources.
    * @param {string} uuid - Device Name.
    * @async
    * @returns {Device}

src/BusHelper.js

@@ -97,6 +97,14 @@ class BusHelper extends EventEmitter {
     return this._ifaceProxy[methodName](...args)
   }
 
+  removeListeners () {
+    this.removeAllListeners('PropertiesChanged')
+    if (this._propsProxy !== null) {
+      this._propsProxy.removeAllListeners('PropertiesChanged')
+      this._ready = false
+    }
+  }
+
   static buildChildren (path, nodes) {
     if (path === '/') path = ''
     const children = new Set()

src/Device.js

@@ -119,7 +119,7 @@ class Device extends EventEmitter {
    */
   async disconnect () {
     await this.helper.callMethod('Disconnect')
-    this.helper.removeAllListeners('PropertiesChanged') // might be improved
+    await this.cleanup()
   }
 
   /**
@@ -142,6 +142,13 @@ class Device extends EventEmitter {
 
     return `${name} [${address}]`
   }
+
+  /**
+   * Cleanup when discarding device object
+   */
+  async cleanup () {
+    this.helper.removeListeners()
+  }
 }
 
 /**

src/index.d.ts

@@ -45,6 +45,7 @@ declare namespace NodeBle {
         disconnect(): Promise<void>;
         gatt(): Promise<GattServer>;
         toString(): Promise<string>;
+        cleanup(): Promise<void>;
 
         on(event: 'connect', listener: (state: ConnectionState) => void): this;
         on(event: 'disconnect', listener: (state: ConnectionState) => void): this;

test/BusHelper.spec.js

@@ -125,3 +125,31 @@ test('propsEvents', async () => {
   await helper.set('VirtualProperty', buildTypedValue('string', 'bar'))
   await expect(res).resolves.toMatchObject({ VirtualProperty: { signature: 's', value: 'bar' } })
 })
+
+test('removeListeners', async () => {
+  const helper = new BusHelper(dbus, TEST_NAME, TEST_OBJECT, TEST_IFACE, { useProps: true, usePropsEvents: true })
+
+  const dummyCb = () => {}
+
+  // Init with listener on helper (directly attached dummyCb) and _propsProxy (through method call triggered _prepare)
+  helper.on('PropertiesChanged', dummyCb)
+  await helper.callMethod('Echo', 'ping')
+  expect(helper.listenerCount('PropertiesChanged')).toBeGreaterThan(0)
+  expect(helper._propsProxy.listenerCount('PropertiesChanged')).toBeGreaterThan(0)
+
+  // Test remove
+  helper.removeListeners()
+  expect(helper.listenerCount('PropertiesChanged')).toBe(0)
+  expect(helper._propsProxy.listenerCount('PropertiesChanged')).toBe(0)
+
+  // Test reuse after remove (same initialization as before)
+  helper.on('PropertiesChanged', dummyCb)
+  await helper.callMethod('Echo', 'ping')
+  expect(helper.listenerCount('PropertiesChanged')).toBeGreaterThan(0)
+  expect(helper._propsProxy.listenerCount('PropertiesChanged')).toBeGreaterThan(0)
+
+  // Remove second time
+  helper.removeListeners()
+  expect(helper.listenerCount('PropertiesChanged')).toBe(0)
+  expect(helper._propsProxy.listenerCount('PropertiesChanged')).toBe(0)
+})

test/Device.spec.js

@@ -13,6 +13,7 @@ jest.doMock('../src/BusHelper', () => {
       this.waitPropChange = jest.fn()
       this.children = jest.fn()
       this.callMethod = jest.fn()
+      this.removeListeners = jest.fn()
     }
   }
 })