cli mode: tail job logs automatically, show job states while in transition, and init project if none

Author: sanfilip

lib/jobs/create.js

@@ -3,17 +3,21 @@
 var method = require('./../method');
 var assign = require('lodash.assign');
 var path = require('path');
+var mkdirp = require('mkdirp');
 var async = require('async');
 var os = require('os');
 var fs = require('fs');
 var archiver = require('archiver');
 var ProgressBar = require('progress');
 var projectConfig = require('./../projectConfig');
+var jobs_logs = require('./../jobs/logs.js');
+var jobs_waitfor = require('./../jobs/waitfor.js');
+var jobs_show = require('./../jobs/show.js');
 
 /**
  * @memberof jobs
  * @method create
- * @description Create a new Paperspace job.
+ * @description Create a new Paperspace job, and tail its log output if run at the command line. To disable the tailing behavior specify '--tail false'.  Note: if a project is not defined for the current working directory, and you are running in command line mode, a project configuration settings file will be created.  Use '--init false' or specify '--project [projectname]' to override this behavior.
  * @param {object} params - Job creation parameters
  * @param {string} params.container - A required reference to a container name or container link to be used for the job.
  * @param {string} [params.machineType] - An optional machine type to run the job on: either 'GPU+', 'P4000', 'P5000', 'P6000', 'V100', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', or 'C10'.<p>Defaults to 'GPU+'.
@@ -23,6 +27,7 @@ var projectConfig = require('./../projectConfig');
  * @param {string} [params.command] - An optional command to run within the workspace or container.
  * @param {string} [params.workspace] - An optional path to a workspace, or link to a git repository to upload and merge with the container.  If a zip file name is provided it is uploaded instead.  If no workspace is provided the current directory is zipped up and transferred.  If the workspace is 'none', no workspace is merged and the container is run as-is.
  * @param {string} [params.dataset] - An optional reference to a dataset to be merged with the container.
+ * @param {boolean} [params.tail] - Optional; defaults to true in command line mode only.  Specify false to disable automatic tailing.
  * @param {boolean} [params.json] - Optional; if true, do not write progress to standard out.  '--json' with no value is equivalent to true.
  * @param {function} cb - Node-style error-first callback function
  * @returns {object} job - The created job JSON object
@@ -118,6 +123,27 @@ function directorySize(path, cb, size) {
 var MAX_UPLOAD_SIZE = 104857600; // 100MB
 
 function create(params, cb) {
+	var json = false;
+	if (params.json) {
+		json = true;
+		// Note: we don't delete params.json because lib/request.js needs to examine it to determine if upload progress should be displayed
+	}
+	var init = true;
+	if (params.init) {
+		init = params.init;
+		delete params.init;
+	}
+	var tail = global.paperspace_cli && !json; // tail defaults to true in cli mode, false otherwise;
+	if (typeof params.tail === 'boolean') {
+		tail = params.tail;
+		delete params.tail;
+	}
+
+	// XXX TODO trim leading/trailing spaces from input paths
+	// XXX TODO whitelist git services
+	// XXX TODO convert to gzip
+	// XXX TODO stream compress
+
 	var cwd = process.cwd();
 	if (!params.project && !params.projectId) {
 		// default to name of project in .ps_project/config.json or name of current directory
@@ -127,18 +153,28 @@ function create(params, cb) {
 			if (params.project === '/') {
 				return ifCliPrintErrorOnly(new Error('Error: cannot create project from root dir. Please create a project dir and run from there.'));
 			}
+			if (global.paperspace_cli && !json && init) {
+				var config = { 'project': params.project };
+				var configDir = path.resolve(cwd, '.ps_project');
+				if (!fs.existsSync(configDir)) mkdirp.sync(configDir);
+				else if (!fs.statSync(configDir).isDirectory()) {
+					return ifCliPrintErrorOnly(new Error('Error: existing file with same name as .ps_project directory.'));
+				}
+
+				var configFileName = path.resolve(configDir, 'config.json');
+				if (fs.existsSync(configFileName) && !fs.statSync(configFileName).isFile()) {
+					return ifCliPrintErrorOnly(new Error('Error: config file not accessible: ' + configFileName));
+				}
+
+				fs.writeFileSync(configFileName, JSON.stringify(config, null, 2) + '\n');
+
+				// refresh projectConfig state
+				params.project = projectConfig.getProject();
+
+				console.log('New project name: ' + params.project);
+			}
 		}
 	}
-	var json = false;
-	if (params.json) {
-		json = true;
-		// Note: we don't delete params.json because lib/request.js needs to examine it to determine if upload progress should be displayed
-	}
-
-  // XXX TODO trim leading/trailing spaces from input paths
-	// XXX TODO whitelist git services
-	// XXX TODO convert to gzip
-	// XXX TODO stream compress
 
 	if (!params.workspace) params.workspace = cwd;
 
@@ -150,6 +186,37 @@ function create(params, cb) {
 		return cb(err);
 	}
 
+	function maybeTailLogs(err, resp) {
+		if (global.paperspace_cli && !json && tail) {
+			if (err) return cb(err);
+			if (!resp.body || !resp.body.id) return new Error('Job create failed; job id not found.');
+			var jobId = resp.body.id;
+			console.log('New jobId: ' + resp.body.id);
+			console.log('Job ' + resp.body.state);
+			if (resp.body.state === 'Pending') console.log('Waiting for job to run...');
+			return jobs_waitfor({ jobId: jobId, state: 'Running' }, function _waitforCb(err, resp) {
+				if (err) return cb(err);
+				if (!resp.body || !resp.body.state) return new Error('Job state not found.');
+				var state = resp.body.state;
+				console.log('Job ' + state);
+				if (state === 'Stopped' && !state === 'Failed' && !state === 'Running') {
+					return cb();
+				}
+				console.log('Awaiting logs...');
+				return jobs_logs({ jobId: jobId, tail: true  }, function _logsCb(err, resp) {
+					if (err) return cb(err);
+					return jobs_show({ jobId: jobId }, function _showCb(err, resp) {
+						if (err) return cb(err);
+						if (!resp.body || !resp.body.state) return new Error('Job state not found.');
+						console.log('Job ' + resp.body.state + (resp.body.exitCode || resp.body.exitCode === 0 ? ', exitCode ' + resp.body.exitCode : ''));
+						return cb();
+					});
+				});
+			});
+		}
+		return cb(err, resp);
+	}
+
 	// don't allow zipping of the root directory
 	if (params.workspace === '/') {
 		return ifCliPrintErrorOnly(new Error('Error: cannot zip workspace from root directory.'));
@@ -199,7 +266,7 @@ function create(params, cb) {
 					return method(create, params, function _methodCb(err, resp) {
 						if (err) return cb(err);
 						if (resp.body) projectConfig.setLastJobId(resp.body.project, resp.body.id);
-						return cb(err, resp);
+						return maybeTailLogs(err, resp);
 					});
 				});
 
@@ -270,7 +337,7 @@ function create(params, cb) {
 			return method(create, params, function _methodCb(err, resp) {
 				if (err) return cb(err);
 				if (resp.body) projectConfig.setLastJobId(resp.body.project, resp.body.id);
-				return cb(err, resp);
+				return maybeTailLogs(err, resp);
 			});
 		}
 	} else {
@@ -284,7 +351,7 @@ function create(params, cb) {
 		return method(create, params, function _methodCb(err, resp) {
 			if (err) return cb(err);
 			if (resp.body) projectConfig.setLastJobId(resp.body.project, resp.body.id);
-			return cb(err, resp);
+			return maybeTailLogs(err, resp);
 		});
 	}
 }