Do not return device handle to the generic wrapper

Author: keeramis

src/cmd/device-protection.js

@@ -65,7 +65,7 @@ module.exports = class DeviceProtectionCommands extends CLICommandBase {
 		} catch (error) {
 			// TODO: Log detailed and user-friendly error messages from the device or API instead of displaying the raw error message
 			if (error.message === 'Not supported') {
-				throw new Error(`Device Protection feature is not supported on this device. Visit ${chalk.yellow('https://docs.particle.io')} for more information${os.EOL}`);
+				throw new Error(`Device Protection feature is not supported on this device. Visit ${chalk.yellow('https://docs.particle.io')} for more information.`);
 			}
 			throw new Error(`Unable to get device status: ${error.message}${os.EOL}`);
 		}
@@ -108,7 +108,7 @@ module.exports = class DeviceProtectionCommands extends CLICommandBase {
 			});
 		} catch (error) {
 			if (error.message === 'Not supported') {
-				throw new Error(`Device Protection feature is not supported on this device. Visit ${chalk.yellow('https://docs.particle.io')} for more information${os.EOL}`);
+				throw new Error(`Device Protection feature is not supported on this device. Visit ${chalk.yellow('https://docs.particle.io')} for more information.`);
 			}
 			throw new Error(`Failed to disable Device Protection: ${error.message}${os.EOL}`);
 		}
@@ -306,6 +306,13 @@ module.exports = class DeviceProtectionCommands extends CLICommandBase {
 	 */
 	async _withDevice({ spinner }, fn) {
 		await this._getUsbDevice(this.device);
+
+		const platform = platformForId(this.device.platformId);
+		// Gen2 platforms can take a long time to respond to control requests. Quit early.
+		if (platform.generation <= 2) {
+			throw new Error(`Device Protection feature is not supported on this device. Visit ${chalk.yellow('https://docs.particle.io')} for more information.`);
+		}
+
 		await this.ui.showBusySpinnerUntilResolved(spinner, (async () => {
 			this.status = await DeviceProtectionHelper.getProtectionStatus(this.device);
 			return await fn();

src/cmd/device-protection.test.js

@@ -11,7 +11,8 @@ describe('DeviceProtectionCommands', () => {
 		deviceProtectionCommands.device = {
 			isInDfuMode: false,
 			unprotectDevice: sinon.stub(),
-			enterDfuMode: sinon.stub()
+			enterDfuMode: sinon.stub(),
+			platformId: 13 /*boron*/
 		};
 	});
 

src/cmd/flash.js

@@ -74,7 +74,6 @@ module.exports = class FlashCommand extends CLICommandBase {
 	}
 
 	async _flashOverUsb(device, binary, factory) {
-		const deviceId = device.id;
 		const platformName = platformForId(device.platformId).name;
 		validateDFUSupport({ device, ui: this.ui });
 
@@ -104,14 +103,6 @@ module.exports = class FlashCommand extends CLICommandBase {
 		this.ui.write(`Flashing ${platformName} device ${device.id}`);
 		const resetAfterFlash = !factory && modulesToFlash[0].prefixInfo.moduleFunction === ModuleInfo.FunctionType.USER_PART;
 		await flashFiles({ device, flashSteps, resetAfterFlash, ui: this.ui });
-
-		// The device obtained here could be closed, so reopen the device and ensure it is ready to talk to
-		// FIXME: Gen2 devices may not be able to respond to control requests immediately after flashing
-		const platform = platformForId(device.platformId);
-		if (platform.generation > 2) {
-			device = await usbUtils.waitForDeviceToRespond(deviceId);
-			return device;
-		}
 	}
 
 	flashCloud({ device, files, target }) {
@@ -138,7 +129,6 @@ module.exports = class FlashCommand extends CLICommandBase {
 	}
 
 	async _flashLocal(device, parsedFiles, deviceIdOrName, knownApp, applicationOnly, target, verbose=true) {
-		const deviceId = device.id;
 		const platformId = device.platformId;
 		const platformName = platformForId(platformId).name;
 		const currentDeviceOsVersion = device.firmwareVersion;
@@ -184,14 +174,6 @@ module.exports = class FlashCommand extends CLICommandBase {
 		});
 
 		await flashFiles({ device, flashSteps, ui: this.ui, verbose });
-
-		// The device obtained here may have been closed, so reopen it and ensure it is ready to send control requests to.
-		// FIXME: Gen2 devices may not be able to respond to control requests immediately after flashing
-		const platform = platformForId(device.platformId);
-		if (platform.generation > 2) {
-			device = await usbUtils.waitForDeviceToRespond(deviceId);
-			return device;
-		}
 	}
 
 	async _analyzeFiles(files) {

src/cmd/update.js

@@ -29,7 +29,6 @@ module.exports = class UpdateCommand extends CLICommandBase {
 	}
 
 	async _updateDevice(device, deviceIdOrName, target) {
-		const deviceId = device.id;
 		const { api } = this._particleApi();
 		const version = target || 'latest';
 		validateDFUSupport({ device, ui: this.ui });
@@ -53,14 +52,6 @@ module.exports = class UpdateCommand extends CLICommandBase {
 		await flashFiles({ device, flashSteps, ui: this.ui });
 
 		this.ui.write('Update success!');
-
-		// The device obtained here may have been closed, so reopen it and ensure it is ready to send control requests to.
-		// FIXME: Gen2 devices may not be able to respond to control requests immediately after flashing
-		const platform = platformForId(device.platformId);
-		if (platform.generation > 2) {
-			device = await usbUtils.waitForDeviceToRespond(deviceId);
-			return device;
-		}
 	}
 
 	_particleApi() {

src/cmd/usb-util.js

@@ -97,6 +97,7 @@ class UsbPermissionsError extends Error {
  */
 async function executeWithUsbDevice({ args, func, enterDfuMode = false, allowProtectedDevices = true } = {}) {
 	let device = await getOneUsbDevice(args);
+	const deviceId = device.id;
 	let deviceIsProtected = false; // Protected and Protected Devices in Service Mode
 	let disableProtection = false; // Only Protected Devices (not in Service Mode)
 
@@ -129,22 +130,16 @@ async function executeWithUsbDevice({ args, func, enterDfuMode = false, allowPro
 		}
 	}
 
-	let newDeviceHandle = null;
 	try {
 		if (enterDfuMode) {
 			validateDFUSupport({ device, ui: args.ui });
 			device = await reopenInDfuMode(device);
 		}
-		newDeviceHandle = await func(device);
-		// Overwrite device handle if it is provided by the executed function
-		// FIXME: Perhaps a poor way to uniquely identify a device is of UsbDevice type
-		if (newDeviceHandle?._dev) {
-			device = newDeviceHandle;
-		}
+		await func(device);
 	} finally {
 		if (deviceIsProtected) {
 			try {
-				// 'device' has finished the CLI command and is now ready to run this command
+				device = await waitForDeviceToRespond(deviceId);
 				await deviceProtectionHelper.turnOffServiceMode(device);
 			} catch (error) {
 				// Ignore error. At most, device is left in Service Mode

src/lib/flash-helper.js

@@ -398,11 +398,11 @@ async function maintainDeviceProtection({ modules, device }) {
 		// Firmware module info is only available when the device is not in DFU mode
 		// If the device was in DFU mode, allow the flashing to continue and fail midway if the device is not compatible
 		if (!device.isInDfuMode) {
-			let currentModules, incompatSystem, incompatBootloader;
+			let currentModules, incompatSystem, incompatBootloader, currentSystem, currentBootloader;
 			try {
 				currentModules = await device.getFirmwareModuleInfo({ timeout: 5000 });
-				const currentSystem = currentModules.find(m => m.type === 'SYSTEM_PART');
-				const currentBootloader = currentModules.find(m => m.type === 'BOOTLOADER' && m.index === 0);
+				currentSystem = currentModules.find(m => m.type === 'SYSTEM_PART');
+				currentBootloader = currentModules.find(m => m.type === 'BOOTLOADER' && m.index === 0);
 				incompatSystem = currentSystem && INCOMPATIBLE_PROTECTED_SYSTEM_VERSIONS[currentSystem.version] &&
 					INCOMPATIBLE_PROTECTED_SYSTEM_VERSIONS[currentSystem.version].includes(moduleVersion);
 				incompatBootloader = currentBootloader && INCOMPATIBLE_PROTECTED_BOOTLOADER_VERSIONS[currentBootloader.version] &&