usb 2.3.0 → 2.4.1

package/test/usb.coffee

@@ -4,6 +4,7 @@ usb = require('../').usb
 getDeviceList = require('../').getDeviceList
 findByIds = require('../').findByIds
 findBySerialNumber = require('../').findBySerialNumber
+Worker = require('worker_threads').Worker
 
 if typeof gc is 'function'
 	# running with --expose-gc, do a sweep between tests so valgrind blames the right one
@@ -20,14 +21,14 @@ describe 'USB Module', ->
 		assert.throws -> usb.Device()
 		assert.throws -> usb.Device.prototype.open.call({})
 
-	describe 'setDebugLevel', ->
-		it 'should throw when passed invalid args', ->
-			assert.throws((-> usb.setDebugLevel()), TypeError)
-			assert.throws((-> usb.setDebugLevel(-1)), TypeError)
-			assert.throws((-> usb.setDebugLevel(5)), TypeError)
+describe 'setDebugLevel', ->
+	it 'should throw when passed invalid args', ->
+		assert.throws((-> usb.setDebugLevel()), TypeError)
+		assert.throws((-> usb.setDebugLevel(-1)), TypeError)
+		assert.throws((-> usb.setDebugLevel(5)), TypeError)
 
-		it 'should succeed with good args', ->
-			assert.doesNotThrow(-> usb.setDebugLevel(0))
+	it 'should succeed with good args', ->
+		assert.doesNotThrow(-> usb.setDebugLevel(0))
 
 describe 'getDeviceList', ->
 	it 'should return at least one device', ->
@@ -201,3 +202,13 @@ describe 'Device', ->
 
 	after ->
 		device.close()
+
+if process.platform != 'win32'
+	describe 'Context Aware', ->
+		it 'should handle opening the same device from different contexts', ->
+			for n in [1..5]
+				worker = new Worker('./test/worker.cjs')
+				worker.on 'message', (serial) ->
+					assert.equal(serial, 'TEST_DEVICE')
+				worker.on 'exit', (code) ->
+					assert.equal(code, 0)

package/test/worker.cjs

@@ -0,0 +1,9 @@
+const parentPort = require('worker_threads').parentPort
+const findByIds = require('../dist').findByIds;
+
+const device = findByIds(0x59e3, 0x0a23);
+device.open();
+device.getStringDescriptor(device.deviceDescriptor.iSerialNumber, (_, serial) => {
+    parentPort.postMessage(serial);
+    device.close();
+});

package/tsc/webusb/webusb-device.ts

@@ -1,7 +1,6 @@
 import * as usb from '../usb';
 import { promisify } from 'util';
 import { Endpoint, InEndpoint, OutEndpoint } from '../usb/endpoint';
-import { Mutex } from './mutex';
 
 const LIBUSB_TRANSFER_TYPE_MASK = 0x03;
 const ENDPOINT_NUMBER_MASK = 0x7f;
@@ -39,8 +38,6 @@ export class WebUSBDevice implements USBDevice {
     public serialNumber?: string | undefined;
     public configurations: USBConfiguration[] = [];
 
-    private deviceMutex = new Mutex();
-
     private constructor(private device: usb.Device) {
         const usbVersion = this.decodeVersion(device.deviceDescriptor.bcdUSB);
         this.usbVersionMajor = usbVersion.major;
@@ -73,8 +70,6 @@ export class WebUSBDevice implements USBDevice {
 
     public async open(): Promise<void> {
         try {
-            await this.deviceMutex.lock();
-
             if (this.opened) {
                 return;
             }
@@ -82,15 +77,11 @@ export class WebUSBDevice implements USBDevice {
             this.device.open();
         } catch (error) {
             throw new Error(`open error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async close(): Promise<void> {
         try {
-            await this.deviceMutex.lock();
-
             if (!this.opened) {
                 return;
             }
@@ -115,137 +106,110 @@ export class WebUSBDevice implements USBDevice {
             this.device.close();
         } catch (error) {
             throw new Error(`close error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async selectConfiguration(configurationValue: number): Promise<void> {
-        try {
-            await this.deviceMutex.lock();
-
-            if (!this.opened || !this.device.configDescriptor) {
-                throw new Error('selectConfiguration error: invalid state');
-            }
+        if (!this.opened || !this.device.configDescriptor) {
+            throw new Error('selectConfiguration error: invalid state');
+        }
 
-            if (this.device.configDescriptor.bConfigurationValue === configurationValue) {
-                return;
-            }
+        if (this.device.configDescriptor.bConfigurationValue === configurationValue) {
+            return;
+        }
 
-            const config = this.configurations.find(configuration => configuration.configurationValue === configurationValue);
-            if (!config) {
-                throw new Error('selectConfiguration error: configuration not found');
-            }
+        const config = this.configurations.find(configuration => configuration.configurationValue === configurationValue);
+        if (!config) {
+            throw new Error('selectConfiguration error: configuration not found');
+        }
 
-            try {
-                const setConfiguration = promisify(this.device.setConfiguration).bind(this.device);
-                await setConfiguration(configurationValue);
-            } catch (error) {
-                throw new Error(`selectConfiguration error: ${error}`);
-            }
-        } finally {
-            this.deviceMutex.unlock();
+        try {
+            const setConfiguration = promisify(this.device.setConfiguration).bind(this.device);
+            await setConfiguration(configurationValue);
+        } catch (error) {
+            throw new Error(`selectConfiguration error: ${error}`);
         }
     }
 
     public async claimInterface(interfaceNumber: number): Promise<void> {
-        try {
-            await this.deviceMutex.lock();
+        if (!this.opened) {
+            throw new Error('claimInterface error: invalid state');
+        }
 
-            if (!this.opened) {
-                throw new Error('claimInterface error: invalid state');
-            }
+        if (!this.configuration) {
+            throw new Error('claimInterface error: interface not found');
+        }
 
-            if (!this.configuration) {
-                throw new Error('claimInterface error: interface not found');
-            }
+        const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
+        if (!iface) {
+            throw new Error('claimInterface error: interface not found');
+        }
 
-            const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
-            if (!iface) {
-                throw new Error('claimInterface error: interface not found');
-            }
+        if (iface.claimed) {
+            return;
+        }
 
-            if (iface.claimed) {
-                return;
-            }
+        try {
+            this.device.interface(interfaceNumber).claim();
+
+            // Re-create the USBInterface to set the claimed attribute
+            this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
+                interfaceNumber,
+                alternate: iface.alternate,
+                alternates: iface.alternates,
+                claimed: true
+            };
+        } catch (error) {
+            throw new Error(`claimInterface error: ${error}`);
+        }
+    }
 
-            try {
-                this.device.interface(interfaceNumber).claim();
+    public async releaseInterface(interfaceNumber: number): Promise<void> {
+        await this._releaseInterface(interfaceNumber);
 
+        if (this.configuration) {
+            const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
+            if (iface) {
                 // Re-create the USBInterface to set the claimed attribute
                 this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
                     interfaceNumber,
                     alternate: iface.alternate,
                     alternates: iface.alternates,
-                    claimed: true
+                    claimed: false
                 };
-            } catch (error) {
-                throw new Error(`claimInterface error: ${error}`);
-            }
-        } finally {
-            this.deviceMutex.unlock();
-        }
-    }
-
-    public async releaseInterface(interfaceNumber: number): Promise<void> {
-        try {
-            await this.deviceMutex.lock();
-            await this._releaseInterface(interfaceNumber);
-
-            if (this.configuration) {
-                const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
-                if (iface) {
-                    // Re-create the USBInterface to set the claimed attribute
-                    this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
-                        interfaceNumber,
-                        alternate: iface.alternate,
-                        alternates: iface.alternates,
-                        claimed: false
-                    };
-                }
             }
-
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async selectAlternateInterface(interfaceNumber: number, alternateSetting: number): Promise<void> {
-        try {
-            await this.deviceMutex.lock();
-
-            if (!this.opened) {
-                throw new Error('selectAlternateInterface error: invalid state');
-            }
+        if (!this.opened) {
+            throw new Error('selectAlternateInterface error: invalid state');
+        }
 
-            if (!this.configuration) {
-                throw new Error('selectAlternateInterface error: interface not found');
-            }
+        if (!this.configuration) {
+            throw new Error('selectAlternateInterface error: interface not found');
+        }
 
-            const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
-            if (!iface) {
-                throw new Error('selectAlternateInterface error: interface not found');
-            }
+        const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
+        if (!iface) {
+            throw new Error('selectAlternateInterface error: interface not found');
+        }
 
-            if (!iface.claimed) {
-                throw new Error('selectAlternateInterface error: invalid state');
-            }
+        if (!iface.claimed) {
+            throw new Error('selectAlternateInterface error: invalid state');
+        }
 
-            try {
-                const iface = this.device.interface(interfaceNumber);
-                const setAltSetting = promisify(iface.setAltSetting).bind(iface);
-                await setAltSetting(alternateSetting);
-            } catch (error) {
-                throw new Error(`selectAlternateInterface error: ${error}`);
-            }
-        } finally {
-            this.deviceMutex.unlock();
+        try {
+            const iface = this.device.interface(interfaceNumber);
+            const setAltSetting = promisify(iface.setAltSetting).bind(iface);
+            await setAltSetting(alternateSetting);
+        } catch (error) {
+            throw new Error(`selectAlternateInterface error: ${error}`);
         }
     }
 
     public async controlTransferIn(setup: USBControlTransferParameters, length: number): Promise<USBInTransferResult> {
         try {
-            await this.deviceMutex.lock();
             const type = this.controlTransferParamsToType(setup, usb.LIBUSB_ENDPOINT_IN);
             const controlTransfer = promisify(this.device.controlTransfer).bind(this.device);
             const result = await controlTransfer(type, setup.request, setup.value, setup.index, length);
@@ -268,14 +232,11 @@ export class WebUSBDevice implements USBDevice {
             }
 
             throw new Error(`controlTransferIn error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async controlTransferOut(setup: USBControlTransferParameters, data?: ArrayBuffer): Promise<USBOutTransferResult> {
         try {
-            await this.deviceMutex.lock();
             const type = this.controlTransferParamsToType(setup, usb.LIBUSB_ENDPOINT_OUT);
             const controlTransfer = promisify(this.device.controlTransfer).bind(this.device);
             const buffer = data ? Buffer.from(data) : Buffer.alloc(0);
@@ -294,27 +255,21 @@ export class WebUSBDevice implements USBDevice {
             }
 
             throw new Error(`controlTransferOut error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async clearHalt(direction: USBDirection, endpointNumber: number): Promise<void> {
         try {
-            await this.deviceMutex.lock();
             const wIndex = endpointNumber | (direction === 'in' ? usb.LIBUSB_ENDPOINT_IN : usb.LIBUSB_ENDPOINT_OUT);
             const controlTransfer = promisify(this.device.controlTransfer).bind(this.device);
             await controlTransfer(usb.LIBUSB_RECIPIENT_ENDPOINT, CLEAR_FEATURE, ENDPOINT_HALT, wIndex, 0);
         } catch (error) {
             throw new Error(`clearHalt error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async transferIn(endpointNumber: number, length: number): Promise<USBInTransferResult> {
         try {
-            await this.deviceMutex.lock();
             const endpoint = this.getEndpoint(endpointNumber | usb.LIBUSB_ENDPOINT_IN) as InEndpoint;
             const transfer = promisify(endpoint.transfer).bind(endpoint);
             const result = await transfer(length);
@@ -337,14 +292,11 @@ export class WebUSBDevice implements USBDevice {
             }
 
             throw new Error(`transferIn error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async transferOut(endpointNumber: number, data: ArrayBuffer): Promise<USBOutTransferResult> {
         try {
-            await this.deviceMutex.lock();
             const endpoint = this.getEndpoint(endpointNumber | usb.LIBUSB_ENDPOINT_OUT) as OutEndpoint;
             const transfer = promisify(endpoint.transfer).bind(endpoint);
             const buffer = Buffer.from(data);
@@ -363,20 +315,15 @@ export class WebUSBDevice implements USBDevice {
             }
 
             throw new Error(`transferOut error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
     public async reset(): Promise<void> {
         try {
-            await this.deviceMutex.lock();
             const reset = promisify(this.device.reset).bind(this.device);
             await reset();
         } catch (error) {
             throw new Error(`reset error: ${error}`);
-        } finally {
-            this.deviceMutex.unlock();
         }
     }
 
@@ -394,8 +341,6 @@ export class WebUSBDevice implements USBDevice {
 
     private async initialize(): Promise<void> {
         try {
-            await this.deviceMutex.lock();
-
             if (!this.opened) {
                 this.device.open();
             }
@@ -410,8 +355,6 @@ export class WebUSBDevice implements USBDevice {
             if (this.opened) {
                 this.device.close();
             }
-
-            this.deviceMutex.unlock();
         }
     }
 

package/dist/webusb/mutex.d.ts

@@ -1,22 +0,0 @@
-/**
- * A mutex implementation that can be used to lock access between concurrent async functions
- */
-export declare class Mutex {
-    private locked;
-    /**
-     * Create a new Mutex
-     */
-    constructor();
-    /**
-     *  Yield the current execution context, effectively moving it to the back of the promise queue
-     */
-    private sleep;
-    /**
-     * Wait until the Mutex is available and claim it
-     */
-    lock(): Promise<void>;
-    /**
-     * Unlock the Mutex
-     */
-    unlock(): void;
-}

package/dist/webusb/mutex.js

@@ -1,89 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Mutex = void 0;
-/**
- * A mutex implementation that can be used to lock access between concurrent async functions
- */
-var Mutex = /** @class */ (function () {
-    /**
-     * Create a new Mutex
-     */
-    function Mutex() {
-        this.locked = false;
-    }
-    /**
-     *  Yield the current execution context, effectively moving it to the back of the promise queue
-     */
-    Mutex.prototype.sleep = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, 1); })];
-            });
-        });
-    };
-    /**
-     * Wait until the Mutex is available and claim it
-     */
-    Mutex.prototype.lock = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!this.locked) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.sleep()];
-                    case 1:
-                        _a.sent();
-                        return [3 /*break*/, 0];
-                    case 2:
-                        this.locked = true;
-                        return [2 /*return*/];
-                }
-            });
-        });
-    };
-    /**
-     * Unlock the Mutex
-     */
-    Mutex.prototype.unlock = function () {
-        this.locked = false;
-    };
-    return Mutex;
-}());
-exports.Mutex = Mutex;
-//# sourceMappingURL=mutex.js.map

package/dist/webusb/mutex.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mutex.js","sourceRoot":"","sources":["../../tsc/webusb/mutex.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;GAEG;AACH;IAGI;;OAEG;IACH;QACI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;OAEG;IACW,qBAAK,GAAnB;;;gBACI,sBAAO,IAAI,OAAO,CAAC,UAAA,OAAO,IAAI,OAAA,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,EAAtB,CAAsB,CAAC,EAAC;;;KACzD;IAED;;OAEG;IACU,oBAAI,GAAjB;;;;;6BACW,IAAI,CAAC,MAAM;wBACd,qBAAM,IAAI,CAAC,KAAK,EAAE,EAAA;;wBAAlB,SAAkB,CAAC;;;wBAGvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;;;;;KACtB;IAED;;OAEG;IACI,sBAAM,GAAb;QACI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IACL,YAAC;AAAD,CAAC,AAlCD,IAkCC;AAlCY,sBAAK"}

package/tsc/webusb/mutex.ts

@@ -1,38 +0,0 @@
-/**
- * A mutex implementation that can be used to lock access between concurrent async functions
- */
-export class Mutex {
-    private locked: boolean;
-
-    /**
-     * Create a new Mutex
-     */
-    constructor() {
-        this.locked = false;
-    }
-
-    /**
-     *  Yield the current execution context, effectively moving it to the back of the promise queue
-     */
-    private async sleep(): Promise<void> {
-        return new Promise(resolve => setTimeout(resolve, 1));
-    }
-
-    /**
-     * Wait until the Mutex is available and claim it
-     */
-    public async lock(): Promise<void> {
-        while (this.locked) {
-            await this.sleep();
-        }
-
-        this.locked = true;
-    }
-
-    /**
-     * Unlock the Mutex
-     */
-    public unlock(): void {
-        this.locked = false;
-    }
-}