Feature/sc 133459/resume downloads from s3

package.json

@@ -52,7 +52,7 @@
     }
   ],
   "dependencies": {
-    "@particle/device-constants": "^3.7.0",
+    "@particle/device-constants": "^3.8.0",
     "binary-version-reader": "^2.5.1",
     "chalk": "^2.4.2",
     "cli-progress": "^3.12.0",
@@ -66,6 +66,7 @@
     "jose": "^4.13.1",
     "lodash": "^4.17.15",
     "moment": "^2.24.0",
+    "node-fetch": "^2.7.0",
     "node-wifiscanner2": "^1.2.1",
     "particle-api-js": "^11.1.0",
     "particle-commands": "^1.0.1",
@@ -75,6 +76,7 @@
     "safe-buffer": "^5.2.0",
     "semver": "^7.5.2",
     "serialport": "^10.4.0",
+    "sha512crypt-node": "^1.0.2",
     "softap-setup": "^4.1.0",
     "temp": "^0.9.1",
     "unzipper": "^0.12.3",

settings.js

@@ -39,7 +39,9 @@ let settings = {
 
 	cloudKnownApps: {
 		'tinker': true
-	}
+	},
+
+	tachyonMeta: 'https://tachyon-ci.particle.io/meta'
 };
 
 function envValue(varName, defaultValue) {

src/cli/cloud.test.js

@@ -64,7 +64,7 @@ describe('Cloud Command-Line Interface', () => {
 					'Display a list of your devices, as well as their variables and functions',
 					'Usage: particle cloud list [options] [filter]',
 					'',
-					'Param filter can be: online, offline, a platform name (core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom, electron2), a device ID or name',
+					'Param filter can be: online, offline, a platform name (core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom, electron2, tachyon), a device ID or name',
 					''
 				].join('\n'));
 			});
@@ -308,7 +308,7 @@ describe('Cloud Command-Line Interface', () => {
 					'  particle cloud compile photon                                  Compile the source code in the current directory in the cloud for a `photon`',
 					'  particle cloud compile electron project --saveTo electron.bin  Compile the source code in the project directory in the cloud for an `electron` and save it to a file named `electron.bin`',
 					'',
-					'Param deviceType can be: core, c, photon, p, p1, electron, e, argon, a, boron, b, xenon, x, esomx, bsom, b5som, tracker, assettracker, trackerm, p2, photon2, msom, muon, electron2',
+					'Param deviceType can be: core, c, photon, p, p1, electron, e, argon, a, boron, b, xenon, x, esomx, bsom, b5som, tracker, assettracker, trackerm, p2, photon2, msom, muon, electron2, tachyon',
 					''
 				].join('\n'));
 			});

src/cli/index.js

@@ -28,6 +28,7 @@ const webhook = require('./webhook');
 const whoami = require('./whoami');
 const wifi = require('./wifi');
 const usb = require('./usb');
+const tachyon = require('./tachyon');
 
 /**
  * The default function export from this module registers all the available commands.
@@ -64,6 +65,7 @@ module.exports = function registerAllCommands(context) {
 	publish(context);
 	serial(context);
 	subscribe(context);
+	tachyon(context);
 	token(context);
 	udp(context);
 	updateCli(context);

src/cli/tachyon.js

@@ -0,0 +1,80 @@
+module.exports = ({ commandProcessor, root }) => {
+	const tachyon = commandProcessor.createCategory(root, 'tachyon', 'Setup Particle devices');
+
+	commandProcessor.createCommand(tachyon, 'setup', 'Setup a Tachyon device', {
+		options: {
+			skip_flashing_os: {
+				description: 'Skip flashing the Operating System',
+				boolean: true
+			},
+			version: {
+				description: 'Version to download package for (default: latest). Can include a directory or a local zip file',
+				type: 'string'
+			},
+			load_config: {
+				description: 'Path to a config file to use for setup',
+				type: 'string'
+			},
+			save_config: {
+				description: 'Path to dump the config file to after setup',
+				type: 'string'
+			}
+		},
+		handler: (args) => {
+			const SetupTachyonCommands = require('../cmd/setup-tachyon');
+			return new SetupTachyonCommands().setup(args);
+		},
+		examples: {
+			'$0 $command': 'Setup a Tachyon device'
+		}
+	});
+
+	commandProcessor.createCommand(tachyon, 'download-package', 'Download a Tachyon package', {
+		options: {
+			region: {
+				description: 'Region to download package for',
+				type: 'string',
+			},
+			version: {
+				description: 'Version to download package for',
+				type: 'string'
+			}
+		},
+		handler: (args) => {
+			const DownloadTachyonPackageCommand = require('../cmd/download-tachyon-package');
+			return new DownloadTachyonPackageCommand().download(args);
+		},
+		examples: {
+			'$0 $command --region': 'Download a Tachyon package for the US region and version 1.0.0',
+			'$0 $command --region NA --version 1.0.0': 'Download a Tachyon package for the North America region and version 1.0.0'
+		}
+	});
+
+	commandProcessor.createCommand(tachyon, 'clean-cache', 'Clean the Tachyon package cache', {
+		options: {
+			region: {
+				description: 'Region to download package for',
+				type: 'string',
+			},
+			version: {
+				description: 'Version to download package for',
+				type: 'string'
+			},
+			all: {
+				description: 'Clean all cached packages',
+				boolean: true
+			}
+		},
+		handler: (args) => {
+			const CleanPackageCacheCommand = require('../cmd/download-tachyon-package');
+			return new CleanPackageCacheCommand().cleanUp(args);
+		},
+		examples: {
+			'$0 $command --region NA --version 1.0.0': 'Clean the Tachyon package cache for the North America region and version 1.0.0',
+			'$0 $command --all': 'Clean all cached packages',
+		}
+	});
+
+	return tachyon;
+};
+

src/cli/usb.test.js

@@ -63,7 +63,7 @@ describe('USB Command-Line Interface', () => {
 					'  --exclude-dfu  Do not list devices which are in DFU mode  [boolean]',
 					'  --ids-only     Print only device IDs  [boolean]',
 					'',
-					'Param filter can be: online, offline, a platform name (core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom, electron2), a device ID or name',
+					'Param filter can be: online, offline, a platform name (core, photon, p1, electron, argon, boron, xenon, esomx, bsom, b5som, tracker, trackerm, p2, msom, electron2, tachyon), a device ID or name',
 					''
 				].join('\n'));
 			});

src/cli/wifi.js

@@ -1,7 +1,7 @@
 const unindent = require('../lib/unindent');
 
 module.exports = ({ commandProcessor, root }) => {
-	const wifi = commandProcessor.createCategory(root, 'wifi', 'Configure Wi-Fi credentials to your device (Supported on Gen 3+ devices).');
+	const wifi = commandProcessor.createCategory(root, 'wifi', 'Configure Wi-Fi credentials to your device (Supported on Gen 3+ devices)');
 
 	commandProcessor.createCommand(wifi, 'add', 'Adds a Wi-Fi network to your device', {
 		options: Object.assign({

src/cmd/api.js

@@ -232,6 +232,43 @@ module.exports = class ParticleApi {
 		);
 	}
 
+	getOrgs() {
+		return this._wrap(
+			this.api.get({
+				uri: '/v1/orgs',
+				auth: this.accessToken
+			})
+		);
+	}
+
+	getRegistrationCode(productId) {
+		return this._wrap(
+			this.api.post({
+				uri: `/v1/products/${productId}/registration_code`,
+				auth: this.accessToken
+			})
+		);
+	}
+
+	createProduct({ name, type, org }) {
+		return this._wrap(
+			this.api.post({
+				uri: `/v1${org ? `/orgs/${org}` : ''}/products`,
+				form: { name, type },
+				auth: this.accessToken
+			})
+		);
+	}
+
+	getProducts(org) {
+		return this._wrap(
+			this.api.get({
+				uri: `/v1${org ? `/orgs/${org}` : ''}/products`,
+				auth: this.accessToken
+			})
+		);
+	}
+
 	getDevice({ deviceId: id }) {
 		return this.api.getDevice({ deviceId: id, auth: this.accessToken });
 	}

src/cmd/download-tachyon-package.js

@@ -0,0 +1,84 @@
+const CLICommandBase = require('./base');
+const DownloadManager = require('../lib/download-manager');
+
+module.exports = class DownloadTachyonPackageCommand extends CLICommandBase {
+	constructor({ ui } = {}) {
+		super();
+		this.ui = ui || this.ui;
+	}
+
+	async _selectRegion() {
+		const regionMapping = {
+			'NA (North America)': 'NA',
+			'RoW (Rest of the World)': 'RoW'
+		};
+		const question = [
+			{
+				type: 'list',
+				name: 'region',
+				message: 'Select the region:',
+				choices: Object.keys(regionMapping),
+			},
+		];
+		const { region } = await this.ui.prompt(question);
+		return regionMapping[region];
+	}
+
+	async _selectVersion() {
+		const question = [
+			{
+				type: 'input',
+				name: 'version',
+				message: 'Enter the version number:',
+				default: 'latest',
+			},
+		];
+		const answer = await this.ui.prompt(question);
+		return answer.version;
+	}
+	async download ({ region, version }) {
+		// prompt for region and version if not provided
+		if (!region) {
+			region = await this._selectRegion();
+		}
+		if (!version) {
+			version = await this._selectVersion();
+		}
+		const manager = new DownloadManager(this.ui);
+		const manifest = await manager.fetchManifest({ version });
+		const build = manifest.builds.find((b) => b.region === region);
+		if (!build) {
+			throw new Error(`No build available for region: ${region}`);
+		}
+		const { artifact_url: url, sha256_checksum: expectedChecksum } = build.artifacts[0];
+		const outputFileName = url.replace(/.*\//, '');
+		const filePath = await manager.download({ url, outputFileName, expectedChecksum });
+		this.ui.write(`Downloaded package to: ${filePath}`);
+
+		return filePath;
+	}
+
+	async cleanUp({ region, version, all }) {
+		const manager = new DownloadManager(this.ui);
+		if (all) {
+			await manager.cleanup({ cleanDownload: true, cleanInProgress: true });
+			this.ui.write('Cleaned up all cached packages');
+		} else {
+			if (!region) {
+				region = await this._selectRegion();
+			}
+			if (!version) {
+				version = await this._selectVersion();
+			}
+			const manifest = await manager.fetchManifest({ version });
+			const build = manifest.builds.find((b) => b.region === region);
+			if (!build) {
+				throw new Error(`No build available for region: ${region}`);
+			}
+			const { artifact_url: url } = build.artifacts[0];
+			const outputFileName = url.replace(/.*\//, '');
+			await manager.cleanup({ cleanDownload: false, fileName: outputFileName });
+			this.ui.write(`Cleaned up package cache for region: ${region} and version: ${version}`);
+		}
+	}
+};

src/cmd/flash.js

@@ -70,9 +70,8 @@ module.exports = class FlashCommand extends CLICommandBase {
 		}
 	}
 
+	//returns true if successful or false if failed
 	async flashTachyon({ files, output }) {
-		this.ui.write(`${os.EOL}Ensure that only one device is connected to the computer before proceeding.${os.EOL}`);
-
 		let zipFile;
 		let includeDir = '';
 		let updateFolder = '';
@@ -82,7 +81,7 @@ module.exports = class FlashCommand extends CLICommandBase {
 			files = ['.'];
 		}
 
-		const input = files[0];
+		const [input, ...rest] = files;
 		const stats = await fs.stat(input);
 		let filesToProgram;
 
@@ -97,17 +96,17 @@ module.exports = class FlashCommand extends CLICommandBase {
 			const zipInfo = await this._extractFlashFilesFromZip(input);
 			includeDir = zipInfo.baseDir;
 			filesToProgram = zipInfo.filesToProgram.map((file) => path.join(includeDir, file));
+			filesToProgram.push(...rest);
 		} else {
 			filesToProgram = files;
 		}
 
-		this.ui.write(`Starting download. This may take several minutes...${os.EOL}`);
 		if (output && !fs.existsSync(output)) {
 			fs.mkdirSync(output);
 		}
 		const outputLog = path.join(output ? output : process.cwd(), `tachyon_flash_${Date.now()}.log`);
 		try {
-			this.ui.write(`Logs are being written to: ${outputLog}${os.EOL}`);
+			this.ui.write(`Starting download. This may take several minutes. See logs at: ${outputLog}${os.EOL}`);
 			const qdl = new QdlFlasher({
 				files: filesToProgram,
 				includeDir,
@@ -118,9 +117,11 @@ module.exports = class FlashCommand extends CLICommandBase {
 			});
 			await qdl.run();
 			fs.appendFileSync(outputLog, 'Download complete.');
+			return true;
 		} catch (error) {
 			this.ui.write('Download failed');
 			fs.appendFileSync(outputLog, 'Download failed with error: ' + error.message);
+			return false;
 		}
 	}