usb 1.8.1-libusb.4 → 1.9.0

package/CHANGELOG.md

@@ -0,0 +1,63 @@
+# Changelog
+
+## [1.9.0] - 2021-11-08
+
+### Changed
+- Changed libusb dependency to upstream v1.0.23 - [`453`](https://github.com/node-usb/node-usb/pull/453) ([Rob Moran](https://github.com/thegecko))
+
+## [1.8.1] - 2021-11-08
+
+### Added
+- Added functionality to ref/unref the hotplug events - [`455`](https://github.com/node-usb/node-usb/pull/455) ([Guilherme Francescon](https://github.com/gfcittolin))
+- Added CHANGELOG - [`454`](https://github.com/node-usb/node-usb/pull/454) ([Rob Moran](https://github.com/thegecko))
+
+### Fixed
+- Fixed delay when exiting program - [`455`](https://github.com/node-usb/node-usb/pull/455) ([Rob Moran](https://github.com/thegecko))
+
+## [1.8.0] - 2021-10-14
+
+### Added
+- Added prebuildify and GitHub action for native binaries - [`450`](https://github.com/node-usb/node-usb/pull/450) ([Rob Moran](https://github.com/thegecko))
+
+### Fixed
+- Fixed crash after wake on Windows when using Electron - [`451`](https://github.com/node-usb/node-usb/pull/451) ([Rob Moran](https://github.com/thegecko))
+- Fixed invalid initial refs - [`445`](https://github.com/node-usb/node-usb/pull/445) ([Alba Mendez](https://github.com/mildsunrise))
+
+### Changed
+- Changed GitHub organisation to [node-usb](https://github.com/node-usb) - [`447`](https://github.com/node-usb/node-usb/pull/447) ([Rob Moran](https://github.com/thegecko))
+
+## [1.7.2] - 2021-08-30
+
+### Fixed
+- Fixed crash when exiting on MacOS with Electron 9 - [`440`](https://github.com/node-usb/node-usb/pull/440) ([Daniel Main](https://github.com/danielmain))
+
+### Changed
+- **Breaking:** Changed minimum Node.js version to `10` - [`428`](https://github.com/node-usb/node-usb/pull/428) ([Rob Moran](https://github.com/thegecko))
+
+## [1.7.1] - 2021-05-08
+
+### Fixed
+- Fixed compiler warnings - [`419`](https://github.com/node-usb/node-usb/pull/419) ([Joel Purra](https://github.com/joelpurra))
+
+## [1.7.0] - 2021-04-10
+
+### Changed
+- Changed native support to use Node Addon API - [`399`](https://github.com/node-usb/node-usb/pull/399) ([Georg Vienna](https://github.com/geovie))
+
+## [1.6.5] - 2021-02-14
+
+### Changed
+- Changed prebuild for Electron 12 beta to nightly - [`410`](https://github.com/node-usb/node-usb/pull/410) ([Piotr Rogowski](https://github.com/karniv00l))
+
+### Removed
+- Removed `portNumbers` test on arm64 - [`408`](https://github.com/node-usb/node-usb/pull/408) ([Rob Moran](https://github.com/thegecko))
+
+## [1.6.4] - 2021-01-30
+
+### Added
+- Added prebuild for Electron 10 and 12 beta - [`407`](https://github.com/node-usb/node-usb/pull/407) ([Rob Moran](https://github.com/thegecko))
+- Added prebuild for Electron 9 - [`362`](https://github.com/node-usb/node-usb/pull/362) (Luke Whyte)
+
+### Changed
+- Changed to GitHub Actions for prebuild workflow - [`404`](https://github.com/node-usb/node-usb/pull/404) ([Rob Moran](https://github.com/thegecko))
+- Changed Node.js 13 prebuild target to Node.js 14 - [`374`](https://github.com/node-usb/node-usb/pull/374) ([Micah Zoltu](https://github.com/MicahZoltu))

package/{Readme.md → README.md}

@@ -304,6 +304,12 @@ Attaches a callback to plugging in a `device`.
 ### usb.on('detach', function(device) { ... });
 Attaches a callback to unplugging a `device`.
 
+### usb.refHotplugEvents();
+Restore (re-reference) the hotplug events unreferenced by `unrefHotplugEvents()`
+
+### usb.unrefHotplugEvents();
+Listening to events will prevent the process to exit. By calling this function, hotplug events will be unreferenced by the event loop, allowing the process to exit even when listening for the `attach` and `detach` events.
+
 
 Development and testing
 =======================

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "usb",
   "description": "Library to access USB devices",
-  "version": "1.8.1-libusb.4",
+  "version": "1.9.0",
   "engines": {
     "node": ">=10.16.0"
   },
@@ -55,7 +55,7 @@
   },
   "devDependencies": {
     "coffeescript": "~2.4.1",
-    "mocha": "^8.3.2",
+    "mocha": "^9.1.3",
     "node-gyp": "^7.1.2",
     "prebuildify": "^4.2.1",
     "prebuildify-ci": "^1.0.5",

package/src/device.cc

@@ -21,6 +21,8 @@ Device::Device(const Napi::CallbackInfo & info) : Napi::ObjectWrap<Device>(info)
 	byPtr.insert(std::make_pair(device, this));
 #ifndef USE_POLL
 	completionQueue.start(info.Env());
+	// Unref threadsafe function immediately to avoid delay in program exit
+	completionQueue.unref(info.Env());
 #endif
 	DEBUG_LOG("Created device %p", this);
 	Constructor(info);
@@ -28,9 +30,6 @@ Device::Device(const Napi::CallbackInfo & info) : Napi::ObjectWrap<Device>(info)
 
 Device::~Device(){
 	DEBUG_LOG("Freed device %p", this);
-#ifndef USE_POLL
-	completionQueue.stop();
-#endif
 	byPtr.erase(device);
 	libusb_close(device_handle);
 	libusb_unref_device(device);

package/src/node_usb.cc

@@ -4,8 +4,11 @@
 
 Napi::Value SetDebugLevel(const Napi::CallbackInfo& info);
 Napi::Value GetDeviceList(const Napi::CallbackInfo& info);
+Napi::Value GetLibusbCapability(const Napi::CallbackInfo& info);
 Napi::Value EnableHotplugEvents(const Napi::CallbackInfo& info);
 Napi::Value DisableHotplugEvents(const Napi::CallbackInfo& info);
+Napi::Value RefHotplugEvents(const Napi::CallbackInfo& info);
+Napi::Value UnrefHotplugEvents(const Napi::CallbackInfo& info);
 void initConstants(Napi::Object target);
 
 libusb_context* usb_context;
@@ -16,6 +19,7 @@ struct HotPlug {
 
 #ifdef USE_POLL
 #include <poll.h>
+#include <uv.h>
 #include <sys/time.h>
 
 std::map<int, uv_poll_t*> pollByFD;
@@ -94,8 +98,11 @@ Napi::Object Init(Napi::Env env, Napi::Object exports) {
 
 	exports.Set("setDebugLevel", Napi::Function::New(env, SetDebugLevel));
 	exports.Set("getDeviceList", Napi::Function::New(env, GetDeviceList));
+	exports.Set("_getLibusbCapability", Napi::Function::New(env, GetLibusbCapability));
 	exports.Set("_enableHotplugEvents", Napi::Function::New(env, EnableHotplugEvents));
 	exports.Set("_disableHotplugEvents", Napi::Function::New(env, DisableHotplugEvents));
+	exports.Set("refHotplugEvents", Napi::Function::New(env, RefHotplugEvents));
+	exports.Set("unrefHotplugEvents", Napi::Function::New(env, UnrefHotplugEvents));
 	return exports;
 }
 
@@ -128,6 +135,17 @@ Napi::Value GetDeviceList(const Napi::CallbackInfo& info) {
 	return arr;
 }
 
+Napi::Value GetLibusbCapability(const Napi::CallbackInfo& info) {
+	Napi::Env env = info.Env();
+
+	if (info.Length() != 1 || !info[0].IsNumber()) {
+		THROW_BAD_ARGS("Usb::GetLibusbCapability argument is invalid!")
+	}
+
+	int res = libusb_has_capability(info[0].As<Napi::Number>().Int32Value());
+	return Napi::Number::New(env, res);
+}
+
 Napi::ObjectReference hotplugThis;
 
 void handleHotplug(HotPlug* info){
@@ -199,10 +217,27 @@ Napi::Value DisableHotplugEvents(const Napi::CallbackInfo& info) {
 	return env.Undefined();
 }
 
+Napi::Value RefHotplugEvents(const Napi::CallbackInfo& info) {
+	Napi::Env env = info.Env();
+	Napi::HandleScope scope(env);
+	if (hotplugEnabled) {
+		hotplugQueue.ref(env);
+	}
+	return env.Undefined();
+}
+
+Napi::Value UnrefHotplugEvents(const Napi::CallbackInfo& info) {
+	Napi::Env env = info.Env();
+	Napi::HandleScope scope(env);
+	if (hotplugEnabled) {
+		hotplugQueue.unref(env);
+	}
+	return env.Undefined();
+}
+
 #define DEFINE_CONSTANT(OBJ, VALUE) \
 	OBJ.DefineProperty(Napi::PropertyDescriptor::Value(#VALUE, Napi::Number::New(OBJ.Env(), VALUE), static_cast<napi_property_attributes>(napi_enumerable | napi_configurable)));
 
-
 void initConstants(Napi::Object target){
 	DEFINE_CONSTANT(target, LIBUSB_CLASS_PER_INTERFACE);
 	DEFINE_CONSTANT(target, LIBUSB_CLASS_AUDIO);
@@ -282,6 +317,12 @@ void initConstants(Napi::Object target){
 	DEFINE_CONSTANT(target, LIBUSB_CONTROL_SETUP_SIZE);
 	DEFINE_CONSTANT(target, LIBUSB_DT_BOS_SIZE);
 
+	// libusb_capability
+	DEFINE_CONSTANT(target, LIBUSB_CAP_HAS_CAPABILITY);
+	DEFINE_CONSTANT(target, LIBUSB_CAP_HAS_HOTPLUG);
+	DEFINE_CONSTANT(target, LIBUSB_CAP_HAS_HID_ACCESS);
+	DEFINE_CONSTANT(target, LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER);
+
 	// libusb_error
 	// Input/output error
 	DEFINE_CONSTANT(target, LIBUSB_ERROR_IO);

package/src/uv_async_queue.h

@@ -3,31 +3,39 @@
 
 template <class T>
 class UVQueue{
-	public:
-		typedef void (*fptr)(T);
-
-		Napi::ThreadSafeFunction tsfn;
-
-		UVQueue(fptr cb): callback(cb)  {}
-
-		void start(Napi::Env env) {
-			Napi::Function empty_func = Napi::Function::New(env, [](const Napi::CallbackInfo& cb) {});
-			tsfn = Napi::ThreadSafeFunction::New(env, empty_func, "libusb", 0, 1);
-		}
-
-		void stop() {
-    		tsfn.Release();
-		}
-		
-		void post(T value){
-			auto cb = callback;
-			tsfn.BlockingCall( value, [cb](Napi::Env _env, Napi::Function _jsCallback, T val) {
-				cb(val);
-			});
-		}
-
-	private:
-		fptr callback;
+    public:
+        typedef void (*fptr)(T);
+
+        Napi::ThreadSafeFunction tsfn;
+
+        UVQueue(fptr cb): callback(cb)  {}
+
+        void start(Napi::Env env) {
+            Napi::Function empty_func = Napi::Function::New(env, [](const Napi::CallbackInfo& cb) {});
+            tsfn = Napi::ThreadSafeFunction::New(env, empty_func, "libusb", 0, 1);
+        }
+
+        void stop() {
+            tsfn.Release();
+        }
+ 
+        void ref(Napi::Env env) {
+            tsfn.Ref(env);
+        }
+
+        void unref(Napi::Env env) {
+            tsfn.Unref(env);
+        }
+
+        void post(T value){
+            auto cb = callback;
+            tsfn.BlockingCall( value, [cb](Napi::Env _env, Napi::Function _jsCallback, T val) {
+                cb(val);
+            });
+        }
+
+    private:
+        fptr callback;
 };
 
 #endif

package/usb.js

@@ -1,9 +1,6 @@
 var usb = exports = module.exports = require('node-gyp-build')(__dirname);
 var events = require('events');
 var util = require('util');
-var os = require('os');
-
-var isWindows = os.platform() === 'win32';
 
 var isBuffer = function(obj) {
 	return obj && obj instanceof Uint8Array
@@ -17,6 +14,8 @@ if (usb.INIT_ERROR) {
 	usb.getDeviceList = function () { return []; };
 	usb._enableHotplugEvents = function () { };
 	usb._disableHotplugEvents = function () { };
+	usb.refHotplugEvents = function () { };
+	usb.unrefHotplugEvents = function () { };
 }
 
 Object.keys(events.EventEmitter.prototype).forEach(function (key) {
@@ -511,35 +510,16 @@ OutEndpoint.prototype.transferWithZLP = function (buf, cb) {
 	}
 }
 
-var hotplugListeners = 0;
-exports.on('newListener', function(name) {
-	if (name !== 'attach' && name !== 'detach') return;
-	if (++hotplugListeners === 1) {
-		if (isWindows) {
-			exports._pollHotplug(true);
-		} else {
-			usb._enableHotplugEvents();
-		}
-	}
-});
-
-exports.on('removeListener', function(name) {
-	if (name !== 'attach' && name !== 'detach') return;
-	if (--hotplugListeners === 0) {
-		if (isWindows) {
-			exports._pollingHotplug = false;
-		} else {
-			usb._disableHotplugEvents();
-		}
-	}
-});
-
 // Polling mechanism for discovering device changes until this is fixed:
 // https://github.com/libusb/libusb/issues/86
-exports._pollHotplug = function(start) {
+exports._pollTimeout = 500;
+var hotplugSupported = usb._getLibusbCapability(usb.LIBUSB_CAP_HAS_HOTPLUG) > 0;
+var pollingHotplug = false;
+var pollDevices = [];
+function pollHotplug(start) {
 	if (start) {
-		exports._pollingHotplug = true;
-	} else if (!exports._pollingHotplug) {
+		pollingHotplug = true;
+	} else if (!pollingHotplug) {
 		return;
 	}
 
@@ -548,14 +528,14 @@ exports._pollHotplug = function(start) {
 	if (!start) {
 		// Find attached devices
 		for (var device of devices) {
-			var found = exports._windowsDevices.find(item => item.deviceAddress === device.deviceAddress);
+			var found = pollDevices.find(item => item.deviceAddress === device.deviceAddress);
 			if (!found) {
 				usb.emit('attach', device);
 			}
 		}
 
 		// Find detached devices
-		for (var device of exports._windowsDevices) {
+		for (var device of pollDevices) {
 			var found = devices.find(item => item.deviceAddress === device.deviceAddress);
 			if (!found) {
 				usb.emit('detach', device);
@@ -563,8 +543,31 @@ exports._pollHotplug = function(start) {
 		}
 	}
 
-	exports._windowsDevices = devices;
+	pollDevices = devices;
 	setTimeout(() => {
-		exports._pollHotplug();
-	}, 500);
+		pollHotplug();
+	}, exports._pollTimeout);
 }
+
+var hotplugListeners = 0;
+exports.on('newListener', function(name) {
+	if (name !== 'attach' && name !== 'detach') return;
+	if (++hotplugListeners === 1) {
+		if (hotplugSupported) {
+			usb._enableHotplugEvents();
+		} else {
+			pollHotplug(true);
+		}
+	}
+});
+
+exports.on('removeListener', function(name) {
+	if (name !== 'attach' && name !== 'detach') return;
+	if (--hotplugListeners === 0) {
+		if (hotplugSupported) {
+			usb._disableHotplugEvents();
+		} else {
+			pollingHotplug = false;
+		}
+	}
+});